object Shipment
Fields
| Field | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | String | Public API ID for this identifiable. | ||||||||||||||||||||||||||||||
legacy_id | BigInt | Numeric legacy ID for this identifiable; use only where legacy IDs are required. | ||||||||||||||||||||||||||||||
order_id | String | Public API order ID that identifies the related record. | ||||||||||||||||||||||||||||||
user_id | String | Public API user ID that identifies the related record. | ||||||||||||||||||||||||||||||
warehouse_id | String | Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects. | ||||||||||||||||||||||||||||||
pending_shipment_id | String | Public API pending shipment ID that identifies the related record. | ||||||||||||||||||||||||||||||
address | Address | Address details for this shipment. | ||||||||||||||||||||||||||||||
profile | String | Profile for this shipment. | ||||||||||||||||||||||||||||||
picked_up | Boolean | Whether the carrier picked up this shipment. | ||||||||||||||||||||||||||||||
needs_refund | Boolean | True when this shipment needs refund; false otherwise. | ||||||||||||||||||||||||||||||
refunded | Boolean | Whether this shipment has refunded label charges. | ||||||||||||||||||||||||||||||
delivered | Boolean | Whether the carrier marked this shipment as delivered. | ||||||||||||||||||||||||||||||
shipped_off_shiphero | Boolean | Whether this shipment was shipped outside Shiphero. | ||||||||||||||||||||||||||||||
dropshipment | Boolean | Whether this shipment is a dropshipment. | ||||||||||||||||||||||||||||||
completed | Boolean | This field indicates if store was notified about the shipment. It should be 'true' by default and 'false' when using the Bulk Ship UI. | ||||||||||||||||||||||||||||||
created_date | ISODateTime | Created date in ISO-8601 date or datetime format, returned in UTC when time is included. | ||||||||||||||||||||||||||||||
line_items | ShipmentLineItemConnection | List of line items associated with this shipment. | ||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||
shipping_labels | [ShippingLabel] | List of shipping labels for this shipment. | ||||||||||||||||||||||||||||||
warehouse | Warehouse | Warehouse display value or nested warehouse object for this record. Use warehouse_id when passing a warehouse reference. | ||||||||||||||||||||||||||||||
order | Order | Order associated with this shipment. | ||||||||||||||||||||||||||||||
total_packages | Int | Total packages as a numeric value. | ||||||||||||||||||||||||||||||
ready_to_ship | String | Readiness flag for this shipment; use shipment status fields for current workflow state. | ||||||||||||||||||||||||||||||
Referenced By
- CreateShipmentOutput Type
- MergeableOrder Type
- Order Type
- OrderShipmentMutationOutput Type
- Package Type
- ShipmentEdge Type
- ShipmentQueryResult Type
Example
{
"id": "UmVjb3JkOjEyMzQ=",
"legacy_id": 1234,
"order_id": "U2hpcG1lbnQ6MTIzNA==",
"user_id": "U2hpcG1lbnQ6MTIzNA==",
"warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
"pending_shipment_id": "U2hpcG1lbnQ6MTIzNA==",
"address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
"profile": "default",
"picked_up": true,
"needs_refund": true,
"refunded": true,
"delivered": true,
"shipped_off_shiphero": true,
"dropshipment": true,
"completed": true,
"created_date": "2026-07-09T15:30:00Z",
"line_items": [{sku: "BLUE-TEE-M", quantity: 2}],
"shipping_labels": [[{tracking_number: "1Z999AA10123456784", carrier: "ups"}]],
"warehouse": {id: "V2FyZWhvdXNlOjEyMzQ=", identifier: "Primary Warehouse"},
"order": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"},
"total_packages": 100,
"ready_to_ship": "pending"
}