Sign in
Ecommerce: Discounts

List discounts

List a store's discounts. Filter by free text over code and name, or by disabled state. Amounts for fixed discounts are integers in the smallest currency unit; percentage discounts carry a whole-number value between 1 and 100.

get/api/ecommerce/v1/stores/{store_id}/discounts

Path parameters

store_idstring required
Example:store_01J8Z5F8W9K8M4A7B3C2D1E0FG

The ID of the store to list discounts for.

Query parameters

qstring
Example:blackfriday

Free-text search over discount code and name.

is_disabled'true' | 'false'

Filter by disabled state.

pageinteger
Example:1

Page number

Response

Success response

Example response

{
  "data": [
    {
      "id": "disc_01J8Z5F8W9K8M4A7B3C2D1E0FG",
      "code": "BLACKFRIDAY",
      "name": "Black Friday",
      "type": "percentage",
      "value": 20,
      "allocation": "total",
      "starts_at": "2026-01-21T07:35:04.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 100
  }
}

Changes

Changed in 1 of the 88 revisions of this API.1