Skip to main content

Shipment

Represents a shipment record in the system.

Properties

PropertyTypeRequiredDescription
IdstringYesUnique shipment ID.
AccountNostringYesAccount number of the shipper.
ReferenceIdstringYesCustomer-provided reference ID.
TrackingNumberstringYesCarrier tracking number.
ShippingProductIdstringYesID of the shipping product used.
ToAddressAddressYesDestination address details.
FromAddressAddressYesOrigin address details.
ReturnAddressAddressNoReturn address details.
WeightWeightYesWeight details of the shipment.
SizeDimensionsYesPhysical dimensions of the shipment.
DeclaredValueMoneyNoDeclared value for insurance purposes.
ShipDatestringNoScheduled shipping date in YYYY-MM-DD format.
ExtraServicesstring[]NoExtra services for the shipment.
NotesstringNoNotes
QuoteShipment QuoteNoPricing and fee breakdown.
CarrierShipmentCarrierNoIntegration status with the carrier.
CreateAtDateTimeYesWhen the shipment was created, in ISO 8601 format.

Shipment Carrier Object

PropertyTypeRequiredDescription
StatusstringYesStatus enum: Processing, Created, Failed.
BarcodestringNoScannable barcode of the shipment label.
MessagestringNoFeedback from the carrier's system.