API reference
- Getting Started with Your API
- SDKs and Toolkits
- Fulfillment Overview
- GETGet Shipments
- POSTCreate Shipment
- POSTCreate Shipments
- GETGet Shipment Step Count by Shipment Type
- GETGet Location Summary Report
- DELDelete Order Shipments
- PUTCancel Order Shipments
- PUTSearch and Receive Transfer
- GETGet Shipment
- PUTReplace Shipment
- DELDelete Shipment
- POSTBackorder Shipment
- PUTUpdate Backorder Items
- POSTBackorder Items
- PUTCancel Shipment
- PUTCancel Items
- PUTCustomer At Curbside
- PUTCustomer At Store
- PUTCustomer Care Shipment
- POSTCustomer Care Items
- PUTCustomer in Transit
- PUTDestination Update
- PUTResend Shipment Email
- PUTFulfill Shipment
- PUTUpdate Fulfillment Fields
- PUTUpdate Gift Card Info
- PUTResend Item Email
- GETRender Order Summary
- POSTPicked Up Items
- PUTReassign Shipments
- PUTReassign Items
- PUTReceive Transfer
- PUTRefresh Shipment
- PUTReject Shipment
- PUTReject Items
- GETRender Packing Slip
- PUTRetry Fulfilling Shipment
- GETGet Tasks
- PUTExecute Task
- PUTRevert Task
- PUTSkip Task
- PUTTransfer Shipment
- PUTTransfer Items
- GETWorkflow Definition Image
- GETGet Workflow Instance Image
- GET
Error
Copy
Ask AI
A valid request URL is required to generate request examplesCopy
Ask AI
{
"_embedded": {},
"_links": {
"empty": true
},
"page": {
"number": 123,
"size": 123,
"totalElements": 123,
"totalPages": 123
}
}Get Shipments
A paged list of shipments is returned according to any specified filter criteria and sort options. These Fulfillment APIs use a different paging and filtering scheme than most other APIs in the system. For more information, see the Sorting & Filtering APIs guide in the knowledge base.
GET
/
commerce
/
shipments
Error
Copy
Ask AI
A valid request URL is required to generate request examplesCopy
Ask AI
{
"_embedded": {},
"_links": {
"empty": true
},
"page": {
"number": 123,
"size": 123,
"totalElements": 123,
"totalPages": 123
}
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
⌘I