Docs
Management API
Promotions Bulk

Promotions API

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
  • id in query - integer

    Filter items by id.

  • name in query - string

    Filter items by name.

  • code in query - string

    Filter items by code.

  • currency_code in query - string

    Filter items by currency_code.

  • redemption_type in query - string

    Filter items by redemption type

    Allowed: automatic | coupon

  • status in query - string

    Filter items by status.

  • page in query - integer

    Query parameter that specifies the page number in a paginated list of resources.

  • limit in query - integer
    required

    Query parameter that limits the number of items displayed per page in a paginated list of resources.

  • sort in query - string

    Query parameter that specifies the field name to sort by. The default value is id.

    Allowed: id | name | priority | start_date

  • direction in query - string

    Query parameter that specifies the sorting direction. The default value is asc.

    Allowed: asc | desc

  • channels in query - array

    Filter promotions that target those channel IDs. Example: ?channels=1,2. Note: promotions that target all the channels are included in the filtering result.

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
  • 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]

example

Response

A 204 response.

Did you find what you were looking for?