Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# About Orders Settings

With the Orders Settings API, you can retrieve and update settings that apply to a site’s eCommerce orders. These settings include adding or removing customer email notifications about order status, defining when to update the store inventory, and creating invoices.    

The default orders settings are provided when you first create a Wix eCommerce site. 

## Before you begin

It’s important to note the following points before starting to code:  

- Install the [Wix Stores](fallback::https://www.wix.com/app-market/wix-stores?referral=category&appIndex=1&referralTag=ecommerce), [Wix Bookings](fallback::https://www.wix.com/app-market/wix-bookings?referral=category&appIndex=0&referralTag=booking--events), or [Wix Events & Tickets](fallback::https://www.wix.com/app-market/wix-events?referral=category&appIndex=5&referralTag=booking--events) app from Wix App Market.

## Use Cases

- [Update orders settings across all sites](fallback::/orders-settings/sample-use-cases-and-flows)

## Terminology

- **Order**: The final stage of the eCommerce purchase flow: cart, checkout, and order. An order represents a customer's request to purchase one or more products or services from a seller. It typically includes details such as the type and quantity of items, shipping address, payment information, and any other relevant transaction details. 
- **Invoice**: Commercial document issued by a seller to a buyer, providing a detailed account of products or services rendered, along with the corresponding costs.  
- **Inventory**: List of goods, products, or materials that a business holds for the purpose of resale or use in its operations.


# Orders Settings: Sample Use Cases and Flows

This article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation. 

## Update orders settings across all sites

If you have several Wix eCommerce sites that use your app you might need to apply the same orders settings to those sites. For example, if now the store inventory is updated only after an order is paid, this change also needs to be reflected on other sites.

To update the orders settings across all sites:

1. Call [Get Orders Settings](fallback::/orders-settings/get-orders-settings) on the site where you updated the settings.
1. Extract the `inventoryUpdateTrigger` field value.
1. Call [Update Orders Settings](fallback::/orders-settings/update-orders-settings) for your other sites and pass the new settings to each.



identityType

IdentificationData

WebhookIdentityType

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

data

eventType

The identification type and identity data.

instanceId

MessageEnvelope

value

BoolValue

paths

FieldMask

Int64Value

values

ListValue

NullValue

StringValue

fields

Struct

nanos

seconds

Timestamp

Value

boolValue

listValue

nullValue

numberValue

stringValue

structValue

kind

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.

currentEntityAsJson

EntityUpdatedEvent

DeleteOrdersSettingsRequest

DeleteOrdersSettingsResponse

GetOrdersSettingsRequest

GetOrdersSettingsResponse

InventoryUpdateTrigger

Whether to automatically create invoices for every new order paid online.
<br>
Default: `false`
<br>
**Note**: The issued invoice for an order is not a tax invoice and doesn't reflect refunds. You are responsible for ensuring that invoices you issue conform to any relevant legal requirements.

createInvoice

Date and time the orders settings were created.

createdDate

Defines when to update the store inventory:

- `ON_ORDER_PAID`: Stock quantities will update only after the payment is approved.
- `ON_ORDER_PLACED`: Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock.

Default: `ON_ORDER_PLACED`

Get Orders Settings

Permission Scopes