curl --location --request GET 'https://client.corrily.com/v1/coupons'
curl --location --request GET 'https://client.corrily.com/v1/coupons?name=Discount-1'
{
"message": "Successfully retrieved all coupons.",
"success": true,
"coupons": [
{
"api_id": "coupon_1",
"name": "Coupon_1",
"currency": null,
"coupon_type": {
"coupon_type": "percentage"
},
"value": 10,
"active_from": null,
"active_till": null,
"org": 1,
"status": "ACTIVE",
"created_at": "2024-01-17T09:40:18.058647+00:00",
"updated_at": "2024-01-17T09:40:18.058647+00:00",
"coupon_external_coupons": []
}
]
}
Coupons
Get Coupons
Retrieve a list of coupons
GET
/
v1
/
coupons
curl --location --request GET 'https://client.corrily.com/v1/coupons'
curl --location --request GET 'https://client.corrily.com/v1/coupons?name=Discount-1'
{
"message": "Successfully retrieved all coupons.",
"success": true,
"coupons": [
{
"api_id": "coupon_1",
"name": "Coupon_1",
"currency": null,
"coupon_type": {
"coupon_type": "percentage"
},
"value": 10,
"active_from": null,
"active_till": null,
"org": 1,
"status": "ACTIVE",
"created_at": "2024-01-17T09:40:18.058647+00:00",
"updated_at": "2024-01-17T09:40:18.058647+00:00",
"coupon_external_coupons": []
}
]
}
curl --location --request GET 'https://client.corrily.com/v1/coupons'
curl --location --request GET 'https://client.corrily.com/v1/coupons?name=Discount-1'
{
"message": "Successfully retrieved all coupons.",
"success": true,
"coupons": [
{
"api_id": "coupon_1",
"name": "Coupon_1",
"currency": null,
"coupon_type": {
"coupon_type": "percentage"
},
"value": 10,
"active_from": null,
"active_till": null,
"org": 1,
"status": "ACTIVE",
"created_at": "2024-01-17T09:40:18.058647+00:00",
"updated_at": "2024-01-17T09:40:18.058647+00:00",
"coupon_external_coupons": []
}
]
}
Query Params
string
Filter coupons by name
Response
boolean
Whether or not the request completed successfully.
string
Text information about request status. In case of an error here will be a useful explanation.
array
An array of found coupons
Show child attributes
Show child attributes
object
A coupon object
Show child attributes
Show child attributes
string
Coupon’s api_id value
string
Coupon’s name
string
Coupon’s currency. Can be null
object
Coupon_type object
Show child attributes
Show child attributes
string
Can be:
- ‘percentage’ for coupons with discount in percents.
- ‘fixed_amount’ for coupons with fixed discount
number
Coupon’s value for discount
string
ISODate value since which a coupon can be applied.
string
ISODate value until which a coupon can be used.
string
Coupon’s status. Can be: “ACTIVE” and “NOT_ACTIVE”
⌘I