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

200

{
  "_embedded": {},
  "_links": {
    "empty": true
  },
  "page": {
    "number": 123,
    "size": 123,
    "totalElements": 123,
    "totalPages": 123
  }
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

bypassSearchIndex · boolean

filter · string

isLate · boolean

page · integer<int32>

pageSize · integer<int32>

quickSearch · string

sort · string

workflowTaskName · string

Response

200

application/hal+json

OK

_embedded · object

Show child attributes

_links · Links · object

Show child attributes

page · PageMetadata · object

Show child attributes