Docs
Management API
Promotions
Coupon Codes Bulk

Coupon Codes (Bulk)

Get Coupon Codes

GET /promotions/{promotion_id}/codes

Request

Get codes for a particular promotion.

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

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.
  • promotion_id in path - string
    required
    The ID of the associated promotion.
  • before in query - string

    A cursor that can be used for backwards pagination. Will fetch results before the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'after' query parameter.

  • after in query - string

    A cursor that can be used for forwards pagination. Will fetch results after the position corresponding to the cursor. Cannot be used with the 'page' query parameter. Cannot be used with the 'before' query parameter.

  • page in query - integer

    Query parameter that specifies the page number in a paginated list of resources. This field is deprecated and the 'before' and 'after' cursor parameters should be used instead.

  • limit in query - integer

    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.

example

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

Response

Body

object | application/json

  • data    array[object]

  • meta    object

    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.

example-1

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

Delete Multiple Coupon Codes

DELETE /promotions/{promotion_id}/codes

Request

Deletes multiple coupon codes relating to the given promotion. Currently, batches are limited to 50 coupon codes.

Notes

  • "id:in" query param is required to delete coupon codes. If not provided, or provided with the wrong data format, a 422 error code is returned.
  • The default rate limit for this endpoint is 40 concurrent requests.

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.
  • id:in in query - array
    required

    A comma-separated list of promotions to filter or target with this operation.

    Example: ?id:in=11,12,13,14

    Type: array[integer]
  • promotion_id in path - string
    required
    The ID of the associated promotion.

example

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

Response

A 204 response.

Generate Multiple Coupon Codes

POST /promotions/{promotion_id}/codegen

Request

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

Parameters

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

Body

object | application/json

  • batch_size    integer
    required

    The number of coupon codes to generate in each batch. The maximum value is 250.
    Min: 1
    Max: 250
    Example: 5

  • max_uses    integer

    The maximum number of times each coupon code can be used. The default value is 1. The value 0 means unlimited usage.
    Min: 0
    Max: 100000
    Example: 10

  • max_uses_per_customer    integer

    The maximum number of times a specific customer can use each coupon code. The default value is 1. The value 0 means unlimited usage.
    Min: 0
    Max: 100000
    Example: 5

example

{
"batch_size": 5,
"max_uses": 10,
"max_uses_per_customer": 5
}

Response

Body

object | application/json

  • data    object

  • meta    object

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

example-1

{
"data": {
"max_uses": 10,
"max_uses_per_customer": 5,
"created": "2019-01-20T22:00:00+00:00",
"batch_size": 5,
"codes": [
{
"code": "WFYUYQM1W1ZYGK7S"
},
{
"code": "TQ4PBBEK9SCZ212Z"
},
{
"code": "B2YKV43O18LPJGNS"
},
{
"code": "OSGJJBV3WBRC3G7X"
},
{
"code": "XA8JS9T2N0C2TGS3"
}
]
},
"meta": {}
}
Did you find what you were looking for?
PromotionsGet Coupon Codes