List Promotions | BigCommerce Developer Center

curl https://api.bigcommerce.com/stores/store_hash/v3/promotions \
     -H "X-Auth-Token: <apiKey>"

{
  "data": [
    {
      "id": 1,
      "redemption_type": "AUTOMATIC",
      "name": "Buy Product worth X Get Y% off upto Z",
      "display_name": "Shop for X and get Y% off upto Z",
      "channels": [
        {
          "id": 1
        }
      ],
      "customer": {
        "group_ids": [
          1,
          2,
          3
        ],
        "minimum_order_count": 0,
        "excluded_group_ids": [
          1,
          2,
          3
        ],
        "segments": {
          "id": [
            "ccec121a-f9bc-4a04-809e-1fe0d8ae7fdd"
          ]
        }
      },
      "rules": [
        {
          "action": {
            "cart_value": {
              "discount": {
                "percentage_amount": "10"
              },
              "maximum_allowed_discount_amount": "20"
            }
          },
          "apply_once": true,
          "stop": true,
          "condition": {
            "cart": {
              "items": {
                "brands": [
                  1,
                  2,
                  3
                ]
              },
              "minimum_spend": "12.95",
              "minimum_quantity": 1
            }
          }
        }
      ],
      "current_uses": 2,
      "max_uses": 10,
      "status": "ENABLED",
      "start_date": "2019-01-20T22:00:00.000Z",
      "end_date": "2019-01-20T22:00:00.000Z",
      "stop": false,
      "can_be_used_with_other_promotions": false,
      "currency_code": "USD",
      "notifications": [
        {
          "content": "Get 10% off on orders over $100 containing Brand A, B or C products.",
          "type": "UPSELL",
          "locations": [
            "HOME_PAGE"
          ]
        }
      ],
      "shipping_address": {
        "countries": [
          {
            "iso2_country_code": "US"
          }
        ]
      },
      "schedule": {
        "week_frequency": 2,
        "week_days": [
          "Monday"
        ],
        "daily_start_time": "01:20:00",
        "daily_end_time": "23:59:00"
      },
      "created_from": "api"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

Returns a list of promotions.

The response includes the display name and other details about each promotion, and lists the promotions ordered by ID by default.

Note: The default rate limit for this endpoint is 40 concurrent requests.

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.

### 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-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts). For more about BigCommerce OAuth scopes, see [API Accounts and OAuth Scopes](/developer/docs/overview/api-accounts#api-accounts). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Query parameters

idintegerOptional

Filter items by id.

namestringOptional

Filter items by name.

codestringOptional

Filter items by code.

currency_codestringOptional

Filter items by currency_code.

redemption_typeenumOptional

Filter items by redemption type

Allowed values:

statusstringOptional

Filter items by status.

pageintegerOptional>=1

Query parameter that specifies the page number in a paginated list of resources.

limitintegerOptional1-250

Query parameter that limits the number of items displayed per page in a paginated list of resources. When none is specified a default value of 50 is used.

sortenumOptional

Query parameter that specifies the field name to sort by. The default value is id.

Allowed values:

directionenumOptional

Query parameter that specifies the sorting direction. The default value is asc.

Allowed values:

channelslist of integersOptional

Filter promotions that target those channel IDs. Example: ?channels=1,2. Note: promotions that target all the channels are included in the filtering result.

querystringOptional

Filter items by both name or code.

Response

datalist of objects

metaobject

Contains data about the response including pagination and collection totals.

Errors

422

Unprocessable Entity Error