Shipments

List shipments

List Store-scoped shipments, newest ID first, using cursor pagination. Results contain summaries without label bytes.

get/api/external/v1/shipments

Request

  • Base URL: http://localhost
  • URL: http://localhost/api/external/v1/shipments
  • Auth: HTTP bearer

Query parameters

external_referencestring

Exact caller-provided shipment reference.

Example:architecto
order_referencestring

Exact canonical order reference. For linked shipments this is the API order external reference, Kustom order UUID, or Shopify order GID.

Example:architecto
order_namestring

Exact customer-visible order name. Names are not unique; every matching shipment is returned.

Example:300975_de
label_status'pending' | 'created' | 'failed' | 'cancelled'

Filter by label status.

Example:created
created_fromstring

Created on or after this ISO 8601 timestamp.

Example:architecto
created_tostring

Created on or before this ISO 8601 timestamp.

Example:architecto
updated_fromstring

Updated on or after this ISO 8601 timestamp. See batch polling for tracking changes across pages.

Example:architecto
updated_tostring

Updated on or before this ISO 8601 timestamp.

Example:architecto
cursorstring

Use meta.next_cursor from the previous page with the same filters.

Example:architecto
limitinteger

Shipments per page (1–200, default 50).

Example:16

Request body

external_referencestring nullable
order_referencestring nullable
order_namestring nullable
label_status'pending' | 'created' | 'failed' | 'cancelled' nullable
created_fromstring nullable

Must be a valid date.

created_tostring nullable

Must be a valid date.

updated_fromstring nullable

Must be a valid date.

updated_tostring nullable

Must be a valid date.

cursorstring nullable
limitinteger nullable

Must be at least 1. Must not be greater than 200.

Example request

{
  "external_reference": "architecto",
  "order_reference": "architecto",
  "order_name": "architecto",
  "label_status": "pending",
  "created_from": "2026-10-13T09:06:16",
  "created_to": "2026-10-13T09:06:16",
  "updated_from": "2026-10-13T09:06:16",
  "updated_to": "2026-10-13T09:06:16",
  "cursor": "architecto",
  "limit": 22
}

Response

Example response

{
  "data": [
    {
      "id": "shp_x7Kq9",
      "external_reference": "ERP-SHIPMENT-100045",
      "order_reference": "ERP-ORDER-5001",
      "shipment_status": null,
      "label_status": "created",
      "tracking_number": "PN123456789SE",
      "shipping_method": {
        "id": "sm_a1b2c3",
        "name": "PostNord Service Point"
      },
      "recipient": {
        "name": "Anna Andersson",
        "postal_code": "11151",
        "city": "Stockholm",
        "country": "SE"
      },
      "created_at": "2026-05-27T10:00:00Z",
      "updated_at": "2026-05-27T10:05:00Z"
    }
  ],
  "meta": {
    "next_cursor": "eyJpZCI6MTIzfQ",
    "limit": 50
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.