PATCH

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

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/ecom/v1/orders-settings

Body Params
ordersSettingsOrdersSettingsRequired

Orders settings to update.

Response Object
ordersSettingsOrdersSettings

The updated orders settings.

Update orders settings
Request
cURL
curl -X PATCH \ 'https://www.wixapis.com/ecom/v1/orders-settings' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ -d '{ "ordersSettings": { "createInvoice": true } }'
Response
JSON
{ "ordersSettings": { "inventoryUpdateTrigger": "ON_ORDER_PLACED", "createInvoice": true, "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.

Event TriggersThis method triggers the following events:
Did this help?