Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

# 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](fallback::https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-invoices/list-invoices-for-multiple-order).


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

orderId

AddInvoiceToOrderRequest

orderInvoices

AddInvoiceToOrderResponse

orderIds

BulkGenerateInvoicesRequest

results

BulkGenerateInvoicesResponse

BulkInvoiceResult

GenerateInvoiceRequest

invoiceId

GenerateInvoiceResponse

appId

Invoice

InvoiceForOrder

invoicesInfo

InvoicesForOrder

Order IDs for which to retrieve invoices.

ListInvoicesForMultipleOrdersRequest

List of order IDs and their associated invoices.

invoicesForOrder

ListInvoicesForMultipleOrdersResponse

ListInvoicesForSingleOrderRequest

invoices

ListInvoicesForSingleOrderResponse

value

BoolValue

Empty

Int64Value

values

ListValue

NullValue

StringValue

fields

Struct

nanos

seconds

Timestamp

Value

boolValue

listValue

nullValue

numberValue

stringValue

structValue

kind

code

data

description

ApplicationError

Number of items that couldn't be processed.

totalFailures

Number of items that were successfully processed.

totalSuccesses

Number of failures without details because detailed failure threshold was exceeded.

undetailedFailures

BulkActionMetadata

Details about the error in case of failure.

Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).

Index of the item within the request array. Allows for correlation between request and response items.

originalIndex

Whether the requested action was successful for this item. When `false`, the `error` field is populated.

success

ItemMetadata

bodyAsJson

ActionEvent

A sequence number defining the order of updates to the underlying entity.
For example, given that some entity was updated at 16:00 and than again at 16:01,
it is guaranteed that the sequence number of the second update is strictly higher than the first.
As the consumer, you can use this value to ensure that you handle messages in the correct order.
To do so, you will need to persist this number on your end, and compare the sequence number from the
message against the one you have stored. Given that the stored number is higher, you should ignore the message.

entityEventSequence

Assumes actions are also always typed to an entity_type
Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction

entityFqdn

ID of the entity associated with the event.

entityId

eventTime

Unique event ID.
Allows clients to ignore duplicate webhooks.

If present, indicates the action that triggered the event.

originatedFrom

This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
This is although the created/updated/deleted notion is duplication of the oneof types
Example: created/updated/deleted/started/completed/email_opened

slug

Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).

triggeredByAnonymizeRequest

DomainEvent

body

entityAsJson

EntityCreatedEvent

deletedEntityAsJson

EntityDeletedEvent

Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.

About the Order Invoices API

Terminology

Permission Scopes