Organization API: Org Staff Coupons
Every Organization API operation tagged Org Staff Coupons.
Base URL: https://api.coritan.com/api/v1. Paths below are complete.
To try these requests in the browser, open the interactive Organization API reference.
GET /api/v1/orgs/{org_slug}/staff/coupons
| Name |
In |
Type |
Required |
org_slug |
path |
string |
yes |
status |
query |
string or null |
no |
| Status |
Meaning |
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
POST /api/v1/orgs/{org_slug}/staff/coupons
| Name |
In |
Type |
Required |
org_slug |
path |
string |
yes |
application/json (required)
| Field |
Type |
Required |
code |
string |
yes |
description |
string or null |
no |
kind |
string |
no |
value |
number or string |
yes |
currency |
string or null |
no |
applies_to |
array of integer or null |
no |
first_invoice_only |
boolean |
no |
max_redemptions |
integer or null |
no |
per_customer_limit |
integer |
no |
starts_at |
string (date-time) or null |
no |
ends_at |
string (date-time) or null |
no |
status |
string |
no |
| Status |
Meaning |
201 |
Success. |
422 |
The request is not valid. detail lists each problem. |
POST /api/v1/orgs/{org_slug}/staff/coupons/feature
Turn coupons on or off for the brand. Off means the checkout shows no
code field and every code is refused, whatever its status.
| Name |
In |
Type |
Required |
org_slug |
path |
string |
yes |
application/json (required)
| Field |
Type |
Required |
enabled |
boolean |
yes |
| Status |
Meaning |
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
PATCH /api/v1/orgs/{org_slug}/staff/coupons/{coupon_id}
| Name |
In |
Type |
Required |
coupon_id |
path |
integer |
yes |
org_slug |
path |
string |
yes |
application/json (required)
| Field |
Type |
Required |
description |
string or null |
no |
value |
number or string or null |
no |
applies_to |
array of integer or null |
no |
clear_applies_to |
boolean |
no |
max_redemptions |
integer or null |
no |
clear_max_redemptions |
boolean |
no |
per_customer_limit |
integer or null |
no |
starts_at |
string (date-time) or null |
no |
ends_at |
string (date-time) or null |
no |
clear_ends_at |
boolean |
no |
status |
string or null |
no |
| Status |
Meaning |
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
GET /api/v1/orgs/{org_slug}/staff/coupons/{coupon_id}/redemptions
| Name |
In |
Type |
Required |
Description |
coupon_id |
path |
integer |
yes |
|
org_slug |
path |
string |
yes |
|
limit |
query |
integer |
no |
Default: 100. |
| Status |
Meaning |
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
