commerce

List discount codes

Every discount code with its derived uses: paid, and still waiting for payment.

redemptions counts paid orders carrying the code. redemptions_waiting counts orders that still hold a use while they can be paid: pending, failed or abandoned, placed in the last 7 days. Checkout counts both against max_redemptions, so a capped code is used up when the two together reach it.

get/api/v1/commerce/discounts

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/commerce/discounts
  • Auth: HTTP bearer

Response

Success

okboolean required

Example response

{
  "ok": true,
  "codes": [
    {
      "id": "6b9d5a20-1c3d-44ef-b193-0ec9747016d9",
      "code": "WELCOME10",
      "is_active": true,
      "redemptions": 3,
      "redemptions_waiting": 1
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.