Skip to main content

Promotions

2026-09-18 — Promotions — create, read, update and delete a promotion; apply a coupon to an order​

🆕 New

  • POST /v1/promotions — Creates a new promotion (coupon) for your company: name, code, discount, validity window, usage limits, and optional product/service-type/audience/schedule restrictions.
  • GET /v1/promotions/{id} — Returns a single promotion by id.
  • PATCH /v1/promotions/{id} — Partially updates a promotion. Only the fields you send are changed; a field can be set but not cleared back to unset (sending null is rejected with a 422).
  • DELETE /v1/promotions/{id} — Deletes a promotion by id.

Scopes​

  • promotions:write — required by POST /v1/promotions, PATCH /v1/promotions/{id} and DELETE /v1/promotions/{id}. Existing API keys need it granted before calling them.