ποΈ Commerce
- Catalog
- Carts
- POSTCreate cart
- GETRetrieve cart detail
- DELDelete cart
- GETRetrieve cart using user id
- DELDelete cart using user id
- POSTAdd/delete cart item
- POSTUpdate cart address
- POSTUpdate shipping method
- POSTApply coupon
- DELRemove coupon
- POSTRedeem loyalty points
- DELRemove loyalty points
- POSTUse credit balance
- DELRemove credit balance
- POSTRedeem gift card
- DELRemove gift card
- GETRetrieve all coupons
- GETRetrieve all promotions
- GETRetrieve wishlist
- POSTAdd product to wishlist
- DELDelete product from wishlist
- POST
- Coupons & Promotions
- Orders
- Shipping
- Payments
- Subscriptions
π Customers
- Auth
- Customers
- KYC
ποΈ Engagement & Retention
- Campaigns
- Analytics
π§° Utilities
- Common
Carts
Retrieve all coupons
Retrieve active coupons
GET
/
carts
/
available-coupons
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/carts/available-coupons \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"success": true,
"content": {
"coupons": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"redemption_limits": {
"total_redemptions": 123,
"per_customer_redemptions": 123,
"per_coupon_code_redemptions": 123
},
"redemption_count": 123,
"minimum_order_total": 0,
"starts_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"details": {
"discount_type": "<string>",
"discount_percent": 123,
"maximum_discount_amount": 123,
"products": [
{
"product_id": "<string>",
"variant_id": "<string>",
"minimum_quantity": 123,
"maximum_quantity": 123,
"minimum_value": 123,
"maximum_value": 123
}
],
"category_id": [
"<string>"
]
},
"applies_to_product": "all",
"coupon_type": "discount",
"coupon_code": [
"<string>"
],
"application_rules": {
"max_applicable_items": 123,
"application_priority": "cheapest_first"
},
"can_be_used_with_promotion": true
}
]
}
}
Authorizations
Access token
Headers
Commercengine customer group id.
Response
200
application/json
OK
The response is of type object
.
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/carts/available-coupons \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"success": true,
"content": {
"coupons": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"redemption_limits": {
"total_redemptions": 123,
"per_customer_redemptions": 123,
"per_coupon_code_redemptions": 123
},
"redemption_count": 123,
"minimum_order_total": 0,
"starts_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"details": {
"discount_type": "<string>",
"discount_percent": 123,
"maximum_discount_amount": 123,
"products": [
{
"product_id": "<string>",
"variant_id": "<string>",
"minimum_quantity": 123,
"maximum_quantity": 123,
"minimum_value": 123,
"maximum_value": 123
}
],
"category_id": [
"<string>"
]
},
"applies_to_product": "all",
"coupon_type": "discount",
"coupon_code": [
"<string>"
],
"application_rules": {
"max_applicable_items": 123,
"application_priority": "cheapest_first"
},
"can_be_used_with_promotion": true
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.