Cart
Handles shopping carts, including adding, removing, and updating items, as well as calculating totals.
The cart provides detailed information about selected items, including their name, quantity, price breakup, applied discounts, and any relevant attributes like size, product image, or tags. It also displays availability status, estimated shipping time, and seller information. This helps customers track their products throughout the order journey.
Operations
POST
# Check cart serviceability
POST
# Check COD serviceability and charges for cart
GET
# Get abandoned carts
GET
# Get abandoned cart details
POST
# Add items to cart
PUT
# Update cart items
POST
# Share cart link
GET
# List shared cart items
POST
# Update shared cart items
GET
# List of carts
PUT
# Update user of a cart
GET
# Get a cart
POST
# Add items to cart
PUT
# Update cart items
PATCH
# Update cart breakup values
PUT
# Delete a cart
GET
# Get a cart items count
PUT
# Update cart metadata
Verify the serviceability of items in the cart at a specific pin code and ensure accurate delivery promises. System checks each item's availability and delivery feasibility, providing real-time information on serviceability and estimated delivery times.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
Request body
cart_items
array of object (CartItem)
Required
List of items in open api cart response
Show
shipping_address
object (ShippingAddress)
Required
Show
POST
Response
200
Cart details with pincode validity information at item level
Hide
Cart serviciability API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment common config, coupon, coupon text, gstin etc.
is_valid
boolean
Cart validity flag determines the if the response is valid or not
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
delivery_promise
object (ShipmentPromise)
Show
message
string
Message of the cart detail API response
breakup_values
object (CartBreakup)
Show
Examples
Parameters
Parameters are not required.
Response
Check cart serviceability
checkCartServiceability
Check whether Cash on Delivery (COD) is available for the given cart items at a specific pin code, and return the applicable COD charges. Performs a pincode-level serviceability check via the logistics layer and computes COD fee based on cart value and payment configuration.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
Request body
cart_items
array of object (CartItem)
Required
List of items in the cart
Show
shipping_address
object (ShippingAddress)
Required
Show
POST
Response
200
Cart details with COD availability and charges at pincode level
Hide
Cart COD serviceability API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment common config, coupon, coupon text, gstin etc along with COD availability and charges.
is_valid
boolean
Cart validity flag determines the if the response is valid or not
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
delivery_promise
object (ShipmentPromise)
Show
message
string
Message of the cart detail API response
breakup_values
object (CartBreakup)
Show
is_cod_available
boolean
Indicates whether Cash on Delivery is available for the given cart items at the requested pincode, based on logistics serviceability and payment configuration
Examples
Parameters
Parameters are not required.
Response
Check COD serviceability and charges for cart
checkCODServiceability
Retrieve the list of abandoned carts that have been active for the specified period of time and have not yet been archived for the specific sales channel.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
page_noquery
integer
current page no as per pagination
Default Value : 0
page_sizequery
integer
Cart max records fetched in single request
Default Value : 10
from_datequery
string
| date-time
Cart which are created on or after from_date
to_datequery
string
| date-time
Cart which are created on or before to_date
anonymous_cartquery
boolean
Filter by `anonymous_cart`
last_idquery
string
pagination is done based on the last_object_id
sort_onquery
string
on which column to sort on i.e created_on or last_modified
GET
Response
200
Abandoned Cart List for sent page_size and page_no
Hide
Abandon cart api response schema hich includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
items
array of object (AbandonedCart)
List of items in abandon cart
Show
result
object
Define the list of items with updated status
page
object (Page)
Show
success
boolean
The request success is defined
message
string
message of the response
Examples
Parameters
Parameters are not required.
Response
Get abandoned carts
getAbandonedCart
Retrieves abandoned cart details linked to a specific customer using a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart
iquery
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
bquery
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
cquery
boolean
This is a boolean value. Select `true` to retrieve the cod charges in breakup of cart items.
GET
Response
200
Success. Returns a Cart object. Check the example shown below or refer `CartDetailResult` for more details.
Hide
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
payment_selection_lock
object (PaymentSelectionLock)
Show
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
coupon
object (CartDetailCoupon)
Show
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
i:
false
b:
false
c:
false
Response
Get abandoned cart details
getAbandonedCartDetails
Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
cart_idpath
string
Required
Current Cart id of user cart
bquery
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
Request body
new_cart
boolean
Field to create to new cart whille user adds item to cart
items
array of object (AddProductCart)
List of items detail which need to be added to cart like item id, item size, and item quantity
Show
POST
Response
200
Success. Returns a cart object as shown below. Refer `AddCartDetailResult` for more details.
Hide
Update cart detail response schema denotes cart data and message of the add product into cart
success
boolean
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResult)
Show
partial
boolean
When adding multiple items check if all added. True if only few are added.
message
string
Message of add cart API response
result
object
Add to cart result data
items
array of object (CartItemInfo)
List of items that needs to be added in cart.
Show
Examples
Parameters
Parameters are not required.
Response
Add items to cart
addItems
Customers can modify added product attributes such as quantity and size, as well as remove items from the cart.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
cart_idpath
string
Required
Current Cart id of user cart
bquery
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
Request body
items
array of object (UpdateProductCart)
Show
free_gift_items
array of object (FreeGiftItemCreation)
List of free gift items with updated sizes.
Show
operation
string
Required
Cart opertaion type
Enum
PUT
Response
200
Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResult` for more details.
Hide
Update cart detail response schema denotes cart data and message of the update cart API response
success
boolean
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResult)
Show
result
object
Contains article related result info
items
array of object (CartItemInfo)
List of items that needs to be updated in cart.
Show
message
string
Message of update cart API response
Response
Update cart items
updateCart
Share cart link
getCartShareLink
List shared cart items
getCartSharedItems
Update shared cart items
updateCartWithSharedItems
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
from_datequery
string
| date-time
Cart which are created on or after from_date. Supports ISO date format.
to_datequery
string
| date-time
Cart which are created on or before to_date. Supports ISO date format.
filter_onquery
string
on which column to sort on i.e created_on or last_modified
GET
Response
200
Platform user cart list
Hide
Get list of active cart which is associated with user
success
boolean
True if get list of cart successfully.
data
array of object (CartList)
List of active carts and their item's count
Show
Examples
Parameters
Parameters are not required.
Response
List of carts
getCartList
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
Cart id of user cart
Request body
user_id
string
Nullable
Customer user ID to associate with the cart. Send null to remove existing mapping of customer from cart.
PUT
Response
200
Hide
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment common config, coupon, coupon text, gstin etc.
coupon_text
string
Coupon text of coupon applied on cart
user
object (UserInfo)
Show
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
payment_selection_lock
object (PaymentSelectionLock)
Show
delivery_charge_info
string
Delivery charge in information message on shipment
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the get cart detail API response
breakup_values
object (CartBreakup)
Show
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
custom_cart_meta
object
Custom meta details added cart checkout API payload
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
pan_no
string
Permanent Account Number of the user
Examples
Parameters
Parameters are not required.
Response
Update user of a cart
updateCartUser
Retrieve details of a cart linked to a specific customer using either the customer's ID or a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart
user_idquery
string
Option to fetch cart for the provided user_id.
order_typequery
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
iquery
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
bquery
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
assign_card_idquery
integer
Token of user's debit or credit card
buy_nowquery
boolean
This is a boolen value. Select `true` to set/initialize buy now cart
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-anonymous-cart
string
Anonymous cart header used to perform operations on cross-platform anonymous cart. When enabled, the system fetches the cart only based on cart_id instead of user_id.
GET
Response
200
400
Success. Returns a Cart object. Check the example shown below or refer `CartDetailResult` for more details.
Hide
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
payment_selection_lock
object (PaymentSelectionLock)
Show
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
coupon
object (CartDetailCoupon)
Show
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
user_id:
"value"
order_type:
"value"
i:
false
b:
false
assign_card_id:
1
buy_now:
false
x-ordering-source:
"value"
x-ordering-source-type:
"value"
x-anonymous-cart:
"value"
Response
Get a cart
getCart
Adds product items to a customer's shopping cart. If the customer does not have an existing cart, a new one is created automatically. - The `new_cart` flag forces creation of a new cart even if one already exists. - The `default_cart` flag determines whether the item is added to the user's default storefront-visible cart. If `true`, the item is added to the user's default cart that is accessible via the storefront. If `false`, an existing active cart is fetched if available; otherwise, a new hidden cart is created.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
iquery
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
bquery
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
include_cart_calculationquery
boolean
Set to `false` to skip recalculating and fetching the updated cart after the edit. Defaults to `true`.
buy_nowquery
boolean
This is a boolen value. Select `true` to set/initialize buy now cart
order_typequery
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
idquery
string
The unique identifier of the cart
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-anonymous-cart
string
Anonymous cart header used to perform operations on cross-platform anonymous cart. When enabled, the system fetches the cart only based on cart_id instead of user_id.
Request body
user_id
string
The unique identifier of the user for whom items are being added to the cart
new_cart
boolean
Indicates whether a new cart should be created. If `true`, a new cart is created even if one already exists.
default_cart
boolean
Determines whether the item is added to the user's default visible cart on the storefront. If `true`, the item is added to the user's default cart that is accessible via the storefront. If `false`, an existing active cart is fetched if available; otherwise, a new hidden cart is created. Defaults to `true`.
items
array of object (AddProductCart)
List of items detail which need to be added to cart like item id, item size, and item quantity
Show
POST
Response
200
Success. Returns a cart object as shown below. Refer `AddCartDetailResult` for more details.
Hide
Update cart detail response schema denotes cart data and message of the add product into cart
success
boolean
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResult)
Show
partial
boolean
When adding multiple items check if all added. True if only few are added.
message
string
Message of add cart API response
result
object
Add to cart result data
items
array of object (CartItemInfo)
List of items that needs to be added in cart.
Show
Examples
Parameters
Parameters are not required.
Response
Add items to cart
platformAddItems
Customers can modify added product attributes such as quantity and size, as well as remove items from the cart.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart
iquery
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
order_typequery
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
bquery
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
include_cart_calculationquery
boolean
Set to `false` to skip recalculating and fetching the updated cart after the edit. Defaults to `true`.
buy_nowquery
boolean
This is a boolen value. Select `true` to set/initialize buy now cart
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-anonymous-cart
string
Anonymous cart header used to perform operations on cross-platform anonymous cart. When enabled, the system fetches the cart only based on cart_id instead of user_id.
Request body
user_id
string
The user id of user, for which we need to update the cart
items
array of object (UpdateProductCart)
List items data that needs to be updated in cart
Show
free_gift_items
array of object (FreeGiftItemCreation)
List of free gift items with updated sizes.
Show
operation
string
Required
Field to determine if item to be removed from cart or it needs to be updated
Enum
free_gift_items_operation
string
Field to determine if free gift item to be removed from cart or it needs to be added.
Enum
PUT
Response
200
Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResult` for more details.
Hide
Update cart detail response schema denotes cart data and message of the update cart API response
success
boolean
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResult)
Show
result
object
Contains article related result info
items
array of object (CartItemInfo)
List of items that needs to be updated in cart.
Show
message
string
Message of update cart API response
Response
Update cart items
platformUpdateCart
Updates the cart breakup based on the enabled features and user preferences. This endpoint allows customers to modify how their cart totals are calculated — including options such as applying store credits, loyalty points, discounts, and other promotional benefits. The API recalculates and returns the updated breakup reflecting the selected configurations in real-time.
Parameters
company_idpath
string
Required
Unique identifier of the company associated with the current cart.
application_idpath
string
Required
Unique identifier of the sales channel (e.g., website, app) for which the cart belongs.
idquery
string
Unique identifier of the cart for which the breakup needs to be updated.
iquery
boolean
Set to `true` to include all items currently added to the cart in the response.
bquery
boolean
Set to `true` to include the detailed price breakup of each cart item in the response.
include_cart_calculationquery
boolean
Set to `false` to skip recalculating and fetching the updated cart after the edit. Defaults to `true`.
buy_nowquery
boolean
Set to `true` to initialize a "Buy Now" cart flow, enabling direct checkout for a single item.
Headers
x-ordering-source
string
Identifier for the ordering source (e.g., web, mobile app, POS). Used to determine the origin of the order request and apply source-specific rules.
x-ordering-source-type
string
Identifier for the ordering source type (e.g., storefront, store_os_pos, kiosk). Used to determine the source type for order governance and validations.
x-anonymous-cart
string
Anonymous cart header used to perform operations on cross-platform anonymous cart. When enabled, the system fetches the cart only based on cart_id instead of user_id.
Request body
store_credit
boolean
Select `true` to include store credit in cart breakup
PATCH
Response
200
400
Success. Updates and returns a cart object as shown below. Refer `CartDetailResult` for more details.
Hide
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
payment_selection_lock
object (PaymentSelectionLock)
Show
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
coupon
object (CartDetailCoupon)
Show
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
i:
false
b:
false
include_cart_calculation:
false
buy_now:
false
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
x-anonymous-cart:
"value"
Response
Update cart breakup values
updateCartBreakup
Delete all items from the user's cart and resets it to its initial state, providing a clean slate for new selections.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart.
Request body
cart_id_list
array of string
List of all cart ids, which need to delete
PUT
Response
200
Success. Returns whether the cart has been deleted or not.
Hide
Delete cart response which includes message and success flag
success
boolean
True if cart is archived successfully. False if not archived.
message
string
Message for delete cart response
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Response
Delete a cart
deleteCart
Retrieve the total count of items currently present in the customer's cart.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart.
buy_nowquery
boolean
Boolean value to get buy_now cart.
GET
Response
200
Success. Returns the total count of items in a user's cart.
Hide
Request schema to return the total number of items in cart
user_cart_items_count
integer
| int32
Item count present in cart
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
buy_now:
false
Response
Get a cart items count
getItemCount
Add or modify metadata associated with a cart, which includes customer preferences, delivery instructions, or any special requirements related to the cart items.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart
buy_nowquery
boolean
this is boolean to get buy_now cart
Request body
gstin
string
GSTIN number to be added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
pick_up_customer_details
object
Customer contact details for customer pickup at store
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
checkout_mode
string
Checkout mode of user cart
gift_details
object
Nullable
Gift details is open json which can include gift message
pan_no
string
Permanent Account Number of the user
comment
string
Comment message to be added in user cart
staff_user_id
string
Nullable
staff user id
PUT
Response
200
400
Returns a message indicating the success of cart meta updation as shown below.
Hide
Cart meta response schema
is_valid
boolean
Whether added meta was vaild
message
string
Detailed message that used to display
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
buy_now:
false
body:
body
Response
Update cart metadata
updateCartMeta
Cart meta includes configuration settings for customizing and optimizing the cart experience, such as adjusting item limits, configuring discounts, and managing delivery charges, to meet the needs of sales channels effectively.
Operations
PUT
# Update cart meta
GET
# Get cart meta
POST
# Create a new cart meta
Modify the configuration settings for cart metadata associated with a specific sales channel. Cart meta includes configuration settings such as allowed maximum cart value, allowed minimum cart value, maximum allowed cart items, delivery charges, etc.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
cart_meta_idpath
string
Required
CartMeta id for fetching single cart meta data for editing
Request body
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
Show
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
PUT
Response
200
400
Cart Meta Config updated successfully
Hide
Update meta information related to cart
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
Show
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
Examples
Parameters
company_id:
"value"
application_id:
"value"
cart_meta_id:
"value"
body:
body
Response
Update cart meta
updateCartMetaConfig
Retrieve meta configuration settings tailored for customizing the cart experience within a specific sales channel. Cart meta includes configuration settings such as allowed maximum cart value, allowed minimum cart value, maximum allowed cart items, delivery charges, etc.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
GET
Response
200
400
Cart Meta Config Fetched successfully
Hide
Add meta information related to cart
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
Show
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
Examples
Parameters
company_id:
"value"
application_id:
"value"
Response
Get cart meta
fetchCartMetaConfig
Create custom meta configurations for carts associated with a specific sales channel. By specifying the company ID and application ID, seller can define unique cart settings, including preferences, rules, and constraints, tailored to their business needs.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
Request body
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
Show
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
POST
Response
201
400
Cart Meta Config Created successfully
Hide
Add meta information related to cart
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
Show
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Response
Create a new cart meta
createCartMetaConfig
Checkout refers to the final stage of the purchasing process where the customer completes their transaction by paying for the selected items and providing necessary shipping and payment information. During checkout, users review their cart contents, enter billing and shipping addresses, choose payment methods, and confirm their order. It's the pivotal moment when the transaction is finalized, and the goods are prepared for delivery to the customer's designated address.
Operations
POST
# Get and validate cart items
POST
# Headless Checkout
POST
# Update cart checkout
POST
# Checkout cart
Retrieve cart details for a provided list of cart items and validate its contents. This ensures accuracy and completeness in cart information, including item quantities, prices, discounts, and applicable taxes.
Parameters
company_idpath
string
Required
Unique identifier of the company
application_idpath
string
Required
Unique identifier of the sales channel application
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-location-detail
string
Location details for the cart checkout
x-currency-code
string
Currency code for transactions.
Default Value : INR
Request body
cart_items
array of object (CartItem)
Required
List of products in cart
Show
POST
Response
200
400
Cart details with breakup
Hide
Open Api cart detail response
is_valid
boolean
Cart validity flag determines the if the response is valid or not
message
string
Message of the cart Open API cart detail response
breakup_values
object (CartBreakup)
Show
items
array of object (CartProductInfo)
Items details in cart
Show
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
x-location-detail:
"value"
x-currency-code:
"value"
Response
Get and validate cart items
fetchAndvalidateCartItems
The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement.
Parameters
company_idpath
string
Required
Unique identifier of the company for which the cart checkout is being performed.
application_idpath
string
Required
Unique identifier for the sales channel application
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-anonymous-cart
string
It allows operations on cross-platform anonymous carts. When provided, the system retrieves the cart using only the cart_id, ignoring the user_id. Use this when interacting with an anonymous or guest cart across platforms.
x-location-detail
string
Location details for the cart checkout
x-currency-code
string
Currency code for transactions. Defaults to INR if the location is India.
Default Value : INR
Request body
payment_mode
string
Payment mode from which the payment to be done for the order
cart_value
number
| float
Required
Total amount of user cart
cart_items
array of object (OpenApiOrderItem)
Required
List of items in user cart
Show
shipping_address
object (ShippingAddress)
Show
loyalty_discount
number
| float
Loyalty points applied on cart
comment
string
Nullable
Comment message added in cart after order placed
payment_methods
array of object (MultiTenderPaymentMethod)
Required
payment methods list used to make the payment
Show
employee_discount
object
Employee discount value applied on user cart
coupon
string
Coupon text of coupon applied on user cart
cashback_applied
number
| float
Required
Cashback applied on user cart
gstin
string
Nullable
GSTIN number added in cart
billing_address
object (ShippingAddress)
Required
Show
coupon_code
string
Required
Coupon code to be applied to cart
coupon_value
number
| float
Required
Value of the coupon applied to cart
delivery_charges
number
| float
Required
Delivery charges of the order placed via checkout API
affiliate_order_id
string
Order id generated after placing order
currency_code
string
Currency code for the price
order_id
string
Order id generated after placing order
files
array of object (OpenApiFiles)
List of file url
Show
cod_charges
number
| float
Required
Cash On Delivery charges of the user cart
POST
Response
200
400
Checkout cart and create Fynd order id
Hide
Open api cart checkout response details schema which includes order id and success message
success
boolean
The request success is defined
message
string
Message of the api response
order_ref_id
string
Order id sent in request
order_id
string
Fynd order id
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
x-anonymous-cart:
"value"
x-location-detail:
"value"
x-currency-code:
"value"
Response
Headless Checkout
checkoutCart
Overrides the cart's checkout process with a new provided cart items. It provides flexibility in customizing checkout flows to meet specific business requirements, enhancing the user experience and optimizing order processing workflows.
Parameters
company_idpath
string
Required
Unique identifier of the company
application_idpath
string
Required
Unique identifier of the sales channel application
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-location-detail
string
Location details for the cart checkout
x-currency-code
string
Currency code for transactions. Defaults to INR if the location is India.
Default Value : INR
Request body
cart_id
string
Required
The cart id of user cart
payment_mode
string
Required
Payment mode from which the payment to be done for the order
billing_address
object (ShippingAddress)
Show
merchant_code
string
Required
Merchant code of the payment mode selected to do the payment
payment_identifier
string
Required
Payment identifier of the payment mode selected to do the payment
currency_code
string
Required
Currency code for the price
aggregator
string
Required
Aggregator name of the payment gateway
order_type
string
Required
Order type of the order being placed like pickAtStore or HomeDelivery
Enum
callback_url
string
Callback url to be redirected after payment received/failed
cart_items
array of object (OverrideCartItem)
Required
List of items which includes their size, id, discount and promo details
Show
ordering_store
integer
| int32
Nullable
Ordering store id of the store from which the order is getting placed
Default Value : null
device_id
string
Nullable
A unique identifier for the EDC (Electronic Data Capture) machine. This value may be null if the identifier is not available.
shipping_address
object (ShippingAddress)
Show
POST
Response
200
Checkout cart and create Fynd order id
Hide
Checkout cart detail respoonse schema includes cart id, delivery promise, items, comment, coupon text etc.
data
object (OverrideCheckoutData)
Show
cart
object (CheckCart)
Show
success
string
Success flag of cart override checkout API response
order_id
string
Order id generated after placing order
message
string
Message of the cart override checkout API response
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
x-location-detail:
"value"
x-currency-code:
"value"
Response
Update cart checkout
overrideCart
The checkout cart initiates the order creation process based on the items in the user’s cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement.
Parameters
company_idpath
string
Required
Unique identifier of the company
application_idpath
string
Required
Unique identifier for the sales channel application
idquery
string
Unique identifier of the cart
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-anonymous-cart
string
It allows operations on cross-platform anonymous carts. When provided, the system retrieves the cart using only the cart_id, ignoring the user_id. Use this when interacting with an anonymous or guest cart across platforms.
x-location-detail
string
| json
Location information for the cart
x-currency-code
string
Currency code for the transaction. Defaults to INR if the order location is India.
Default Value : INR
Request body
address_id
string
Identifier for the address where the order will be delivered
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment
payment_params
object
Nullable
Payment params which includes payment identifier and merchant code
custom_meta
array of object (CartCheckoutCustomMeta)
Custom meta data to be added in order
Show
payment_auto_confirm
boolean
Payment auto confirm flag if payment need not to be collected from user
id
string
Required
Cart identifier of the user cart
pos
boolean
Field indicating whether the user is making the request from a POS
billing_address_id
string
Identifier for the customer's billing address where the invoice will be generated after order placement
merchant_code
string
Merchant code of the payment mode selected to do the payment
aggregator
string
Aggregator name of the payment gateway
pick_at_store_uid
integer
| int32
Nullable
Store id where we have to pick product
Default Value : null
device_id
string
Nullable
Unique identifier for the device used during checkout
delivery_address
object
Complete delivery address object containing customer address details, phone number, email address, pincode, landmark, and full name.
payment_mode
string
Payment mode from which the payment to be done for the order
checkout_mode
string
Checkout mode for the cart, such as guest and logged-in checkout
customer_details
object (CustomerDetails)
Show
meta
object
Meta data to be added in order
payment_methods
array of object (PaymentMethod)
Required
Payment methods list used to make the payment
Show
staff
object (StaffCheckout)
Show
employee_code
string
Nullable
Employee code of staff who does checkout on behalf of customer
billing_address
object
Billing address json which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name
callback_url
string
Nullable
Callback URL to redirect the user after payment is received or has failed
Default Value : null
user_id
string
Unique identifier of the user associated with the cart
extra_meta
object
Extra meta to be added while checkout in order
order_type
string
Required
Order type of the order being placed
Enum
files
array of object (Files)
List of file url
Show
ordering_store
integer
| int32
Nullable
Ordering store id of the store from which the order is getting placed
iin
string
Issuer Identification Number (IIN) of the card to be used for payment. This field is applicable when the payment mode is set to card.
network
string
Card network to use for payment, relevant when the selected payment mode is a card
type
string
Specifies the cart type, particularly when the payment mode is a card
card_id
string
Identifier for the saved card to be used for payment. This field is applicable when card payment mode has been selected.
success_callback_url
string
Nullable
URL to which the user will be redirected after successful payment completion
failure_callback_url
string
Nullable
URL to which the user will be redirected if the payment fails
order_tags
array of object (OrderTag)
Order tags used to identify specific type of order which is tagged using order tags
Show
POST
Response
200
400
Success. Returns the status of cart checkout. Refer `CartCheckoutDetailsSchema` for more details.
Hide
Checkout cart detail respoonse schema includes cart id, delivery promise, items, comment, coupon text etc.
app_intercept_url
string
App intercept URL which is used to redirect on app after payment in confirmed/failed
data
object (CartCheckoutDetailsData)
Show
cart
object (CheckCart)
Show
success
boolean
Success flag of cart checkout API response
callback_url
string
Callback url to be redirected after payment received/failed
payment_confirm_url
string
Payment confirm url used to redirect after payment is confirmed
order_id
string
Order id generated after placing order
message
string
Message of the cart checkout v2 API response
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
x-anonymous-cart:
"value"
x-location-detail:
"value"
x-currency-code:
"value"
Response
Checkout cart
platformCheckoutCartV2
Coupons are promotional tools offered by businesses to customers, providing discounts, incentives, or special offers on purchases. Their aim is to attract customers, increase sales, encourage repeat purchases, and promote customer loyalty. Various types of coupons include: X Percentage Value: Offers a discount based on a percentage of the total purchase value. Example: Get 15% off your entire order. X Amount Value: Provides a fixed discount amount regardless of the total purchase value. Example: Save Rs.20 on your purchase. Bundle Percentage Discount: Discounts applied when purchasing a specific combination or quantity of items. Example: Buy 2 shirts and get 20% off each. Bundle Amount Percentage Discount: Similar to bundle percentage discount, but the discount is applied to a specific amount spent. Example: Spend Rs.100 on shoes and receive 25% off your entire order. Buy X Items Get Y Items Free: Offers a certain number of items for free when a specified quantity is purchased. Example: Buy 2 pairs of socks and get 1 pair free. Buy X Items at Absolute Amount: Allows customers to purchase a set number of items at a fixed price. Example: Buy 3 t-shirts for Rs. 250.
Operations
GET
# List of coupons
POST
# Create a coupon
GET
# Get a coupon
PUT
# Update a coupon
DEL
# Delete a coupon which is in draft state
GET
# Check coupon code exists
GET
# List of coupons
POST
# Apply coupon
DEL
# Remove coupon
GET
# Validate applied coupon
Retrieve a list of all created coupons for specific sales channel. It also supports searching based on text search, pagination and other flags to filter coupons.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
page_noquery
integer
current page no as per pagination
Default Value : 0
page_sizequery
integer
Coupon max records fetched in single request
Default Value : 10
is_archivedquery
boolean
Filter by active or inactive coupon
Default Value : false
titlequery
string
Filter coupon by coupon title
is_publicquery
boolean
Filter coupons which is public
is_displayquery
boolean
Filter coupons which is visible to sales channel
type_slugquery
string
Filter by coupon type
codequery
string
Filter by coupon code
created_byquery
string
Filter by coupon creater user id
reviewed_byquery
string
Filter by coupon reviewer user id
approved_start_timequery
string
| date-time
Filter coupon by start time date range when status is approved
approved_end_timequery
string
| date-time
Filter coupon by end time date range when status is approved
review_start_timequery
string
Filter coupon by start time date range when status is in review state
review_end_timequery
string
Filter coupon by end time date range when status is in review state
statusquery
string
Filter your coupons effortlessly by status, such as draft, review and more
Enum
filter_tagsquery
string
Filter by filter tag. Repeat this query parameter for multiple values (e.g. `?filter_tags=homepage&filter_tags=seasonal`). Entities matching any provided tag are returned (OR).
GET
Response
200
Coupon List for sent page_size and page_no
Hide
Response schema for coupon list
items
array of object (CouponAdd)
Coupons list for sales channel
Show
page
object (Page)
Show
Examples
Parameters
Parameters are not required.
Response
List of coupons
getCoupons
Creates a new coupon based on the selected coupon type. Sellers can choose from multiple supported coupon types, including percentage value, fixed amount value, bundled discount, buy X get Y items, and more, along with customizable coupon criteria to meet specific business requirements.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
Request body
date_meta
object (CouponDateMeta)
Show
ownership
object (Ownership)
Show
author
object (CouponAuthor)
Show
state
object (State)
Show
restrictions
object (Restrictions)
Show
validation
object (Validation)
Show
action
object (CouponAction)
Show
coupon_type
string
The type of coupon like bulk or single
Enum
coupon_prefix
string
Nullable
Bulk coupon code prefix string
coupon_counts
integer
Counts of bulk coupon
Default Value : 1
tags
array of string
List of tags specify to platform
Default Value :
filter_tags
array of string
Tags used to filter coupons, promotions, or offers in list APIs. When multiple values are provided in a list request, entities matching any tag are returned (OR).
Default Value :
_schedule
object (CouponSchedule)
Show
rule
array of object (Rule)
Show
display_meta
object (DisplayMeta)
Show
code
string
Required
Unique code of coupon
type_slug
string
Required
The type slug of coupon discount
identifiers
object (Identifier)
Show
validity
object (Validity)
Show
rule_definition
object (RuleDefinition)
Show
_id
string
Unique identifier of coupon
POST
Response
201
400
Coupon Created successfully
Hide
Create coupon request success message schema
success
boolean
Whether the request was successful (true/false)
message
string
Create coupon response message that can shown to creator user
_id
string
Unique identifier for coupon created
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Response
Create a coupon
createCoupon
Retrieve details of a specific coupon by providing its unique identifier to obtain information such as coupon type, rules, validity period and other related information.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idpath
string
Required
Coupon id for fetching single coupon data for editing
GET
Response
200
404
Coupon object for sent coupon id
Hide
Request schema used to update a coupon
date_meta
object (CouponDateMeta)
Show
ownership
object (Ownership)
Show
author
object (CouponAuthor)
Show
state
object (State)
Show
restrictions
object (Restrictions)
Show
validation
object (Validation)
Show
action
object (CouponAction)
Show
tags
array of string
List of tags specify to platform
Default Value :
filter_tags
array of string
Tags used to filter coupons, promotions, or offers in list APIs. When multiple values are provided in a list request, entities matching any tag are returned (OR).
Default Value :
_schedule
object (CouponSchedule)
Show
rule
array of object (Rule)
Show
display_meta
object (DisplayMeta)
Show
code
string
Unique code that is used to apply coupon
coupon_type
string
The type of coupon like bulk or single
Enum
coupon_prefix
string
Nullable
Bulk coupon code prefix string
coupon_counts
integer
Counts of culk coupon
Default Value : 1
reason
string
Nullable
Coupon rejection reason added by reviewer
type_slug
string
The type slug of coupon discount
identifiers
object (Identifier)
Show
validity
object (Validity)
Show
rule_definition
object (RuleDefinition)
Show
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Response
Get a coupon
getCouponById
Update the details of an existing coupon by specifying its unique identifier. This includes modifying coupon attributes such as discount percentage, validity period, and associated conditions. Leveraging this functionality allows businesses to quickly adapt their promotional strategies to changing market dynamics.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idpath
string
Required
Coupon id for fetching single coupon data for editing
Request body
date_meta
object (CouponDateMeta)
Show
ownership
object (Ownership)
Show
author
object (CouponAuthor)
Show
state
object (State)
Show
restrictions
object (Restrictions)
Show
validation
object (Validation)
Show
action
object (CouponAction)
Show
tags
array of string
List of tags specify to platform
Default Value :
filter_tags
array of string
Tags used to filter coupons, promotions, or offers in list APIs. When multiple values are provided in a list request, entities matching any tag are returned (OR).
Default Value :
_schedule
object (CouponSchedule)
Show
rule
array of object (Rule)
Show
display_meta
object (DisplayMeta)
Show
code
string
Required
Unique code that is used to apply coupon
coupon_type
string
The type of coupon like bulk or single
Enum
coupon_prefix
string
Nullable
Bulk coupon code prefix string
coupon_counts
integer
Counts of culk coupon
Default Value : 1
reason
string
Nullable
Coupon rejection reason added by reviewer
type_slug
string
Required
The type slug of coupon discount
identifiers
object (Identifier)
Show
validity
object (Validity)
Show
rule_definition
object (RuleDefinition)
Show
PUT
Response
200
404
Coupon updated successfully
Hide
Create coupon request success message schema
success
boolean
Whether the request was successful (true/false)
message
string
Create coupon response message that can shown to creator user
_id
string
Unique identifier for coupon created
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Response
Update a coupon
updateCoupon
Delete details of a draft coupon by providing its unique identifier to delete information such as coupon type, rules, validity period and other related information.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Application id of sales channel
idpath
string
Required
Coupon id for fetching single coupon data for deleting
DEL
Response
200
404
Coupon deleted for sent coupon id
Hide
Request success message schema
success
boolean
Whether the request was successful (true/false).
message
string
Response message needs to display
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Response
Delete a coupon which is in draft state
deleteCoupon
Validates the presence of a coupon code for the specified sales channel to verify whether the provided code already exists or not.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
codequery
string
Coupon code
GET
Response
200
400
Valid response with existing coupon code count
Hide
success
boolean
count
integer
Examples
Parameters
Parameters are not required.
Response
Check coupon code exists
getCouponCodeExists
Retrieve a list of all available coupons that customer can apply to their carts. It provides details about each coupon, including its code, discount amount, and applicable conditions.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart.
buy_nowquery
boolean
This is boolean to get buy_now cart
slugquery
string
Product slug to fetch the available coupons
store_idquery
string
Store id
GET
Response
200
Success. Returns a coupon object which has a list of all the eligible coupons. Refer `GetCouponResult` for more details.
Hide
Get coupon list response schema which page information and list of coupons
available_coupon_list
array of object (Coupon)
List of available coupon which can be applied on cart
Show
page
object (PageCoupon)
Show
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
buy_now:
false
slug:
"value"
store_id:
"value"
Response
List of coupons
getAppCoupons
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
iquery
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
bquery
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
pquery
boolean
This is a boolean value. Select `true` for getting a payment option in response.
idquery
string
The unique identifier of the cart
buy_nowquery
boolean
This is boolean to get buy_now cart
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-anonymous-cart
string
Anonymous cart header used to perform operations on cross-platform anonymous cart. When enabled, the system fetches the cart only based on cart_id instead of user_id.
Request body
coupon_code
string
Required
Coupon code to be applied
POST
Response
201
Success. Returns coupons applied to the cart along with item details and price breakup. Refer `CartDetailResult` for more details.
Hide
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
payment_selection_lock
object (PaymentSelectionLock)
Show
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
coupon
object (CartDetailCoupon)
Show
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
Examples
Parameters
company_id:
"value"
application_id:
"value"
i:
false
b:
false
p:
false
id:
"value"
buy_now:
false
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
x-anonymous-cart:
"value"
Response
Apply coupon
applyCoupon
Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
uidquery
string
The unique identifier of the cart
buy_nowquery
boolean
This is boolean to get buy_now cart
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-anonymous-cart
string
Anonymous cart header used to perform operations on cross-platform anonymous cart. When enabled, the system fetches the cart only based on cart_id instead of user_id.
DEL
Response
200
Success. Returns coupons removed from the cart along with item details and price breakup. Refer `CartDetailResult` for more details.
Hide
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
payment_selection_lock
object (PaymentSelectionLock)
Show
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
coupon
object (CartDetailCoupon)
Show
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
Examples
Parameters
company_id:
"value"
application_id:
"value"
uid:
"value"
buy_now:
false
x-ordering-source:
"value"
x-ordering-source-type:
"value"
x-anonymous-cart:
"value"
Response
Remove coupon
removeCoupon
Validates the applicability of a coupon code for the selected payment mode for the existing cart. This ensures the coupon's validity before proceeding with the payment process, enhancing user experience and preventing potential errors during transactions.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart
buy_nowquery
boolean
This is boolean to get buy_now cart
address_idquery
string
ID allotted to an address
payment_modequery
string
Payment mode selected by the customer
payment_identifierquery
string
Identifier of payment like ICIC, PAYTM
aggregator_namequery
string
Payment gateway identifier
merchant_codequery
string
Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
GET
Response
200
Success. Returns a success message and the coupon validity. Refer `PaymentCouponValidate` for more details.
Hide
Payment mode validity details of the coupon which shows coupon is valid for the payment mode or not
success
boolean
success flag of coupon payment mode validity API response
message
string
Payment mode valid message for coupon
coupon_validity
object (CouponValidity)
Show
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
buy_now:
false
address_id:
"value"
payment_mode:
"value"
payment_identifier:
"value"
aggregator_name:
"value"
merchant_code:
"value"
x-ordering-source:
"value"
x-ordering-source-type:
"value"
Response
Validate applied coupon
validateCouponForPayment
A customer's address refers to the address where the ordered product is to be delivered. It usually includes details such as the recipient's name, contact, street address, city, state or province, PIN code or ZIP code, and country. Each customer can have multiple addresses associated with them. Storing addresses includes validating the address based on the country and its unique identifiers like PIN code, ZIP code, or area code.
Operations
GET
# Get a list of addresses for a customer
POST
# Creates a new address for a customer
GET
# Get details for a single customer address
PUT
# Updates an existing customer address
DEL
# Removes an address from a customer's address list
POST
# Select customer address for order processing
Retrieves a list of all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
cart_idquery
string
The unique identifier of the cart
buy_nowquery
boolean
This is boolean to get buy_now cart
mobile_noquery
string
10-digit mobile number of the customer
checkout_modequery
string
Option to checkout for `self` or for `others`. By default, it is `self`.
tagsquery
string
Tag given to an address, e.g. work, home, office, shop.
is_defaultquery
boolean
This is a boolean value. Select `true` to fetch the default address.
user_idquery
string
Option to fetch address for the provided user_id.
GET
Response
200
400
Success. Returns an Address object containing a list of address saved in the account. Refer `PlatformGetAddressesDetails` for more details.
Hide
List all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery.
pii_masking
boolean
Personally Identifiable Information masking flag to denote if the user data in address is masked or not.
address
array of object (PlatformAddress)
List of all address saved by customer
Show
validation_config
object (ValidationConfig)
Show
Examples
Parameters
Parameters are not required.
Response
Get a list of addresses for a customer
getAddresses
Customers can add a new address to their cart to save details such as name, email, contact information, and address.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
Request body
phone
string
Phone number for address
id
string
Id of the address
area_code_slug
string
Area code slug for address. example pincode is slug for India
country_code
string
Country code of address
geo_location
object (GeoLocation)
Show
country
string
Country of address
state
string
State of the address
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected
tags
array of string
Tags of address from which it can be identified
created_by_user_id
string
Created by user id of address
landmark
string
Landmark of address
email
string
Email address for address data
area_code
string
Area code of the address
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart
meta
object
Metadata of the address
is_active
boolean
States whether address is active or not
name
string
Name of person in address data to whom it belongs to
google_map_point
object
Google map point of the address
cart_id
string
The cart id of user cart
city
string
City of the address
sector
string
Sector of the address
state_code
string
State code for international address
area
string
Area description for address
user_id
string
User id of address for which address is created
address_type
string
Address type of address
address
string
Address description for address data
country_phone_code
string
Country phone code for address
country_iso_code
string
Country iso code for address
_custom_json
object
Custom json of the address
POST
Response
200
400
422
Success. Returns the address ID, a flag whether the address is set as default, and a success message. Refer `SaveAddressDetails` for more details.
Hide
Save address response details, which includes address id, success flag and default address flag
id
string
Id of the address
success
boolean
Success flag of save address Response
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected
Examples
Parameters
Parameters are not required.
Response
Creates a new address for a customer
addAddress
Retrieve a specific customer address stored in the system by providing its unique identifier. This API provides detailed information about the address, including the recipient's name, address, city, postal code, and other relevant details.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idpath
string
Required
ID allotted to the selected address
cart_idquery
string
The unique identifier of the cart
buy_nowquery
boolean
This is boolean to get buy_now cart
mobile_noquery
string
10-digit mobile number of the customer
checkout_modequery
string
Option to checkout for self or for others
tagsquery
string
Tag given to an address, e.g. work, home, office, shop.
is_defaultquery
boolean
This is a boolean value. Select `true` to fetch the default address.
user_idquery
string
Option to fetch address for the provided user_id.
GET
Response
200
400
Success. Returns an PlatformAddress object containing a list of address saved in the account. Refer `PlatformAddress` for more details.
Hide
Address details, consists of pincode, phone, address id, country code, geo location, country, state, city, landmark, email etc
phone
string
Phone number for address
id
string
Id of the address
area_code_slug
string
Area code slug for address. example pincode is slug for India
country_code
string
Country code of address
geo_location
object (GeoLocation)
Show
country
string
Country of address
state
string
State of the address
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected
tags
array of string
Tags of address from which it can be identified
created_by_user_id
string
Created by user id of address
landmark
string
Landmark of address
email
string
Email address for address data
area_code
string
Area code of the address
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart
meta
object
Metadata of the address
is_active
boolean
States whether address is active or not
name
string
Name of person in address data to whom it belongs to
google_map_point
object
Google map point of the address
cart_id
string
The cart id of user cart
city
string
City of the address
sector
string
Sector of the address
state_code
string
State code for international address
area
string
Area description for address
user_id
string
User id of address for which address is created
address_type
string
Address type of address
address
string
Address description for address data
country_phone_code
string
Country phone code for address
country_iso_code
string
Country iso code for address
_custom_json
object
Custom json of the address
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
cart_id:
"value"
buy_now:
false
mobile_no:
"value"
checkout_mode:
"value"
tags:
"value"
is_default:
false
user_id:
"value"
Response
Get details for a single customer address
getAddressById
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idpath
string
Required
ID allotted to the selected address
Request body
phone
string
Phone number for address
id
string
Id of the address
area_code_slug
string
Area code slug for address. example pincode is slug for India
country_code
string
Country code of address
geo_location
object (GeoLocation)
Show
country
string
Country of address
state
string
State of the address
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected
tags
array of string
Tags of address from which it can be identified
created_by_user_id
string
Created by user id of address
landmark
string
Landmark of address
email
string
Email address for address data
area_code
string
Area code of the address
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart
meta
object
Metadata of the address
is_active
boolean
States whether address is active or not
name
string
Name of person in address data to whom it belongs to
google_map_point
object
Google map point of the address
cart_id
string
The cart id of user cart
city
string
City of the address
sector
string
Sector of the address
state_code
string
State code for international address
area
string
Area description for address
user_id
string
User id of address for which address is created
address_type
string
Address type of address
address
string
Address description for address data
country_phone_code
string
Country phone code for address
country_iso_code
string
Country iso code for address
_custom_json
object
Custom json of the address
PUT
Response
201
400
Success. Returns the address ID and a message indicating a successful address updation.
Hide
Update address response details, includes address id, updated flag and success flag
id
string
ID of an address
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected
success
boolean
Success flag of update address response
is_updated
boolean
Updated flag for update address operation if the address updated or not
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Response
Updates an existing customer address
updateAddress
Remove an existing customer address from the system.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idpath
string
Required
ID allotted to the selected address
user_idquery
string
Option to delete address for the provided user_id.
DEL
Response
201
400
Returns a Status object indicating the success or failure of address deletion.
Hide
Delete address response, includes address id and deleted flag
id
string
Id of the address
is_deleted
boolean
Deleted flag in delete address response states whether the address was deleted or not
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
user_id:
"value"
Response
Removes an address from a customer's address list
removeAddress
Select an address from the saved customer addresses and validates the availability of items in the cart. Additionally, it verifies and updates the delivery promise based on the selected address.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
cart_idquery
string
The unique identifier of the cart
buy_nowquery
boolean
This is boolean to get buy_now cart
iquery
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
bquery
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-anonymous-cart
string
Anonymous cart header used to perform operations on cross-platform anonymous cart. When enabled, the system fetches the cart only based on cart_id instead of user_id.
Request body
cart_id
string
Cart id of the user cart for which the select address operation performed
billing_address_id
string
Billing address id selected by user on which shipment bill to be generated
checkout_mode
string
The checkout mode in cart
id
string
Address is selected by user on which shipment to be delivered
user_id
string
Unique Identifier of user
POST
Response
201
400
Success. Returns a Cart object as shown below. Refer `CartDetailResult` for more details.
Hide
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
payment_selection_lock
object (PaymentSelectionLock)
Show
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
coupon
object (CartDetailCoupon)
Show
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
Examples
Parameters
company_id:
"value"
application_id:
"value"
cart_id:
"value"
buy_now:
false
i:
false
b:
false
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
x-anonymous-cart:
"value"
Response
Select customer address for order processing
selectAddress
Represents a unified construct for applying benefits to the cart, encompassing both system-driven promotions and user-applied coupons. Offers include absolute or percentage discounts, free gifts, bundles, BOGO deals, and more. Each offer is evaluated based on eligibility rules, usage limits, and cart state, and can be auto-applied or manually redeemed by users.
Operations
GET
# List of offers
POST
# Create an offer
GET
# Get a specific offer
PUT
# Update existing offer
PATCH
# Partially update offer
DEL
# Delete draft offer
Retrieve a list of all created offers for specific sales channel. It also supports efficient text search and pagination functionalities, ensuring optimized offers listing for streamlined navigation and management.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
page_noquery
integer
Current page no as per pagination
Default Value : 1
page_sizequery
integer
Offers max records fetched in single request
Default Value : 10
searchquery
string
Filter by offer name
modequery
string
Filter by offer mode
Enum
typequery
string
Filter by offer type
promo_groupquery
string
Filter by promotion offer group
Enum
exclude_contract_offersquery
boolean
Filter non contract offers
offer_idquery
string
Filter by offer id
created_byquery
string
Filter by offer created by user id
reviewed_byquery
string
Filter by offer reviewer user id
approved_start_timequery
string
| date-time
Filter offer by start time date range when status is in approved state
approved_end_timequery
string
| date-time
Filter offer by end time date range when status is in approved state
statusquery
string
Filter your offers effortlessly by status, such as draft, review and more
Enum
codequery
string
Filter by offer code in case of coupons
is_publicquery
boolean
Filter offers which are public
filter_tagsquery
string
Filter by filter tag. Repeat this query parameter for multiple values (e.g. `?filter_tags=homepage&filter_tags=special`) or pass a comma-separated value. Entities matching any provided tag are returned (OR).
GET
Response
200
Offer List for requested filters, page_size and page_no
Hide
List of offers and all their information like name, mode, type, schedule, etc necessary to power listing.
items
array of object (OfferListItem)
List of offers
Show
page
object (Page)
Show
Examples
Parameters
Parameters are not required.
Response
List of offers
getOffers
Creates a new offer based on the selected offer type. Sellers can choose from multiple supported offer types, including percentage value, fixed amount value, bundled discount, buy X get Y items, and more, along with customizable offer criteria to meet specific business requirements.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
Request body
_id
string
Unique identifier of offer. This will be auto generated upon successful offer creation.
mode
string
Required
Offer mode, like coupon or promotion
Enum
auto_apply
boolean
Indicates whether the offer is automatically applied. This flag is false for coupons and true for promotions. For free-gift promotions, a false value means manual gift selection is required.
application_id
string
Application id through which offer was created.
company_id
string
Company id through which offer was created.
discount_rules
array of object (OfferDiscountRule)
Discount rules based on which offer will be applied
Maximum Items : 10
Show
buy_rules
object
Contains the individual buy rules associated with the offer. The keys in this object are dynamic (e.g., 'rule#1', 'rule#2', etc.), and each key must correspond to a buy condition referenced within `discount_rules`. For example, if a discount rule includes a buy_condition '(rule#1)', then 'rule#1' must be defined in this object. Each rule key value must follow the format of OfferItemCriteria schema.
restrictions
object (OfferRestrictions)
Show
display_meta
object (OfferDisplayMeta)
Required
Show
ownership
object (OfferOwnership)
Show
author
object (OfferAuthor)
Show
date_meta
object (OfferDateMeta)
Show
_schedule
object (OfferSchedule)
Show
_custom_json
object
Set extra properties in offer
stackable
boolean
Boolean value set true to apply other promotions as well.
Default Value : true
status
string
Required
Status of the offer
Enum
published
boolean
Required
Determines whether the offer is published to customers or marked inactive
type
string
Required
Different types of offers available in the system. This is used to determine the type of offer and the calculation of the offer. Some types are mode specific, few examples are :> - free_item_discount_absolute is only applicable for coupon mode - contract_price, shipping_price, free_gift_items, cashback, free_items, free_non_sellable_items, external_price_adjustment_discount, custom is only applicable for promotion mode
Enum
priority
integer
| value <= 100000
| int32
Defines the priority of the offer. Its behavior varies based on the offer type. For coupons, a higher priority value means the coupon will appear higher in the listing order. For promotions, this value determines the sequence in which promotions are evaluated and applied. Promotions are evaluated in descending order of their effective priority. In case of conflicting priorities, the offer will be prioritised on the basis of creation order (desc).
Default Value : 1
is_exclusive_coupon
boolean
Flag to determine if coupon is exclusive. Exclusive coupon removes other applied offers from the cart. If both `is_exclusive_coupon` and `apply_exclusive` are set, `is_exclusive_coupon` takes priority for offer evaluation logic effectively making the offer exclusive.
Default Value : false
apply_exclusive
string
Nullable
Controls how this offer excludes other offers when it is applied. When this offer is applied at cart level, no other promotions are evaluated or applied for the same cart (it becomes the only active promotion for that cart). When this offer is applied on specific articles, those articles will not be eligible for any other promotions, but other promotions can still apply to different articles in the cart. If null, the offer follows the normal stacking rules and does not enforce additional exclusivity.
Enum
calculate_on
string
Article Price on which offer is calculated, like effective price or marked price. Only available for few supported types lile Contract pricing and Ladder pricing.
Default Value : esp
Enum
promo_group
string
The type of promotion group
Default Value : product
Enum
currency
string
ISO 4217 currency code in which the offer's discount amounts and calculations are specified (e.g., "INR", "USD", "EUR"). This currency is used as the base currency for discount calculations and currency conversions when applying the offer. If not provided, defaults to the seller's default currency code. All discount values in discount_rules are interpreted in this currency.
code
string
Unique identifier code for the offer. For coupons (i.e mode = "coupon"), this is the coupon code that users enter to apply the offer (e.g., "SAVE20", "WELCOME50"). For promotions (mode = "promotion"), this field is typically null or empty as promotions are auto-applied. This code is used to fetch and identify offers when applying them to carts. Must be unique within an application_id. For bulk coupons, this is auto-generated based on coupon_config.coupon_prefix.
coupon_config
object (OfferCouponConfiguration)
Show
is_processed
boolean
Flag to verify if promotion is ready to be applied on cart and ready to update promotion
is_bank_offer
boolean
Flag to determine if any bank offer is applicable
Default Value : false
filter_tags
array of string
Tags used to filter coupons, promotions, or offers in list APIs. When multiple values are provided in a list request, entities matching any tag are returned (OR).
Default Value :
POST
Response
201
400
Creates a discount offer which applies on user cart.
Hide
Offer object defining the structure of an offer and all its attributes
_id
string
Unique identifier of offer. This will be auto generated upon successful offer creation.
mode
string
Offer mode, like coupon or promotion
Enum
auto_apply
boolean
Indicates whether the offer is automatically applied. This flag is false for coupons and true for promotions. For free-gift promotions, a false value means manual gift selection is required.
application_id
string
Application id through which offer was created.
company_id
string
Company id through which offer was created.
discount_rules
array of object (OfferDiscountRule)
Discount rules based on which offer will be applied
Maximum Items : 10
Show
buy_rules
object
Contains the individual buy rules associated with the offer. The keys in this object are dynamic (e.g., 'rule#1', 'rule#2', etc.), and each key must correspond to a buy condition referenced within `discount_rules`. For example, if a discount rule includes a buy_condition '(rule#1)', then 'rule#1' must be defined in this object. Each rule key value must follow the format of OfferItemCriteria schema.
restrictions
object (OfferRestrictions)
Show
display_meta
object (OfferDisplayMeta)
Show
ownership
object (OfferOwnership)
Show
author
object (OfferAuthor)
Show
date_meta
object (OfferDateMeta)
Show
_schedule
object (OfferSchedule)
Show
_custom_json
object
Set extra properties in offer
stackable
boolean
Boolean value set true to apply other promotions as well.
Default Value : true
status
string
Status of the offer
Enum
published
boolean
Determines whether the offer is published to customers or marked inactive
type
string
Different types of offers available in the system. This is used to determine the type of offer and the calculation of the offer. Some types are mode specific, few examples are :> - free_item_discount_absolute is only applicable for coupon mode - contract_price, shipping_price, free_gift_items, cashback, free_items, free_non_sellable_items, external_price_adjustment_discount, custom is only applicable for promotion mode
Enum
priority
integer
| value <= 100000
| int32
Defines the priority of the offer. Its behavior varies based on the offer type. For coupons, a higher priority value means the coupon will appear higher in the listing order. For promotions, this value determines the sequence in which promotions are evaluated and applied. Promotions are evaluated in descending order of their effective priority. In case of conflicting priorities, the offer will be prioritised on the basis of creation order (desc).
Default Value : 1
is_exclusive_coupon
boolean
Flag to determine if coupon is exclusive. Exclusive coupon removes other applied offers from the cart. If both `is_exclusive_coupon` and `apply_exclusive` are set, `is_exclusive_coupon` takes priority for offer evaluation logic effectively making the offer exclusive.
Default Value : false
apply_exclusive
string
Nullable
Controls how this offer excludes other offers when it is applied. When this offer is applied at cart level, no other promotions are evaluated or applied for the same cart (it becomes the only active promotion for that cart). When this offer is applied on specific articles, those articles will not be eligible for any other promotions, but other promotions can still apply to different articles in the cart. If null, the offer follows the normal stacking rules and does not enforce additional exclusivity.
Enum
calculate_on
string
Article Price on which offer is calculated, like effective price or marked price. Only available for few supported types lile Contract pricing and Ladder pricing.
Default Value : esp
Enum
promo_group
string
The type of promotion group
Default Value : product
Enum
currency
string
ISO 4217 currency code in which the offer's discount amounts and calculations are specified (e.g., "INR", "USD", "EUR"). This currency is used as the base currency for discount calculations and currency conversions when applying the offer. If not provided, defaults to the seller's default currency code. All discount values in discount_rules are interpreted in this currency.
code
string
Unique identifier code for the offer. For coupons (i.e mode = "coupon"), this is the coupon code that users enter to apply the offer (e.g., "SAVE20", "WELCOME50"). For promotions (mode = "promotion"), this field is typically null or empty as promotions are auto-applied. This code is used to fetch and identify offers when applying them to carts. Must be unique within an application_id. For bulk coupons, this is auto-generated based on coupon_config.coupon_prefix.
coupon_config
object (OfferCouponConfiguration)
Show
is_processed
boolean
Flag to verify if promotion is ready to be applied on cart and ready to update promotion
is_bank_offer
boolean
Flag to determine if any bank offer is applicable
Default Value : false
filter_tags
array of string
Tags used to filter coupons, promotions, or offers in list APIs. When multiple values are provided in a list request, entities matching any tag are returned (OR).
Default Value :
Response
Create an offer
createOffer
Retrieve details of a specific offer by providing its unique identifier to obtain information such as offer type, rules, validity period and other related information.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idpath
string
Required
Offer id for fetching corresponding offer data
GET
Response
200
404
Offer object for sent id
Hide
Offer object defining the structure of an offer and all its attributes
_id
string
Unique identifier of offer. This will be auto generated upon successful offer creation.
mode
string
Offer mode, like coupon or promotion
Enum
auto_apply
boolean
Indicates whether the offer is automatically applied. This flag is false for coupons and true for promotions. For free-gift promotions, a false value means manual gift selection is required.
application_id
string
Application id through which offer was created.
company_id
string
Company id through which offer was created.
discount_rules
array of object (OfferDiscountRule)
Discount rules based on which offer will be applied
Maximum Items : 10
Show
buy_rules
object
Contains the individual buy rules associated with the offer. The keys in this object are dynamic (e.g., 'rule#1', 'rule#2', etc.), and each key must correspond to a buy condition referenced within `discount_rules`. For example, if a discount rule includes a buy_condition '(rule#1)', then 'rule#1' must be defined in this object. Each rule key value must follow the format of OfferItemCriteria schema.
restrictions
object (OfferRestrictions)
Show
display_meta
object (OfferDisplayMeta)
Show
ownership
object (OfferOwnership)
Show
author
object (OfferAuthor)
Show
date_meta
object (OfferDateMeta)
Show
_schedule
object (OfferSchedule)
Show
_custom_json
object
Set extra properties in offer
stackable
boolean
Boolean value set true to apply other promotions as well.
Default Value : true
status
string
Status of the offer
Enum
published
boolean
Determines whether the offer is published to customers or marked inactive
type
string
Different types of offers available in the system. This is used to determine the type of offer and the calculation of the offer. Some types are mode specific, few examples are :> - free_item_discount_absolute is only applicable for coupon mode - contract_price, shipping_price, free_gift_items, cashback, free_items, free_non_sellable_items, external_price_adjustment_discount, custom is only applicable for promotion mode
Enum
priority
integer
| value <= 100000
| int32
Defines the priority of the offer. Its behavior varies based on the offer type. For coupons, a higher priority value means the coupon will appear higher in the listing order. For promotions, this value determines the sequence in which promotions are evaluated and applied. Promotions are evaluated in descending order of their effective priority. In case of conflicting priorities, the offer will be prioritised on the basis of creation order (desc).
Default Value : 1
is_exclusive_coupon
boolean
Flag to determine if coupon is exclusive. Exclusive coupon removes other applied offers from the cart. If both `is_exclusive_coupon` and `apply_exclusive` are set, `is_exclusive_coupon` takes priority for offer evaluation logic effectively making the offer exclusive.
Default Value : false
apply_exclusive
string
Nullable
Controls how this offer excludes other offers when it is applied. When this offer is applied at cart level, no other promotions are evaluated or applied for the same cart (it becomes the only active promotion for that cart). When this offer is applied on specific articles, those articles will not be eligible for any other promotions, but other promotions can still apply to different articles in the cart. If null, the offer follows the normal stacking rules and does not enforce additional exclusivity.
Enum
calculate_on
string
Article Price on which offer is calculated, like effective price or marked price. Only available for few supported types lile Contract pricing and Ladder pricing.
Default Value : esp
Enum
promo_group
string
The type of promotion group
Default Value : product
Enum
currency
string
ISO 4217 currency code in which the offer's discount amounts and calculations are specified (e.g., "INR", "USD", "EUR"). This currency is used as the base currency for discount calculations and currency conversions when applying the offer. If not provided, defaults to the seller's default currency code. All discount values in discount_rules are interpreted in this currency.
code
string
Unique identifier code for the offer. For coupons (i.e mode = "coupon"), this is the coupon code that users enter to apply the offer (e.g., "SAVE20", "WELCOME50"). For promotions (mode = "promotion"), this field is typically null or empty as promotions are auto-applied. This code is used to fetch and identify offers when applying them to carts. Must be unique within an application_id. For bulk coupons, this is auto-generated based on coupon_config.coupon_prefix.
coupon_config
object (OfferCouponConfiguration)
Show
is_processed
boolean
Flag to verify if promotion is ready to be applied on cart and ready to update promotion
is_bank_offer
boolean
Flag to determine if any bank offer is applicable
Default Value : false
filter_tags
array of string
Tags used to filter coupons, promotions, or offers in list APIs. When multiple values are provided in a list request, entities matching any tag are returned (OR).
Default Value :
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Response
Get a specific offer
getOfferById
Update the details of an existing offer by specifying its unique identifier. This includes modifying offer attributes such as discount percentage, validity period, and associated conditions.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idpath
string
Required
Offer identifier for updating corresponding offer data
Request body
_id
string
Unique identifier of offer. This will be auto generated upon successful offer creation.
mode
string
Required
Offer mode, like coupon or promotion
Enum
auto_apply
boolean
Indicates whether the offer is automatically applied. This flag is false for coupons and true for promotions. For free-gift promotions, a false value means manual gift selection is required.
application_id
string
Application id through which offer was created.
company_id
string
Company id through which offer was created.
discount_rules
array of object (OfferDiscountRule)
Discount rules based on which offer will be applied
Maximum Items : 10
Show
buy_rules
object
Contains the individual buy rules associated with the offer. The keys in this object are dynamic (e.g., 'rule#1', 'rule#2', etc.), and each key must correspond to a buy condition referenced within `discount_rules`. For example, if a discount rule includes a buy_condition '(rule#1)', then 'rule#1' must be defined in this object. Each rule key value must follow the format of OfferItemCriteria schema.
restrictions
object (OfferRestrictions)
Show
display_meta
object (OfferDisplayMeta)
Required
Show
ownership
object (OfferOwnership)
Show
author
object (OfferAuthor)
Show
date_meta
object (OfferDateMeta)
Show
_schedule
object (OfferSchedule)
Show
_custom_json
object
Set extra properties in offer
stackable
boolean
Boolean value set true to apply other promotions as well.
Default Value : true
status
string
Required
Status of the offer
Enum
published
boolean
Required
Determines whether the offer is published to customers or marked inactive
type
string
Required
Different types of offers available in the system. This is used to determine the type of offer and the calculation of the offer. Some types are mode specific, few examples are :> - free_item_discount_absolute is only applicable for coupon mode - contract_price, shipping_price, free_gift_items, cashback, free_items, free_non_sellable_items, external_price_adjustment_discount, custom is only applicable for promotion mode
Enum
priority
integer
| value <= 100000
| int32
Defines the priority of the offer. Its behavior varies based on the offer type. For coupons, a higher priority value means the coupon will appear higher in the listing order. For promotions, this value determines the sequence in which promotions are evaluated and applied. Promotions are evaluated in descending order of their effective priority. In case of conflicting priorities, the offer will be prioritised on the basis of creation order (desc).
Default Value : 1
is_exclusive_coupon
boolean
Flag to determine if coupon is exclusive. Exclusive coupon removes other applied offers from the cart. If both `is_exclusive_coupon` and `apply_exclusive` are set, `is_exclusive_coupon` takes priority for offer evaluation logic effectively making the offer exclusive.
Default Value : false
apply_exclusive
string
Nullable
Controls how this offer excludes other offers when it is applied. When this offer is applied at cart level, no other promotions are evaluated or applied for the same cart (it becomes the only active promotion for that cart). When this offer is applied on specific articles, those articles will not be eligible for any other promotions, but other promotions can still apply to different articles in the cart. If null, the offer follows the normal stacking rules and does not enforce additional exclusivity.
Enum
calculate_on
string
Article Price on which offer is calculated, like effective price or marked price. Only available for few supported types lile Contract pricing and Ladder pricing.
Default Value : esp
Enum
promo_group
string
The type of promotion group
Default Value : product
Enum
currency
string
ISO 4217 currency code in which the offer's discount amounts and calculations are specified (e.g., "INR", "USD", "EUR"). This currency is used as the base currency for discount calculations and currency conversions when applying the offer. If not provided, defaults to the seller's default currency code. All discount values in discount_rules are interpreted in this currency.
code
string
Unique identifier code for the offer. For coupons (i.e mode = "coupon"), this is the coupon code that users enter to apply the offer (e.g., "SAVE20", "WELCOME50"). For promotions (mode = "promotion"), this field is typically null or empty as promotions are auto-applied. This code is used to fetch and identify offers when applying them to carts. Must be unique within an application_id. For bulk coupons, this is auto-generated based on coupon_config.coupon_prefix.
coupon_config
object (OfferCouponConfiguration)
Show
is_processed
boolean
Flag to verify if promotion is ready to be applied on cart and ready to update promotion
is_bank_offer
boolean
Flag to determine if any bank offer is applicable
Default Value : false
filter_tags
array of string
Tags used to filter coupons, promotions, or offers in list APIs. When multiple values are provided in a list request, entities matching any tag are returned (OR).
Default Value :
PUT
Response
200
404
Offer updated successfully
Hide
Offer object defining the structure of an offer and all its attributes
_id
string
Unique identifier of offer. This will be auto generated upon successful offer creation.
mode
string
Offer mode, like coupon or promotion
Enum
auto_apply
boolean
Indicates whether the offer is automatically applied. This flag is false for coupons and true for promotions. For free-gift promotions, a false value means manual gift selection is required.
application_id
string
Application id through which offer was created.
company_id
string
Company id through which offer was created.
discount_rules
array of object (OfferDiscountRule)
Discount rules based on which offer will be applied
Maximum Items : 10
Show
buy_rules
object
Contains the individual buy rules associated with the offer. The keys in this object are dynamic (e.g., 'rule#1', 'rule#2', etc.), and each key must correspond to a buy condition referenced within `discount_rules`. For example, if a discount rule includes a buy_condition '(rule#1)', then 'rule#1' must be defined in this object. Each rule key value must follow the format of OfferItemCriteria schema.
restrictions
object (OfferRestrictions)
Show
display_meta
object (OfferDisplayMeta)
Show
ownership
object (OfferOwnership)
Show
author
object (OfferAuthor)
Show
date_meta
object (OfferDateMeta)
Show
_schedule
object (OfferSchedule)
Show
_custom_json
object
Set extra properties in offer
stackable
boolean
Boolean value set true to apply other promotions as well.
Default Value : true
status
string
Status of the offer
Enum
published
boolean
Determines whether the offer is published to customers or marked inactive
type
string
Different types of offers available in the system. This is used to determine the type of offer and the calculation of the offer. Some types are mode specific, few examples are :> - free_item_discount_absolute is only applicable for coupon mode - contract_price, shipping_price, free_gift_items, cashback, free_items, free_non_sellable_items, external_price_adjustment_discount, custom is only applicable for promotion mode
Enum
priority
integer
| value <= 100000
| int32
Defines the priority of the offer. Its behavior varies based on the offer type. For coupons, a higher priority value means the coupon will appear higher in the listing order. For promotions, this value determines the sequence in which promotions are evaluated and applied. Promotions are evaluated in descending order of their effective priority. In case of conflicting priorities, the offer will be prioritised on the basis of creation order (desc).
Default Value : 1
is_exclusive_coupon
boolean
Flag to determine if coupon is exclusive. Exclusive coupon removes other applied offers from the cart. If both `is_exclusive_coupon` and `apply_exclusive` are set, `is_exclusive_coupon` takes priority for offer evaluation logic effectively making the offer exclusive.
Default Value : false
apply_exclusive
string
Nullable
Controls how this offer excludes other offers when it is applied. When this offer is applied at cart level, no other promotions are evaluated or applied for the same cart (it becomes the only active promotion for that cart). When this offer is applied on specific articles, those articles will not be eligible for any other promotions, but other promotions can still apply to different articles in the cart. If null, the offer follows the normal stacking rules and does not enforce additional exclusivity.
Enum
calculate_on
string
Article Price on which offer is calculated, like effective price or marked price. Only available for few supported types lile Contract pricing and Ladder pricing.
Default Value : esp
Enum
promo_group
string
The type of promotion group
Default Value : product
Enum
currency
string
ISO 4217 currency code in which the offer's discount amounts and calculations are specified (e.g., "INR", "USD", "EUR"). This currency is used as the base currency for discount calculations and currency conversions when applying the offer. If not provided, defaults to the seller's default currency code. All discount values in discount_rules are interpreted in this currency.
code
string
Unique identifier code for the offer. For coupons (i.e mode = "coupon"), this is the coupon code that users enter to apply the offer (e.g., "SAVE20", "WELCOME50"). For promotions (mode = "promotion"), this field is typically null or empty as promotions are auto-applied. This code is used to fetch and identify offers when applying them to carts. Must be unique within an application_id. For bulk coupons, this is auto-generated based on coupon_config.coupon_prefix.
coupon_config
object (OfferCouponConfiguration)
Show
is_processed
boolean
Flag to verify if promotion is ready to be applied on cart and ready to update promotion
is_bank_offer
boolean
Flag to determine if any bank offer is applicable
Default Value : false
filter_tags
array of string
Tags used to filter coupons, promotions, or offers in list APIs. When multiple values are provided in a list request, entities matching any tag are returned (OR).
Default Value :
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Response
Update existing offer
updateOffer
Seller can make partial adjustments of an existing offer by specifying its unique identifier. It enables businesses to modify specific attributes of the offer while preserving other details intact.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idpath
string
Required
Offer identifier for fetching single promotion data for editing
Request body
schedule
object (PromotionSchedule)
Show
PATCH
Response
200
404
Offer updated successfully
Hide
Request success message schema
success
boolean
Whether the request was successful (true/false).
message
string
Response message needs to display
Examples
Parameters
body:
body
Response
Partially update offer
updateOfferPartially
Delete details of a draft offer by providing its unique identifier to delete information such as offer type, rules, validity period and other related information.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idpath
string
Required
Offer identifier for fetching single offer data for editing
DEL
Response
200
404
Offer deleted for sent id
Hide
Request success message schema
success
boolean
Whether the request was successful (true/false).
message
string
Response message needs to display
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Response
Delete draft offer
deleteOffer
Payment mode refers to the method used by customers to pay for their purchases during the checkout process. Payment modes typically include options such as credit card, debit card, digital wallets, bank transfer, cash on delivery (COD), and various online payment platforms like PayPal or Stripe. Customers select their preferred payment mode based on factors such as convenience, security, and availability. The chosen payment mode dictates how the transaction is processed and completed, ensuring a smooth and secure payment experience for the customer.
Operations
PUT
# Select payment mode
PUT
# Select payment mode (latest)
Customers can select a preferred payment mode from available options during the cart checkout process to securely and efficiently complete their transaction.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart
buy_nowquery
boolean
This is boolean to get buy_now cart
order_typequery
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-anonymous-cart
string
Anonymous cart header used to perform operations on cross-platform anonymous cart. When enabled, the system fetches the cart only based on cart_id instead of user_id.
Request body
address_id
string
Address id of the user on which the order to be delivered
payment_mode
string
Payment mode from which the payment to be done for the order
aggregator_name
string
Aggregator name of the payment gateway
merchant_code
string
Merchant code of the payment mode selected to do the payment
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment
id
string
Cart id of the user cart
PUT
Response
200
Success. Returns a Cart object as shown below. Refer `CartDetailResult` for more details.
Hide
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
payment_selection_lock
object (PaymentSelectionLock)
Show
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
coupon
object (CartDetailCoupon)
Show
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
buy_now:
false
order_type:
"value"
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
x-anonymous-cart:
"value"
Response
Select payment mode
selectPaymentMode
Selection of payment mode that supports multiple MOP(mode of payment).
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart
buy_nowquery
boolean
This is boolean to get buy_now cart
order_typequery
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
Request body
address_id
string
Address id of the user address selected to deliver the shipment
payment_mode
string
Payment mode of the payment selected to do the payment
aggregator_name
string
Aggregator name of the payment gateway
merchant_code
string
Merchant code of the payment mode selected to do the payment
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment
id
string
Cart id of the user cart for which the update cart payment operation performed
payment_methods
array of object (PaymentMethod)
Show
PUT
Response
200
400
Success. Returns a Cart object as shown below. Refer `CartDetailResult` for more details.
Hide
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
payment_selection_lock
object (PaymentSelectionLock)
Show
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
coupon
object (CartDetailCoupon)
Show
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
buy_now:
false
order_type:
"value"
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
Response
Select payment mode (latest)
selectPaymentModeV2
Price adjustment refers to modification of product prices based on various factors such as user behavior, market conditions, or business rules. It allows for real-time adjustments to product pricing, enabling businesses to offer personalized pricing or targeted discounts to individual customers or specific segments of users. For example, suppose a user has paid through a third-party platform, and the business wants to offer them a discount or apply a different pricing strategy. In that case, the Price Adjustment enable developers to incorporate these adjustments into the transaction process, enhancing flexibility and convenience for both users and businesses.
Operations
PUT
# Update price adjustments
DEL
# Remove price adjustments
POST
# Create price adjustments
GET
# Get a list of all price adjustments associated with a cart
Modify price adjustments for specific items in the cart. By providing the seller ID, sales channel ID, and price adjustment ID, seller can apply discounts or other adjustments to the prices of cart items, facilitating dynamic pricing strategies.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idpath
string
Required
price adjustment id for fetching single price adjustment data for editing
Request body
modified_by
string
The entity that modified the field
value
number
| float
Required
The amount applied on the cart
message
string
Required
The message associated with the price adjustment
apply_expiry
string
| date-time
The date and time when the expiry should be applied
restrictions
object (PriceAdjustmentRestrictions)
Restrictions applied to this particular item or product, including whether or not cancellation and return are allowed.
Show
article_level_distribution
boolean
Required
Flag indicating whether the distribution should is done at the article level
included_in_eligibility_amount
boolean
Opt-in flag. When true (valid only for charge type with article_level_distribution=true), the distributed charge value is added to the price_total used for offer cart_total eligibility checks. Which mode(s) are affected is controlled by eligibility_scope. When false or omitted, the charge does not affect coupon/promotion eligibility and eligibility_scope is ignored. Defaults to false — carts without this flag are unaffected.
eligibility_scope
string
When included_in_eligibility_amount is true, which offer mode receives this charge in cart_total eligibility: coupon (default / omitted), promotion or all (both coupon and promotion). Has no effect when included_in_eligibility_amount is false. Defaults to coupon when omitted.
Default Value : coupon
Enum
collection
object (Collection)
Required
Show
type
string
Required
Type of price adjusment like charge, mop, discount etc.
Enum
allowed_refund
boolean
Flag indicating whether refunds are allowed at cart level
is_authenticated
boolean
Required
Flag indicating whether the user is authenticated
article_ids
array of object (Article)
Required
The list of article object in the price adjustment
Show
auto_remove
boolean
This field if set true will remove mop type price adjustment.
meta
object
Additional information regarding price adjustment
cart_id
string
Required
Unique identifier of the cart
distribution_logic
object (DistributionLogic)
Show
PUT
Response
200
400
Price Adjustment Updated successfully
Hide
List of price adjustment information related to cart
data
array of object (PriceAdjustment)
Show
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Response
Update price adjustments
updatePriceAdjustment
Remove the applied price adjustments for specific items within the cart based on unique price adjustment ID.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idpath
string
Required
Price Adjustment id for removing particular price adjustment data
DEL
Response
200
400
Price Adjustment data Removed successfully
Hide
Request success message schema
success
boolean
Whether the request was successful (true/false).
message
string
Response message needs to display
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Response
Remove price adjustments
removePriceAdjustment
Create custom price adjustments for items in the cart, facilitating the application of discounts or promotions. Price adjustments can be tailored based on specific sales channel contexts, enhancing flexibility in pricing strategies.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
Request body
value
number
| float
Required
The amount applied on the cart
message
string
Required
The message associated with the price adjustment
apply_expiry
string
| date-time
The date and time when the expiry should be applied
restrictions
object (PriceAdjustmentRestrictions)
This field accepts the restrictions applied to this particular item or service, including whether or not cancellation and return are allowed, etc
Show
created_by
string
The entity that created the field
article_level_distribution
boolean
Required
Flag indicating whether the distribution should is done at the article level
included_in_eligibility_amount
boolean
Opt-in flag. When true (valid only for charge type with article_level_distribution=true), the distributed charge value is added to the price_total used for offer cart_total eligibility checks. Which mode(s) are affected is controlled by eligibility_scope. When false or omitted, the charge does not affect coupon/promotion eligibility and eligibility_scope is ignored. Defaults to false — carts without this flag are unaffected.
eligibility_scope
string
When included_in_eligibility_amount is true, which offer mode receives this charge in cart_total eligibility: coupon (default / omitted), promotion or all (both coupon and promotion). Has no effect when included_in_eligibility_amount is false. Defaults to coupon when omitted.
Default Value : coupon
Enum
collection
object (Collection)
Required
Show
type
string
Required
type of price adjusment
Enum
allowed_refund
boolean
Flag indicating whether refunds are allowed at cart level
is_authenticated
boolean
Required
Flag indicating whether the user is authenticated
article_ids
array of object (Article)
Required
The list of article object in the price adjustment
Show
meta
object
Additional information regarding price adjustment
cart_id
string
Required
Unique identifier of the cart
auto_remove
boolean
This field if set true will remove mop type price adjustment.
distribution_logic
object (DistributionLogic)
Show
POST
Response
201
400
Price Adjustment Created successfully
Hide
List of price adjustment information related to cart
data
array of object (PriceAdjustment)
Show
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Response
Create price adjustments
addPriceAdjustment
This API helps to get price adjustments data associated to a particular cart
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
cart_idquery
string
Required
Cart id of user cart
GET
Response
200
Price Adjustments List. See example below for details
Hide
List of price adjustment information related to cart
data
array of object (PriceAdjustment)
Show
Examples
Parameters
cart_id:
"65c06fe589db42581e4be72e"
Response
Get a list of all price adjustments associated with a cart
getPriceAdjustments
Promotion refers to a marketing campaign designed to incentivize customers to make purchases by offering discounts, bonuses, or other special offers. The aim of promotions is to attract customers, increase sales, clear excess inventory, introduce new products, encourage repeat purchases, and foster customer loyalty. Various types of promotions include: X Percentage Value: Offers a percentage discount based on the total purchase value. Example: Get 20% off orders over Rs. 1000. X Amount Value: Provides a fixed discount amount regardless of the total purchase value. Example: Save Rs. 50 on orders over Rs. 500. Buy X Items Get Y Items Free: Offers free items when a specified quantity is purchased. Example: Buy 2 shirts, get 1 shirt free. Buy X Items at Absolute Amount: Allows purchasing a set number of items at a fixed price. Example: Buy 3 t-shirts for Rs. 500. Free Shipping: Waives shipping fees on orders over Rs. 500. Example: Enjoy free shipping on all orders over Rs. 500. Free Gift Items: Offers complimentary items with qualifying purchases. Example: Get a free tote bag with orders over Rs. 1000. Bundle Percentage Discount: Discounts applied when buying specific combinations or quantities. Example: Buy 2 shirts, get 20% off each. Bundle Amount Discount: Similar to bundle percentage discount, but discount is applied to a specific spending amount. Example: Spend Rs. 1000 on shoes, receive Rs. 200 off entire order. Buy X Amount and Get Y Percentage Off: Offers a percentage discount on the total purchase when a specified amount is spent. Example: Spend Rs. 1500, get 10% off entire order.
Operations
GET
# List of promotions
POST
# Create a promotion
GET
# Get a specific promotion
PUT
# Update a promotion
DEL
# Delete a promotion which is in draft state
GET
# Get promotion and coupon type
GET
# Check promotion code exists
Retrieve a list of all created promotions for specific sales channel. It also supports efficient text search and pagination functionalities, ensuring optimized promotion listing for streamlined navigation and management.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
page_noquery
integer
current page no as per pagination
Default Value : 0
page_sizequery
integer
Promotion max records fetched in single request
Default Value : 10
qquery
string
Filter by promotion name or title
is_activequery
boolean
Filter by active or inactive promotion
Default Value : true
promo_groupquery
string
Filter by promotion group
Enum
promotion_typequery
string
Filter by promotion type
Enum
fp_panelquery
string
Filter non extension promotions
promotion_idquery
string
Filter by promotion id
created_byquery
string
Filter by promotion creater user id
reviewed_byquery
string
Filter by promotion reviewer user id
approved_start_timequery
string
| date-time
Filter promotion by start time date range when status is in approved state
approved_end_timequery
string
| date-time
Filter promotion by end time date range when status is in approved state
review_start_timequery
string
| date-time
Filter promotion by start time date range when status is in review state
review_end_timequery
string
| date-time
Filter promotion by end time date range when status is in review state
statusquery
string
Filter your promotions effortlessly by status, such as draft, review and more
Enum
filter_tagsquery
string
Filter by filter tag. Repeat this query parameter for multiple values (e.g. `?filter_tags=flash_sale&filter_tags=vip`). Entities matching any provided tag are returned (OR).
GET
Response
200
Promotion List for sent page_size and page_no
Hide
List of promotions and their information like promotion name, promotion type and promotion schedule etc.
items
array of object (PromotionListItem)
List of promotions
Show
page
object (Page)
Show
Examples
Parameters
Parameters are not required.
Response
List of promotions
getPromotions
Creates a new promotion based on the selected promotion type. Sellers can choose from multiple supported promotion types, including percentage value, fixed amount value, bundled discount, buy X get Y items, and more, along with customizable promotion criteria to meet specific business requirements.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
Request body
stackable
boolean
Boolean value set true to apply other promotions also
calculate_on
string
Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
promotion should apply on either article or cart.
Enum
promo_group
string
Required
The type of promotion group
Enum
mode
string
Required
Promotion mode, like coupon or promotion
Enum
apply_all_discount
boolean
True means to apply all discount offers
display_meta
object (DisplayMeta1)
Show
ownership
object (Ownership1)
Show
promotion_type
string
Required
Type of promotion
Enum
discount_rules
array of object (DiscountRule)
List of discount offers and their applicable conditions
Show
restrictions
object (Restrictions1)
Show
currency
string
Promotion Currency code like INR
code
string
Promotion unique code
_schedule
object (PromotionSchedule)
Show
post_order_action
object (PromotionAction)
Show
apply_priority
integer
| int32
Promotion applicable priority
author
object (PromotionAuthor)
Show
visiblility
object (Visibility)
Show
application_id
string
Required
Current application id of sales channel
buy_rules
object (BuyRuleItemCriteria)
Show
_custom_json
object
Set extra properties in promotion
date_meta
object (PromotionDateMeta)
Show
tags
array of string
List of tags applicable for promotion
Default Value :
filter_tags
array of string
Tags used to filter coupons, promotions, or offers in list APIs. When multiple values are provided in a list request, entities matching any tag are returned (OR).
Default Value :
auto_apply
boolean
Boolean value to determine if the promotion should be applied automatically or not
POST
Response
201
400
Creates a discount promotion which applies on user cart.
Hide
Request schema used to create the promotion
stackable
boolean
Boolean value set true to apply other promotions also
calculate_on
string
Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
promotion should apply on either article or cart.
Enum
promo_group
string
The type of promotion group
Enum
mode
string
Promotion mode, like coupon or promotion
Enum
is_processed
boolean
Flag to verify if promotion is ready to be applied on cart and ready to update promotion
apply_all_discount
boolean
True means to apply all discount offers
display_meta
object (DisplayMeta1)
Show
ownership
object (Ownership1)
Show
promotion_type
string
Type of promotion
Enum
discount_rules
array of object (DiscountRule)
List of discount offers and their applicable conditions
Show
restrictions
object (Restrictions1)
Show
currency
string
Promotion Currency code like INR
code
string
Promotion unique code
_schedule
object (PromotionSchedule)
Show
post_order_action
object (PromotionAction)
Show
apply_priority
integer
| int32
Promotion applicable priority
author
object (PromotionAuthor)
Show
visiblility
object (Visibility)
Show
application_id
string
Current application id of sales channel
buy_rules
object (ItemCriteria)
Show
_custom_json
object
Set extra properties in promotion
date_meta
object (PromotionDateMeta)
Show
tags
array of string
List of tags applicable for promotion
Default Value :
filter_tags
array of string
Tags used to filter coupons, promotions, or offers in list APIs. When multiple values are provided in a list request, entities matching any tag are returned (OR).
Default Value :
auto_apply
boolean
Boolean value to determine if the promotion should be applied automatically or not
Response
Create a promotion
createPromotion
Retrieve details of a specific promotion by providing its unique identifier to obtain information such as promotion type, rules, validity period and other related information.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idpath
string
Required
Promotion id for fetching single promotion data for editing
GET
Response
200
404
Promotion object for sent promotion id
Hide
Request schema used to update the promotion
stackable
boolean
Set true to apply other promotions in cart
calculate_on
string
Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
promotion should apply on either article or cart.
Enum
reason
string
Nullable
Promotion rejection reason added by reviewer
is_processed
boolean
Flag to verify if promotion is ready to be applied on cart and ready to update promotion
promo_group
string
The type of promotion group
Enum
mode
string
Promotion mode
Enum
apply_all_discount
boolean
True means to apply all discount offers
display_meta
object (DisplayMeta1)
Show
ownership
object (Ownership1)
Show
promotion_type
string
The Promotion type like amount, bogo and percentage etc.
Enum
discount_rules
array of object (DiscountRule)
List of discount offers and their applicable conditions
Show
restrictions
object (Restrictions1)
Show
currency
string
Promotion Currency code like INR
code
string
Promotion unique code
_schedule
object (PromotionSchedule)
Show
post_order_action
object (PromotionAction)
Show
apply_priority
integer
| int32
Promotion applicable priority
author
object (PromotionAuthor)
Show
visiblility
object (Visibility)
Show
application_id
string
Current application id of sales channel
buy_rules
object (BuyRuleItemCriteria)
Show
_custom_json
object
Set extra properties in promotion
date_meta
object (PromotionDateMeta)
Show
tags
array of string
List of tags applicable for promotion
Default Value :
filter_tags
array of string
Tags used to filter coupons, promotions, or offers in list APIs. When multiple values are provided in a list request, entities matching any tag are returned (OR).
Default Value :
auto_apply
boolean
Boolean value to determine if the promotion should be applied automatically or not
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Response
Get a specific promotion
getPromotionById
Update the details of an existing promotion by specifying its unique identifier. This includes modifying promotion attributes such as discount percentage, validity period, and associated conditions. Leveraging this functionality allows businesses to quickly adapt their promotional strategies to changing market dynamics.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idpath
string
Required
Promotion identifier for fetching single promotion data for editing
Request body
stackable
boolean
Set true to apply other promotions in cart
calculate_on
string
Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
promotion should apply on either article or cart.
Enum
reason
string
Nullable
Promotion rejection reason added by reviewer
promo_group
string
Required
The type of promotion group
Enum
mode
string
Required
Promotion mode
Enum
apply_all_discount
boolean
True means to apply all discount offers
display_meta
object (DisplayMeta1)
Show
ownership
object (Ownership1)
Show
promotion_type
string
Required
The Promotion type like amount, bogo and percentage etc.
Enum
discount_rules
array of object (DiscountRule)
List of discount offers and their applicable conditions
Show
restrictions
object (Restrictions1)
Show
currency
string
Promotion Currency code like INR
code
string
Promotion unique code
_schedule
object (PromotionSchedule)
Show
post_order_action
object (PromotionAction)
Show
apply_priority
integer
| int32
Promotion applicable priority
author
object (PromotionAuthor)
Show
visiblility
object (Visibility)
Show
application_id
string
Required
Current application id of sales channel
buy_rules
object (ItemCriteria)
Show
_custom_json
object
Set extra properties in promotion
date_meta
object (PromotionDateMeta)
Show
tags
array of string
List of tags applicable for promotion
Default Value :
filter_tags
array of string
Tags used to filter coupons, promotions, or offers in list APIs. When multiple values are provided in a list request, entities matching any tag are returned (OR).
Default Value :
auto_apply
boolean
Boolean value to determine if the promotion should be applied automatically or not
PUT
Response
200
404
Promotion updated successfully
Hide
Request schema used to update the promotion
stackable
boolean
Set true to apply other promotions in cart
calculate_on
string
Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
promotion should apply on either article or cart.
Enum
reason
string
Nullable
Promotion rejection reason added by reviewer
is_processed
boolean
Flag to verify if promotion is ready to be applied on cart and ready to update promotion
promo_group
string
The type of promotion group
Enum
mode
string
Promotion mode
Enum
apply_all_discount
boolean
True means to apply all discount offers
display_meta
object (DisplayMeta1)
Show
ownership
object (Ownership1)
Show
promotion_type
string
The Promotion type like amount, bogo and percentage etc.
Enum
discount_rules
array of object (DiscountRule)
List of discount offers and their applicable conditions
Show
restrictions
object (Restrictions1)
Show
currency
string
Promotion Currency code like INR
code
string
Promotion unique code
_schedule
object (PromotionSchedule)
Show
post_order_action
object (PromotionAction)
Show
apply_priority
integer
| int32
Promotion applicable priority
author
object (PromotionAuthor)
Show
visiblility
object (Visibility)
Show
application_id
string
Current application id of sales channel
buy_rules
object (BuyRuleItemCriteria)
Show
_custom_json
object
Set extra properties in promotion
date_meta
object (PromotionDateMeta)
Show
tags
array of string
List of tags applicable for promotion
Default Value :
filter_tags
array of string
Tags used to filter coupons, promotions, or offers in list APIs. When multiple values are provided in a list request, entities matching any tag are returned (OR).
Default Value :
auto_apply
boolean
Boolean value to determine if the promotion should be applied automatically or not
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Response
Update a promotion
updatePromotion
Delete details of a draft promotion by providing its unique identifier to delete information such as promotion type, rules, validity period and other related information.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Application id of sales channel
idpath
string
Required
Promotion id for fetching single promotion data for deleting
DEL
Response
200
404
Promotion deleted for sent id
Hide
Request success message schema
success
boolean
Whether the request was successful (true/false).
message
string
Response message needs to display
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Response
Delete a promotion which is in draft state
deletePromotion
Retrieve the configuration settings related to promotions and coupons for a specific seller. It provides details of the supported types of coupons and promotions along with their descriptions, examples, and related attributes.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
entity_typequery
string
Entity type as promotion or coupon
Enum
is_hiddenquery
boolean
Promotion coupon config shown or not
GET
Response
200
Success. Returns a list of all the curently active coupons/promos
Hide
Response schema for coupon and promotion type information
entity_slug
string
A short, human-readable, URL-friendly identifier of Promotion or coupon
title
string
Name of the promotion or coupon
modified_on
string
| date-time
Coupon or promotion modification date
example
string
Discount offers examples
entity_type
string
Type of entity to be selected from : ['coupon', 'promotion']
created_on
string
| date-time
Coupon or modification creation date
is_hidden
boolean
If the promo is active or not
type
string
Coupon or promotion type
subtitle
string
Small description of the current offer
description
string
The description of the offer in the form of an HTML
discount_type
string
Determines the type of discount offered i.e percentage, amount, free item, etc.
Enum
Examples
Parameters
company_id:
"value"
application_id:
"value"
entity_type:
"value"
is_hidden:
false
Response
Get promotion and coupon type
getPromosCouponConfig
Validates the presence of a promotion code for the specified sales channel to verify whether the provided code already exists or not.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
codequery
string
Promotion code
GET
Response
200
400
Valid response with existing promotion code count
Hide
success
boolean
count
integer
Examples
Parameters
Parameters are not required.
Response
Check promotion code exists
getPromotionCodeExists
Promotion offers are special incentives or discounts provided to customers to encourage purchases or enhance their shopping experience. These offers can take various forms, such as percentage discounts, fixed-price discounts, free shipping, buy-one-get-one (BOGO) deals. Ladder pricing, also known as tiered pricing, refers to a pricing strategy where the price of a product varies depending on the quantity purchased or other specified criteria. With ladder pricing, customers are incentivized to buy more by offering discounts or reduced prices for larger quantities or higher purchase volumes. For example, a retailer might offer a discounted price per unit for purchasing 10 items instead of just one.
Operations
GET
# List of all available promotion offers
GET
# Fetch available promotions payment offers
Retrieve a list of all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id
slugquery
string
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/
page_sizequery
integer
Number of offers to be fetched to show
promotion_groupquery
string
Type of promotion groups
store_idquery
integer
Unique identifier of a store
cart_typequery
string
The type of cart
promotion_typequery
string
Type of promotion to be fetched
cart_idquery
string
The unique identifier of the user cart.
auto_applyquery
boolean
Indicates whether to filter promotions based on their auto_apply status.
GET
Response
200
400
Success. Returns a array containing the available offers (if exists) on product via promotions. Refer `PromotionOffersDetails` for more details.
Hide
Response schema for available promotions for cart
available_promotions
array of object (PromotionOffer)
List of available promotion for product
Show
Examples
Parameters
company_id:
"value"
application_id:
"value"
slug:
"value"
page_size:
1
promotion_group:
"value"
store_id:
1
cart_type:
"value"
promotion_type:
"value"
cart_id:
"value"
auto_apply:
false
Response
List of all available promotion offers
getPromotionOffers
Use this API to get top 5 payment offers available for current product
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
Cart id of the user cart
uidquery
integer
Cart uid of the user cart
GET
Response
200
400
Success. Returns a array containing the available offers (if exists) on product via promotions. Refer `PromotionPaymentOffersDetails` for more details.
Hide
Response schema for available payment promotions for cart
success
boolean
Indicates if operation is successful or not.
promotions
array of object (PromotionPaymentOffer)
Show
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
uid:
1
Response
Fetch available promotions payment offers
getPromotionPaymentOffers
Operations
POST
# Redeem loyalty points.
Users can redeem their accumulated loyalty points and apply them to the items in their cart, thereby availing discounts on their current purchases.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart.
iquery
boolean
Select `true` to retrieve all the items added in the cart.
bquery
boolean
Select `true` to retrieve the price breakup of cart items.
buy_nowquery
boolean
This is boolean to get buy_now cart.
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
Request body
redeem_points
boolean
Required
Marks if engage points are to be redeemed for the given cart.
meta
object
Free-form metadata forwarded to the loyalty engine. Any field can be passed (e.g. points, redeem_rule_id). Engage reads from this dict when processing redemption.
POST
Response
200
Success. Returns a Cart object. Check the example shown below or refer `CartDetailResult` for more details.
Hide
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
payment_selection_lock
object (PaymentSelectionLock)
Show
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
coupon
object (CartDetailCoupon)
Show
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
i:
false
b:
false
buy_now:
false
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
Response
Redeem loyalty points.
applyLoyaltyPoints
A selling location represents a geographical location where your stores, pop-up stores, headquarters, and warehouses exist. Find in-stock locations for products Additionally, the API retrieves detailed location information by ID, offering comprehensive store details for enhanced user convenience
Operations
GET
# Get Store Address
Retrieve store details by entering the unique identifier of the pickup stores. Store details include the seller's name, contact information such as email address or phone number and business address.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
store_uidquery
integer
Required
The unique identifier of the store
GET
Response
200
Success. Returns available store information with its address as shown below.
Hide
Store related information associated with the address
items
array of object (PickupStoreDetail)
List of items need to pickup from store
Show
Examples
Parameters
company_id:
"value"
application_id:
"value"
store_uid:
1
Response
Get Store Address
getStoreAddressByUid
Shipment refers to the process of delivering purchased items from the seller's location to the customer’s designated address. Shipment details includes seller information, estimated delivery dates, item quantity, order type (Home Delivery or Pick At Store or Digital) and other shipment meta information. Additionally, it provides details about the items included in the shipment.
Operations
GET
# Get shipments details
PUT
# Update shipments
GET
# Get delivery modes
Use this API to get shipment details, expected delivery date, items and price breakup of the shipment.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
pick_at_store_uidquery
integer
ID of the store from where the order will be picked up by the customer, assuming the order_type is `PickAtStore`. This may or may not be the same as the ID of the ordering store.
ordering_store_idquery
integer
ID of the store where the customer is ordering from.
iquery
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
pquery
boolean
This is a boolean value. Select `true` for getting a payment option in response.
idquery
string
The unique identifier of the cart
address_idquery
string
ID allotted to the selected address
area_codequery
string
The PIN Code of the destination address, e.g. 400059
order_typequery
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
Enum
GET
Response
200
Success. Returns delivery promise along with shipment details and price breakup. Refer `PlatformCartShipmentsResult` for more details.
Hide
Cart shipment response schema
coupon_text
string
Coupon text of coupon applied on cart
id
string
Cart id of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
comment
string
Comment message added in cart
items
array of object (CartProductInfo)
List of items in cart
Show
payment_selection_lock
object (PaymentSelectionLock)
Show
delivery_charge_info
string
Delivery charge in information message on shipment
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Response message of get shipments API
breakup_values
object (CartBreakup)
Show
staff_user_id
string
Nullable
Staff employee user id if cart is created by staff employee for the customer
is_valid
boolean
Cart validity flag determines the if the response is valid or not
shipments
array of object (PlatformShipmentDetails)
List of shipments that will be shipped
Show
currency
object (CartCurrency)
Show
checkout_mode
string
Checkout mode of cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag of user cart
gstin
string
GSTIN number added in cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
error
boolean
Error details if any error occurs which includes type of error, error code and error message
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom cart meta details added in cart
customer_id
string
Customer user id associated with cart
Examples
Parameters
Parameters are not required.
Response
Get shipments details
getShipments
Update the quantity or delivery type of the shipments. Customers can switch the order type from Home Delivery to Pick At Store and vice versa.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
iquery
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
pquery
boolean
This is a boolean value. Select `true` for getting a payment option in response.
idquery
string
The unique identifier of the cart
address_idquery
string
ID allotted to an address
area_codequery
string
The PIN Code of the destination address, e.g. 400059
order_typequery
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
Request body
shipments
array of object (UpdateCartShipmentItem)
Required
List of Shipments which includes shipment data like shipment items, shipment promise, Shipment type, shipment order type, shipment dp options etc
Show
PUT
Response
200
Success. Returns delivery promise along with shipment details and price breakup. Refer `PlatformCartShipmentsResult` for more details.
Hide
Cart shipment response schema
coupon_text
string
Coupon text of coupon applied on cart
id
string
Cart id of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
comment
string
Comment message added in cart
items
array of object (CartProductInfo)
List of items in cart
Show
payment_selection_lock
object (PaymentSelectionLock)
Show
delivery_charge_info
string
Delivery charge in information message on shipment
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Response message of get shipments API
breakup_values
object (CartBreakup)
Show
staff_user_id
string
Nullable
Staff employee user id if cart is created by staff employee for the customer
is_valid
boolean
Cart validity flag determines the if the response is valid or not
shipments
array of object (PlatformShipmentDetails)
List of shipments that will be shipped
Show
currency
object (CartCurrency)
Show
checkout_mode
string
Checkout mode of cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag of user cart
gstin
string
GSTIN number added in cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
error
boolean
Error details if any error occurs which includes type of error, error code and error message
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom cart meta details added in cart
customer_id
string
Customer user id associated with cart
Examples
Parameters
Parameters are not required.
Response
Update shipments
updateShipments
Retrieve a list of delivery modes (home delivery/store pickup) along with a list of available pickup stores for a given cart at a specified PIN Code.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
area_codequery
string
Required
The PIN Code of the destination address, e.g. 400059
idquery
string
The unique identifier of the cart
GET
Response
200
Success. Returns the available delivery mode available for a given PIN Code, along with the UID of all the eligible pickup stores.
Hide
Delivery mode schema for cart which include pickup_stores and available_modes
pickup_stores
array of integer
Store pick up available store uids
available_modes
array of string
Available delivery modes
Examples
Parameters
company_id:
"value"
application_id:
"value"
area_code:
"value"
id:
"value"
Response