Skip to content

List of shipments

Request

Returns a paginated list of shipments. Optionally filter by status or order code.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
statusstring

Filtering by shipment status. Optional. For possible values see Shipment statuses code list.

Example:status=closed
orderCodestring

filtering according to order code. Optional.

Example:orderCode=2024000008
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/shipments?status=closed&orderCode=2024000008' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json; charset=utf-8
dataobjectrequired
errorsArray of objects or null(Errors)required
Response
{
  "data": {
    "items": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ]
}