Баримт бичиг / API лавлах

Хөнгөлөлтийн код

Түншийн түгээх код.

GET/v1/workspaces/{workspaceId}/discount-code-validation

Hosted validation for the custom provider flow: the checkout asks whether a code is live and gets the partner, link and discount terms. Key-protected like the rest of the API.

Шаардлагатай API түлхүүрийн хамрах хүрээ: discount_codes.read

Параметр (2)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
codequerystringтийм

Хариу: 200 ValidateDto

GET/v1/workspaces/{workspaceId}/discount-codes

List discount codes of the program, newest first. pageSize max 100.

Шаардлагатай API түлхүүрийн хамрах хүрээ: discount_codes.read

Параметр (6)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
partnerIdquerystring
discountIdquerystring
codequerystringExact code string (case-insensitive).
pagequeryinteger (int32)
pageSizequeryinteger (int32)

Хариу: 200 CodeDto[]

POST/v1/workspaces/{workspaceId}/discount-codes

Create a discount code for a partner link. 422 when the group has no discount or the link is not the partner's, 409 when the link has a code or the string is taken.

Шаардлагатай API түлхүүрийн хамрах хүрээ: discount_codes.write

Параметр (1)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
Хүсэлтийн бие (CreateCode)
НэрТөрөлЗаавалТайлбар
partnerIdstringтийм
linkIdstringтийм
codestringUp to 100 characters of letters, digits, `-` and `_`; generated from the partner name when omitted.

Хариу: 200 CodeDto

DELETE/v1/workspaces/{workspaceId}/discount-codes/{idOrCode}

Delete a code by id or by code string; emits discount_code.deleted.

Шаардлагатай API түлхүүрийн хамрах хүрээ: discount_codes.write

Параметр (2)
НэрБайрлалТөрөлЗаавалТайлбар
workspaceIdpathstringтийм
idOrCodepathstringтийм

Хариу: 200 DeletedDto