Docs
Management API
Promotions Bulk

Promotions (Bulk)

Get All Promotions

GET /promotions

Request

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

Parameters

  • store_hash in path - string

example

Response

Body

object | application/json
  • data
    array[]

  • meta
    object

    Contains data about the response including pagination and collection totals.

example-1

Delete Multiple Promotions

DELETE /promotions

Request

Deletes multiple promotions. Currently, batches are limited to 50 promotions.

Notes

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

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

A 204 response.

Did you find what you were looking for?