Get Coupon Code | BigCommerce Developer Center

import requests
url = "https://api.bigcommerce.com/stores/store_hash/v3/promotions/codes"
querystring = {"code":"TEST_COUPON"}
headers = {"X-Auth-Token": "<apiKey>"}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

{
  "data": [
    {
      "id": 1,
      "code": "TEST_COUPON",
      "current_uses": 0,
      "created": "2019-01-20T22:00:00+00:00",
      "max_uses": 10,
      "max_uses_per_customer": 5
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "current": "?page=1&limit=50"
      }
    },
    "cursor_pagination": {
      "count": 1,
      "per_page": 50,
      "links": {
        "next": "?limit=5&after=eyJpZCI6IjIzNzU1NyJ9"
      },
      "start_cursor": "eyJpZCI6IjIzNzU1NyJ9",
      "end_cursor": "eyJpZCI6IjIzNzU1MyJ9"
    }
  }
}

Get a coupon with a given coupon code.

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

Query parameters

codestringRequired

Filter items by code.

Response

datalist of objects

metaobject

Contains data about paginating the response via cursors. If no pagination details are specified, then both properties will be present. When a ‘before’ or ‘after’ cursor is provided, only the ‘cursor_pagination’ property will be present. When a ‘page’ parameter is provided, only the offset based ‘pagination’ property will be present.