BAbagisto
Customer Order

Retrieves a CustomerOrderShipment resource.

Retrieves a CustomerOrderShipment resource.

get/customer-order-shipments/{id}

Request

Path parameters

idstring required

Customer order shipment ID

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 resource

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.