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:

Use Cases

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.
Was this helpful?
Yes
No

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 on the site where you updated the settings.
  2. Extract the inventoryUpdateTrigger field value.
  3. Call Update Orders Settings for your other sites and pass the new settings to each.
Was this helpful?
Yes
No

Orders Settings Object

Properties
inventoryUpdateTriggerstring
3 enum supported values:
UNKNOWN_INVENTORY_UPDATE_TRIGGERON_ORDER_PAIDON_ORDER_PLACED
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

createInvoiceboolean
Whether to automatically create invoices for every new order paid online.
Default: false
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.
Was this helpful?
Yes
No

GetGet Orders Settings

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 site's order settings.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Read eCommerce - all read permissions
Read Orders
Read Stores - all read permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/ecom/v1/orders-settings

Was this helpful?
Yes
No

PatchUpdate Orders Settings

Developer Preview

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

Updates the site's orders settings.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage eCommerce - all permissions
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/ecom/v1/orders-settings

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

Orders Settings Updated

Developer Preview

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

Triggered when orders settings are updated.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Read eCommerce - all read permissions
Read Orders
Read Stores - all read permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.ecom.v1.orders_settings.

slugstring
Event name. Expected updated.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

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

originatedFromstring
If present, indicates the action that triggered the event.

updatedEventobject
Event information.

Was this helpful?
Yes
No