Schemas | Freight API
Freight API schemas: every request and response object used by the DataShift Freight API, with field types and required properties.
ConnectorSummary
Prop
Type
ConnectorListResponse
Prop
Type
Address
Prop
Type
BookingAddress
Prop
Type
Package
Prop
Type
RateRequest
Prop
Type
RatedService
Prop
Type
AggregatedRateResult
Prop
Type
AggregatedRateResponse
Prop
Type
SingleConnectorRateResponse
Prop
Type
Items
Prop
Type
BookingRequest
Prop
Type
ConsignmentBookingRequest
BookingRequest plus a required `packages` array. `POST /{connectorId}/shipments` needs the authoritative per-package weight/dimension breakdown (not just the flattened `items` total) so the carrier consignment payload carries one line per physical package with its own real weight, rather than an averaged weight applied to every line.
Prop
Type
BookingResponse
Prop
Type
PickupBookingRequest
Provide either `shipmentId` alone (derived mode — books against that existing consignment) or all three of `collection`, `items`, and `receiver` together (standalone mode). A partial standalone submission (e.g. `collection` without `items`/`receiver`) is rejected with a 400.
Prop
Type
PickupBookingResponse
Prop
Type
PickupBookingDetail
One pickup-booking attempt. Every attempt is its own row — for a shipment with a retry history, this is a single row, not the latest-of-many; use the shipment's own `pickupStatus` for the current outcome.
Prop
Type
PickupBookingDetailResponse
Prop
Type
ShipmentSummary
Prop
Type
ShipmentListResponse
Prop
Type
ShipmentDetail
Prop
Type
ShipmentDetailResponse
Prop
Type
CancelEligibilityRequest
Prop
Type
CancelWarning
Prop
Type
CancelEligibilityResult
Prop
Type
CancelEligibilityResponse
Prop
Type
CancelShipmentsRequest
Prop
Type
CancelSkipped
Prop
Type
CancelShipmentsResponse
Prop
Type
TrackingEvent
Prop
Type
TrackingPod
Proof of delivery. Populated by TNT AU (its Customer Consignment Tracking service) and TGE AU (its ProofOfDelivery service, `signedBy` only); BEX AU has the signer only on the v1 batch path. Other carriers omit this field entirely rather than returning it null.
Prop
Type
TrackingInfo
Prop
Type
TrackingResponse
Prop
Type
PrintDevice
Prop
Type
PrintDevicePrinter
Prop
Type
PrintDeviceListResponse
Prop
Type
PrintRequest
Prop
Type
PrintJobCreated
Prop
Type
LabelNotAvailableError
Prop
Type
PrintNotFoundError
Prop
Type
CarrierError
Prop
Type
Error
Prop
Type
Last updated on