Shipment

Object

id

The Globally Unique ID of this object

status

The current status of the shipment

createdAt

When the shipment was created

updatedAt

When the shipment was last updated

method

The shipping method (e.g. Ground, Priority Mail)

courier

The courier/carrier (e.g. USPS, UPS, FedEx)

weight

The weight of the shipment

dimensions

The dimensions of the shipment

sellerPaidShippingCost

Amount the seller paid for shipping

signatureRequired

Whether a signature is required upon delivery

hazardousMaterial

The hazardous material classification for this shipment.

maxBundleSize

The max bundle size for this shipment

insuranceInfo

Insurance information for this shipment

shipmentItemCount

The number of shipment items in this shipment

totalItemQuantity

The total quantity of items in this shipment

totalOrderValue

The total value of all orders in this shipment

actionItemsNeeded

Actions required from the seller before this shipment can be processed

dropoffDueDetails

Details about when the shipment is due to be dropped off. If the shipment is already dropped off, this will be null.

shipmentItems

The order items included in this shipment.

Required scopes: read:shipments

buyer

The buyer receiving this shipment.

Required scopes: read:customer

destinationAddress

The shipping address for this shipment.

Required scopes: read:customer

trackingInfo

Tracking information for the shipment (tracking code, courier, label URL).

shipmentDocuments

Documents associated with the shipment (label, bundled file, commercial invoice).