Sign in
Commerce

List discounts

The store's discounts (Shopify code and automatic discounts, WooCommerce coupons), cursor-paginated with limit, cursor and an optional query. Each discount lists its first 10 codes; codeCount has the total. Needs discounts.read.

get/v1/commerce/discounts

Query parameters

accountIdstring required

Connected store SocialAccount id.

limitinteger
cursorstring
querystring

Platform search syntax, passed through.

Response

Discounts listed

nextCursorstring nullable

Example response

{
  "discounts": [
    {
      "value": {
        "percentage": 15
      },
      "minimum": {
        "amount": {
          "amount": "19.90",
          "currency": "USD"
        }
      }
    }
  ]
}

Changes

Changed in 2 of the 60 revisions of this API.2