Generate Multiple Coupon Codes | BigCommerce Developer Center

Generate a batch of coupon codes for a particular bulk coupon promotion.

Note:

batch_size (number of codes generated per request) is limited to 250. If batch_size is not an integer or larger than 250, it will return a 422 error code.
The default rate limit for this endpoint is 10 concurrent requests.

Generate a batch of coupon codes for a particular bulk coupon promotion. **Note:** * batch_size (number of codes generated per request) is limited to 250. If batch_size is not an integer or larger than 250, it will return a 422 error code. * The default rate limit for this endpoint is 10 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).

Path parameters

promotion_idstringRequired

The ID of the associated promotion.

Request

This endpoint expects an object.

batch_sizeintegerRequired1-250

The number of coupon codes to generate in each batch. The maximum value is 250.

max_usesintegerOptional0-100000

The maximum number of times each coupon code can be used. The default value is 1. The value 0 means unlimited usage.

max_uses_per_customerintegerOptional0-100000

The maximum number of times a specific customer can use each coupon code. The default value is 1. The value 0 means unlimited usage.

Response

dataobject

metaobject

Empty meta object, which may be used at a later time.

Errors

400

Bad Request Error

403

Forbidden Error

405

Method Not Allowed Error

422

Unprocessable Entity Error

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v3/promotions/promotion_id/codegen"
4
5	payload = { "batch_size": 5 }
6	headers = {
7	"Accept": "application/json",
8	"X-Auth-Token": "<apiKey>",
9	"Content-Type": "application/json"
10	}
11
12	response = requests.post(url, json=payload, headers=headers)
13
14	print(response.json())

1	{
2	"data": {
3	"created": "2019-01-20T22:00:00+00:00",
4	"max_uses": 10,
5	"max_uses_per_customer": 5,
6	"batch_size": 5,
7	"codes": [
8	{
9	"code": "WFYUYQM1W1ZYGK7S"
10	},
11	{
12	"code": "TQ4PBBEK9SCZ212Z"
13	},
14	{
15	"code": "B2YKV43O18LPJGNS"
16	},
17	{
18	"code": "OSGJJBV3WBRC3G7X"
19	},
20	{
21	"code": "XA8JS9T2N0C2TGS3"
22	}
23	]
24	},
25	"meta": {}
26	}

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Request

Response

Errors

OAuth scopes

Authentication header

Further reading