Note: You are viewing an older version of the documentation. Click here to go the latest version
Cart
Handles shopping carts, including adding, removing, and updating items, as well as calculating totals.
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
GET
# Get a cart
HEAD
# Get last modified timestamp of a cart
POST
# Add items to a cart
PUT
# Update cart items
PATCH
# Update store credits into cart and their items
PUT
# Delete a cart
GET
# Get a cart items count
PUT
# Update cart metadata
POST
# Create share cart link
GET
# List shared cart items
POST
# Update with shared items
Get details of a cart 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
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.
cquery
boolean
Select `true` to retrieve the cod charges in breakup of cart items.
assign_card_idquery
integer
Token of user's debit or credit card.
area_codequery
string
Customer servicable area_code.
buy_nowquery
boolean
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.
Enum
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 Cart object. Check the example shown below or refer `CartDetailResult` for more details.
Hide
Get cart detail 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.
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
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment Default Selection Schema.
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
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
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc.
article
object (ProductArticle)
Show
Product store information of the product added in cart.
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article.
base
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
converted
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
product_group_tags
array of string
List fot the unique identifier for the product grouping.
extra_meta
object
Field to update extra meta of the article in cart.
quantity
integer
| int32
Quantity of the article added in cart.
_custom_json
object
Field to update custom json of the article in cart.
meta
object
Article meta data.
size
string
Size of the article added in cart.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
seller_identifier
string
List of identifiers used by sellers for the product size.
parent_item_identifiers
object
Fields to determine parent product of the product.
identifier
object
Unique identifier of the article.
store
object (StoreInfo)
Show
Store information of the store which includes store name, store id and store code.
store_code
string
A unique code or identifier for the store, often used for internal reference.
uid
integer
| int32
Unique identifiers of the store from where product is fulfilled.
name
string
Store name of the store from where the product is fulfilled.
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of delivery service.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
Undefined Type
The store's operational hours for each day of the week.
cart_item_meta
object
Meta details of the article added from cart.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
gift_card
object
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift.
is_gift_visible
boolean
Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
type
string
Type of the data sent in response. Possible value is article.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags.
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
promo_meta
object (PromoMeta)
Show
Loyalty points message data.
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
price
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
converted
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
quantity
integer
| int32
Quantity of the product added in cart.
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of value.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
out_of_stock
boolean
Denotes if the product is available in stock.
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not.
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability.
Show
Product sizes availability.
display
string
Display size of the product.
value
string
Actual value of the size.
is_available
boolean
Available flag for the size of the product if that is available.
is_valid
boolean
Valid flag for the product if the product added in cart is valid to place the order.
other_store_quantity
integer
| int32
Quantity of the product available on other store.
sizes
array of string
All sizes of the product.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categories, images, item code, tags, item id, item name, etc.
_custom_json
object
Field to add custom json of the product in cart.
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
action
object (ProductAction)
Show
Schema of Action Object to render the product.
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs.
product_slug
array of string
Contains list of product slug.
url
string
Url of the product to render the product
type
string
Type of action.
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart.
tags
object
Tags is a lable or batch that is attached to a product in cart.
slug
string
Unique product url name generated via product name and other meta data.
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url.
Show
Product images data in different formats.
secure_url
string
Secured url of the product image.
aspect_ratio
string
Aspect ratio of the product image.
url
string
Bucket link url for product image.
uid
integer
| int32
Unique identifier of the product in cart.
name
string
Product name of the product in cart which is defined on platform.
item_code
string
Nullable
Product code of the product while defining product on platform.
categories
array of object (CategoryInfo)
Product category information which incldes category name and category id.
Show
Category information schema which denotes category name and category id.
uid
integer
| int32
Product Category Id.
name
string
Category name of the product.
tags
array of string
Products tags that are added to each product to identify the set of products.
type
string
Type of product in cart.
attributes
object
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
coupon
object (CouponDetails)
Show
Coupon actual price breakup details.
discount_single_quantity
number
| float
Discount amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
custom_order
object
Whether MTO (Make to Order) is enabled or not.
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
key
string
The attribute key associated with the size.
message
string
Product level message which denotes error information to display over the product in cart.
is_set
boolean
Whether or not the product is a set of items.
price_per_unit
object (ProductPricePerUnitInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
converted
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Show
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
item_type
string
Type of the item in cart.
Enum
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
delivery_charge_info
string
Delivery charge in information message on shipment.
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config.
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag.
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold.
charges
number
| float
Charges amount to be applied on cart.
threshold
number
| float
Threshold of cart value on which the charge should be applied.
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value.
cashback_amount
number
| float
Fields denotes cashback amount applied to cart.
cashback_message_primary
string
Primary cashback message for coupon applied to cart.
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart.
coupon_code
string
Coupon code to be applied to cart.
coupon_description
string
Coupon description of the coupon applied to cart.
coupon_id
string
Unique identifier of the coupon applied to cart.
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart.
coupon_title
string
Coupon Title of the coupon applied.
coupon_type
string
Type of the coupon applied to cart.
coupon_value
number
| float
Value of the coupon applied to cart.
discount
number
| float
Total discount earned from coupon applied to cart.
is_applied
boolean
Flag to determine where the coupon is applied to cart or not.
is_valid
boolean
Determine where the coupon applied to cart is valid.
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
message
string
Coupon message of the coupon applied to cart.
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart.
message
string
Message of the get 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.
gstin
string
GSTIN added in user cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, engage and loyalty points.
display
array of object (DisplayBreakup)
List of breakup data which is used to display the breakup to the customer like MRP total, Discount, Sub total, coupon value, promotion value and final total.
Show
Display price breakup schema denotes price currency, key, value,message to display as breakup on UI.
currency_symbol
string
Currency symbol for the price.
key
string
Key of the price like total_mrp, total, subtotal etc.
display
string
Display key field that to be shown against the value.
message
array of string
List of message at price level to be displayed.
currency_code
string
Currency code for the price.
value
number
| float
Numeric value of the price.
preset
number
| float
Value for the price which is set from platform if applicable.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convenience fee, coupon amount, delivery charge, discount, loyalty points, engage points, gift card, gst charge, etc.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
subtotal
number
| float
Selling price amount of all products in cart.
engage_amount
number
| float
Engage amount applied on the cart.
engage_mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
fynd_cash
number
| float
Loyalty points applied on cart.
discount
number
| float
Discount amount received on cart.
convenience_fee
number
| float
Convenience fee amount applied to cart.
delivery_charge
number
| float
Delivery charge applied to cart.
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
total_charge
number
| float
Total amount of charges applied on cart.
coupon
number
| float
Coupon amount applied to cart.
total
number
| float
Total payable amount by the customer.
gift_card
number
| float
Gift cart amount applied on cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
coupon
object (CouponBreakup)
Show
Coupon price breakup details which includes coupon code, coupon type, coupon value, coupon description, coupn message etc.
coupon_value
number
| float
Value of the coupon applied to cart.
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
minimum_cart_value
number
| float
Minimum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
uid
string
Unique identifier of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
loyalty_points
object (LoyaltyPoints)
Show
Engage points data for the user cart.
total
number
| float
Total loyalty points available with user.
description
string
Description for loyalty points.
applicable
number
| float
Whether the loyalty points are applicable for the cart.
is_applied
boolean
Whether the loyalty points are applied on the cart.
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage discount amount applied on the cart as engage redeemed points can be set as discount or MOP from engage platform.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Formatted title that can be used by theme to display points earned by user for this cart.
title
string
Unique title for loyalty program applicable.
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
currency
object (CartCurrency)
Show
Currency data of the cart for prices.
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
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 (AlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
customer_id
string
Customer user id associated with cart
Examples
Parameters
id:
"value"
i:
false
b:
false
c:
false
assign_card_id:
1
area_code:
"value"
buy_now:
false
order_type:
"value"
x-ordering-source:
"value"
x-ordering-source-type:
"value"
Response
Get a cart
getCart
Retrieve the last modified timestamp of the cart using unique cart ID. It indicates the most recent update made to the cart's content or properties.
Parameters
idquery
string
The unique identifier of the cart.
HEAD
Response
200
Success. Receives last modifed timestamp in the header.
Header Items
Last-Modified
string
| date
Last-Modified Action on Cart
Examples
Parameters
id:
"value"
Response
Get last modified timestamp of a cart
getCartLastModified
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
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.
include_cart_calculationquery
boolean
Set to `false` to skip recalculating and fetching the updated cart after the edit. Defaults to `true`.
area_codequery
string
Customer servicable area_code.
buy_nowquery
boolean
Select `true` to set/initialize buy now cart.
idquery
string
The unique identifier of 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.
Enum
bodyrequestBody
object (AddCartCreation)
Required
Specify the item details as shown below. Refer `AddCartCreation` for more details.
Hide
Add to cart request schema which has items data to be added in 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
Items data list to be added in cart which includes item id, article id, item size, meta, parent item identifier, article assignment and custom json.
article_assignment
object
Field to determine how article assignment should happen by article assignment level and strategy.
product_group_tags
array of string
Field to specify the product groups of the product that the user is trying to add in cart.
extra_meta
object
Extra meta data to be added at article level while add items to cart.
quantity
integer
| int32
Field to specify the product quantity that user wants to buy.
_custom_json
object
Field to add custom json at article level while add items to cart.
force_new_line_item
boolean
Field used to decide the product add as a separate product in cart
item_size
string
Field to determine size of the product.
store_id
integer
| int32
Unique identifier of the store selected by the user from which user want to buy a product.
display
string
Display field at article level.
article_id
string
Unique identifier of an article.
parent_item_identifiers
array of object
Fields to determine parent product of the product.
seller_id
integer
| int32
Unique identifier of the seller selected by the user from which user want to buy a product.
pos
boolean
Field to determine whether user is making request from pos or not.
item_id
integer
| int32
Unique identifier to identify product.
meta
object
Field to add meta data at article level.
seller_identifier
string
Add items using seller identifier for store os.
fulfillment_option_slug
string
specifies the fulfillment method, indicating whether an order is for home delivery or store pickup
pickup_store_id
integer
| int32
Unique identifier of the pickup store selected by the user from which user wants to pickup the product.
new_cart
boolean
Field to create to new cart whille user adds item to 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
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
Items data list to be added in cart which includes item id, article id, item size, meta, parent item identifier, article assignment and custom json.
article_assignment
object
Field to determine how article assignment should happen by article assignment level and strategy.
product_group_tags
array of string
Field to specify the product groups of the product that the user is trying to add in cart.
extra_meta
object
Extra meta data to be added at article level while add items to cart.
quantity
integer
| int32
Field to specify the product quantity that user wants to buy.
_custom_json
object
Field to add custom json at article level while add items to cart.
force_new_line_item
boolean
Field used to decide the product add as a separate product in cart
item_size
string
Field to determine size of the product.
store_id
integer
| int32
Unique identifier of the store selected by the user from which user want to buy a product.
display
string
Display field at article level.
article_id
string
Unique identifier of an article.
parent_item_identifiers
array of object
Fields to determine parent product of the product.
seller_id
integer
| int32
Unique identifier of the seller selected by the user from which user want to buy a product.
pos
boolean
Field to determine whether user is making request from pos or not.
item_id
integer
| int32
Unique identifier to identify product.
meta
object
Field to add meta data at article level.
seller_identifier
string
Add items using seller identifier for store os.
fulfillment_option_slug
string
specifies the fulfillment method, indicating whether an order is for home delivery or store pickup
pickup_store_id
integer
| int32
Unique identifier of the pickup store selected by the user from which user wants to pickup the product.
new_cart
boolean
Field to create to new cart whille user adds item to cart.
POST
Response
200
Success. Returns a cart object as shown below. Refer `AddCartDetailResult` for more details.
Hide
Add cart detail API schema which specifies cart data, response message and success flag.
message
string
Message of add to cart API response.
partial
boolean
When adding multiple items check if all added. True if only few are added.
cart
object (CartDetailResult)
Show
Get cart detail 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.
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
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment Default Selection Schema.
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
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
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc.
article
object (ProductArticle)
Show
Product store information of the product added in cart.
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article.
base
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
converted
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
product_group_tags
array of string
List fot the unique identifier for the product grouping.
extra_meta
object
Field to update extra meta of the article in cart.
quantity
integer
| int32
Quantity of the article added in cart.
_custom_json
object
Field to update custom json of the article in cart.
meta
object
Article meta data.
size
string
Size of the article added in cart.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
seller_identifier
string
List of identifiers used by sellers for the product size.
parent_item_identifiers
object
Fields to determine parent product of the product.
identifier
object
Unique identifier of the article.
store
object (StoreInfo)
Show
Store information of the store which includes store name, store id and store code.
store_code
string
A unique code or identifier for the store, often used for internal reference.
uid
integer
| int32
Unique identifiers of the store from where product is fulfilled.
name
string
Store name of the store from where the product is fulfilled.
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of delivery service.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
cart_item_meta
object
Meta details of the article added from cart.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
gift_card
object
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift.
is_gift_visible
boolean
Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
type
string
Type of the data sent in response. Possible value is article.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags.
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
promo_meta
object (PromoMeta)
Show
Loyalty points message data.
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
price
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
converted
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
quantity
integer
| int32
Quantity of the product added in cart.
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of value.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
out_of_stock
boolean
Denotes if the product is available in stock.
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not.
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability.
Show
Product sizes availability.
display
string
Display size of the product.
value
string
Actual value of the size.
is_available
boolean
Available flag for the size of the product if that is available.
is_valid
boolean
Valid flag for the product if the product added in cart is valid to place the order.
other_store_quantity
integer
| int32
Quantity of the product available on other store.
sizes
array of string
All sizes of the product.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categories, images, item code, tags, item id, item name, etc.
_custom_json
object
Field to add custom json of the product in cart.
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
action
object (ProductAction)
Show
Schema of Action Object to render the product.
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs.
product_slug
array of string
Contains list of product slug.
url
string
Url of the product to render the product
type
string
Type of action.
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart.
tags
object
Tags is a lable or batch that is attached to a product in cart.
slug
string
Unique product url name generated via product name and other meta data.
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url.
Show
Product images data in different formats.
secure_url
string
Secured url of the product image.
aspect_ratio
string
Aspect ratio of the product image.
url
string
Bucket link url for product image.
uid
integer
| int32
Unique identifier of the product in cart.
name
string
Product name of the product in cart which is defined on platform.
item_code
string
Nullable
Product code of the product while defining product on platform.
categories
array of object (CategoryInfo)
Product category information which incldes category name and category id.
Show
Category information schema which denotes category name and category id.
uid
integer
| int32
Product Category Id.
name
string
Category name of the product.
tags
array of string
Products tags that are added to each product to identify the set of products.
type
string
Type of product in cart.
attributes
object
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
coupon
object (CouponDetails)
Show
Coupon actual price breakup details.
discount_single_quantity
number
| float
Discount amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
custom_order
object
Whether MTO (Make to Order) is enabled or not.
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
key
string
The attribute key associated with the size.
message
string
Product level message which denotes error information to display over the product in cart.
is_set
boolean
Whether or not the product is a set of items.
price_per_unit
object (ProductPricePerUnitInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
converted
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Show
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
item_type
string
Type of the item in cart.
Enum
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
delivery_charge_info
string
Delivery charge in information message on shipment.
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config.
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag.
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold.
charges
number
| float
Charges amount to be applied on cart.
threshold
number
| float
Threshold of cart value on which the charge should be applied.
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value.
cashback_amount
number
| float
Fields denotes cashback amount applied to cart.
cashback_message_primary
string
Primary cashback message for coupon applied to cart.
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart.
coupon_code
string
Coupon code to be applied to cart.
coupon_description
string
Coupon description of the coupon applied to cart.
coupon_id
string
Unique identifier of the coupon applied to cart.
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart.
coupon_title
string
Coupon Title of the coupon applied.
coupon_type
string
Type of the coupon applied to cart.
coupon_value
number
| float
Value of the coupon applied to cart.
discount
number
| float
Total discount earned from coupon applied to cart.
is_applied
boolean
Flag to determine where the coupon is applied to cart or not.
is_valid
boolean
Determine where the coupon applied to cart is valid.
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
message
string
Coupon message of the coupon applied to cart.
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart.
message
string
Message of the get 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.
gstin
string
GSTIN added in user cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, engage and loyalty points.
display
array of object (DisplayBreakup)
List of breakup data which is used to display the breakup to the customer like MRP total, Discount, Sub total, coupon value, promotion value and final total.
Show
Display price breakup schema denotes price currency, key, value,message to display as breakup on UI.
currency_symbol
string
Currency symbol for the price.
key
string
Key of the price like total_mrp, total, subtotal etc.
display
string
Display key field that to be shown against the value.
message
array of string
List of message at price level to be displayed.
currency_code
string
Currency code for the price.
value
number
| float
Numeric value of the price.
preset
number
| float
Value for the price which is set from platform if applicable.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convenience fee, coupon amount, delivery charge, discount, loyalty points, engage points, gift card, gst charge, etc.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
subtotal
number
| float
Selling price amount of all products in cart.
engage_amount
number
| float
Engage amount applied on the cart.
engage_mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
fynd_cash
number
| float
Loyalty points applied on cart.
discount
number
| float
Discount amount received on cart.
convenience_fee
number
| float
Convenience fee amount applied to cart.
delivery_charge
number
| float
Delivery charge applied to cart.
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
total_charge
number
| float
Total amount of charges applied on cart.
coupon
number
| float
Coupon amount applied to cart.
total
number
| float
Total payable amount by the customer.
gift_card
number
| float
Gift cart amount applied on cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
coupon
object (CouponBreakup)
Show
Coupon price breakup details which includes coupon code, coupon type, coupon value, coupon description, coupn message etc.
coupon_value
number
| float
Value of the coupon applied to cart.
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
minimum_cart_value
number
| float
Minimum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
uid
string
Unique identifier of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
loyalty_points
object (LoyaltyPoints)
Show
Engage points data for the user cart.
total
number
| float
Total loyalty points available with user.
description
string
Description for loyalty points.
applicable
number
| float
Whether the loyalty points are applicable for the cart.
is_applied
boolean
Whether the loyalty points are applied on the cart.
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage discount amount applied on the cart as engage redeemed points can be set as discount or MOP from engage platform.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Formatted title that can be used by theme to display points earned by user for this cart.
title
string
Unique title for loyalty program applicable.
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
currency
object (CartCurrency)
Show
Currency data of the cart for prices.
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
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 (AlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
customer_id
string
Customer user id associated with cart
success
boolean
True if all items are added successfully. False if partially added or not added.
result
object
Contains article related result info
items
array of object (CartItemInfo)
List of items that needs to be added in cart.
Show
item_id
integer
| int32
Item id of the product that needs to be added/updated/removed.
size
string
Item size of the product that needs to be added/updated/removed.
store_id
integer
| int32
Unique identifier of the store selected by the user from which user want to buy a product.
success
boolean
True if items are added/updated/removed successfully.
message
string
Message for added/updated/removed item.
Examples
Parameters
Parameters are not required.
Response
Add items to a cart
addItems
Update cart. Customers can modify added product attributes such as quantity and size, as well as remove items from the cart.
Parameters
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.
include_cart_calculationquery
boolean
Set to `false` to skip recalculating and fetching the updated cart after the edit. Defaults to `true`.
area_codequery
string
Customer servicable area_code.
buy_nowquery
boolean
Select `true` to set/initialize buy now cart.
cart_typequery
string
The type of 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.
Enum
bodyrequestBody
object (UpdateCartCreation)
Required
Specify the item details and operation as shown below. Refer `UpdateCartCreation` for more details.
Hide
Update cart request data that involves items in cart and operation to be performed for items specified.
items
array of object (UpdateProductCart)
List items data that needs to be updated in cart.
Show
Update cart product request schema details which includes artidcle id, custom json, extra meta, identifiers, item id, item size, item index, meta, parent item identifiers and quantity.
extra_meta
object
Field to update extra meta of the product in cart.
_custom_json
object
Field to update custom json of the product in cart.
force_new_line_item
boolean
Field used to decide the product add as a separate product in cart
quantity
integer
| int32
Field to update the quantity of the item in cart.
item_size
string
Field to update the size of the product in cart.
item_index
integer
| int32
Item index determines on which index the product falls to be updated.
identifiers
object (CartProductIdentifer)
Required
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
article_id
string
Article id of the product in cart.
parent_item_identifiers
object
Field to update parent product of the item in cart.
item_id
integer
| int32
Item id of the product that needs to be updated.
meta
object
Field to update meta of the item in cart.
fulfillment_option_slug
string
specifies the fulfillment method, indicating whether an order is for home delivery or store pickup
pickup_store_id
integer
| int32
Unique identifier of the pickup store selected by the user from which user
free_gift_items
array of object (FreeGiftItemCreation)
List of free gift items with updated sizes.
Show
promotion_id
string
Required
Unique identifier of the free gift promotion.
item_id
string
Required
Unique identifier of the selected free gift item.
item_size
string
Required
Size of the selected free gift item.
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
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
items
array of object (UpdateProductCart)
List items data that needs to be updated in cart.
Show
Update cart product request schema details which includes artidcle id, custom json, extra meta, identifiers, item id, item size, item index, meta, parent item identifiers and quantity.
extra_meta
object
Field to update extra meta of the product in cart.
_custom_json
object
Field to update custom json of the product in cart.
force_new_line_item
boolean
Field used to decide the product add as a separate product in cart
quantity
integer
| int32
Field to update the quantity of the item in cart.
item_size
string
Field to update the size of the product in cart.
item_index
integer
| int32
Item index determines on which index the product falls to be updated.
identifiers
object (CartProductIdentifer)
Required
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
article_id
string
Article id of the product in cart.
parent_item_identifiers
object
Field to update parent product of the item in cart.
item_id
integer
| int32
Item id of the product that needs to be updated.
meta
object
Field to update meta of the item in cart.
fulfillment_option_slug
string
specifies the fulfillment method, indicating whether an order is for home delivery or store pickup
pickup_store_id
integer
| int32
Unique identifier of the pickup store selected by the user from which user
free_gift_items
array of object (FreeGiftItemCreation)
List of free gift items with updated sizes.
Show
promotion_id
string
Required
Unique identifier of the free gift promotion.
item_id
string
Required
Unique identifier of the selected free gift item.
item_size
string
Required
Size of the selected free gift item.
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.
message
string
Message of update cart API response.
cart
object (CartDetailResult)
Show
Get cart detail 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.
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
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment Default Selection Schema.
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
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
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc.
article
object (ProductArticle)
Show
Product store information of the product added in cart.
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article.
base
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
converted
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
product_group_tags
array of string
List fot the unique identifier for the product grouping.
extra_meta
object
Field to update extra meta of the article in cart.
quantity
integer
| int32
Quantity of the article added in cart.
_custom_json
object
Field to update custom json of the article in cart.
meta
object
Article meta data.
size
string
Size of the article added in cart.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
seller_identifier
string
List of identifiers used by sellers for the product size.
parent_item_identifiers
object
Fields to determine parent product of the product.
identifier
object
Unique identifier of the article.
store
object (StoreInfo)
Show
Store information of the store which includes store name, store id and store code.
store_code
string
A unique code or identifier for the store, often used for internal reference.
uid
integer
| int32
Unique identifiers of the store from where product is fulfilled.
name
string
Store name of the store from where the product is fulfilled.
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of delivery service.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
cart_item_meta
object
Meta details of the article added from cart.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
gift_card
object
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift.
is_gift_visible
boolean
Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
type
string
Type of the data sent in response. Possible value is article.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags.
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
promo_meta
object (PromoMeta)
Show
Loyalty points message data.
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
price
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
converted
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
quantity
integer
| int32
Quantity of the product added in cart.
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of value.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
out_of_stock
boolean
Denotes if the product is available in stock.
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not.
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability.
Show
Product sizes availability.
display
string
Display size of the product.
value
string
Actual value of the size.
is_available
boolean
Available flag for the size of the product if that is available.
is_valid
boolean
Valid flag for the product if the product added in cart is valid to place the order.
other_store_quantity
integer
| int32
Quantity of the product available on other store.
sizes
array of string
All sizes of the product.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categories, images, item code, tags, item id, item name, etc.
_custom_json
object
Field to add custom json of the product in cart.
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
action
object (ProductAction)
Show
Schema of Action Object to render the product.
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs.
product_slug
array of string
Contains list of product slug.
url
string
Url of the product to render the product
type
string
Type of action.
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart.
tags
object
Tags is a lable or batch that is attached to a product in cart.
slug
string
Unique product url name generated via product name and other meta data.
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url.
Show
Product images data in different formats.
secure_url
string
Secured url of the product image.
aspect_ratio
string
Aspect ratio of the product image.
url
string
Bucket link url for product image.
uid
integer
| int32
Unique identifier of the product in cart.
name
string
Product name of the product in cart which is defined on platform.
item_code
string
Nullable
Product code of the product while defining product on platform.
categories
array of object (CategoryInfo)
Product category information which incldes category name and category id.
Show
Category information schema which denotes category name and category id.
uid
integer
| int32
Product Category Id.
name
string
Category name of the product.
tags
array of string
Products tags that are added to each product to identify the set of products.
type
string
Type of product in cart.
attributes
object
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
coupon
object (CouponDetails)
Show
Coupon actual price breakup details.
discount_single_quantity
number
| float
Discount amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
custom_order
object
Whether MTO (Make to Order) is enabled or not.
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
key
string
The attribute key associated with the size.
message
string
Product level message which denotes error information to display over the product in cart.
is_set
boolean
Whether or not the product is a set of items.
price_per_unit
object (ProductPricePerUnitInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
converted
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Show
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
item_type
string
Type of the item in cart.
Enum
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
delivery_charge_info
string
Delivery charge in information message on shipment.
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config.
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag.
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold.
charges
number
| float
Charges amount to be applied on cart.
threshold
number
| float
Threshold of cart value on which the charge should be applied.
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value.
cashback_amount
number
| float
Fields denotes cashback amount applied to cart.
cashback_message_primary
string
Primary cashback message for coupon applied to cart.
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart.
coupon_code
string
Coupon code to be applied to cart.
coupon_description
string
Coupon description of the coupon applied to cart.
coupon_id
string
Unique identifier of the coupon applied to cart.
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart.
coupon_title
string
Coupon Title of the coupon applied.
coupon_type
string
Type of the coupon applied to cart.
coupon_value
number
| float
Value of the coupon applied to cart.
discount
number
| float
Total discount earned from coupon applied to cart.
is_applied
boolean
Flag to determine where the coupon is applied to cart or not.
is_valid
boolean
Determine where the coupon applied to cart is valid.
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
message
string
Coupon message of the coupon applied to cart.
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart.
message
string
Message of the get 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.
gstin
string
GSTIN added in user cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, engage and loyalty points.
display
array of object (DisplayBreakup)
List of breakup data which is used to display the breakup to the customer like MRP total, Discount, Sub total, coupon value, promotion value and final total.
Show
Display price breakup schema denotes price currency, key, value,message to display as breakup on UI.
currency_symbol
string
Currency symbol for the price.
key
string
Key of the price like total_mrp, total, subtotal etc.
display
string
Display key field that to be shown against the value.
message
array of string
List of message at price level to be displayed.
currency_code
string
Currency code for the price.
value
number
| float
Numeric value of the price.
preset
number
| float
Value for the price which is set from platform if applicable.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convenience fee, coupon amount, delivery charge, discount, loyalty points, engage points, gift card, gst charge, etc.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
subtotal
number
| float
Selling price amount of all products in cart.
engage_amount
number
| float
Engage amount applied on the cart.
engage_mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
fynd_cash
number
| float
Loyalty points applied on cart.
discount
number
| float
Discount amount received on cart.
convenience_fee
number
| float
Convenience fee amount applied to cart.
delivery_charge
number
| float
Delivery charge applied to cart.
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
total_charge
number
| float
Total amount of charges applied on cart.
coupon
number
| float
Coupon amount applied to cart.
total
number
| float
Total payable amount by the customer.
gift_card
number
| float
Gift cart amount applied on cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
coupon
object (CouponBreakup)
Show
Coupon price breakup details which includes coupon code, coupon type, coupon value, coupon description, coupn message etc.
coupon_value
number
| float
Value of the coupon applied to cart.
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
minimum_cart_value
number
| float
Minimum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
uid
string
Unique identifier of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
loyalty_points
object (LoyaltyPoints)
Show
Engage points data for the user cart.
total
number
| float
Total loyalty points available with user.
description
string
Description for loyalty points.
applicable
number
| float
Whether the loyalty points are applicable for the cart.
is_applied
boolean
Whether the loyalty points are applied on the cart.
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage discount amount applied on the cart as engage redeemed points can be set as discount or MOP from engage platform.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Formatted title that can be used by theme to display points earned by user for this cart.
title
string
Unique title for loyalty program applicable.
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
currency
object (CartCurrency)
Show
Currency data of the cart for prices.
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
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 (AlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
customer_id
string
Customer user id associated with cart
success
boolean
True if all items are added successfully. False if partially added or not added.
result
object
Contains article related result info
items
array of object (CartItemInfo)
List of items that needs to be updated in cart.
Show
item_id
integer
| int32
Item id of the product that needs to be added/updated/removed.
size
string
Item size of the product that needs to be added/updated/removed.
store_id
integer
| int32
Unique identifier of the store selected by the user from which user want to buy a product.
success
boolean
True if items are added/updated/removed successfully.
message
string
Message for added/updated/removed item.
Response
Update cart items
updateCart
Update cart. Customers can adjust the cart breakup by applying or removing store credits as needed.
Parameters
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
Select `true` to set/initialize buy now cart.
cart_typequery
string
The type of cart.
bodyrequestBody
object (UpdateCartBreakup)
Required
Check the example shown below or refer `UpdateCartBreakup` for more details.
Hide
Update cart request data that involves items in cart and operation to be performed for items specified.
store_credit
boolean
Required
Field to determine if store credits needs to apply on cart or not.
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
store_credit
boolean
Required
Field to determine if store credits needs to apply on cart or not.
PATCH
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.
message
string
Message of update cart API response.
cart
object (CartDetailResult)
Show
Get cart detail 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.
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
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment Default Selection Schema.
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
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
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc.
article
object (ProductArticle)
Show
Product store information of the product added in cart.
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article.
base
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
converted
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
product_group_tags
array of string
List fot the unique identifier for the product grouping.
extra_meta
object
Field to update extra meta of the article in cart.
quantity
integer
| int32
Quantity of the article added in cart.
_custom_json
object
Field to update custom json of the article in cart.
meta
object
Article meta data.
size
string
Size of the article added in cart.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
seller_identifier
string
List of identifiers used by sellers for the product size.
parent_item_identifiers
object
Fields to determine parent product of the product.
identifier
object
Unique identifier of the article.
store
object (StoreInfo)
Show
Store information of the store which includes store name, store id and store code.
store_code
string
A unique code or identifier for the store, often used for internal reference.
uid
integer
| int32
Unique identifiers of the store from where product is fulfilled.
name
string
Store name of the store from where the product is fulfilled.
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of delivery service.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
cart_item_meta
object
Meta details of the article added from cart.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
gift_card
object
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift.
is_gift_visible
boolean
Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
type
string
Type of the data sent in response. Possible value is article.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags.
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
promo_meta
object (PromoMeta)
Show
Loyalty points message data.
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
price
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
converted
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
quantity
integer
| int32
Quantity of the product added in cart.
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of value.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
out_of_stock
boolean
Denotes if the product is available in stock.
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not.
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability.
Show
Product sizes availability.
display
string
Display size of the product.
value
string
Actual value of the size.
is_available
boolean
Available flag for the size of the product if that is available.
is_valid
boolean
Valid flag for the product if the product added in cart is valid to place the order.
other_store_quantity
integer
| int32
Quantity of the product available on other store.
sizes
array of string
All sizes of the product.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categories, images, item code, tags, item id, item name, etc.
_custom_json
object
Field to add custom json of the product in cart.
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
action
object (ProductAction)
Show
Schema of Action Object to render the product.
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs.
product_slug
array of string
Contains list of product slug.
url
string
Url of the product to render the product
type
string
Type of action.
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart.
tags
object
Tags is a lable or batch that is attached to a product in cart.
slug
string
Unique product url name generated via product name and other meta data.
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url.
Show
Product images data in different formats.
secure_url
string
Secured url of the product image.
aspect_ratio
string
Aspect ratio of the product image.
url
string
Bucket link url for product image.
uid
integer
| int32
Unique identifier of the product in cart.
name
string
Product name of the product in cart which is defined on platform.
item_code
string
Nullable
Product code of the product while defining product on platform.
categories
array of object (CategoryInfo)
Product category information which incldes category name and category id.
Show
Category information schema which denotes category name and category id.
uid
integer
| int32
Product Category Id.
name
string
Category name of the product.
tags
array of string
Products tags that are added to each product to identify the set of products.
type
string
Type of product in cart.
attributes
object
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
coupon
object (CouponDetails)
Show
Coupon actual price breakup details.
discount_single_quantity
number
| float
Discount amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
custom_order
object
Whether MTO (Make to Order) is enabled or not.
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
key
string
The attribute key associated with the size.
message
string
Product level message which denotes error information to display over the product in cart.
is_set
boolean
Whether or not the product is a set of items.
price_per_unit
object (ProductPricePerUnitInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
converted
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Show
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
item_type
string
Type of the item in cart.
Enum
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
delivery_charge_info
string
Delivery charge in information message on shipment.
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config.
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag.
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold.
charges
number
| float
Charges amount to be applied on cart.
threshold
number
| float
Threshold of cart value on which the charge should be applied.
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value.
cashback_amount
number
| float
Fields denotes cashback amount applied to cart.
cashback_message_primary
string
Primary cashback message for coupon applied to cart.
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart.
coupon_code
string
Coupon code to be applied to cart.
coupon_description
string
Coupon description of the coupon applied to cart.
coupon_id
string
Unique identifier of the coupon applied to cart.
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart.
coupon_title
string
Coupon Title of the coupon applied.
coupon_type
string
Type of the coupon applied to cart.
coupon_value
number
| float
Value of the coupon applied to cart.
discount
number
| float
Total discount earned from coupon applied to cart.
is_applied
boolean
Flag to determine where the coupon is applied to cart or not.
is_valid
boolean
Determine where the coupon applied to cart is valid.
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
message
string
Coupon message of the coupon applied to cart.
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart.
message
string
Message of the get 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.
gstin
string
GSTIN added in user cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, engage and loyalty points.
display
array of object (DisplayBreakup)
List of breakup data which is used to display the breakup to the customer like MRP total, Discount, Sub total, coupon value, promotion value and final total.
Show
Display price breakup schema denotes price currency, key, value,message to display as breakup on UI.
currency_symbol
string
Currency symbol for the price.
key
string
Key of the price like total_mrp, total, subtotal etc.
display
string
Display key field that to be shown against the value.
message
array of string
List of message at price level to be displayed.
currency_code
string
Currency code for the price.
value
number
| float
Numeric value of the price.
preset
number
| float
Value for the price which is set from platform if applicable.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convenience fee, coupon amount, delivery charge, discount, loyalty points, engage points, gift card, gst charge, etc.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
subtotal
number
| float
Selling price amount of all products in cart.
engage_amount
number
| float
Engage amount applied on the cart.
engage_mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
fynd_cash
number
| float
Loyalty points applied on cart.
discount
number
| float
Discount amount received on cart.
convenience_fee
number
| float
Convenience fee amount applied to cart.
delivery_charge
number
| float
Delivery charge applied to cart.
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
total_charge
number
| float
Total amount of charges applied on cart.
coupon
number
| float
Coupon amount applied to cart.
total
number
| float
Total payable amount by the customer.
gift_card
number
| float
Gift cart amount applied on cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
coupon
object (CouponBreakup)
Show
Coupon price breakup details which includes coupon code, coupon type, coupon value, coupon description, coupn message etc.
coupon_value
number
| float
Value of the coupon applied to cart.
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
minimum_cart_value
number
| float
Minimum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
uid
string
Unique identifier of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
loyalty_points
object (LoyaltyPoints)
Show
Engage points data for the user cart.
total
number
| float
Total loyalty points available with user.
description
string
Description for loyalty points.
applicable
number
| float
Whether the loyalty points are applicable for the cart.
is_applied
boolean
Whether the loyalty points are applied on the cart.
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage discount amount applied on the cart as engage redeemed points can be set as discount or MOP from engage platform.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Formatted title that can be used by theme to display points earned by user for this cart.
title
string
Unique title for loyalty program applicable.
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
currency
object (CartCurrency)
Show
Currency data of the cart for prices.
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
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 (AlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
customer_id
string
Customer user id associated with cart
success
boolean
True if all items are added successfully. False if partially added or not added.
result
object
Contains article related result info
items
array of object (CartItemInfo)
List of items that needs to be updated in cart.
Show
item_id
integer
| int32
Item id of the product that needs to be added/updated/removed.
size
string
Item size of the product that needs to be added/updated/removed.
store_id
integer
| int32
Unique identifier of the store selected by the user from which user want to buy a product.
success
boolean
True if items are added/updated/removed successfully.
message
string
Message for added/updated/removed item.
Examples
Parameters
Parameters are not required.
Response
Update store credits into cart and their items
updateCartBreakup
Delete all items from the user's cart and resets it to its initial state, providing a clean slate for new selections.
Parameters
idquery
string
The unique identifier of the cart.
PUT
Response
200
Success. Returns whether the cart has been deleted or not.
Hide
Delete cart response which includes message and success flag.
message
string
Message for delete cart response.
success
boolean
True if cart is archived successfully. False if not archived.
Examples
Parameters
id:
"value"
Response
Delete a cart
deleteCart
Parameters
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
Result schema which defines how many total number of items are in cart.
user_cart_items_count
integer
| int32
Item count present in cart.
Examples
Parameters
id:
"value"
buy_now:
false
Response
Get a cart items count
getItemCount
Update metadata associated with a cart, which includes customer preferences, delivery instructions, or any special requirements related to the cart items.
Parameters
idquery
string
The unique identifier of the cart.
buy_nowquery
boolean
Whether to get buy_now cart.
bodyrequestBody
object (CartMetaCreation)
Required
gstin: Pass gstin number to claim GST credit, e.g. 27AAAAA0939A1AA checkout_mode: Pass checkout mode for current order as described below.
self: Customer him self placing order staff:Placing order on behalf of customer comment: Set comments to be passed to order team during adding items, e.g. leave the package with my neighbour.
Hide
Cart meta request schema to update the cart meta detail like delivery slots, comment message, GSTIN and custom cart meta.
delivery_slots
object
Delivery slots details includes article level time slot when the shipment can be delivered.
gift_details
object (ArticleGiftDetail)
Show
Article level gift details which includes article id.
article_id
object (GiftDetail)
Show
Gift details which includes flag for gift applied or not and gift message added by user.
is_gift_applied
boolean
Is gift applied flag which determines if this is a gift oder not.
gift_message
string
Gift message for the one while receive the delivery of the order with this message.
pick_up_customer_details
object
Customer contact details for customer pickup at store.
alternate_pickup_person
object (AlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
checkout_mode
string
Checkout mode of user cart.
comment
string
Comment message to be added in user cart.
gstin
string
GSTIN number to be added in user cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
custom_cart_meta
object
Custom cart meta json to be added in order meta which can be further received in cart API response and order meta in order detail API or webhook.
Request body
delivery_slots
object
Delivery slots details includes article level time slot when the shipment can be delivered.
gift_details
object (ArticleGiftDetail)
Show
Article level gift details which includes article id.
article_id
object (GiftDetail)
Show
Gift details which includes flag for gift applied or not and gift message added by user.
is_gift_applied
boolean
Is gift applied flag which determines if this is a gift oder not.
gift_message
string
Gift message for the one while receive the delivery of the order with this message.
pick_up_customer_details
object
Customer contact details for customer pickup at store.
alternate_pickup_person
object (AlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
checkout_mode
string
Checkout mode of user cart.
comment
string
Comment message to be added in user cart.
gstin
string
GSTIN number to be added in user cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
custom_cart_meta
object
Custom cart meta json to be added in order meta which can be further received in cart API response and order meta in order detail API or webhook.
PUT
Response
200
400
Returns a message indicating the success of cart meta updation as shown below.
Hide
Cart meta response schema.
message
string
Detailed message.
is_valid
boolean
Whether added meta was vaild.
Examples
Parameters
id:
"value"
buy_now:
false
body:
body
Response
Update cart metadata
updateCartMeta
Generate a unique shareable link for the customer's cart for a specific sales channel. This link enables easy sharing of the cart contents with other users, facilitating collaborative shopping experiences.
Parameters
No Parameters
bodyrequestBody
object (GetShareCartLinkCreation)
Required
Pass object to generate share cart snapshot uid Cart id for sharing cart. meta Staff, ordering store and other store related data meta data to merge
Hide
Cart share link request schema used to get the share link to share cart to any other user. This includes cart id and meta json.
id
string
Cart id of user cart for generating cart sharing token.
meta
object
Staff, Ordering store or any other data. This data will be used to generate link as well as sent as shared details.
Request body
id
string
Cart id of user cart for generating cart sharing token.
meta
object
Staff, Ordering store or any other data. This data will be used to generate link as well as sent as shared details.
POST
Response
200
Returns a URL to share and a token as shown below.
Hide
Cart share link response schema which includes url and token.
token
string
Short url unique id of the cart which is opted to share with other user.
share_url
string
Short shareable final url which can populate shared cart items in one's cart or replaced one's cart with shared cart items.
Examples
Parameters
Parameters are not required.
Response
Create share cart link
getCartShareLink
Parameters
tokenpath
string
Required
Token of the shared short link.
GET
Response
200
404
Success. Returns a Cart object as per the valid token. Refer `SharedCartResult` for more details.
Hide
Shared cart response schema which included error or cart data.
error
string
Error details if any error occurs which includes type of error, error code and error message.
cart
object (SharedCart)
Show
Share cart detail includes checkout mode, cart id , payment selection lock config, delivery promise, comment message, items , breakup values and other cart data of shared cart.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
cart_id
integer
| int32
Cart id of user cart for generating cart sharing token.
is_valid
boolean
Valid flag for get shared cart detail API.
id
string
Cart id of shared cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment Default Selection Schema.
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
Comment message 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
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc.
article
object (ProductArticle)
Show
Product store information of the product added in cart.
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article.
base
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
converted
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
product_group_tags
array of string
List fot the unique identifier for the product grouping.
extra_meta
object
Field to update extra meta of the article in cart.
quantity
integer
| int32
Quantity of the article added in cart.
_custom_json
object
Field to update custom json of the article in cart.
meta
object
Article meta data.
size
string
Size of the article added in cart.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
seller_identifier
string
List of identifiers used by sellers for the product size.
parent_item_identifiers
object
Fields to determine parent product of the product.
identifier
object
Unique identifier of the article.
store
object (StoreInfo)
Show
Store information of the store which includes store name, store id and store code.
store_code
string
A unique code or identifier for the store, often used for internal reference.
uid
integer
| int32
Unique identifiers of the store from where product is fulfilled.
name
string
Store name of the store from where the product is fulfilled.
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of delivery service.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
cart_item_meta
object
Meta details of the article added from cart.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
gift_card
object
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift.
is_gift_visible
boolean
Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
type
string
Type of the data sent in response. Possible value is article.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags.
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
promo_meta
object (PromoMeta)
Show
Loyalty points message data.
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
price
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
converted
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
quantity
integer
| int32
Quantity of the product added in cart.
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of value.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
out_of_stock
boolean
Denotes if the product is available in stock.
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not.
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability.
Show
Product sizes availability.
display
string
Display size of the product.
value
string
Actual value of the size.
is_available
boolean
Available flag for the size of the product if that is available.
is_valid
boolean
Valid flag for the product if the product added in cart is valid to place the order.
other_store_quantity
integer
| int32
Quantity of the product available on other store.
sizes
array of string
All sizes of the product.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categories, images, item code, tags, item id, item name, etc.
_custom_json
object
Field to add custom json of the product in cart.
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
action
object (ProductAction)
Show
Schema of Action Object to render the product.
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs.
product_slug
array of string
Contains list of product slug.
url
string
Url of the product to render the product
type
string
Type of action.
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart.
tags
object
Tags is a lable or batch that is attached to a product in cart.
slug
string
Unique product url name generated via product name and other meta data.
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url.
Show
Product images data in different formats.
secure_url
string
Secured url of the product image.
aspect_ratio
string
Aspect ratio of the product image.
url
string
Bucket link url for product image.
uid
integer
| int32
Unique identifier of the product in cart.
name
string
Product name of the product in cart which is defined on platform.
item_code
string
Nullable
Product code of the product while defining product on platform.
categories
array of object (CategoryInfo)
Product category information which incldes category name and category id.
Show
Category information schema which denotes category name and category id.
uid
integer
| int32
Product Category Id.
name
string
Category name of the product.
tags
array of string
Products tags that are added to each product to identify the set of products.
type
string
Type of product in cart.
attributes
object
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
coupon
object (CouponDetails)
Show
Coupon actual price breakup details.
discount_single_quantity
number
| float
Discount amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
custom_order
object
Whether MTO (Make to Order) is enabled or not.
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
key
string
The attribute key associated with the size.
message
string
Product level message which denotes error information to display over the product in cart.
is_set
boolean
Whether or not the product is a set of items.
price_per_unit
object (ProductPricePerUnitInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
converted
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Show
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
item_type
string
Type of the item in cart.
Enum
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
uid
string
Cart id of the user cart.
delivery_charge_info
string
Delivery charge info message of the user cart.
message
string
Message of the get shared cart API response.
gstin
string
GSTIN added in user cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
shared_cart_details
object (SharedCartDetails)
Show
Shared cart details schema included token, user, created on, source and meta.
token
string
Short link id of the user cart that needs to be shared.
user
object
User details of who generated share link.
created_on
string
| date-time
Created on timestamp of user cart.
source
object
Share link device and other source information.
meta
object
Meta data sent while generating share cart link.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of user cart.
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, engage and loyalty points.
display
array of object (DisplayBreakup)
List of breakup data which is used to display the breakup to the customer like MRP total, Discount, Sub total, coupon value, promotion value and final total.
Show
Display price breakup schema denotes price currency, key, value,message to display as breakup on UI.
currency_symbol
string
Currency symbol for the price.
key
string
Key of the price like total_mrp, total, subtotal etc.
display
string
Display key field that to be shown against the value.
message
array of string
List of message at price level to be displayed.
currency_code
string
Currency code for the price.
value
number
| float
Numeric value of the price.
preset
number
| float
Value for the price which is set from platform if applicable.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convenience fee, coupon amount, delivery charge, discount, loyalty points, engage points, gift card, gst charge, etc.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
subtotal
number
| float
Selling price amount of all products in cart.
engage_amount
number
| float
Engage amount applied on the cart.
engage_mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
fynd_cash
number
| float
Loyalty points applied on cart.
discount
number
| float
Discount amount received on cart.
convenience_fee
number
| float
Convenience fee amount applied to cart.
delivery_charge
number
| float
Delivery charge applied to cart.
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
total_charge
number
| float
Total amount of charges applied on cart.
coupon
number
| float
Coupon amount applied to cart.
total
number
| float
Total payable amount by the customer.
gift_card
number
| float
Gift cart amount applied on cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
coupon
object (CouponBreakup)
Show
Coupon price breakup details which includes coupon code, coupon type, coupon value, coupon description, coupn message etc.
coupon_value
number
| float
Value of the coupon applied to cart.
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
minimum_cart_value
number
| float
Minimum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
uid
string
Unique identifier of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
loyalty_points
object (LoyaltyPoints)
Show
Engage points data for the user cart.
total
number
| float
Total loyalty points available with user.
description
string
Description for loyalty points.
applicable
number
| float
Whether the loyalty points are applicable for the cart.
is_applied
boolean
Whether the loyalty points are applied on the cart.
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage discount amount applied on the cart as engage redeemed points can be set as discount or MOP from engage platform.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Formatted title that can be used by theme to display points earned by user for this cart.
title
string
Unique title for loyalty program applicable.
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
currency
object (CartCurrency)
Show
Currency data of the cart for prices.
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
coupon_text
string
Coupon text of the applied coupon on user cart.
buy_now
boolean
Buy now flag of user cart.
custom_cart_meta
object
Custom cart meta of user cart added via update cart meta API.
Examples
Parameters
token:
"value"
Response
List shared cart items
getCartSharedItems
Parameters
tokenpath
string
Required
Token of the shared short link.
actionpath
string
Required
Operation to perform on the existing cart merge or replace.
Enum
POST
Response
200
Success. Returns a merged or replaced cart as per the valid token. Refer `SharedCartResult` for more details.
Hide
Shared cart response schema which included error or cart data.
error
string
Error details if any error occurs which includes type of error, error code and error message.
cart
object (SharedCart)
Show
Share cart detail includes checkout mode, cart id , payment selection lock config, delivery promise, comment message, items , breakup values and other cart data of shared cart.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
cart_id
integer
| int32
Cart id of user cart for generating cart sharing token.
is_valid
boolean
Valid flag for get shared cart detail API.
id
string
Cart id of shared cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment Default Selection Schema.
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
Comment message 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
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc.
article
object (ProductArticle)
Show
Product store information of the product added in cart.
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article.
base
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
converted
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
product_group_tags
array of string
List fot the unique identifier for the product grouping.
extra_meta
object
Field to update extra meta of the article in cart.
quantity
integer
| int32
Quantity of the article added in cart.
_custom_json
object
Field to update custom json of the article in cart.
meta
object
Article meta data.
size
string
Size of the article added in cart.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
seller_identifier
string
List of identifiers used by sellers for the product size.
parent_item_identifiers
object
Fields to determine parent product of the product.
identifier
object
Unique identifier of the article.
store
object (StoreInfo)
Show
Store information of the store which includes store name, store id and store code.
store_code
string
A unique code or identifier for the store, often used for internal reference.
uid
integer
| int32
Unique identifiers of the store from where product is fulfilled.
name
string
Store name of the store from where the product is fulfilled.
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of delivery service.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
cart_item_meta
object
Meta details of the article added from cart.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
gift_card
object
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift.
is_gift_visible
boolean
Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
type
string
Type of the data sent in response. Possible value is article.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags.
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
promo_meta
object (PromoMeta)
Show
Loyalty points message data.
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
price
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
converted
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
quantity
integer
| int32
Quantity of the product added in cart.
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of value.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
out_of_stock
boolean
Denotes if the product is available in stock.
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not.
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability.
Show
Product sizes availability.
display
string
Display size of the product.
value
string
Actual value of the size.
is_available
boolean
Available flag for the size of the product if that is available.
is_valid
boolean
Valid flag for the product if the product added in cart is valid to place the order.
other_store_quantity
integer
| int32
Quantity of the product available on other store.
sizes
array of string
All sizes of the product.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categories, images, item code, tags, item id, item name, etc.
_custom_json
object
Field to add custom json of the product in cart.
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
action
object (ProductAction)
Show
Schema of Action Object to render the product.
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs.
product_slug
array of string
Contains list of product slug.
url
string
Url of the product to render the product
type
string
Type of action.
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart.
tags
object
Tags is a lable or batch that is attached to a product in cart.
slug
string
Unique product url name generated via product name and other meta data.
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url.
Show
Product images data in different formats.
secure_url
string
Secured url of the product image.
aspect_ratio
string
Aspect ratio of the product image.
url
string
Bucket link url for product image.
uid
integer
| int32
Unique identifier of the product in cart.
name
string
Product name of the product in cart which is defined on platform.
item_code
string
Nullable
Product code of the product while defining product on platform.
categories
array of object (CategoryInfo)
Product category information which incldes category name and category id.
Show
Category information schema which denotes category name and category id.
uid
integer
| int32
Product Category Id.
name
string
Category name of the product.
tags
array of string
Products tags that are added to each product to identify the set of products.
type
string
Type of product in cart.
attributes
object
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
coupon
object (CouponDetails)
Show
Coupon actual price breakup details.
discount_single_quantity
number
| float
Discount amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
custom_order
object
Whether MTO (Make to Order) is enabled or not.
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
key
string
The attribute key associated with the size.
message
string
Product level message which denotes error information to display over the product in cart.
is_set
boolean
Whether or not the product is a set of items.
price_per_unit
object (ProductPricePerUnitInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
converted
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Show
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
item_type
string
Type of the item in cart.
Enum
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
uid
string
Cart id of the user cart.
delivery_charge_info
string
Delivery charge info message of the user cart.
message
string
Message of the get shared cart API response.
gstin
string
GSTIN added in user cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
shared_cart_details
object (SharedCartDetails)
Show
Shared cart details schema included token, user, created on, source and meta.
token
string
Short link id of the user cart that needs to be shared.
user
object
User details of who generated share link.
created_on
string
| date-time
Created on timestamp of user cart.
source
object
Share link device and other source information.
meta
object
Meta data sent while generating share cart link.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of user cart.
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, engage and loyalty points.
display
array of object (DisplayBreakup)
List of breakup data which is used to display the breakup to the customer like MRP total, Discount, Sub total, coupon value, promotion value and final total.
Show
Display price breakup schema denotes price currency, key, value,message to display as breakup on UI.
currency_symbol
string
Currency symbol for the price.
key
string
Key of the price like total_mrp, total, subtotal etc.
display
string
Display key field that to be shown against the value.
message
array of string
List of message at price level to be displayed.
currency_code
string
Currency code for the price.
value
number
| float
Numeric value of the price.
preset
number
| float
Value for the price which is set from platform if applicable.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convenience fee, coupon amount, delivery charge, discount, loyalty points, engage points, gift card, gst charge, etc.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
subtotal
number
| float
Selling price amount of all products in cart.
engage_amount
number
| float
Engage amount applied on the cart.
engage_mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
fynd_cash
number
| float
Loyalty points applied on cart.
discount
number
| float
Discount amount received on cart.
convenience_fee
number
| float
Convenience fee amount applied to cart.
delivery_charge
number
| float
Delivery charge applied to cart.
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
total_charge
number
| float
Total amount of charges applied on cart.
coupon
number
| float
Coupon amount applied to cart.
total
number
| float
Total payable amount by the customer.
gift_card
number
| float
Gift cart amount applied on cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
coupon
object (CouponBreakup)
Show
Coupon price breakup details which includes coupon code, coupon type, coupon value, coupon description, coupn message etc.
coupon_value
number
| float
Value of the coupon applied to cart.
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
minimum_cart_value
number
| float
Minimum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
uid
string
Unique identifier of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
loyalty_points
object (LoyaltyPoints)
Show
Engage points data for the user cart.
total
number
| float
Total loyalty points available with user.
description
string
Description for loyalty points.
applicable
number
| float
Whether the loyalty points are applicable for the cart.
is_applied
boolean
Whether the loyalty points are applied on the cart.
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage discount amount applied on the cart as engage redeemed points can be set as discount or MOP from engage platform.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Formatted title that can be used by theme to display points earned by user for this cart.
title
string
Unique title for loyalty program applicable.
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
currency
object (CartCurrency)
Show
Currency data of the cart for prices.
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
coupon_text
string
Coupon text of the applied coupon on user cart.
buy_now
boolean
Buy now flag of user cart.
custom_cart_meta
object
Custom cart meta of user cart added via update cart meta API.
Examples
Parameters
Parameters are not required.
Response
Update with shared items
updateCartWithSharedItems
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
# Checkout cart
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
buy_nowquery
boolean
This indicates the type of cart to checkout.
cart_typequery
string
The type of cart.
bodyrequestBody
object (CartCheckoutDetailV2Creation)
Required
Check the example shown below or refer `CartCheckoutDetailV2Creation` for more details.
Hide
Checkout v2 request schema which includes custom meta, merchant code, cart id, payment methods, address id, callback url, order type, billing address and card details.
custom_meta
array of object (CartCheckoutCustomMeta)
Custom meta data to be added in order.
Show
Custom meta schema which includes key and value that needs to be added in meta data.
key
string
Required
Key name of custom meta.
value
string
Required
Value to be added in key.
customer_details
object (CustomerDetails)
Show
Customer details Schema which includes customer name, mobile and email.
email
string
Email address of the customer to be added in customer detail while checkout.
mobile
string
Required
Mobile number of customer to be added in customer detail while checkout.
name
string
Name of customer to be added in customer detail while checkout.
merchant_code
string
Merchant code of the payment mode selected to do the payment.
cart_id
string
Cart id of the user cart.
id
string
Nullable
Cart id of the user cart.
payment_auto_confirm
boolean
Payment auto confirm flag if payment need not to be collected from user.
payment_methods
array of object (PaymentMethod)
Required
Payment methods list used to make the payment.
Show
Payment method details used to make the payment includes data like payment meta, payment mode, payment name, amout, and payment extra identifiers.
payment_meta
object (PaymentMeta)
Required
Show
Payment meta detail includes merchant code, type, payment gateway, and payment identifier.
merchant_code
string
Merchant code of the payment mode selected to do the payment.
type
string
Type of card if payment mode is card to do the payment.
payment_gateway
string
Payment gateway used to do the payment.
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment.
mode
string
Required
Payment mode of payment method used to make payment.
payment
string
Payment name of payment method used to make payment.
amount
number
| float
Nullable
Amount of the payment mode to be paid.
name
string
Name of the payment mode used to make payment.
payment_extra_identifiers
object
Payment extra identifier for the payment mode to do the payment.
payment_mode
string
Required
Payment mode of the payment selected to do the payment.
aggregator
string
Aggregator of payment mode to do the payment.
address_id
string
Address id of the user where the order to be delivered.
callback_url
string
Nullable
Callback url after payment received/failed.
Default Value : null
delivery_address
object
Delivery address data which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name.
staff
object (StaffCheckout)
Show
Staff details which can be added while checkout if staff member is doing check on behalf of customer which incluedes empployee code, user, last name, first name and staff user id.
employee_code
string
Employee code of staff who does checkout on behalf of customer.
user
string
Required
User id of the employee who does checkout on behalf of customer.
last_name
string
Required
Last name of staff employee who does checkout on behalf of customer.
first_name
string
Required
First name of staff emplyee who does checkout on behalf of customer.
_id
string
Required
Id of staff who does checkout on behalf of customer.
order_type
string
Order type of the order being placed like pickAtStore or HomeDelivery.
Enum
ordering_store
integer
| int32
Nullable
Ordering store id of the store from which the order is getting placed.
extra_meta
object
Extra meta to be added while checkout in order.
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment.
billing_address
object
Billing address json which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name.
payment_params
object
Nullable
Payment params which includes payment identifier and merchant code.
billing_address_id
string
Billing address id selected by user on which shipment bill to be generated.
meta
object
Meta data sent while checkout v2.
iin
string
Issuer Identification Number' number of card if payment mode is card to do the payment.
network
string
Network of card if payment mode is card to do the payment.
type
string
Type of cart if payment mode is card to do the payment.
card_id
string
Saved card id if payment mode is card to do the payment.
success_callback_url
string
Nullable
Success callback url to be redirected after payment received
failure_callback_url
string
Nullable
Failure callback url to be redirected after payment failed
order_tags
array of object (OrderTag)
Order tags used to identify specific type of order which is tagged using order tags
Show
display_text
string
Display text for order tag
slug
string
Slug to be used for tagging order with any unique value
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
custom_meta
array of object (CartCheckoutCustomMeta)
Custom meta data to be added in order.
Show
Custom meta schema which includes key and value that needs to be added in meta data.
key
string
Required
Key name of custom meta.
value
string
Required
Value to be added in key.
customer_details
object (CustomerDetails)
Show
Customer details Schema which includes customer name, mobile and email.
email
string
Email address of the customer to be added in customer detail while checkout.
mobile
string
Required
Mobile number of customer to be added in customer detail while checkout.
name
string
Name of customer to be added in customer detail while checkout.
merchant_code
string
Merchant code of the payment mode selected to do the payment.
cart_id
string
Cart id of the user cart.
id
string
Nullable
Cart id of the user cart.
payment_auto_confirm
boolean
Payment auto confirm flag if payment need not to be collected from user.
payment_methods
array of object (PaymentMethod)
Required
Payment methods list used to make the payment.
Show
Payment method details used to make the payment includes data like payment meta, payment mode, payment name, amout, and payment extra identifiers.
payment_meta
object (PaymentMeta)
Required
Show
Payment meta detail includes merchant code, type, payment gateway, and payment identifier.
merchant_code
string
Merchant code of the payment mode selected to do the payment.
type
string
Type of card if payment mode is card to do the payment.
payment_gateway
string
Payment gateway used to do the payment.
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment.
mode
string
Required
Payment mode of payment method used to make payment.
payment
string
Payment name of payment method used to make payment.
amount
number
| float
Nullable
Amount of the payment mode to be paid.
name
string
Name of the payment mode used to make payment.
payment_extra_identifiers
object
Payment extra identifier for the payment mode to do the payment.
payment_mode
string
Required
Payment mode of the payment selected to do the payment.
aggregator
string
Aggregator of payment mode to do the payment.
address_id
string
Address id of the user where the order to be delivered.
callback_url
string
Nullable
Callback url after payment received/failed.
Default Value : null
delivery_address
object
Delivery address data which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name.
staff
object (StaffCheckout)
Show
Staff details which can be added while checkout if staff member is doing check on behalf of customer which incluedes empployee code, user, last name, first name and staff user id.
employee_code
string
Employee code of staff who does checkout on behalf of customer.
user
string
Required
User id of the employee who does checkout on behalf of customer.
last_name
string
Required
Last name of staff employee who does checkout on behalf of customer.
first_name
string
Required
First name of staff emplyee who does checkout on behalf of customer.
_id
string
Required
Id of staff who does checkout on behalf of customer.
order_type
string
Order type of the order being placed like pickAtStore or HomeDelivery.
Enum
ordering_store
integer
| int32
Nullable
Ordering store id of the store from which the order is getting placed.
extra_meta
object
Extra meta to be added while checkout in order.
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment.
billing_address
object
Billing address json which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name.
payment_params
object
Nullable
Payment params which includes payment identifier and merchant code.
billing_address_id
string
Billing address id selected by user on which shipment bill to be generated.
meta
object
Meta data sent while checkout v2.
iin
string
Issuer Identification Number' number of card if payment mode is card to do the payment.
network
string
Network of card if payment mode is card to do the payment.
type
string
Type of cart if payment mode is card to do the payment.
card_id
string
Saved card id if payment mode is card to do the payment.
success_callback_url
string
Nullable
Success callback url to be redirected after payment received
failure_callback_url
string
Nullable
Failure callback url to be redirected after payment failed
order_tags
array of object (OrderTag)
Order tags used to identify specific type of order which is tagged using order tags
Show
display_text
string
Display text for order tag
slug
string
Slug to be used for tagging order with any unique value
POST
Response
200
400
Success. Returns the status of cart checkout. Refer `CartCheckoutResultSchema` for more details.
Hide
Checkout cart detail response schema includes cart id, delivery promise, items, comment, coupon text etc.
payment_confirm_url
string
Payment confirm url used to redirect after payment is confirmed.
app_intercept_url
string
App intercept url which is used to redirect on app after payment in confirmed/failed.
success
boolean
Success flag of cart checkout API response.
callback_url
string
Callback url to be redirected after payment received/failed.
message
string
Message of the cart checkout v2 API response.
data
object
Data of the user cart checkout includes cart data, address, user id, order type etc.
order_id
string
Order id generated after placing order.
cart
object (CheckCart)
Show
Checkout cart detail response schema includes cart id, delivery promise, items, comment, coupon text etc.
checkout_mode
string
Checkout mode of user cart.
user_type
string
User type of the cart who places the order.
cod_message
string
Cash On Delivery message for the order placed.
cart_id
integer
| int32
Cart id of the user cart for which the order placed.
is_valid
boolean
Valid flag fotr the checkout response if order placed was valid.
delivery_charges
number
| float
Delivery charges of the order placed via checkout API.
id
string
Cart id of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment Default Selection Schema.
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
error_message
string
Error details if any error occurs which includes type of error, error code and error message.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
Comment message added in cart after order placed.
items
array of object (CartProductInfo)
Items details in cart after order placed.
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc.
article
object (ProductArticle)
Show
Product store information of the product added in cart.
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article.
base
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
converted
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
product_group_tags
array of string
List fot the unique identifier for the product grouping.
extra_meta
object
Field to update extra meta of the article in cart.
quantity
integer
| int32
Quantity of the article added in cart.
_custom_json
object
Field to update custom json of the article in cart.
meta
object
Article meta data.
size
string
Size of the article added in cart.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
seller_identifier
string
List of identifiers used by sellers for the product size.
parent_item_identifiers
object
Fields to determine parent product of the product.
identifier
object
Unique identifier of the article.
store
object (StoreInfo)
Show
Store information of the store which includes store name, store id and store code.
store_code
string
A unique code or identifier for the store, often used for internal reference.
uid
integer
| int32
Unique identifiers of the store from where product is fulfilled.
name
string
Store name of the store from where the product is fulfilled.
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of delivery service.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
cart_item_meta
object
Meta details of the article added from cart.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
gift_card
object
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift.
is_gift_visible
boolean
Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
type
string
Type of the data sent in response. Possible value is article.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags.
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
promo_meta
object (PromoMeta)
Show
Loyalty points message data.
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
price
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
converted
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
quantity
integer
| int32
Quantity of the product added in cart.
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of value.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
out_of_stock
boolean
Denotes if the product is available in stock.
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not.
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability.
Show
Product sizes availability.
display
string
Display size of the product.
value
string
Actual value of the size.
is_available
boolean
Available flag for the size of the product if that is available.
is_valid
boolean
Valid flag for the product if the product added in cart is valid to place the order.
other_store_quantity
integer
| int32
Quantity of the product available on other store.
sizes
array of string
All sizes of the product.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categories, images, item code, tags, item id, item name, etc.
_custom_json
object
Field to add custom json of the product in cart.
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
action
object (ProductAction)
Show
Schema of Action Object to render the product.
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs.
product_slug
array of string
Contains list of product slug.
url
string
Url of the product to render the product
type
string
Type of action.
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart.
tags
object
Tags is a lable or batch that is attached to a product in cart.
slug
string
Unique product url name generated via product name and other meta data.
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url.
Show
Product images data in different formats.
secure_url
string
Secured url of the product image.
aspect_ratio
string
Aspect ratio of the product image.
url
string
Bucket link url for product image.
uid
integer
| int32
Unique identifier of the product in cart.
name
string
Product name of the product in cart which is defined on platform.
item_code
string
Nullable
Product code of the product while defining product on platform.
categories
array of object (CategoryInfo)
Product category information which incldes category name and category id.
Show
Category information schema which denotes category name and category id.
uid
integer
| int32
Product Category Id.
name
string
Category name of the product.
tags
array of string
Products tags that are added to each product to identify the set of products.
type
string
Type of product in cart.
attributes
object
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
coupon
object (CouponDetails)
Show
Coupon actual price breakup details.
discount_single_quantity
number
| float
Discount amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
custom_order
object
Whether MTO (Make to Order) is enabled or not.
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
key
string
The attribute key associated with the size.
message
string
Product level message which denotes error information to display over the product in cart.
is_set
boolean
Whether or not the product is a set of items.
price_per_unit
object (ProductPricePerUnitInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
converted
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Show
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
item_type
string
Type of the item in cart.
Enum
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
uid
string
Cart id of user cart.
delivery_charge_order_value
integer
| int32
Delivery charge order value.
delivery_charge_info
string
Delivery charge in information message on shipment.
cod_available
boolean
Whether Cash On Delivery available.
success
boolean
Success flag of checkout cart API response.
store_code
string
Store code from which the order placed.
message
string
Message of the cart checkout API response.
gstin
string
GSTIN number added in cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
order_id
string
Order id generated after placing order.
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, engage and loyalty points.
display
array of object (DisplayBreakup)
List of breakup data which is used to display the breakup to the customer like MRP total, Discount, Sub total, coupon value, promotion value and final total.
Show
Display price breakup schema denotes price currency, key, value,message to display as breakup on UI.
currency_symbol
string
Currency symbol for the price.
key
string
Key of the price like total_mrp, total, subtotal etc.
display
string
Display key field that to be shown against the value.
message
array of string
List of message at price level to be displayed.
currency_code
string
Currency code for the price.
value
number
| float
Numeric value of the price.
preset
number
| float
Value for the price which is set from platform if applicable.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convenience fee, coupon amount, delivery charge, discount, loyalty points, engage points, gift card, gst charge, etc.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
subtotal
number
| float
Selling price amount of all products in cart.
engage_amount
number
| float
Engage amount applied on the cart.
engage_mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
fynd_cash
number
| float
Loyalty points applied on cart.
discount
number
| float
Discount amount received on cart.
convenience_fee
number
| float
Convenience fee amount applied to cart.
delivery_charge
number
| float
Delivery charge applied to cart.
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
total_charge
number
| float
Total amount of charges applied on cart.
coupon
number
| float
Coupon amount applied to cart.
total
number
| float
Total payable amount by the customer.
gift_card
number
| float
Gift cart amount applied on cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
coupon
object (CouponBreakup)
Show
Coupon price breakup details which includes coupon code, coupon type, coupon value, coupon description, coupn message etc.
coupon_value
number
| float
Value of the coupon applied to cart.
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
minimum_cart_value
number
| float
Minimum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
uid
string
Unique identifier of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
loyalty_points
object (LoyaltyPoints)
Show
Engage points data for the user cart.
total
number
| float
Total loyalty points available with user.
description
string
Description for loyalty points.
applicable
number
| float
Whether the loyalty points are applicable for the cart.
is_applied
boolean
Whether the loyalty points are applied on the cart.
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage discount amount applied on the cart as engage redeemed points can be set as discount or MOP from engage platform.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Formatted title that can be used by theme to display points earned by user for this cart.
title
string
Unique title for loyalty program applicable.
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
currency
object (CartCurrency)
Show
Currency data of the cart for prices.
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
store_emps
array of object
Store employees data.
coupon_text
string
Coupon text of the applied coupon on order placed.
buy_now
boolean
Buy now flag of user cart.
cod_charges
number
| float
Cash On Delivery charges of the user cart.
custom_cart_meta
object
Custom cart meta details added in cart.
Examples
Parameters
buy_now:
false
cart_type:
"value"
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
x-location-detail:
"value"
x-currency-code:
"value"
Response
Checkout cart
checkoutCartV2
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 available coupons
POST
# Apply coupon
DEL
# Remove coupon
GET
# List bulk discounts
GET
# Validate applied coupon
List 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
idquery
string
The unique identifier of the cart.
buy_nowquery
boolean
Whether to get buy_now cart.
product_slugquery
string
Product slug to fetch the available coupons.
store_idquery
string
Unique identifier of a store.
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.
page
object (PageCoupon)
Show
Pagination schema for get coupon list available on cart.
total_item_count
integer
| int32
Total coupons are available for the cart.
has_next
boolean
Denotes if next page of coupon is available.
total
integer
| int32
Total pages of coupon availalbe.
current
integer
| int32
Current page number.
has_previous
boolean
Denotes if previous page of the coupon is available.
available_coupon_list
array of object (Coupon)
List of available coupon which can be applied on cart.
Show
Coupon data applied on cart that includes coupon code, coupon type, coupon value, description, title, subtitle etc.
coupon_amount
number
| float
The amount based on cart value.
coupon_value
number
| float
Coupon value of the coupon applied to cart.
title
string
Coupon Title of the coupon applied denotes name of the coupon.
rule
array of object (DiscountRules)
Discount rules of coupons
Show
List of discounted price applies on the product, when the product is added to the cart.
discounted_price
number
| float
Discount will be reflected in the cart upon adding the product.
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart.
sub_title
string
Coupon subtitle of the coupon applied to cart which is used to display.
expires_on
string
Message to display to user for expiry of the coupon.
expires_at
string
| date-time
Nullable
Represents the last valid timeslot date on which the coupon can be applied in ISO 8601 (UTC Z) format,based on its configured schedule. If the coupon is restricted to specific days (e.g., Mondays and Thursdays), the expiry date will be the last eligible day within the overall end date range, not necessarily the end date itself.
message
string
Coupon message of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
coupon_code
string
Coupon code of the coupon applied on cart.
coupon_id
string
Unique identifier of the coupon.
is_applicable
boolean
Flag to determine where the coupon is applicable to cart or not.
description
string
Nullable
Coupon description of the coupon applied to cart.
is_applied
boolean
Flag to determine where the coupon is applied to cart or not.
start_date
string
| date-time
Nullable
Start date of the coupon when the coupon will be live for the users to apply on cart.
end_date
string
| date-time
Nullable
End date of the coupon on which the coupon expires.
coupon_applicable_message
string
Message which is used to display to the customer if the coupon is applied successfully.
offer_text
string
Offer text of the coupon which highlights coupon offer defined while creating coupon.
is_bank_offer
boolean
Bank offer flag for the coupon if the coupon is applicable for only if payment done by bank or mode specified in coupon.
Examples
Parameters
id:
"value"
buy_now:
false
product_slug:
"value"
store_id:
"value"
Response
List available coupons
getCoupons
Parameters
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.
pquery
boolean
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.
cart_typequery
string
The type of cart.
bodyrequestBody
object (ApplyCoupon)
Required
Pass coupon code in the request body as shown below.
Hide
Apply coupon request schema used to apply the coupon that includes cart id and coupon to be applied.
coupon_code
string
Required
Coupon code to be applied.
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
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
Get cart detail 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.
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
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment Default Selection Schema.
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
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
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc.
article
object (ProductArticle)
Show
Product store information of the product added in cart.
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article.
base
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
converted
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
product_group_tags
array of string
List fot the unique identifier for the product grouping.
extra_meta
object
Field to update extra meta of the article in cart.
quantity
integer
| int32
Quantity of the article added in cart.
_custom_json
object
Field to update custom json of the article in cart.
meta
object
Article meta data.
size
string
Size of the article added in cart.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
seller_identifier
string
List of identifiers used by sellers for the product size.
parent_item_identifiers
object
Fields to determine parent product of the product.
identifier
object
Unique identifier of the article.
store
object (StoreInfo)
Show
Store information of the store which includes store name, store id and store code.
store_code
string
A unique code or identifier for the store, often used for internal reference.
uid
integer
| int32
Unique identifiers of the store from where product is fulfilled.
name
string
Store name of the store from where the product is fulfilled.
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of delivery service.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
cart_item_meta
object
Meta details of the article added from cart.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
gift_card
object
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift.
is_gift_visible
boolean
Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
type
string
Type of the data sent in response. Possible value is article.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags.
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
promo_meta
object (PromoMeta)
Show
Loyalty points message data.
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
price
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
converted
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
quantity
integer
| int32
Quantity of the product added in cart.
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of value.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
out_of_stock
boolean
Denotes if the product is available in stock.
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not.
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability.
Show
Product sizes availability.
display
string
Display size of the product.
value
string
Actual value of the size.
is_available
boolean
Available flag for the size of the product if that is available.
is_valid
boolean
Valid flag for the product if the product added in cart is valid to place the order.
other_store_quantity
integer
| int32
Quantity of the product available on other store.
sizes
array of string
All sizes of the product.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categories, images, item code, tags, item id, item name, etc.
_custom_json
object
Field to add custom json of the product in cart.
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
action
object (ProductAction)
Show
Schema of Action Object to render the product.
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs.
product_slug
array of string
Contains list of product slug.
url
string
Url of the product to render the product
type
string
Type of action.
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart.
tags
object
Tags is a lable or batch that is attached to a product in cart.
slug
string
Unique product url name generated via product name and other meta data.
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url.
Show
Product images data in different formats.
secure_url
string
Secured url of the product image.
aspect_ratio
string
Aspect ratio of the product image.
url
string
Bucket link url for product image.
uid
integer
| int32
Unique identifier of the product in cart.
name
string
Product name of the product in cart which is defined on platform.
item_code
string
Nullable
Product code of the product while defining product on platform.
categories
array of object (CategoryInfo)
Product category information which incldes category name and category id.
Show
Category information schema which denotes category name and category id.
uid
integer
| int32
Product Category Id.
name
string
Category name of the product.
tags
array of string
Products tags that are added to each product to identify the set of products.
type
string
Type of product in cart.
attributes
object
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
coupon
object (CouponDetails)
Show
Coupon actual price breakup details.
discount_single_quantity
number
| float
Discount amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
custom_order
object
Whether MTO (Make to Order) is enabled or not.
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
key
string
The attribute key associated with the size.
message
string
Product level message which denotes error information to display over the product in cart.
is_set
boolean
Whether or not the product is a set of items.
price_per_unit
object (ProductPricePerUnitInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
converted
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Show
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
item_type
string
Type of the item in cart.
Enum
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
delivery_charge_info
string
Delivery charge in information message on shipment.
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config.
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag.
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold.
charges
number
| float
Charges amount to be applied on cart.
threshold
number
| float
Threshold of cart value on which the charge should be applied.
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value.
cashback_amount
number
| float
Fields denotes cashback amount applied to cart.
cashback_message_primary
string
Primary cashback message for coupon applied to cart.
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart.
coupon_code
string
Coupon code to be applied to cart.
coupon_description
string
Coupon description of the coupon applied to cart.
coupon_id
string
Unique identifier of the coupon applied to cart.
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart.
coupon_title
string
Coupon Title of the coupon applied.
coupon_type
string
Type of the coupon applied to cart.
coupon_value
number
| float
Value of the coupon applied to cart.
discount
number
| float
Total discount earned from coupon applied to cart.
is_applied
boolean
Flag to determine where the coupon is applied to cart or not.
is_valid
boolean
Determine where the coupon applied to cart is valid.
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
message
string
Coupon message of the coupon applied to cart.
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart.
message
string
Message of the get 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.
gstin
string
GSTIN added in user cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, engage and loyalty points.
display
array of object (DisplayBreakup)
List of breakup data which is used to display the breakup to the customer like MRP total, Discount, Sub total, coupon value, promotion value and final total.
Show
Display price breakup schema denotes price currency, key, value,message to display as breakup on UI.
currency_symbol
string
Currency symbol for the price.
key
string
Key of the price like total_mrp, total, subtotal etc.
display
string
Display key field that to be shown against the value.
message
array of string
List of message at price level to be displayed.
currency_code
string
Currency code for the price.
value
number
| float
Numeric value of the price.
preset
number
| float
Value for the price which is set from platform if applicable.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convenience fee, coupon amount, delivery charge, discount, loyalty points, engage points, gift card, gst charge, etc.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
subtotal
number
| float
Selling price amount of all products in cart.
engage_amount
number
| float
Engage amount applied on the cart.
engage_mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
fynd_cash
number
| float
Loyalty points applied on cart.
discount
number
| float
Discount amount received on cart.
convenience_fee
number
| float
Convenience fee amount applied to cart.
delivery_charge
number
| float
Delivery charge applied to cart.
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
total_charge
number
| float
Total amount of charges applied on cart.
coupon
number
| float
Coupon amount applied to cart.
total
number
| float
Total payable amount by the customer.
gift_card
number
| float
Gift cart amount applied on cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
coupon
object (CouponBreakup)
Show
Coupon price breakup details which includes coupon code, coupon type, coupon value, coupon description, coupn message etc.
coupon_value
number
| float
Value of the coupon applied to cart.
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
minimum_cart_value
number
| float
Minimum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
uid
string
Unique identifier of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
loyalty_points
object (LoyaltyPoints)
Show
Engage points data for the user cart.
total
number
| float
Total loyalty points available with user.
description
string
Description for loyalty points.
applicable
number
| float
Whether the loyalty points are applicable for the cart.
is_applied
boolean
Whether the loyalty points are applied on the cart.
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage discount amount applied on the cart as engage redeemed points can be set as discount or MOP from engage platform.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Formatted title that can be used by theme to display points earned by user for this cart.
title
string
Unique title for loyalty program applicable.
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
currency
object (CartCurrency)
Show
Currency data of the cart for prices.
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
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 (AlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
customer_id
string
Customer user id associated with cart
Examples
Parameters
i:
false
b:
false
p:
false
id:
"value"
buy_now:
false
cart_type:
"value"
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
Response
Apply coupon
applyCoupon
Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total.
Parameters
idquery
string
The unique identifier of the cart.
buy_nowquery
boolean
Wheter 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.
DEL
Response
200
Success. Returns coupons removed from the cart along with item details and price breakup. Refer `CartDetailResult` for more details.
Hide
Get cart detail 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.
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
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment Default Selection Schema.
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
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
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc.
article
object (ProductArticle)
Show
Product store information of the product added in cart.
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article.
base
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
converted
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
product_group_tags
array of string
List fot the unique identifier for the product grouping.
extra_meta
object
Field to update extra meta of the article in cart.
quantity
integer
| int32
Quantity of the article added in cart.
_custom_json
object
Field to update custom json of the article in cart.
meta
object
Article meta data.
size
string
Size of the article added in cart.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
seller_identifier
string
List of identifiers used by sellers for the product size.
parent_item_identifiers
object
Fields to determine parent product of the product.
identifier
object
Unique identifier of the article.
store
object (StoreInfo)
Show
Store information of the store which includes store name, store id and store code.
store_code
string
A unique code or identifier for the store, often used for internal reference.
uid
integer
| int32
Unique identifiers of the store from where product is fulfilled.
name
string
Store name of the store from where the product is fulfilled.
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of delivery service.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
cart_item_meta
object
Meta details of the article added from cart.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
gift_card
object
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift.
is_gift_visible
boolean
Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
type
string
Type of the data sent in response. Possible value is article.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags.
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
promo_meta
object (PromoMeta)
Show
Loyalty points message data.
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
price
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
converted
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
quantity
integer
| int32
Quantity of the product added in cart.
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of value.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
out_of_stock
boolean
Denotes if the product is available in stock.
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not.
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability.
Show
Product sizes availability.
display
string
Display size of the product.
value
string
Actual value of the size.
is_available
boolean
Available flag for the size of the product if that is available.
is_valid
boolean
Valid flag for the product if the product added in cart is valid to place the order.
other_store_quantity
integer
| int32
Quantity of the product available on other store.
sizes
array of string
All sizes of the product.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categories, images, item code, tags, item id, item name, etc.
_custom_json
object
Field to add custom json of the product in cart.
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
action
object (ProductAction)
Show
Schema of Action Object to render the product.
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs.
product_slug
array of string
Contains list of product slug.
url
string
Url of the product to render the product
type
string
Type of action.
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart.
tags
object
Tags is a lable or batch that is attached to a product in cart.
slug
string
Unique product url name generated via product name and other meta data.
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url.
Show
Product images data in different formats.
secure_url
string
Secured url of the product image.
aspect_ratio
string
Aspect ratio of the product image.
url
string
Bucket link url for product image.
uid
integer
| int32
Unique identifier of the product in cart.
name
string
Product name of the product in cart which is defined on platform.
item_code
string
Nullable
Product code of the product while defining product on platform.
categories
array of object (CategoryInfo)
Product category information which incldes category name and category id.
Show
Category information schema which denotes category name and category id.
uid
integer
| int32
Product Category Id.
name
string
Category name of the product.
tags
array of string
Products tags that are added to each product to identify the set of products.
type
string
Type of product in cart.
attributes
object
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
coupon
object (CouponDetails)
Show
Coupon actual price breakup details.
discount_single_quantity
number
| float
Discount amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
custom_order
object
Whether MTO (Make to Order) is enabled or not.
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
key
string
The attribute key associated with the size.
message
string
Product level message which denotes error information to display over the product in cart.
is_set
boolean
Whether or not the product is a set of items.
price_per_unit
object (ProductPricePerUnitInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
converted
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Show
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
item_type
string
Type of the item in cart.
Enum
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
delivery_charge_info
string
Delivery charge in information message on shipment.
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config.
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag.
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold.
charges
number
| float
Charges amount to be applied on cart.
threshold
number
| float
Threshold of cart value on which the charge should be applied.
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value.
cashback_amount
number
| float
Fields denotes cashback amount applied to cart.
cashback_message_primary
string
Primary cashback message for coupon applied to cart.
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart.
coupon_code
string
Coupon code to be applied to cart.
coupon_description
string
Coupon description of the coupon applied to cart.
coupon_id
string
Unique identifier of the coupon applied to cart.
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart.
coupon_title
string
Coupon Title of the coupon applied.
coupon_type
string
Type of the coupon applied to cart.
coupon_value
number
| float
Value of the coupon applied to cart.
discount
number
| float
Total discount earned from coupon applied to cart.
is_applied
boolean
Flag to determine where the coupon is applied to cart or not.
is_valid
boolean
Determine where the coupon applied to cart is valid.
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
message
string
Coupon message of the coupon applied to cart.
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart.
message
string
Message of the get 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.
gstin
string
GSTIN added in user cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, engage and loyalty points.
display
array of object (DisplayBreakup)
List of breakup data which is used to display the breakup to the customer like MRP total, Discount, Sub total, coupon value, promotion value and final total.
Show
Display price breakup schema denotes price currency, key, value,message to display as breakup on UI.
currency_symbol
string
Currency symbol for the price.
key
string
Key of the price like total_mrp, total, subtotal etc.
display
string
Display key field that to be shown against the value.
message
array of string
List of message at price level to be displayed.
currency_code
string
Currency code for the price.
value
number
| float
Numeric value of the price.
preset
number
| float
Value for the price which is set from platform if applicable.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convenience fee, coupon amount, delivery charge, discount, loyalty points, engage points, gift card, gst charge, etc.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
subtotal
number
| float
Selling price amount of all products in cart.
engage_amount
number
| float
Engage amount applied on the cart.
engage_mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
fynd_cash
number
| float
Loyalty points applied on cart.
discount
number
| float
Discount amount received on cart.
convenience_fee
number
| float
Convenience fee amount applied to cart.
delivery_charge
number
| float
Delivery charge applied to cart.
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
total_charge
number
| float
Total amount of charges applied on cart.
coupon
number
| float
Coupon amount applied to cart.
total
number
| float
Total payable amount by the customer.
gift_card
number
| float
Gift cart amount applied on cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
coupon
object (CouponBreakup)
Show
Coupon price breakup details which includes coupon code, coupon type, coupon value, coupon description, coupn message etc.
coupon_value
number
| float
Value of the coupon applied to cart.
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
minimum_cart_value
number
| float
Minimum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
uid
string
Unique identifier of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
loyalty_points
object (LoyaltyPoints)
Show
Engage points data for the user cart.
total
number
| float
Total loyalty points available with user.
description
string
Description for loyalty points.
applicable
number
| float
Whether the loyalty points are applicable for the cart.
is_applied
boolean
Whether the loyalty points are applied on the cart.
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage discount amount applied on the cart as engage redeemed points can be set as discount or MOP from engage platform.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Formatted title that can be used by theme to display points earned by user for this cart.
title
string
Unique title for loyalty program applicable.
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
currency
object (CartCurrency)
Show
Currency data of the cart for prices.
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
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 (AlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
customer_id
string
Customer user id associated with cart
Examples
Parameters
id:
"value"
buy_now:
false
x-ordering-source:
"value"
x-ordering-source-type:
"value"
Response
Remove coupon
removeCoupon
List offer discounts with information about quantity and seller. One offer is marked with a "best" flag, indicating it as the best offer among the list.
Parameters
item_idquery
integer
The Item ID of the product.
article_idquery
string
Article ID.
uidquery
integer
UID of the product.
slugquery
string
A short, human-readable, URL-friendly identifier of a product.
GET
Response
200
Success. Returns a data object containing the seller details and available offers (if exists) on bulk products. Refer `BulkPriceResult` for more details.
Hide
Bulk price response schema details consists of offers from multiple seller.
data
array of object (BulkPriceOffer)
Actual data to be in response consist of offers from multiple seller.
Show
Bulk price offer details which denotes offers list and seller details.
offers
array of object (OfferItem)
Offers is the list of Offer item, which consists of margin percentage, price, quantity, offer type and offer price.
Show
Offer Item Details, This consists of margin percentage, price, quantity, offer type and offer price.
price
object (OfferPrice)
Show
Offer price details of the item includes effective price, selling price, currency and max price.
currency_symbol
string
Currency symbol for currency.
bulk_effective
number
| float
Discounted per unit price for current offer object.
currency_code
string
The currency code for an offer price is the three-letter code that corresponds to the currency in which the offer price is denominated.
effective
integer
| int32
The "effective price" is the actual price paid by the consumer after accounting for product discounts. It represents the true cost of a product or service after all adjustments have been made.
marked
integer
| int32
The price at which the product is sold to the end consumer, typically the original price before discounts.
margin
integer
| int32
Percentage value of discount.
quantity
integer
| int32
Quantity on which offer is applicable.
best
boolean
Is true for best offer from all offers present for all sellers.
total
number
| float
Total price of offer quantity with discount.
auto_applied
boolean
Whether offer discount is auto applied in cart.
type
string
Type of the offer.
seller
object (OfferSeller)
Show
Seller details consists of seller uid and seller name.
uid
integer
| int32
Unique identifier for a seller.
name
string
Name of a seller.
Examples
Parameters
Parameters are not required.
Response
List bulk discounts
getBulkDiscountOffers
Validate 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
idquery
string
The unique identifier of the cart.
buy_nowquery
boolean
Whether 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.
iinquery
string
Debit/Credit card prefix (first 6 digit).
networkquery
string
Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY.
typequery
string
Card type, e.g. Credit, Debit.
card_idquery
string
Saved card token reference id.
cart_typequery
string
Type 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.
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.
message
string
Payment mode valid message for coupon.
coupon_validity
object (CouponValidity)
Show
Coupon validity schema which includes coupon title, coupon code, next validation flag, valid flag, error display message and discount of coupon.
title
string
Coupon Title of the coupon applied.
discount
number
| float
Coupon discount value of the coupon applied.
next_validation_required
boolean
Nullable
Flag for coupon validation required on next page or not.
valid
boolean
Valid flag which denotes if the applied coupon is valid or not.
display_message_en
string
Nullable
Display message for coupon validity.
code
string
Nullable
Coupon code of the coupon applied.
error_en
string
Nullable
Error message for the selected payment mode.
success
boolean
Success flag of coupon payment mode validity API response.
Examples
Parameters
id:
"value"
buy_now:
false
address_id:
"value"
payment_mode:
"value"
payment_identifier:
"value"
aggregator_name:
"value"
merchant_code:
"value"
iin:
"value"
network:
"value"
type:
"value"
card_id:
"value"
cart_type:
"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
List all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery.
Parameters
cart_idquery
string
The unique identifier of the user cart.
buy_nowquery
boolean
Whether to get buy_now cart.
mobile_noquery
string
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
Select `true` to fetch the default address.
GET
Response
200
Success. Returns an Address object containing a list of address saved in the account. Refer `GetAddressesResult` for more details.
Hide
Fetch address response schema which includes pii masking flag and list of addresses.
pii_masking
boolean
Personally Identifiable Information masking flag to denote if the user data in address is masked or not.
address
array of object (Address)
Address description for address data.
Show
Address details, consists of pincode, phone, address id, country code, geo location, country, state, city, landmark, email etc.
country_iso_code
string
Country iso code for address.
area
string
Area description for address.
phone
string
Phone number for address.
country_phone_code
string
Country phone code for address.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
address
string
Address description for address data.
area_code_slug
string
Area code slug for address. example pincode is slug for India.
geo_location
object (GeoLocation)
Show
Geolocation details for address data.
latitude
number
| float
Latitude coordinate for address.
Default Value : 0
longitude
number
| float
Longitude coordinate for address.
Default Value : 0
id
string
Id of the address.
_custom_json
object
Custom json of the address.
city
string
City of the address.
sector
string
Sector of the address.
state_code
string
State code for address.
created_by_user_id
string
Created by user id of address.
landmark
string
Landmark of address.
user_id
string
User id of address for which address is created.
name
string
Name of person in address data to whom it belongs to.
google_map_point
object
Google map point of the address.
is_active
boolean
States whether address is active or not.
tags
array of string
Tags of address from which it can be identified.
country_code
string
Country code of address.
address_type
string
Address type of address.
country
string
Country of address.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
area_code
string
Area code of the address.
email
string
Email address for address data.
state
string
State of the address.
meta
object
Metadata of the address.
validation_config
object (ValidationConfig)
Show
Defines validation rules for user addresses.
address_max_limit
integer
| int32
The maximum number of addresses a user can have.
user_address_count
integer
| int32
The total number of addresses saved by a user.
Examples
Parameters
Parameters are not required.
Response
Get a list of addresses for a customer
getAddresses
Add a new address to their cart to save details such as name, email, contact information, and address.
Parameters
No Parameters
bodyrequestBody
object (Address)
Required
Add address details in the request body as shown below or refer `Address` for more details.
Hide
Address details, consists of pincode, phone, address id, country code, geo location, country, state, city, landmark, email etc.
country_iso_code
string
Country iso code for address.
area
string
Area description for address.
phone
string
Phone number for address.
country_phone_code
string
Country phone code for address.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
address
string
Address description for address data.
area_code_slug
string
Area code slug for address. example pincode is slug for India.
geo_location
object (GeoLocation)
Show
Geolocation details for address data.
latitude
number
| float
Latitude coordinate for address.
Default Value : 0
longitude
number
| float
Longitude coordinate for address.
Default Value : 0
id
string
Id of the address.
_custom_json
object
Custom json of the address.
city
string
City of the address.
sector
string
Sector of the address.
state_code
string
State code for address.
created_by_user_id
string
Created by user id of address.
landmark
string
Landmark of address.
user_id
string
User id of address for which address is created.
name
string
Name of person in address data to whom it belongs to.
google_map_point
object
Google map point of the address.
is_active
boolean
States whether address is active or not.
tags
array of string
Tags of address from which it can be identified.
country_code
string
Country code of address.
address_type
string
Address type of address.
country
string
Country of address.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
area_code
string
Area code of the address.
email
string
Email address for address data.
state
string
State of the address.
meta
object
Metadata of the address.
Request body
country_iso_code
string
Country iso code for address.
area
string
Area description for address.
phone
string
Phone number for address.
country_phone_code
string
Country phone code for address.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
address
string
Address description for address data.
area_code_slug
string
Area code slug for address. example pincode is slug for India.
geo_location
object (GeoLocation)
Show
Geolocation details for address data.
latitude
number
| float
Latitude coordinate for address.
Default Value : 0
longitude
number
| float
Longitude coordinate for address.
Default Value : 0
id
string
Id of the address.
_custom_json
object
Custom json of the address.
city
string
City of the address.
sector
string
Sector of the address.
state_code
string
State code for address.
created_by_user_id
string
Created by user id of address.
landmark
string
Landmark of address.
user_id
string
User id of address for which address is created.
name
string
Name of person in address data to whom it belongs to.
google_map_point
object
Google map point of the address.
is_active
boolean
States whether address is active or not.
tags
array of string
Tags of address from which it can be identified.
country_code
string
Country code of address.
address_type
string
Address type of address.
country
string
Country of address.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
area_code
string
Area code of the address.
email
string
Email address for address data.
state
string
State of the address.
meta
object
Metadata of the address.
POST
Response
200
422
Success. Returns the address ID, a flag whether the address is set as default, and a success message. Refer `SaveAddressResult` 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 Result.
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
Get 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
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
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.
GET
Response
200
Success. Returns an Address object containing a list of address saved in the account. Refer `Address` for more details.
Hide
Address details, consists of pincode, phone, address id, country code, geo location, country, state, city, landmark, email etc.
country_iso_code
string
Country iso code for address.
area
string
Area description for address.
phone
string
Phone number for address.
country_phone_code
string
Country phone code for address.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
address
string
Address description for address data.
area_code_slug
string
Area code slug for address. example pincode is slug for India.
geo_location
object (GeoLocation)
Show
Geolocation details for address data.
latitude
number
| float
Latitude coordinate for address.
Default Value : 0
longitude
number
| float
Longitude coordinate for address.
Default Value : 0
id
string
Id of the address.
_custom_json
object
Custom json of the address.
city
string
City of the address.
sector
string
Sector of the address.
state_code
string
State code for address.
created_by_user_id
string
Created by user id of address.
landmark
string
Landmark of address.
user_id
string
User id of address for which address is created.
name
string
Name of person in address data to whom it belongs to.
google_map_point
object
Google map point of the address.
is_active
boolean
States whether address is active or not.
tags
array of string
Tags of address from which it can be identified.
country_code
string
Country code of address.
address_type
string
Address type of address.
country
string
Country of address.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
area_code
string
Area code of the address.
email
string
Email address for address data.
state
string
State of the address.
meta
object
Metadata of the address.
Examples
Parameters
id:
"value"
cart_id:
"value"
buy_now:
false
mobile_no:
"value"
checkout_mode:
"value"
tags:
"value"
is_default:
false
Response
Get details for a single customer address
getAddressById
Customer can modify the details of a previously saved address.
Parameters
idpath
string
Required
ID allotted to the selected address.
bodyrequestBody
object (Address)
Required
Add address details in the request body as shown below or refer `Address` for more details.
Hide
Address details, consists of pincode, phone, address id, country code, geo location, country, state, city, landmark, email etc.
country_iso_code
string
Country iso code for address.
area
string
Area description for address.
phone
string
Phone number for address.
country_phone_code
string
Country phone code for address.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
address
string
Address description for address data.
area_code_slug
string
Area code slug for address. example pincode is slug for India.
geo_location
object (GeoLocation)
Show
Geolocation details for address data.
latitude
number
| float
Latitude coordinate for address.
Default Value : 0
longitude
number
| float
Longitude coordinate for address.
Default Value : 0
id
string
Id of the address.
_custom_json
object
Custom json of the address.
city
string
City of the address.
sector
string
Sector of the address.
state_code
string
State code for address.
created_by_user_id
string
Created by user id of address.
landmark
string
Landmark of address.
user_id
string
User id of address for which address is created.
name
string
Name of person in address data to whom it belongs to.
google_map_point
object
Google map point of the address.
is_active
boolean
States whether address is active or not.
tags
array of string
Tags of address from which it can be identified.
country_code
string
Country code of address.
address_type
string
Address type of address.
country
string
Country of address.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
area_code
string
Area code of the address.
email
string
Email address for address data.
state
string
State of the address.
meta
object
Metadata of the address.
Request body
country_iso_code
string
Country iso code for address.
area
string
Area description for address.
phone
string
Phone number for address.
country_phone_code
string
Country phone code for address.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
address
string
Address description for address data.
area_code_slug
string
Area code slug for address. example pincode is slug for India.
geo_location
object (GeoLocation)
Show
Geolocation details for address data.
latitude
number
| float
Latitude coordinate for address.
Default Value : 0
longitude
number
| float
Longitude coordinate for address.
Default Value : 0
id
string
Id of the address.
_custom_json
object
Custom json of the address.
city
string
City of the address.
sector
string
Sector of the address.
state_code
string
State code for address.
created_by_user_id
string
Created by user id of address.
landmark
string
Landmark of address.
user_id
string
User id of address for which address is created.
name
string
Name of person in address data to whom it belongs to.
google_map_point
object
Google map point of the address.
is_active
boolean
States whether address is active or not.
tags
array of string
Tags of address from which it can be identified.
country_code
string
Country code of address.
address_type
string
Address type of address.
country
string
Country of address.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
area_code
string
Area code of the address.
email
string
Email address for address data.
state
string
State of the address.
meta
object
Metadata of the address.
PUT
Response
201
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.
is_updated
boolean
Updated flag for update address operation if the address updated or not.
id
string
ID of an address.
success
boolean
Success flag of update address response.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
Examples
Parameters
id:
"value"
body:
body
Response
Updates an existing customer address
updateAddress
Delete an existing customer address from the system.
Parameters
idpath
string
Required
ID allotted to the selected address.
DEL
Response
201
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
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
cart_idquery
string
The unique identifier of the cart.
buy_nowquery
boolean
Whether to get buy_now 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.
bodyrequestBody
object (SelectCartAddressCreation)
Required
Pass address details in the request body as shown below or refer `SelectCartAddressCreation` for more details.
Hide
Select address request schema, includes cart id, address id and billing address id.
id
string
Address is selected by user on which shipment to be delivered.
billing_address_id
string
Billing address id selected by user on which shipment bill to be generated.
cart_id
string
Cart id of the user cart for which the select address operation performed.
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
id
string
Address is selected by user on which shipment to be delivered.
billing_address_id
string
Billing address id selected by user on which shipment bill to be generated.
cart_id
string
Cart id of the user cart for which the select address operation performed.
POST
Response
201
400
Success. Returns a Cart object as shown below. Refer `CartDetailResult` for more details.
Hide
Get cart detail 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.
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
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment Default Selection Schema.
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
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
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc.
article
object (ProductArticle)
Show
Product store information of the product added in cart.
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article.
base
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
converted
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
product_group_tags
array of string
List fot the unique identifier for the product grouping.
extra_meta
object
Field to update extra meta of the article in cart.
quantity
integer
| int32
Quantity of the article added in cart.
_custom_json
object
Field to update custom json of the article in cart.
meta
object
Article meta data.
size
string
Size of the article added in cart.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
seller_identifier
string
List of identifiers used by sellers for the product size.
parent_item_identifiers
object
Fields to determine parent product of the product.
identifier
object
Unique identifier of the article.
store
object (StoreInfo)
Show
Store information of the store which includes store name, store id and store code.
store_code
string
A unique code or identifier for the store, often used for internal reference.
uid
integer
| int32
Unique identifiers of the store from where product is fulfilled.
name
string
Store name of the store from where the product is fulfilled.
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of delivery service.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
cart_item_meta
object
Meta details of the article added from cart.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
gift_card
object
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift.
is_gift_visible
boolean
Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
type
string
Type of the data sent in response. Possible value is article.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags.
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
promo_meta
object (PromoMeta)
Show
Loyalty points message data.
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
price
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
converted
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
quantity
integer
| int32
Quantity of the product added in cart.
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of value.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
out_of_stock
boolean
Denotes if the product is available in stock.
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not.
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability.
Show
Product sizes availability.
display
string
Display size of the product.
value
string
Actual value of the size.
is_available
boolean
Available flag for the size of the product if that is available.
is_valid
boolean
Valid flag for the product if the product added in cart is valid to place the order.
other_store_quantity
integer
| int32
Quantity of the product available on other store.
sizes
array of string
All sizes of the product.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categories, images, item code, tags, item id, item name, etc.
_custom_json
object
Field to add custom json of the product in cart.
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
action
object (ProductAction)
Show
Schema of Action Object to render the product.
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs.
product_slug
array of string
Contains list of product slug.
url
string
Url of the product to render the product
type
string
Type of action.
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart.
tags
object
Tags is a lable or batch that is attached to a product in cart.
slug
string
Unique product url name generated via product name and other meta data.
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url.
Show
Product images data in different formats.
secure_url
string
Secured url of the product image.
aspect_ratio
string
Aspect ratio of the product image.
url
string
Bucket link url for product image.
uid
integer
| int32
Unique identifier of the product in cart.
name
string
Product name of the product in cart which is defined on platform.
item_code
string
Nullable
Product code of the product while defining product on platform.
categories
array of object (CategoryInfo)
Product category information which incldes category name and category id.
Show
Category information schema which denotes category name and category id.
uid
integer
| int32
Product Category Id.
name
string
Category name of the product.
tags
array of string
Products tags that are added to each product to identify the set of products.
type
string
Type of product in cart.
attributes
object
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
coupon
object (CouponDetails)
Show
Coupon actual price breakup details.
discount_single_quantity
number
| float
Discount amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
custom_order
object
Whether MTO (Make to Order) is enabled or not.
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
key
string
The attribute key associated with the size.
message
string
Product level message which denotes error information to display over the product in cart.
is_set
boolean
Whether or not the product is a set of items.
price_per_unit
object (ProductPricePerUnitInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
converted
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Show
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
item_type
string
Type of the item in cart.
Enum
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
delivery_charge_info
string
Delivery charge in information message on shipment.
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config.
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag.
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold.
charges
number
| float
Charges amount to be applied on cart.
threshold
number
| float
Threshold of cart value on which the charge should be applied.
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value.
cashback_amount
number
| float
Fields denotes cashback amount applied to cart.
cashback_message_primary
string
Primary cashback message for coupon applied to cart.
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart.
coupon_code
string
Coupon code to be applied to cart.
coupon_description
string
Coupon description of the coupon applied to cart.
coupon_id
string
Unique identifier of the coupon applied to cart.
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart.
coupon_title
string
Coupon Title of the coupon applied.
coupon_type
string
Type of the coupon applied to cart.
coupon_value
number
| float
Value of the coupon applied to cart.
discount
number
| float
Total discount earned from coupon applied to cart.
is_applied
boolean
Flag to determine where the coupon is applied to cart or not.
is_valid
boolean
Determine where the coupon applied to cart is valid.
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
message
string
Coupon message of the coupon applied to cart.
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart.
message
string
Message of the get 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.
gstin
string
GSTIN added in user cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, engage and loyalty points.
display
array of object (DisplayBreakup)
List of breakup data which is used to display the breakup to the customer like MRP total, Discount, Sub total, coupon value, promotion value and final total.
Show
Display price breakup schema denotes price currency, key, value,message to display as breakup on UI.
currency_symbol
string
Currency symbol for the price.
key
string
Key of the price like total_mrp, total, subtotal etc.
display
string
Display key field that to be shown against the value.
message
array of string
List of message at price level to be displayed.
currency_code
string
Currency code for the price.
value
number
| float
Numeric value of the price.
preset
number
| float
Value for the price which is set from platform if applicable.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convenience fee, coupon amount, delivery charge, discount, loyalty points, engage points, gift card, gst charge, etc.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
subtotal
number
| float
Selling price amount of all products in cart.
engage_amount
number
| float
Engage amount applied on the cart.
engage_mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
fynd_cash
number
| float
Loyalty points applied on cart.
discount
number
| float
Discount amount received on cart.
convenience_fee
number
| float
Convenience fee amount applied to cart.
delivery_charge
number
| float
Delivery charge applied to cart.
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
total_charge
number
| float
Total amount of charges applied on cart.
coupon
number
| float
Coupon amount applied to cart.
total
number
| float
Total payable amount by the customer.
gift_card
number
| float
Gift cart amount applied on cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
coupon
object (CouponBreakup)
Show
Coupon price breakup details which includes coupon code, coupon type, coupon value, coupon description, coupn message etc.
coupon_value
number
| float
Value of the coupon applied to cart.
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
minimum_cart_value
number
| float
Minimum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
uid
string
Unique identifier of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
loyalty_points
object (LoyaltyPoints)
Show
Engage points data for the user cart.
total
number
| float
Total loyalty points available with user.
description
string
Description for loyalty points.
applicable
number
| float
Whether the loyalty points are applicable for the cart.
is_applied
boolean
Whether the loyalty points are applied on the cart.
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage discount amount applied on the cart as engage redeemed points can be set as discount or MOP from engage platform.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Formatted title that can be used by theme to display points earned by user for this cart.
title
string
Unique title for loyalty program applicable.
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
currency
object (CartCurrency)
Show
Currency data of the cart for prices.
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
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 (AlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
customer_id
string
Customer user id associated with cart
Examples
Parameters
cart_id:
"value"
buy_now:
false
i:
false
b:
false
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"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 eligible offer products
List all products eligible for the given offer. Lookup can be done by offer_code (takes priority) or offer_id. At least one must be provided.
Parameters
offer_codequery
string
Offer code (takes priority over offer_id when both are provided)
offer_idquery
string
The unique identifier of the offer
pagequery
integer
Page number for pagination
Default Value : 1
page_sizequery
integer
Number of items per page
Default Value : 20
GET
Response
200
400
Success. Returns list of eligible products with pagination
Hide
Response schema for eligible offer products list
success
boolean
Whether the request was successful
message
string
Response message
items
array of object (EligibleProductItem)
List of eligible products
Show
Product item eligible for an offer
product_slug
string
URL-friendly identifier for the product
uid
integer
| int32
Unique identifier of the product
page
object (PageInfo)
Show
Pagination information for the response
current
integer
| int32
Current page number
has_previous
boolean
Whether previous page is available
has_next
boolean
Whether next page is available
size
integer
| int32
Number of items per page
Examples
Parameters
offer_code:
"value"
offer_id:
"value"
page:
1
page_size:
1
Response
List eligible offer products
getProductsByOfferId
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
Select a preferred payment mode from available options during the cart checkout process to securely and efficiently complete their transaction.
Parameters
idquery
string
The unique identifier of the cart.
buy_nowquery
boolean
Whether to get buy_now cart.
bodyrequestBody
object (UpdateCartPaymentCreation)
Required
Check the example shown below or refer `UpdateCartPaymentCreation` for more details.
Hide
Update cart payment mode request schema to update payment mode by which the payment to be done to process the order, includes cart id, payment identifier, address id, merchant code, aggregator name and payment mode.
id
string
Cart id of the user cart for which the update cart payment operation performed.
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment.
address_id
string
Address id of the user address selected to deliver the shipment.
merchant_code
string
Merchant code of the payment mode selected to do the payment.
aggregator_name
string
Aggregator name of the payment gateway.
payment_mode
string
Payment mode of the payment selected to do the payment.
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
id
string
Cart id of the user cart for which the update cart payment operation performed.
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment.
address_id
string
Address id of the user address selected to deliver the shipment.
merchant_code
string
Merchant code of the payment mode selected to do the payment.
aggregator_name
string
Aggregator name of the payment gateway.
payment_mode
string
Payment mode of the payment selected to do the payment.
PUT
Response
200
Success. Returns a Cart object as shown below. Refer `CartDetailResult` for more details.
Hide
Get cart detail 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.
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
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment Default Selection Schema.
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
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
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc.
article
object (ProductArticle)
Show
Product store information of the product added in cart.
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article.
base
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
converted
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
product_group_tags
array of string
List fot the unique identifier for the product grouping.
extra_meta
object
Field to update extra meta of the article in cart.
quantity
integer
| int32
Quantity of the article added in cart.
_custom_json
object
Field to update custom json of the article in cart.
meta
object
Article meta data.
size
string
Size of the article added in cart.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
seller_identifier
string
List of identifiers used by sellers for the product size.
parent_item_identifiers
object
Fields to determine parent product of the product.
identifier
object
Unique identifier of the article.
store
object (StoreInfo)
Show
Store information of the store which includes store name, store id and store code.
store_code
string
A unique code or identifier for the store, often used for internal reference.
uid
integer
| int32
Unique identifiers of the store from where product is fulfilled.
name
string
Store name of the store from where the product is fulfilled.
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of delivery service.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
cart_item_meta
object
Meta details of the article added from cart.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
gift_card
object
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift.
is_gift_visible
boolean
Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
type
string
Type of the data sent in response. Possible value is article.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags.
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
promo_meta
object (PromoMeta)
Show
Loyalty points message data.
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
price
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
converted
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
quantity
integer
| int32
Quantity of the product added in cart.
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of value.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
out_of_stock
boolean
Denotes if the product is available in stock.
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not.
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability.
Show
Product sizes availability.
display
string
Display size of the product.
value
string
Actual value of the size.
is_available
boolean
Available flag for the size of the product if that is available.
is_valid
boolean
Valid flag for the product if the product added in cart is valid to place the order.
other_store_quantity
integer
| int32
Quantity of the product available on other store.
sizes
array of string
All sizes of the product.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categories, images, item code, tags, item id, item name, etc.
_custom_json
object
Field to add custom json of the product in cart.
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
action
object (ProductAction)
Show
Schema of Action Object to render the product.
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs.
product_slug
array of string
Contains list of product slug.
url
string
Url of the product to render the product
type
string
Type of action.
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart.
tags
object
Tags is a lable or batch that is attached to a product in cart.
slug
string
Unique product url name generated via product name and other meta data.
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url.
Show
Product images data in different formats.
secure_url
string
Secured url of the product image.
aspect_ratio
string
Aspect ratio of the product image.
url
string
Bucket link url for product image.
uid
integer
| int32
Unique identifier of the product in cart.
name
string
Product name of the product in cart which is defined on platform.
item_code
string
Nullable
Product code of the product while defining product on platform.
categories
array of object (CategoryInfo)
Product category information which incldes category name and category id.
Show
Category information schema which denotes category name and category id.
uid
integer
| int32
Product Category Id.
name
string
Category name of the product.
tags
array of string
Products tags that are added to each product to identify the set of products.
type
string
Type of product in cart.
attributes
object
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
coupon
object (CouponDetails)
Show
Coupon actual price breakup details.
discount_single_quantity
number
| float
Discount amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
custom_order
object
Whether MTO (Make to Order) is enabled or not.
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
key
string
The attribute key associated with the size.
message
string
Product level message which denotes error information to display over the product in cart.
is_set
boolean
Whether or not the product is a set of items.
price_per_unit
object (ProductPricePerUnitInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
converted
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Show
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
item_type
string
Type of the item in cart.
Enum
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
delivery_charge_info
string
Delivery charge in information message on shipment.
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config.
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag.
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold.
charges
number
| float
Charges amount to be applied on cart.
threshold
number
| float
Threshold of cart value on which the charge should be applied.
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value.
cashback_amount
number
| float
Fields denotes cashback amount applied to cart.
cashback_message_primary
string
Primary cashback message for coupon applied to cart.
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart.
coupon_code
string
Coupon code to be applied to cart.
coupon_description
string
Coupon description of the coupon applied to cart.
coupon_id
string
Unique identifier of the coupon applied to cart.
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart.
coupon_title
string
Coupon Title of the coupon applied.
coupon_type
string
Type of the coupon applied to cart.
coupon_value
number
| float
Value of the coupon applied to cart.
discount
number
| float
Total discount earned from coupon applied to cart.
is_applied
boolean
Flag to determine where the coupon is applied to cart or not.
is_valid
boolean
Determine where the coupon applied to cart is valid.
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
message
string
Coupon message of the coupon applied to cart.
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart.
message
string
Message of the get 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.
gstin
string
GSTIN added in user cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, engage and loyalty points.
display
array of object (DisplayBreakup)
List of breakup data which is used to display the breakup to the customer like MRP total, Discount, Sub total, coupon value, promotion value and final total.
Show
Display price breakup schema denotes price currency, key, value,message to display as breakup on UI.
currency_symbol
string
Currency symbol for the price.
key
string
Key of the price like total_mrp, total, subtotal etc.
display
string
Display key field that to be shown against the value.
message
array of string
List of message at price level to be displayed.
currency_code
string
Currency code for the price.
value
number
| float
Numeric value of the price.
preset
number
| float
Value for the price which is set from platform if applicable.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convenience fee, coupon amount, delivery charge, discount, loyalty points, engage points, gift card, gst charge, etc.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
subtotal
number
| float
Selling price amount of all products in cart.
engage_amount
number
| float
Engage amount applied on the cart.
engage_mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
fynd_cash
number
| float
Loyalty points applied on cart.
discount
number
| float
Discount amount received on cart.
convenience_fee
number
| float
Convenience fee amount applied to cart.
delivery_charge
number
| float
Delivery charge applied to cart.
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
total_charge
number
| float
Total amount of charges applied on cart.
coupon
number
| float
Coupon amount applied to cart.
total
number
| float
Total payable amount by the customer.
gift_card
number
| float
Gift cart amount applied on cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
coupon
object (CouponBreakup)
Show
Coupon price breakup details which includes coupon code, coupon type, coupon value, coupon description, coupn message etc.
coupon_value
number
| float
Value of the coupon applied to cart.
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
minimum_cart_value
number
| float
Minimum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
uid
string
Unique identifier of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
loyalty_points
object (LoyaltyPoints)
Show
Engage points data for the user cart.
total
number
| float
Total loyalty points available with user.
description
string
Description for loyalty points.
applicable
number
| float
Whether the loyalty points are applicable for the cart.
is_applied
boolean
Whether the loyalty points are applied on the cart.
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage discount amount applied on the cart as engage redeemed points can be set as discount or MOP from engage platform.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Formatted title that can be used by theme to display points earned by user for this cart.
title
string
Unique title for loyalty program applicable.
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
currency
object (CartCurrency)
Show
Currency data of the cart for prices.
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
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 (AlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
customer_id
string
Customer user id associated with cart
Examples
Parameters
id:
"value"
buy_now:
false
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
Response
Select payment mode
selectPaymentMode
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 available promotion offers
GET
# List ladder offers
GET
# Fetch available promotions payment offers
List all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period.
Parameters
slugquery
string
A short, human-readable, URL-friendly identifier of a product.
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 an array containing the available offers (if exists) on product via promotions. Refer `PromotionOffersResult` for more details.
Hide
Promotion offer response detail which incluedes available promotions list.
available_promotions
array of object (PromotionOffer)
Available promotion details which are available on product which includes promotion data like promotion id, promotion name, buy rules, discount rules validity dates etc.
Show
Promotion offer details includes promotion id, buy rules, offer text, promotion type, promotion name, promotion group, discount rules, free gift items list and promo description.
id
string
Promotion id of the promotion which is available on product.
buy_rules
object (BuyRuleItemCriteria)
Show
To the avialability of promotion, article rules criteria given
cart_quantity
object (CompareObject)
Show
Manage operator and their value for cart rules in promotion
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
available_zones
array of string
List of all zones on which promotion is applicable
item_exclude_company
array of integer
List of all company ids on which promotion is not applicable
item_id
array of integer
List of all item ids on which promotion is applicable
item_l1_category
array of integer
List of all L1 category on which promotion is applicable
cart_total
object (CompareObject)
Show
Manage operator and their value for cart rules in promotion
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_quantity
object (CompareObject)
Show
Manage operator and their value for cart rules in promotion
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_amount
object (CompareObject)
Show
Manage operator and their value for cart rules in promotion
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
item_exclude_id
array of integer
List of all item ids on which promotion is not applicable
all_items
boolean
Boolean flag set true to applicable the promotion for all products
item_exclude_l1_category
array of integer
List of all item ids on which promotion is not applicable
item_size
array of string
List of all item sizes on which promotion is applicable
item_store
array of integer
List of all store ids on which promotion is applicable
item_exclude_sku
array of string
List of all item sku on which promotion is not applicable
item_department
array of integer
List of all department ids on which promotion is applicable
item_exclude_store
array of integer
List of all store ids on which promotion is not applicable
item_brand
array of integer
List of all brand ids on which promotion is applicable
item_exclude_department
array of integer
List of all department ids on which promotion is not applicable
item_exclude_category
array of integer
List of all L3 category on which promotion is not applicable
item_category
array of integer
List of all L3 category on which promotion is applicable
buy_rules
array of string
List of buy rules that is applicable for this promotion
item_exclude_brand
array of integer
List of all brand ids on which promotion is not applicable
item_l2_category
array of integer
List of all L2 category on which promotion is applicable
item_company
array of integer
List of all company ids on which promotion is applicable
item_tags
array of string
List of all product tags on which promotion is applicable
item_exclude_l2_category
array of integer
List of all L2 category on which promotion is not applicable
item_sku
array of string
List of all item sku on which promotion is applicable
meta
object (ItemSizeMapping)
Show
Map size with product in promotion
item_size_mapping
object
Item size mapping in promotion i.e. item_id - [OS, L]
offer_text
string
Offer title of the promotion which is available on product.
promotion_type
string
Promotion type of the promotion which is availalbe on product.
Enum
promotion_name
string
Name of the promotion which is available on product.
promotion_group
string
Group of the promotion which is available on product.
valid_till
string
| date-time
Datetime ISO String for promotion end date which is available on product.
discount_rules
array of object (DiscountOfferRule)
Discount rules of promotions which is avaiable on product.
Show
Defines discount rule in a promotion, including offer configuration, item criteria, buy conditions, and computed values.
discount_type
string
Discount offer type of the promotion
Enum
offer
object (DiscountOffer)
Show
Specifies the configuration for discounts applicable under a promotion.
max_discount_amount
number
| float
Maximum discount amount in promotion
discount_price
number
| float
Discount price which is price after deducting discount amount in fixed price promotion
max_usage_per_transaction
integer
| int32
Maximum usage per transaction in promotion
discount_amount
number
| float
Discount amount in promotion
discount_percentage
number
| float
Discount percentage in promotion
min_offer_quantity
integer
| int32
Minimum quantity of offer in promotion
max_offer_quantity
integer
| int32
Maximum quantity of product in promotion
item_criteria
object (DiscountItemCriteria)
Show
Criteria for items that this discount rule applies to
item_store
array of integer
List of all item store ids on which promotion is applicable
item_company
array of integer
List of all company ids on which promotion is applicable
item_brand
array of integer
List of all brand ids on which promotion is applicable
item_exclude_brand
array of integer
List of all brand ids on which promotion is not applicable
item_category
array of integer
List of all L3 category on which promotion is applicable
item_exclude_category
array of integer
List of all L3 category on which promotion is not applicable
item_l1_category
array of integer
List of all L1 category on which promotion is applicable
item_exclude_l1_category
array of integer
List of all item ids on which promotion is not applicable
item_l2_category
array of integer
List of all L2 category on which promotion is applicable
item_exclude_l2_category
array of integer
List of all L2 category on which promotion is not applicable
item_department
array of integer
List of all departments ids on which promotion is applicable
item_exclude_department
array of integer
List of all department ids on which promotion is not applicable
item_id
array of integer
List of all item ids on which promotion is applicable
item_exclude_id
array of integer
List of all item ids on which promotion is not applicable
buy_rules
array of string
Buy rules that apply to this discount
available_zones
array of string
List of all zones ids on which promotion is applicable
product_tags
array of string
Product tags that qualify for the discount
all_items
boolean
Whether the discount applies to all items
buy_condition
string
Logical condition expression for buy rules
discounted_price
number
| float
Price of product after applying this discount rule of promotion. Note - returned only when store id is provided in request params.
matched_buy_rules
array of string
List of buy rules that are matching with item for this promotion
meta
object (ItemSizeMapping)
Show
Map size with product in promotion
item_size_mapping
object
Item size mapping in promotion i.e. item_id - [OS, L]
free_gift_items
array of object (FreeGiftItems)
Details of free gift items which included item id, brand name, item name, item slug, item price and item image url.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
description
string
Offer details including T&C of the promotion which is avaiable on product.
Examples
Parameters
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 available promotion offers
getPromotionOffers
Get ladder offers associated for the items in the cart. Ladder offers provide discounts or special pricing based on item quantity, allowing users to benefit from bulk purchases or promotional deals.
Parameters
slugquery
string
Required
A short, human-readable, URL-friendly identifier of a product.
store_idquery
string
Store uid of assigned store on PDP page. If not passed default first created ladder will be returned.
promotion_idquery
string
Get ladder information of given promotion id explicitely.
page_sizequery
integer
Number of offers to be fetched to show.
GET
Response
200
400
Success. Returns a object containing the applicable ladder price offers (if exists) on product. Refer `PromotionOffersResult` for more details.
Hide
Ladder price offers details which includes list of available ladder promotion on product.
available_offers
array of object (LadderPriceOffer)
Available ladder promotions offers list.
Show
Ladder price offer details which included promotion id, buy rules, calculate on, offer text, discount rules, promotion group, free gift items and description of promotion data.
id
string
ID of the promotion.
buy_rules
object
Buy rules of ladder price promotion applicable on product.
calculate_on
string
If this ladder offer is to be calculated on MRP or ESP price.
offer_text
string
Offer title of ladder price promotion applicable on product.
promotion_group
string
Group of ladder price promotion applicable on product.
valid_till
string
| date-time
Datetime ISO String for promotion end date.
discount_rules
array of object
Discount rules of ladder price promotion applicable on product.
offer_prices
array of object (LadderOfferItem)
Offer prices for ladder price promotion applicable on product.
Show
Ladder offer item details which includes price, margin, max quantity, min quantity and type.
price
object (LadderPrice)
Show
Ladder price details which includes currency symbol, offer price, currency code, effective and marked price.
currency_symbol
string
Currency symbol for currency of ladder price product.
offer_price
number
| float
Discounted per unit price for current offer object.
currency_code
string
Currency code for all amounts.
effective
integer
| int32
Current per unit price of product after existing deductions.
marked
integer
| int32
Original price of product.
margin
integer
| int32
Percentage value of discount.
max_quantity
integer
| int32
Minimum quantity upto which offer is applicable. If not present that offer is applicable on all quantities.
min_quantity
integer
| int32
Minimum quantity from which offer is applicable.
type
string
Offer type of the ladder promotion.
free_gift_items
array of object (FreeGiftItems)
Details of free gift items list.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
description
string
Offer details including T&C of ladder price promotion applicable on product.
currency
object (CurrencyInfo)
Show
Currency info details of ladder price which includes currency code and currency symbol.
code
string
Currency code of ladder price promotion.
symbol
string
Currency symbol for currency of ladder price product.
Examples
Parameters
slug:
"value"
store_id:
"value"
promotion_id:
"value"
page_size:
1
Response
List ladder offers
getLadderOffers
Use this API to get top 5 payment offers available for current product.
Parameters
idquery
string
Cart id of the user cart.
uidquery
integer
Cart uid of the user cart.
GET
Response
200
400
Success. Returns an array containing the available offers (if exists) on product via promotions. Refer `PromotionPaymentOffersResult` for more details.
Hide
Promotion payment offer response includes success flag and promotion list applicable.
success
boolean
Success flag of get payment offers API response.
promotions
array of object (PromotionPaymentOffer)
List of promotions data which are applicable on cart/product.
Show
Promotion payment offer details includes app id, buy rules, calculate on, discount rules etc.
application_id
string
Application id on which the promotion was created.
buy_rules
array of object
Buy rules of promotions which denotes if the rules matches than only promotion is applicable.
calculate_on
string
Article Price on which promotion calculated like effective price or marked price.
description
string
Offer details including T&C of the promotion which is avaiable on cart.
discount_rules
array of object
Discount rules of promotions which is avaiable on cart.
id
string
Promotion id of the promotion which is available on cart.
offer_text
string
Offer title of the promotion which is available on cart.
promotion_group
string
Group promotion which is available on cart.
promotion_type
string
Promotion type of the promotion which is availalbe on cart.
Enum
promotion_name
string
Name of the promotion which is available on cart.
Examples
Parameters
id:
"value"
uid:
1
Response
Fetch available promotions payment offers
getPromotionPaymentOffers
Reward points are incentives given to customers as part of a loyalty program or promotional campaign. Users accumulate reward points through various activities, such as making purchases, referring friends, or engaging with the platform. Reward points can be redeemed for discounts.
Operations
POST
# Use 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
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.
bodyrequestBody
object (RedeemLoyaltyPoints)
Required
Check the example shown below or refer `RedeemLoyaltyPoints` for more details.
Hide
Loyalty point request details.
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.
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
Get cart detail 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.
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
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment Default Selection Schema.
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
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
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc.
article
object (ProductArticle)
Show
Product store information of the product added in cart.
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article.
base
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
converted
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
product_group_tags
array of string
List fot the unique identifier for the product grouping.
extra_meta
object
Field to update extra meta of the article in cart.
quantity
integer
| int32
Quantity of the article added in cart.
_custom_json
object
Field to update custom json of the article in cart.
meta
object
Article meta data.
size
string
Size of the article added in cart.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
seller_identifier
string
List of identifiers used by sellers for the product size.
parent_item_identifiers
object
Fields to determine parent product of the product.
identifier
object
Unique identifier of the article.
store
object (StoreInfo)
Show
Store information of the store which includes store name, store id and store code.
store_code
string
A unique code or identifier for the store, often used for internal reference.
uid
integer
| int32
Unique identifiers of the store from where product is fulfilled.
name
string
Store name of the store from where the product is fulfilled.
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of delivery service.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
cart_item_meta
object
Meta details of the article added from cart.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
gift_card
object
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift.
is_gift_visible
boolean
Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
type
string
Type of the data sent in response. Possible value is article.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags.
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
promo_meta
object (PromoMeta)
Show
Loyalty points message data.
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
price
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
converted
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
quantity
integer
| int32
Quantity of the product added in cart.
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of value.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
out_of_stock
boolean
Denotes if the product is available in stock.
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not.
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability.
Show
Product sizes availability.
display
string
Display size of the product.
value
string
Actual value of the size.
is_available
boolean
Available flag for the size of the product if that is available.
is_valid
boolean
Valid flag for the product if the product added in cart is valid to place the order.
other_store_quantity
integer
| int32
Quantity of the product available on other store.
sizes
array of string
All sizes of the product.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categories, images, item code, tags, item id, item name, etc.
_custom_json
object
Field to add custom json of the product in cart.
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
action
object (ProductAction)
Show
Schema of Action Object to render the product.
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs.
product_slug
array of string
Contains list of product slug.
url
string
Url of the product to render the product
type
string
Type of action.
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart.
tags
object
Tags is a lable or batch that is attached to a product in cart.
slug
string
Unique product url name generated via product name and other meta data.
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url.
Show
Product images data in different formats.
secure_url
string
Secured url of the product image.
aspect_ratio
string
Aspect ratio of the product image.
url
string
Bucket link url for product image.
uid
integer
| int32
Unique identifier of the product in cart.
name
string
Product name of the product in cart which is defined on platform.
item_code
string
Nullable
Product code of the product while defining product on platform.
categories
array of object (CategoryInfo)
Product category information which incldes category name and category id.
Show
Category information schema which denotes category name and category id.
uid
integer
| int32
Product Category Id.
name
string
Category name of the product.
tags
array of string
Products tags that are added to each product to identify the set of products.
type
string
Type of product in cart.
attributes
object
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
coupon
object (CouponDetails)
Show
Coupon actual price breakup details.
discount_single_quantity
number
| float
Discount amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
custom_order
object
Whether MTO (Make to Order) is enabled or not.
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
key
string
The attribute key associated with the size.
message
string
Product level message which denotes error information to display over the product in cart.
is_set
boolean
Whether or not the product is a set of items.
price_per_unit
object (ProductPricePerUnitInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
converted
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Show
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
item_type
string
Type of the item in cart.
Enum
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
delivery_charge_info
string
Delivery charge in information message on shipment.
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config.
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag.
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold.
charges
number
| float
Charges amount to be applied on cart.
threshold
number
| float
Threshold of cart value on which the charge should be applied.
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value.
cashback_amount
number
| float
Fields denotes cashback amount applied to cart.
cashback_message_primary
string
Primary cashback message for coupon applied to cart.
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart.
coupon_code
string
Coupon code to be applied to cart.
coupon_description
string
Coupon description of the coupon applied to cart.
coupon_id
string
Unique identifier of the coupon applied to cart.
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart.
coupon_title
string
Coupon Title of the coupon applied.
coupon_type
string
Type of the coupon applied to cart.
coupon_value
number
| float
Value of the coupon applied to cart.
discount
number
| float
Total discount earned from coupon applied to cart.
is_applied
boolean
Flag to determine where the coupon is applied to cart or not.
is_valid
boolean
Determine where the coupon applied to cart is valid.
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
message
string
Coupon message of the coupon applied to cart.
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart.
message
string
Message of the get 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.
gstin
string
GSTIN added in user cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, engage and loyalty points.
display
array of object (DisplayBreakup)
List of breakup data which is used to display the breakup to the customer like MRP total, Discount, Sub total, coupon value, promotion value and final total.
Show
Display price breakup schema denotes price currency, key, value,message to display as breakup on UI.
currency_symbol
string
Currency symbol for the price.
key
string
Key of the price like total_mrp, total, subtotal etc.
display
string
Display key field that to be shown against the value.
message
array of string
List of message at price level to be displayed.
currency_code
string
Currency code for the price.
value
number
| float
Numeric value of the price.
preset
number
| float
Value for the price which is set from platform if applicable.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convenience fee, coupon amount, delivery charge, discount, loyalty points, engage points, gift card, gst charge, etc.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
subtotal
number
| float
Selling price amount of all products in cart.
engage_amount
number
| float
Engage amount applied on the cart.
engage_mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
fynd_cash
number
| float
Loyalty points applied on cart.
discount
number
| float
Discount amount received on cart.
convenience_fee
number
| float
Convenience fee amount applied to cart.
delivery_charge
number
| float
Delivery charge applied to cart.
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
total_charge
number
| float
Total amount of charges applied on cart.
coupon
number
| float
Coupon amount applied to cart.
total
number
| float
Total payable amount by the customer.
gift_card
number
| float
Gift cart amount applied on cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
coupon
object (CouponBreakup)
Show
Coupon price breakup details which includes coupon code, coupon type, coupon value, coupon description, coupn message etc.
coupon_value
number
| float
Value of the coupon applied to cart.
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
minimum_cart_value
number
| float
Minimum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
uid
string
Unique identifier of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
loyalty_points
object (LoyaltyPoints)
Show
Engage points data for the user cart.
total
number
| float
Total loyalty points available with user.
description
string
Description for loyalty points.
applicable
number
| float
Whether the loyalty points are applicable for the cart.
is_applied
boolean
Whether the loyalty points are applied on the cart.
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage discount amount applied on the cart as engage redeemed points can be set as discount or MOP from engage platform.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Formatted title that can be used by theme to display points earned by user for this cart.
title
string
Unique title for loyalty program applicable.
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
currency
object (CartCurrency)
Show
Currency data of the cart for prices.
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
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 (AlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
customer_id
string
Customer user id associated with cart
Examples
Parameters
id:
"value"
i:
false
b:
false
buy_now:
false
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
Response
Use loyalty points
applyLoyaltyPoints
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 Digital) and other shipment meta information. Additionally, it provides details about the items included in the shipment.
Operations
GET
# List shipments
Get shipment details for the items in a cart, specific to the selected address. Shipment details include delivery promises, seller information, item details, and other relevant information.
Parameters
pquery
boolean
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.
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. Digital - If the customer wants to buy digital voucher ( for jiogames ).
Enum
GET
Response
200
Success. Returns delivery promise along with shipment details and price breakup. Refer `CartShipmentsResult` for more details.
Hide
Cart shipment response schema for get shipments API.
delivery_charge_info
string
Delivery charge in information message on shipment.
checkout_mode
string
Checkout mode of cart.
message
string
Result message of get shipments API.
gstin
string
GSTIN number added in cart.
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
cart_id
integer
| int32
Cart id of the user cart.
is_valid
boolean
Cart validity flag determines if the response is valid or not.
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, engage and loyalty points.
display
array of object (DisplayBreakup)
List of breakup data which is used to display the breakup to the customer like MRP total, Discount, Sub total, coupon value, promotion value and final total.
Show
Display price breakup schema denotes price currency, key, value,message to display as breakup on UI.
currency_symbol
string
Currency symbol for the price.
key
string
Key of the price like total_mrp, total, subtotal etc.
display
string
Display key field that to be shown against the value.
message
array of string
List of message at price level to be displayed.
currency_code
string
Currency code for the price.
value
number
| float
Numeric value of the price.
preset
number
| float
Value for the price which is set from platform if applicable.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convenience fee, coupon amount, delivery charge, discount, loyalty points, engage points, gift card, gst charge, etc.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
subtotal
number
| float
Selling price amount of all products in cart.
engage_amount
number
| float
Engage amount applied on the cart.
engage_mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
fynd_cash
number
| float
Loyalty points applied on cart.
discount
number
| float
Discount amount received on cart.
convenience_fee
number
| float
Convenience fee amount applied to cart.
delivery_charge
number
| float
Delivery charge applied to cart.
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
total_charge
number
| float
Total amount of charges applied on cart.
coupon
number
| float
Coupon amount applied to cart.
total
number
| float
Total payable amount by the customer.
gift_card
number
| float
Gift cart amount applied on cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
coupon
object (CouponBreakup)
Show
Coupon price breakup details which includes coupon code, coupon type, coupon value, coupon description, coupn message etc.
coupon_value
number
| float
Value of the coupon applied to cart.
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
minimum_cart_value
number
| float
Minimum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
uid
string
Unique identifier of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
loyalty_points
object (LoyaltyPoints)
Show
Engage points data for the user cart.
total
number
| float
Total loyalty points available with user.
description
string
Description for loyalty points.
applicable
number
| float
Whether the loyalty points are applicable for the cart.
is_applied
boolean
Whether the loyalty points are applied on the cart.
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage discount amount applied on the cart as engage redeemed points can be set as discount or MOP from engage platform.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Formatted title that can be used by theme to display points earned by user for this cart.
title
string
Unique title for loyalty program applicable.
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
currency
object (CartCurrency)
Show
Currency data of the cart for prices.
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
id
string
Cart id of the user cart.
shipments
array of object (ShipmentResult)
List of Shipments which includes shipment data like shipment items, shipment promise, Shipment type, shipment order type, shipment dp options etc.
Show
Shipment Result details of the cart which how many shipments will be shipped for the items in cart and gives information about box type, order type, promise of each shipment and delivery partner details.
shipments
integer
| int32
Count of shipments that will be shipped.
Default Value : 1
promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
order_type
string
Order type of the shipment like pickAtStore or HomeDelivery.
Enum
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
Default Value : null
shipment_type
string
Shipment type of the shipment returned in get shipments API like single_shipment or multiple shipment. Single Shipment means 1 item in 1 shipment and vice versa in the other one.
dp_options
object
Nullable
Delivery partner options that are available to deliver the shipment.
Default Value : null
dp_id
string
Nullable
Delivery partner id of the shipment.
Default Value : null
items
array of object (CartProductInfo)
Item details in the shipment.
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc.
article
object (ProductArticle)
Show
Product store information of the product added in cart.
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article.
base
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
converted
object (BasePrice)
Show
Base price information like currency code, currency symbol, effective and marked, selling prices.
effective
number
| float
Current per unit price of product after existing deductions.
currency_symbol
string
Currency symbol of the currency used for price.
marked
number
| float
Original price of product.
currency_code
string
Currency code for all amounts.
product_group_tags
array of string
List fot the unique identifier for the product grouping.
extra_meta
object
Field to update extra meta of the article in cart.
quantity
integer
| int32
Quantity of the article added in cart.
_custom_json
object
Field to update custom json of the article in cart.
meta
object
Article meta data.
size
string
Size of the article added in cart.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
seller_identifier
string
List of identifiers used by sellers for the product size.
parent_item_identifiers
object
Fields to determine parent product of the product.
identifier
object
Unique identifier of the article.
store
object (StoreInfo)
Show
Store information of the store which includes store name, store id and store code.
store_code
string
A unique code or identifier for the store, often used for internal reference.
uid
integer
| int32
Unique identifiers of the store from where product is fulfilled.
name
string
Store name of the store from where the product is fulfilled.
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of delivery service.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
cart_item_meta
object
Meta details of the article added from cart.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
gift_card
object
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift.
is_gift_visible
boolean
Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
type
string
Type of the data sent in response. Possible value is article.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags.
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart.
identifier
string
Article idenfier generated by cart.
promo_meta
object (PromoMeta)
Show
Loyalty points message data.
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
price
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
converted
object (ProductPrice)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
marked
number
| float
Original MRP of product.
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
quantity
integer
| int32
Quantity of the product added in cart.
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of value.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
out_of_stock
boolean
Denotes if the product is available in stock.
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not.
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability.
Show
Product sizes availability.
display
string
Display size of the product.
value
string
Actual value of the size.
is_available
boolean
Available flag for the size of the product if that is available.
is_valid
boolean
Valid flag for the product if the product added in cart is valid to place the order.
other_store_quantity
integer
| int32
Quantity of the product available on other store.
sizes
array of string
All sizes of the product.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categories, images, item code, tags, item id, item name, etc.
_custom_json
object
Field to add custom json of the product in cart.
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity.
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Name of entities like brand or seller.
action
object (ProductAction)
Show
Schema of Action Object to render the product.
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs.
product_slug
array of string
Contains list of product slug.
url
string
Url of the product to render the product
type
string
Type of action.
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart.
tags
object
Tags is a lable or batch that is attached to a product in cart.
slug
string
Unique product url name generated via product name and other meta data.
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url.
Show
Product images data in different formats.
secure_url
string
Secured url of the product image.
aspect_ratio
string
Aspect ratio of the product image.
url
string
Bucket link url for product image.
uid
integer
| int32
Unique identifier of the product in cart.
name
string
Product name of the product in cart which is defined on platform.
item_code
string
Nullable
Product code of the product while defining product on platform.
categories
array of object (CategoryInfo)
Product category information which incldes category name and category id.
Show
Category information schema which denotes category name and category id.
uid
integer
| int32
Product Category Id.
name
string
Category name of the product.
tags
array of string
Products tags that are added to each product to identify the set of products.
type
string
Type of product in cart.
attributes
object
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
coupon
object (CouponDetails)
Show
Coupon actual price breakup details.
discount_single_quantity
number
| float
Discount amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
custom_order
object
Whether MTO (Make to Order) is enabled or not.
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
key
string
The attribute key associated with the size.
message
string
Product level message which denotes error information to display over the product in cart.
is_set
boolean
Whether or not the product is a set of items.
price_per_unit
object (ProductPricePerUnitInfo)
Show
Price of single quantity product for seller currency and customer currency.
base
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
converted
object (ProductPricePerUnit)
Show
Per quantity price of the product.
currency_symbol
string
Currency symbol of the price defined for the product.
selling_price
number
| float
Selling price of the product.
currency_code
string
Currency code of the price defined for the product.
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
effective
number
| float
Selling price of the product.
marked
number
| float
Maximum price of the product.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Show
Fields to determine the applied promotions details on a product.
promo_id
string
Promotion id.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Show
Rules of promotion which must be satisfied for the promotion to be applied.
item_criteria
object
Item criteria of promotion.
cart_conditions
object
Cart conditions details for promotion.
offer_text
string
Offer text of current promotion.
offer_label
string
Offer label of the applied promotion, to be used as display text.
promotion_group
string
Promotion group for the promotion.
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_name
string
Promotion name of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Show
Discount rules of the promotion.
matched_buy_rules
array of string
Matched buy rules for promotion.
raw_offer
object
Raw offer details for promotion.
offer
object
Offer for promotion.
item_criteria
object
Item criteria of promotion.
ownership
object (Ownership)
Ownership of promotion.
Show
Ownership details of the promotion who burns the cash.
payable_category
string
Promotion amount payable category.
payable_by
string
Promotion amount bearable party.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Show
Fields to determine the free gift items to be received from the promotion applied.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
Show
Details of free gift items which are received via promotion.
item_slug
string
Slug for an item.
item_name
string
Name of the free gift item received via free gift promotion.
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency.
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article.
min
number
| float
Min price of article added in user cart.
max
number
| float
Max price of article added in user cart.
currency
string
Currency of the article added in cart.
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Item brand name of the free gift item promotion applied on cart.
item_id
integer
| int32
Item id of the free gift item.
available_sizes
array of string
Available sizes for the free gift item.
size
string
Selected size for the free gift item.
item_images_url
array of string
Images URLs for free gift items.
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
promotion_type
string
Promotion type of current promotion.
Enum
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
item_type
string
Type of the item in cart.
Enum
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
fulfillment_type
string
Fulfillment type of shipment.
fulfillment_id
integer
| int32
Fulfillment id of the shipment.
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of delivery service.
Enum
name
string
Name of the delivery service.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment Default Selection Schema.
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
coupon_text
string
Coupon text of coupon applied on cart.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format.
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp.
max
string
Maximum Delivery promise formatted timestamp.
min
string
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times.
max
number
| float
Maximum Promise for the shipment.
min
number
| float
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
error
boolean
Error details if any error occurs which includes type of error, error code and error message.
comment
string
Comment message added in cart.
buy_now
boolean
Buy now flag of user cart.
uid
string
Cart id of the user cart.
custom_cart_meta
object
Custom meta details added cart checkout API payload.
customer_id
string
Customer user id associated with cart
Examples
Parameters
Parameters are not required.
Response