API reference
- Getting Started with Your API
- SDKs and Toolkits
- Catalog Administration Overview
- POSTDelete Coupons
- GETGet Assigned Discounts
- POSTAssign Discount to Coupon Set
- GETGet Coupon
- DELDelete Coupon
- GETGet Coupon Set
- PUTUpdate Coupon Set
- DELDelete Coupon Set
- GETGet Coupon Sets
- POSTAdd Coupon Set
- GETGet Coupons
- POSTAdd Coupons
- GETGet Unique Coupon Set Code
- DELUnassign Discount from Coupon Set
- POSTValidate Unique Coupon Set Code
Error
A valid request URL is required to generate request examples{
"couponCode": "<string>",
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"canBeDeleted": true,
"couponSetCode": "<string>",
"couponSetId": 123,
"redemptionCount": 123
}Get Coupon
Retrieves a single coupon by its coupon code.
GET
/
commerce
/
catalog
/
admin
/
couponsets
/
{couponSetCode}
/
couponcodes
/
{couponCode}
Error
A valid request URL is required to generate request examples{
"couponCode": "<string>",
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"canBeDeleted": true,
"couponSetCode": "<string>",
"couponSetId": 123,
"redemptionCount": 123
}Documentation Index
Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
limits which fields are returned in the response body
Response
Success
Coupon in a coupon set.
The code the customer uses to claim this coupon
Show child attributes
Show child attributes
Link to associated coupon
ReadOnly system id for releated couponset.
Total number of times this code has been redeemed. ReadOnly, calculated. Only returned with response group includeCounts
⌘I