Skip to content

ShipmentState ​

Type: Object

A shipment tracking record

Fields ​

NameTypeArgsDescriptionDeprecated
carrierCarrierStateShipping carrier. Requires carrier:read permission.
carrierIdCarrierIDAssociated carrier ID
createdAtString!Creation timestamp (ISO8601)
currencyCurrencyISOCurrency code
deliveredAtISO8601Delivered timestamp (ISO8601)
estimatedDeliveryAtISO8601Estimated delivery timestamp (ISO8601)
idShipmentID!Unique identifier
notesStringOptional notes
orderOrderStateSource order. Requires order:read permission.
orderIdOrderIDAssociated order ID
packages[ShipmentPackageState!]!Packages in this shipment. Requires shipment:read permission.
shipmentNumberStringShipment number
shippedAtISO8601Shipped timestamp (ISO8601)
shippingAddressIdAddressIDShipping address ID
shippingCostFloatShipping cost
statusShipmentStatus!Shipment status
totalPackagesIntTotal number of packages
totalWeightFloatTotal weight
trackingNumberStringTracking number
trackingUrlStringTracking URL
updatedAtString!Last update timestamp (ISO8601)

Relationships ​

Connect machines, automate workflows, and build custom apps for print production.