Get tax invoices for order

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

Request and response example

Request:

GET /api/v3/1003/orders/JJ5HH/invoices HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com

Response:

{
    "invoices": [
        {
            "internalId": 1002002,
            "id": "AB000308",
            "created": "2024-11-07 12:09:45 +0000",
            "link": "https://app.ecwid.com/download_tax_invoice?ownerid=JJ5HH&invoice_id=1002002&access_key=a***5",
            "type": "SALE"
        }
        {
            "internalId": 1002004,
            "id": "AB000310",
            "created": "2024-11-17 02:13:10 +0000",
            "link": "https://app.ecwid.com/download_tax_invoice?ownerid=JJ5HH&invoice_id=1002004&access_key=G***c",
            "type": "FULL_CANCEL"
        }
    ]
}

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	array 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.