List shipments for an order.

GET

/orders/{direction}/{orderID}/shipments

200

Roles

At least one of the roles below is required to access this endpoint.

FullAccessOrderAdminShipmentReader

Name		Type	Description	Possible Values
direction	Required	`string`	Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.	Incoming, Outgoing, All
orderID	Required	`string`	ID of the order.	---
search		`string`	Word or phrase to search for.	---
searchOn		`array`	Comma-delimited list of fields to search on.	ID, BuyerID, Shipper, DateShipped, DateDelivered, TrackingNumber
sortBy		`array`	Comma-delimited list of fields to sort by.	DateShipped, OwnerID, ID, BuyerID, Shipper, DateDelivered, Cost, !DateShipped, !OwnerID, !ID, !BuyerID, !Shipper, !DateDelivered, !Cost
page		`integer`	Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.	---
pageSize		`integer`	Number of results to return per page. Default: 20, max: 100.	---
filters		`object`	An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'	---

Property Type Format Max Length Possible Values

Items array --- --- ---

Meta object --- --- ---

GET