Create a discount code
Creates a code. type is PERCENT (value 1-100), FIXED (value in minor units of the studio currency)
or DEPOSIT_EXEMPT (no value). code is 4-32 characters of A-Z, 0-9 and -, stored upper case, unique in
the studio and across its gift vouchers (409, field: code) and cannot be changed later. Discount codes
are account-level: live at once, not part of any publish. Requires the catalog:write scope, the PRO plan and
an Idempotency-Key header.
ApiKeyAuth catalog:writeAuthorizationBearer <shyni_sk_live_*>An API key, issued once and never retrievable again: an organization key in the developer
portal, or a studio key in the studio's admin (Moje studio → API). Send as Authorization: Bearer shyni_sk_live_....
Scope: catalog:write
Idempotency-Key*stringCaller-chosen idempotency token for this write. A retry under the SAME key with
the SAME body replays the first response; the SAME key with a DIFFERENT body is
422 IDEMPOTENCY_KEY_MISMATCH. See Idempotency above.
length <= 64application/json- body
code*stringtype*string"PERCENT""FIXED""DEPOSIT_EXEMPT"value?integerint64validFrom?stringdatevalidUntil?stringdatemaxUses?integermaxUsesPerCustomer?integerThe new discount code.
application/json- response
id*stringcode*stringtype*string"PERCENT""FIXED""DEPOSIT_EXEMPT"value*|Whole percent (PERCENT), minor units of the studio currency (FIXED) or null.
int64validFrom*|datevalidUntil*|datemaxUses*integer|nullmaxUsesPerCustomer*integer|nullactive*booleanusedCount*integerNon-cancelled orders that used the code.
createdAt*stringdate-timecurl -X POST 'https://api.shyni.io/api/v1/discount-codes' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \ -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13' \ -H 'Content-Type: application/json' \ -d '{ "code": "string", "type": "PERCENT"}'Response 201
The new discount code.
{ "id": "string", "code": "string", "type": "PERCENT", "value": 0, "validFrom": "2019-08-24", "validUntil": "2019-08-24", "maxUses": 0, "maxUsesPerCustomer": 0, "active": true, "usedCount": 0, "createdAt": "2019-08-24T14:15:22Z"}Response 400
A parameter, header or request body is missing, malformed, or out of range. A request body property the endpoint does not define answers UNKNOWN_FIELD instead, with field naming it.
{ "code": "INVALID_INPUT", "message": "Parameter perPage must be between 1 and 100."}Response 401
Missing, malformed, unknown, or revoked API key (INVALID_API_KEY).
{ "code": "INVALID_API_KEY", "message": "Missing or invalid API key."}Response 403
The key is valid but the request is refused. Branch on code: INSUFFICIENT_SCOPE (the key lacks the
permission this endpoint requires), PLAN_REQUIRED (the studio is not on a plan that includes API keys,
Pro and above), ORIGIN_NOT_ALLOWED, SECRET_KEY_IN_BROWSER, or DEMO_STUDIO on a write to the demo studio.
See Authentication and Scopes above.
{ "code": "INSUFFICIENT_SCOPE", "message": "This API key does not have the permission this endpoint requires."}Response 404
The resource does not exist, or belongs to a different studio.
{ "code": "NOT_FOUND", "message": "Order not found."}Response 409
The request is well-formed but the studio's current state forbids it.
{ "code": "CONFLICT", "message": "The voucher cannot be deactivated because it is not active."}Response 422
The same Idempotency-Key was already used for a request with a different body, use a new key (see Idempotency above).
{ "code": "IDEMPOTENCY_KEY_MISMATCH", "message": "This Idempotency-Key was already used for a different request. Use a new key."}Response 429
Burst rate limit exceeded.
{ "code": "RATE_LIMITED", "message": "Too many requests. Retry after the time given in the Retry-After header."}