ποΈ Commerce
- Catalog
- Carts
- Coupons & Promotions
- Orders
- Shipping
- Payments
- Subscriptions
π Customers
- Auth
- Customers
- KYC
ποΈ Engagement & Retention
- Campaigns
- Analytics
π§° Utilities
- Common
Coupons & Promotions
Retrieve all promotions
All active promotions
GET
/
offer
/
promotions
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/offer/promotions \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"success": true,
"content": {
"promotions": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"promotion_type": "discount",
"tags": [
"<string>"
],
"details": {},
"has_redemption_limit": true,
"redemption_limit": 123,
"redemption_count": 123,
"require_minimum_order_total": true,
"minimum_order_total": 123,
"for_first_time_customer_only": true,
"terms_and_conditions": [
"<string>"
],
"starts_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
]
}
}
Authorizations
Access token
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/offer/promotions \
--header 'Authorization: Bearer <token>'
{
"message": "<string>",
"success": true,
"content": {
"promotions": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"promotion_type": "discount",
"tags": [
"<string>"
],
"details": {},
"has_redemption_limit": true,
"redemption_limit": 123,
"redemption_count": 123,
"require_minimum_order_total": true,
"minimum_order_total": 123,
"for_first_time_customer_only": true,
"terms_and_conditions": [
"<string>"
],
"starts_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
]
}
}