commerce

Create a discount code

Create a checkout discount: a percentage, a rand amount, or free delivery, exactly one of the three.

Pass exactly ONE of percent_off (1 to 100), amount_off_rands (R1 to R100 000) or free_delivery: true.

Codes are stored uppercase (2 to 40 letters, numbers or dashes) and normalised the same way at checkout.

A date-only expires_at like 2026-09-30 means through the end of that day. min_order_rands gates any kind.

post/api/v1/commerce/discounts

Request

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

Request body

codestring required
percent_offnumber
expires_atstring date-time
max_redemptionsnumber

Example request

{
  "code": "WELCOME10",
  "percent_off": 10,
  "expires_at": "2026-09-30",
  "max_redemptions": 100
}

Response

Success

okboolean required

Example response

{
  "ok": true,
  "discount": {
    "id": "6b9d5a20-1c3d-44ef-b193-0ec9747016d9",
    "code": "WELCOME10",
    "is_active": true
  }
}

Changes

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