Backend API
Fields
Unique identifier for the shipment.
List of line items describing the products shipped.
Unique identifier for the shipment item.
ID of the order item shipped.
ID of the item product.
ID of the order bundle item shipped, if applicable.
Options from the order item shipped, if applicable.
Unique identifier for the object.
Name of the product option.
Name value of the product option.
Expandable link to the item product.
Quantity of the item shipped. Defaults to 1.
ID of the item variant, if applicable.
Expandable link to the item variant, if applicable.
The id of the order this shipment was created for.
Indicates the shipment was canceled.
The id of a third-party carrier offering the service, if applicable.
Name of a third-party carrier offering the service, if applicable.
Date and time the shipment was created.
Date the expected shipment is meant to arrive at the destination, if applicable.
Date and time the shipment was last updated.
The customer's shipping address.
Destination customer name.
Destination address line 1: street address/PO box/company name.
Destination address line 2: apartment/suite/unit/building.
Two-letter ISO code country code.
Destination city/district/suburb/town/village.
Destination state/county/province/region.
Destination zip/postal code.
Destination phone number.
Indicates the shipment is a draft.
Internal admin notes, not visible to the customer.
Expandable list of notifications sent on behalf of the shipment.
Unique incremental shipment number, assigned automatically.
Expandable link to the order.
The shipment origin location.
ID of the origin location, if applicable.
List of packages included in this shipment.
Height of the package in centimeters or inches.
Length of the package in centimeters or inches.
Type of package. This value can be enumerated, representing the types of packages used by the fulfillment provider.
Weight of the package in the unit of the store's default (lb, oz, lb).
Width of the package in centimeters or inches.
The id of a shipping service as configured in shipment settings.
Name of the shipping service.
Tracking code used to identify the shipment, if applicable.
The order’s shipping label.
Date and time the label was created.
When set to true, a shipment label will be purchased on-demand from the carrier. The carrier is set in label purchase settings.
An image of the shipment label, if present.
Unique identifier for the image.
Date the image was uploaded.
Size of the image in bytes.
An MD5 hash of the image contents. This can be used to identify the image for caching purposes.
Optional image name.
MIME content type of the image.
Arbitrary image data, typically used to store custom values. See Frontend API for more details.
A reference to the raw image data.
Indicates the image is not visible to customers.
A public URL to reference the image. Updated automatically if image content changes.
Image width in pixels, if applicable.
Image height in pixels, if applicable.
The shipment model
{
"id": "60f199509111e70000000089",
"items": [
{
"id": "5ca537326a0ec32a521139dd",
"order_item_id": null,
"product_id": "5cad15bc9b14d1990724663b",
"quantity": 2
}
],
"order_id": "60f199509111e7000000008b",
"date_created": "2021-07-16T14:36:00.413Z",
"date_updated": "2021-07-16T14:36:00.413Z",
"destination": {
"name": "Hieronymus Lex",
"address1": "South Watch Tower, Captain's Quarters",
"city": "Imperial City",
"state": "NY",
"zip": 11201,
"country": "US",
"phone": "(555) 555-5555"
},
"service": "imperial_express",
"tracking_code": "T192000000XYZ"
}