Customer Order

Retrieves the collection of CustomerOrder resources.

get/customer-orders

Request

Base URL
http://localhost:8000/api/shop
Auth
HTTP bearer
TypeScript
https://skmtc.dev/bagisto/apis/bagisto-shop-api/docs/customer-orders/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

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

CustomerOrder collection

idinteger nullable

incrementIdstring nullable

statusstring nullable

channelNamestring nullable

customerEmailstring nullable

customerFirstNamestring nullable

customerLastNamestring nullable

shippingMethodstring nullable

shippingTitlestring nullable

couponCodestring nullable

totalItemCountinteger nullable

totalQtyOrderedinteger nullable

grandTotalnumber nullable

baseGrandTotalnumber nullable

subTotalnumber nullable

baseSubTotalnumber nullable

taxAmountnumber nullable

shippingAmountnumber nullable

discountAmountnumber nullable

baseCurrencyCodestring nullable

orderCurrencyCodestring nullable

createdAtstring nullable

updatedAtstring nullable

Changes

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