Auth
- POSTAnonymous user
- POSTLogin with phone
- POSTLogin with email
- POSTLogin with whatsapp
- POSTLogin with password
- POSTVerify OTP
- POSTRegister with phone
- POSTRegister with email
- POSTRegister with whatsapp
- POSTRegister with password
- GETRetrieve a user
- PUTUpdate a user
- GETRetrieve a profile image
- PUTUpdate profile image
- POSTAdd profile image
- DELDelete profile image
- PUTDeactivate account
- POSTRefresh access token
- POSTChange password
- POSTForgot password
- POSTReset password
- GETRetrieve user notification preferences
- PUTUpdate user notification preferences
- POSTCreate user notification preferences
- POSTGenerate OTP
- POSTLogout user
- POSTCheck email/phone verification status
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
- POSTApply coupon
- DELRemove coupon
- POSTRedeem loyalty points
- DELRemove loyalty points
- POSTUse credit balance
- DELRemove credit balance
- POSTRedeem gift card
- DELRemove gift card
- GETRetrieve wishlist
- POSTAdd product to wishlist
- DELDelete product from wishlist
Coupons & promotions
Customers
Orders
Shipping
Analytics
Campaigns
Retrieve all 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
promotion model
Available options:
discount
, free-shipping
, free-goods
, fixed-price
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"
}
]
}
}