BAbagisto
Customer Order

Retrieves a CustomerOrder resource.

Changed on

Retrieves a CustomerOrder resource.

get/customer-orders/{id}

Request

Path parameters

idstring required

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

CustomerOrder resource

idinteger nullable
incrementIdstring nullable
statusstring nullable
channelNamestring nullable
isGuestboolean nullable
customerEmailstring nullable
customerFirstNamestring nullable
customerLastNamestring nullable
customerFullNamestring nullable
shippingMethodstring nullable
shippingTitlestring nullable
shippingDescriptionstring nullable
couponCodestring nullable
isGiftboolean nullable
totalItemCountinteger nullable
totalQtyOrderedinteger nullable
baseCurrencyCodestring nullable
channelCurrencyCodestring nullable
orderCurrencyCodestring nullable
grandTotalnumber nullable
baseGrandTotalnumber nullable
grandTotalInvoicednumber nullable
baseGrandTotalInvoicednumber nullable
grandTotalRefundednumber nullable
baseGrandTotalRefundednumber nullable
subTotalnumber nullable
baseSubTotalnumber nullable
subTotalInvoicednumber nullable
baseSubTotalInvoicednumber nullable
subTotalRefundednumber nullable
baseSubTotalRefundednumber nullable
discountPercentnumber nullable
discountAmountnumber nullable
baseDiscountAmountnumber nullable
discountInvoicednumber nullable
baseDiscountInvoicednumber nullable
discountRefundednumber nullable
baseDiscountRefundednumber nullable
taxAmountnumber nullable
baseTaxAmountnumber nullable
taxAmountInvoicednumber nullable
baseTaxAmountInvoicednumber nullable
taxAmountRefundednumber nullable
baseTaxAmountRefundednumber nullable
shippingAmountnumber nullable
baseShippingAmountnumber nullable
shippingInvoicednumber nullable
baseShippingInvoicednumber nullable
shippingRefundednumber nullable
baseShippingRefundednumber nullable
shippingDiscountAmountnumber nullable
baseShippingDiscountAmountnumber nullable
shippingTaxAmountnumber nullable
baseShippingTaxAmountnumber nullable
shippingTaxRefundednumber nullable
baseShippingTaxRefundednumber nullable
subTotalInclTaxnumber nullable
baseSubTotalInclTaxnumber nullable
shippingAmountInclTaxnumber nullable
baseShippingAmountInclTaxnumber nullable
customerIdinteger nullable
channelIdinteger nullable
cartIdinteger nullable
appliedCartRuleIdsstring nullable
createdAtstring nullable
updatedAtstring nullable
hasNonCancelableBookingunknown

Changes

  • b84d43839844Revision changes
    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/html)