About the Order Invoices API

The Order Invoices API allows you to retrieve the IDs of invoices, and IDs of the external invoice apps that created them.

With the Order Invoices API, you can retrieve invoice IDs and external invoice app IDs associated with one or more orders.

Terminology

  • Invoice ID: Used to retrieve the invoice itself from the service that created it.
  • Invoice App ID: ID of the external invoice app that created the invoice.
Did this help?

Invoice Object


Manage eCommerce order invoices

Properties
idstring

Invoice ID.


appIdstring

ID of the app that set the invoice.

Did this help?

POST

List Invoices For Multiple Orders


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves the IDs of invoices associated with all specified orders.

Permissions
Manage eCommerce - all permissions
Read eCommerce - all read permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Read Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/ep-invoices/list-by-ids

Body Params
orderIdsArray <string>RequiredminItems 0maxItems 100minLength 1maxLength 100

Order IDs for which to retrieve invoices.

Response Object
invoicesForOrderArray <InvoicesForOrder>

List of order IDs and their associated invoices.

List Invoices For Multiple Orders

Retrieves invoices of the 2 requested order IDs

Request
cURL
curl -X POST \ 'https://www.wixapis.com/ecom/v1/invoices/list-by-ids' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ --data-binary '{ "orderIds": [ "ba2553e1-548e-4b84-96d8-4978e74d7b3b", "5887eb1a-d695-4a8b-965a-b2a9dec463a9" ] }'
Response
JSON
{ "invoicesForOrder": [ { "orderId": "5887eb1a-d695-4a8b-965a-b2a9dec463a9", "invoicesInfo": [ { "id": "5887eb1a-d695-4a8b-965a-b2a9dec463a9", "appId": "1380b703-ce81-ff05-f115-39571d94dfcd" } ] }, { "orderId": "ba2553e1-548e-4b84-96d8-4978e74d7b3b", "invoicesInfo": [ { "id": "ba2553e1-548e-4b84-96d8-4978e74d7b3b", "appId": "1380b703-ce81-ff05-f115-39571d94dfcd" } ] } ] }
Did this help?