BAbagisto
Customer Order

List shipments for the authenticated customer

Mirrors the GraphQL customerOrderShipments(orderId:) query. Use ?order_id=N to scope to a specific order, ?status=X to filter by shipment status.

get/customer-order-shipments

Request

Query parameters

order_idinteger
Example:3

Return only shipments for this order ID. Accepts orderId as an alias.

statusstring

Filter by shipment status (pending, shipped, canceled).

pageinteger

The collection page number

per_pageinteger

The number of items per page

Headers

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring
Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring
Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring
Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Response

CustomerOrderShipment collection

idinteger
statusstring nullable
totalQtyinteger nullable
totalWeightnumber nullable
carrierCodestring nullable
carrierTitlestring nullable
trackNumberstring nullable
emailSentboolean
customerIdinteger nullable
customerTypestring nullable
inventorySourceIdinteger nullable
inventorySourceNamestring nullable
createdAtstring date-time nullable
updatedAtstring date-time nullable
shippingNumberstring
itemsstring[]
shippingAddressstring iri-reference
billingAddressstring iri-reference

Example response

[
  {
    "items": [
      "https://example.com/"
    ],
    "shippingAddress": "https://example.com/",
    "billingAddress": "https://example.com/"
  }
]

Changes

No recorded changes to this operation across all 13 revisions of this API.