Beta Programs
Promotions
Coupon Codes Bulk

Promotions API (Beta)

Get Coupon Codes (Beta)

GET /promotions/{promotion_id}/codes

Request

Get codes for a particular promotion.

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

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • promotion_id in path - string - required

    The ID of the associated promotion.

example

Response

Body

object | application/json
  • data
    array[object]

  • meta
    object

    Contains data about the response including pagination and collection totals.

example-1

Delete Multiple Coupon Codes (Beta)

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 - required

Parameters

  • store_hash in path - string
  • 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

  • promotion_id in path - string - required

    The ID of the associated promotion.

example

Response

A 204 response.

Did you find what you were looking for?