BAbagisto
Customer Order

List invoices for the authenticated customer

Mirrors the GraphQL customerInvoices(orderId:) query. Use ?order_id=N to scope to a specific order, ?state=paid (or pending, pending_payment, overdue, refunded) to filter by invoice state.

get/customer-invoices

Request

Query parameters

order_idinteger
Example:590

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

statestring

Filter by invoice state (pending, pending_payment, paid, overdue, refunded).

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

CustomerInvoice collection

idinteger
incrementIdstring nullable
statestring nullable
emailSentboolean
totalQtyinteger nullable
baseCurrencyCodestring nullable
channelCurrencyCodestring nullable
orderCurrencyCodestring nullable
subTotalnumber nullable
baseSubTotalnumber nullable
grandTotalnumber nullable
baseGrandTotalnumber nullable
shippingAmountnumber nullable
baseShippingAmountnumber nullable
taxAmountnumber nullable
baseTaxAmountnumber nullable
discountAmountnumber nullable
baseDiscountAmountnumber nullable
shippingTaxAmountnumber
baseShippingTaxAmountnumber
subTotalInclTaxnumber
baseSubTotalInclTaxnumber
shippingAmountInclTaxnumber
baseShippingAmountInclTaxnumber
transactionIdstring nullable
remindersinteger
nextReminderAtstring date-time nullable
createdAtstring date-time nullable
updatedAtstring date-time nullable
downloadUrlstring
itemsstring[]
addressesstring[]

Example response

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

Changes

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