RESTAdminManagementPromotion SettingsPromotion Settings

Update Global Promotion Settings

- Updates global promotion settings. - Note: *promotions_apply_on_products_with_custom_product_price*, *number_of_coupons_allowed_at_checkout* and *promotions_triggered_by_products_with_zero_product_price* can only be modified by enterprise accounts.

Authentication

X-Auth-Tokenstring
### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Marketing | modify | `store_v2_marketing` | | Marketing | read-only | `store_v2_marketing_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see [API Accounts and OAuth Scopes](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts). For more about BigCommerce OAuth scopes, see [API Accounts and OAuth Scopes](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Request

This endpoint expects an object.
promotions_apply_on_products_with_custom_product_pricebooleanRequiredDefaults to false
  • When the property is set to “true”, promotions will apply for products with custom pricing.
  • When the property is set to “false”, promotions will not apply for products with custom pricing.
  • Note: This field can only be edited for Enterprise Accounts.
promotions_triggered_by_products_with_zero_product_pricebooleanRequiredDefaults to false
  • When the property is set to “true”, promotions will be triggered by zero price products.
  • When the property is set to “false”, promotions will not be triggered by zero price products.
  • Note: This field can only be edited for Enterprise Accounts.
number_of_coupons_allowed_at_checkoutintegerRequired1-5Defaults to 1

Specifies the number of coupons allowed at checkout on a single order.

  • Note: This field can only be edited for Enterprise Accounts.
promotions_applied_on_original_product_pricebooleanRequiredDefaults to true
  • When the property is set to “true”, promotions in a cart are calculated independently, each applied to the original price of the included products.
  • When the property is set to “false”, promotions in a cart are calculated cumulatively, applied to the order sub-total based on your promotion order.

Response

OK
promotions_apply_on_products_with_custom_product_pricebooleanDefaults to false
  • When the property is set to “true”, promotions will apply for products with custom pricing.
  • When the property is set to “false”, promotions will not apply for products with custom pricing.
  • Note: This field can only be edited for Enterprise Accounts.
promotions_triggered_by_products_with_zero_product_pricebooleanDefaults to false
  • When the property is set to “true”, promotions will be triggered by zero price products.
  • When the property is set to “false”, promotions will not be triggered by zero price products.
  • Note: This field can only be edited for Enterprise Accounts.
number_of_coupons_allowed_at_checkoutinteger1-5Defaults to 1

Specifies the number of coupons allowed at checkout on a single order.

  • Note: This field can only be edited for Enterprise Accounts.
promotions_applied_on_original_product_pricebooleanDefaults to true
  • When the property is set to “true”, promotions in a cart are calculated independently, each applied to the original price of the included products.
  • When the property is set to “false”, promotions in a cart are calculated cumulatively, applied to the order sub-total based on your promotion order.

Errors

400
Bad Request Error
422
Unprocessable Entity Error