GET

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

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
GET
https://www.wixapis.com/ecom/v1/orders-settings
Request
This endpoint does not take any parameters.
Response Object
ordersSettingsOrdersSettings

Orders settings.

Get orders settings
Request
cURL
curl -X GET \
  'https://www.wixapis.com/ecom/v1/orders-settings' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: <AUTH>'
Response
JSON
{
  "ordersSettings": {
    "inventoryUpdateTrigger": "ON_ORDER_PLACED",
    "createInvoice": false,
    "createdDate": "2024-07-04T15:10:46.070Z",
    "updatedDate": "2024-07-04T15:10:46.070Z"
  }
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?