Docs
Management API
Promotion settings

Promotion Settings API

A promotion setting determines how promotions should be applied and/or calculated.

To learn more about promotions, consult the Promotions Overview.

Get Global Promotion Settings

GET /promotions/settings

Request

Returns global promotion settings.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/promotions/settings' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

OK

Body

object | application/json

  • promotions_apply_on_products_with_custom_product_price    boolean
    required

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

    Default: false

  • promotions_triggered_by_products_with_zero_product_price    boolean
    required

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

    Default: false

  • number_of_coupons_allowed_at_checkout    integer
    required

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

    • Note: This field can only be edited for Enterprise Accounts.
    Min: 1
    Max: 5
    Example: 1

    Default: 1

  • promotions_applied_on_original_product_price    boolean
    required

    • 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.
    Example: true

    Default: true

example

{
"promotions_triggered_by_products_with_zero_product_price": true,
"promotions_apply_on_products_with_custom_product_price": false,
"number_of_coupons_allowed_at_checkout": 1,
"promotions_applied_on_original_product_price": true
}

Update Global Promotion Settings

PUT /promotions/settings

Request

  • 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-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • promotions_apply_on_products_with_custom_product_price    boolean
    required

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

    Default: false

  • promotions_triggered_by_products_with_zero_product_price    boolean
    required

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

    Default: false

  • number_of_coupons_allowed_at_checkout    integer
    required

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

    • Note: This field can only be edited for Enterprise Accounts.
    Min: 1
    Max: 5
    Example: 1

    Default: 1

  • promotions_applied_on_original_product_price    boolean
    required

    • 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.
    Example: true

    Default: true

example

{
"promotions_triggered_by_products_with_zero_product_price": true,
"promotions_apply_on_products_with_custom_product_price": false,
"number_of_coupons_allowed_at_checkout": 1,
"promotions_applied_on_original_product_price": true
}

Response

OK

Body

object | application/json

  • promotions_apply_on_products_with_custom_product_price    boolean
    required

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

    Default: false

  • promotions_triggered_by_products_with_zero_product_price    boolean
    required

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

    Default: false

  • number_of_coupons_allowed_at_checkout    integer
    required

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

    • Note: This field can only be edited for Enterprise Accounts.
    Min: 1
    Max: 5
    Example: 1

    Default: 1

  • promotions_applied_on_original_product_price    boolean
    required

    • 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.
    Example: true

    Default: true

example

{
"promotions_apply_on_products_with_custom_product_price": false,
"promotions_triggered_by_products_with_zero_product_price": false,
"number_of_coupons_allowed_at_checkout": 1,
"promotions_applied_on_original_product_price": true
}

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Delete PromotionGet Global Promotion Settings