Customer Order

Retrieves a CustomerOrderShipmentItem resource.

Retrieves a CustomerOrderShipmentItem resource.

get/customer-order-shipment-items/{id}

Request

Path parameters

idstring required

Customer order shipment item 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

CustomerOrderShipmentItem resource

idinteger
namestring nullable
descriptionstring nullable
skustring nullable
qtyinteger nullable
weightnumber nullable
pricenumber nullable
basePricenumber nullable
totalnumber nullable
baseTotalnumber nullable
priceInclTaxnumber
basePriceInclTaxnumber
productIdstring nullable
productTypestring nullable
createdAtstring date-time nullable
updatedAtstring date-time nullable
shipmentstring iri-reference

Example response

{
  "shipment": "https://example.com/"
}

Changes

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