API reference
- Getting Started with Your API
- SDKs and Toolkits
- Fulfillment Overview
- PUTUpdate Backorder Items
- POSTBackorder Items
- POSTBackorder Shipment
- PUTCancel Items
- PUTCancel Order Shipments
- PUTCancel Shipment
- POSTCreate Shipments
- PUTCustomer At Curbside
- PUTCustomer At Store
- POSTCustomer Care Items
- PUTCustomer Care Shipment
- PUTCustomer in Transit
- DELDelete Order Shipments
- PUTDestination Update
- PUTExecute Task
- PUTFulfill Shipment
- GETGet Location Summary Report
- GETGet Shipment
- PUTReplace Shipment
- DELDelete Shipment
- GETGet Shipment Step Count by Shipment Type
- GETGet Shipments
- POSTCreate Shipment
- GETGet Tasks
- GETGet Workflow Instance Image
- POSTPicked Up Items
- PUTReassign Items
- PUTReassign Shipments
- PUTReceive Transfer
- PUTRefresh Shipment
- PUTReject Items
- PUTReject Shipment
- GETRender Order Summary
- GETRender Packing Slip
- PUTResend Item Email
- PUTResend Shipment Email
- PUTRetry Fulfilling Shipment
- PUTRevert Task
- PUTSearch and Receive Transfer
- PUTSkip Task
- PUTTransfer Items
- PUTTransfer Shipment
- PUTUpdate Fulfillment Fields
- PUTUpdate Gift Card Info
- GETWorkflow Definition Image
Error
A valid request URL is required to generate request examples{
"_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
A valid request URL is required to generate request examples{
"_embedded": {},
"_links": {
"empty": true
},
"page": {
"number": 123,
"size": 123,
"totalElements": 123,
"totalPages": 123
}
}Documentation Index
Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
⌘I