Get tax invoices for order

GET https://app.ecwid.com/api/v3/{storeId}/orders/{orderId}/invoices

Required access scopes

Your app must have the following access scopes to make this request: read_orders

Path params

All path params are required.

Param
Type
Description

storeId

number

Ecwid store ID.

orderId

number

Order ID. Can contain prefixes and suffixes, for example: EG4H2,J77J8,SALE-G01ZG

Query params

All query params are optional.

Param
Type
Description

responseFields

string

Limit JSON response by specific fields. If specified, all missing fields will be removed from the response body. Example: ?responseFields=invoices(id,link)

Headers

The Authorization header is required.

Header
Format
Description

Authorization

Bearer secret_ab***cd

Access token of the application.

Response JSON

A JSON object with the following fields:

Field
Type
Description

invoices

Details about tax invoices created for the order.

invoices

Field
Type
Description

internalId

number

Internal ID of the tax invoice.

id

string

Public invoice ID visible in the tax invoice.

created

string

Datetime of tax invoice creation in UTC +0.

link

string

Download link for the tax invoice in PDF format.

type

string

Tax invoice type.

One of: SALE - Regular sale invoice. FULL_CANCEL - Full refund invoice.

Last updated

Was this helpful?