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
# Retrieve cart details.
HEAD
# Get last modified timestamp of a cart
POST
# Add items to a cart
PUT
# Update items in the cart
PUT
# Clears the cart
GET
# Count cart items.
GET
# Count items in the cart according to cart_type
PUT
# Update cart metadata.
POST
# Create share cart link
GET
# List shared cart items
POST
# Update with shared items
GET
# Get cart configuration
GET
# Get cart configuration by id
POST
# Add items to a cart
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
id
string
The unique identifier of the cart.
i
boolean
Select `true` to retrieve all the items added in the cart.
b
boolean
Select `true` to retrieve the price breakup of cart items.
c
boolean
Select `true` to retrieve the cod charges in breakup of cart items.
assign_card_id
integer
Token of user's debit or credit card.
area_code
string
Customer servicable area_code.
buy_now
boolean
Select `true` to set/initialize buy now cart.
cart_type
string
The type of cart
Enum
order_type
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
Response
200
Success. Returns a Cart object. Check the example shown below or refer `CartDetailResult` for more details.
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart.
uid
string
Unique identifier of the user cart.
coupon_text
string
Coupon text of coupon applied on cart.
id
string
Unique identifier of the user cart.
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
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.
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart.
product
object (CartProduct)
CartProduct
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.
Array of ProductImage
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.
teaser_tag
object
Nullable
Teaser tag or short promotional phrase for the product.
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
action
object (ProductAction)
ProductAction
query
object (ActionQuery)
ActionQuery
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)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart.
tags
array of string
Nullable
Products tags that are added to each product to identify the set of products.
_custom_json
object
Field to add custom json of the product in cart.
type
string
Nullable
Type of 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.
Array of CategoryInfo
uid
integer
| int32
Product Category Id.
name
string
Category name of the product .
attributes
object
Nullable
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
is_set
boolean
Nullable
Whether or not the product is a set of items.
article
object (ProductArticle)
ProductArticle
seller_identifier
string
Nullable
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart.
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
cart_item_meta
object
Meta details of the article added from cart.
parent_item_identifiers
object
Fields to determine parent product of the product.
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.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
gift_card
object (ArticleGiftCard)
ArticleGiftCard
gift_price
number
| float32
Gift price amount applied on article.
display_text
string
Nullable
A gift message for the recipient to be included with the delivery of the order.
gift_message
string
Gift message for the one while receive the delivery of the order with this message.
is_gift_applied
boolean
A flag indicating if the order is a gift.
product_group_tags
array of string
Nullable
List fot the unique identifier for the product grouping.
identifier
object
Nullable
Unique identifier of the article.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
extra_meta
object
Field to update extra meta of the article in cart.
type
string
Type of the data sent in response. Possible value is article.
Enum
_custom_json
object
Field to update custom json of the article in cart.
price
object (ArticlePriceInfo)
ArticlePriceInfo
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
meta
object
Article meta data.
size
string
Size of the article added in cart.
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld.
name
string
Nullable
Store name of the store from where the product is fulfiled .
store_code
string
Nullable
A unique code or identifier for the store, often used for internal reference.
tags
array of string
A list of article tags.
variants
object
Product variant responses, each detailing a specific variant.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
Min Promise in ISO format.
key
string
The attribute key associated with the size.
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
discount_single_quantity
number
| float
Discout amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
price_adjustment_applied
array of object (ArticleAppliedPriceAdjustment)
Array of ArticleAppliedPriceAdjustment
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
article_id
string
Article Id of product.
applied_quantity
integer
| int32
Article quantity on which this price adjusment applied.
meta
object
Meta data added in article of price adjustment.
price
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart.
message
string
Product level message which denotes error information to display over the product in cart.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
ProductAvailability
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.
Array of ProductAvailabilitySize
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.
moq
object (CartItemMOQ)
CartItemMOQ
increment_unit
number
| int32
Nullable
maximum
number
| int32
Nullable
minimum
number
| int32
Nullable
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
custom_order
object (CartItemCustomOrder)
CartItemCustomOrder
is_custom_order
boolean
manufacturing_time
number
| int32
manufacturing_time_unit
string
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Array of Charges
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
ChargesAmount
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of 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.
seller_count
number
Number of sellers offering the product.
allow_remove
boolean
If true, the product is allowed to be removed from the cart.
auto_add_to_cart
boolean
In case of bundle product this product is automatically added with parent product if true.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_charge_info
string
Delivery charge information message of the shipment.
common_config
object (CartCommonConfig)
CartCommonConfig
delivery_charges_config
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Array of ChargesThreshold
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)
CartDetailCoupon
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
Nullable
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.
medias
array of object (CartCouponMedias)
Array of CartCouponMedias
alt
string
url
string
type
string
key
string
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
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.
breakup_values
object (CartBreakup)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
uid
string
Nullable
Unique identifier of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
coupon_value
number
| float
Value of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
minimum_cart_value
number
| float
Minumum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
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.
Array of DisplayBreakup
key
string
Key of the price like total_mrp, total, subtotal etc.
value
number
| float
Numeric value of the price.
currency_code
string
Currency code for the price .
currency_symbol
string
Currency symbol for the price.
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.
original
number
| float32
attr
string
meta
object
preset
number
Value for the price which is set from platform if applicable.
loyalty_points
object (LoyaltyPoints)
LoyaltyPoints
is_applied
boolean
Nullable
Whether the loyalty points are applied on the cart .
total
number
| float
Nullable
Total loyalty points available with user.
applicable
number
| float
Nullable
Whether the loyalty points are applicable for the cart .
description
string
Nullable
Description for loyalty points.
message
string
Nullable
raw
object (RawBreakup)
RawBreakup
promotion
number
| float
coupon
number
| float
Coupon amount 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.
fynd_cash
number
| float
Loyalty points applied on cart.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
gift_card
number
| float
Gift cart amount applied on cart.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
total
number
| float
Total payable amount by the customer.
discount
number
| float
Discount amount recieved on cart.
delivery_charge
number
| float
Delivery charge applied to cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
subtotal
number
| float
Selling price amount of all products in cart.
sub_total
number
| float
convenience_fee
number
| float
Convenience fee amount applied to cart.
total_charge
number
| float
Total amount of charges applied on cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
checkout_mode
string
Checkout mode of user cart.
last_modified
string
Last modified timestamp of cart.
price_adjustment_applied
array of object (CartAppliedPriceAdjustment)
Array of CartAppliedPriceAdjustment
remove_articles
boolean
Boolean value indicating if articles should be removed from cart.
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
auto_remove
boolean
Boolean value indicating if auto remove is enabled.
applied_articles_ids
array of string
List of article IDs where the adjustment is applied.
message
string
Message associated with the Price adjustment.
_type
string
Type of the Price Adjustment.
Enum
meta
object
Meta data added in article of price adjustment.
restrictions
object
It contains all the restrictions applied on price adjustments.
_id
string
ID of the price Adjustment.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
gstin
string
Nullable
GSTIN added in 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.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
pan_no
string
Nullable
Permanent Account Number of the user.
custom_cart
object (CustomCart)
CustomCart
id
string
Id of custom cart config.
cart_name
string
Name of custom cart.
cart_type
string
Type of custom cart.
is_universal
boolean
By default all carts are universal, will be false for custom cart.
is_pan_received
boolean
If the customer provides a PAN number, set it to true.
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 .
Examples
Parameters
id:
"65c06fe589db42581e4be72e"
i:
"true"
b:
"true"
area_code:
"400093"
Was this section helpful?
GET
Response
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
id
string
The unique identifier of the cart.
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"
Was this section helpful?
HEAD
Response
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
i
boolean
Select `true` to retrieve all the items added in the cart.
b
boolean
Select `true` to retrieve the price breakup of cart items.
area_code
string
Customer servicable area_code.
buy_now
boolean
Select `true` to set/initialize buy now cart.
id
string
The unique identifier of the cart.
cart_type
string
The type of cart
Enum
order_type
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
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.
Array of AddProductCart
quantity
integer
| int32
Field to specify the product quantity that user wants to buy.
item_size
string
Field to determine size of the product.
seller_id
integer
| int32
Unique idetifier of the seller selected by the user from which user want to buy a product .
price_factory_type_id
string
parent_item_identifiers
array of object
Fields to determine parent product of the product.
product_group_tags
array of string
Field to specify the product groups of the product that the user is trying to add in cart.
article_id
string
Unique identifier of an article .
article_assignment
object (ArticleAssignment)
ArticleAssignment
level
string
strategy
string
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 .
item_id
integer
| int32
Unique identifier to identify product.
extra_meta
object
Extra meta data to be added at article level while add items to cart.
_custom_json
object
Field to add custom json at article level while add items to cart .
meta
object
Field to add meta data at article level.
pos
boolean
Filed to determine whether user is making request from pos or not.
seller_identifier
string
Add items using seller identifier for store os.
new_cart
boolean
Field to create to new cart whille user adds item to cart.
Response
200
Success. Returns a cart object as shown below. Refer `AddCartDetailResult` for more details.
AddCartDetailResult
success
boolean
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResult)
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart.
uid
string
Unique identifier of the user cart.
coupon_text
string
Coupon text of coupon applied on cart.
id
string
Unique identifier of the user cart.
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
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.
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart.
product
object (CartProduct)
CartProduct
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.
Array of ProductImage
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.
teaser_tag
object
Nullable
Teaser tag or short promotional phrase for the product.
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
action
object (ProductAction)
ProductAction
query
object (ActionQuery)
ActionQuery
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)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart.
tags
array of string
Nullable
Products tags that are added to each product to identify the set of products.
_custom_json
object
Field to add custom json of the product in cart.
type
string
Nullable
Type of 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.
Array of CategoryInfo
uid
integer
| int32
Product Category Id.
name
string
Category name of the product .
attributes
object
Nullable
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
is_set
boolean
Nullable
Whether or not the product is a set of items.
article
object (ProductArticle)
ProductArticle
seller_identifier
string
Nullable
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart.
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
cart_item_meta
object
Meta details of the article added from cart.
parent_item_identifiers
object
Fields to determine parent product of the product.
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.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
gift_card
object (ArticleGiftCard)
ArticleGiftCard
gift_price
number
| float32
Gift price amount applied on article.
display_text
string
Nullable
A gift message for the recipient to be included with the delivery of the order.
gift_message
string
Gift message for the one while receive the delivery of the order with this message.
is_gift_applied
boolean
A flag indicating if the order is a gift.
product_group_tags
array of string
Nullable
List fot the unique identifier for the product grouping.
identifier
object
Nullable
Unique identifier of the article.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
extra_meta
object
Field to update extra meta of the article in cart.
type
string
Type of the data sent in response. Possible value is article.
Enum
_custom_json
object
Field to update custom json of the article in cart.
price
object (ArticlePriceInfo)
ArticlePriceInfo
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
meta
object
Article meta data.
size
string
Size of the article added in cart.
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld.
name
string
Nullable
Store name of the store from where the product is fulfiled .
store_code
string
Nullable
A unique code or identifier for the store, often used for internal reference.
tags
array of string
A list of article tags.
variants
object
Product variant responses, each detailing a specific variant.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
Min Promise in ISO format.
key
string
The attribute key associated with the size.
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
discount_single_quantity
number
| float
Discout amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
price_adjustment_applied
array of object (ArticleAppliedPriceAdjustment)
Array of ArticleAppliedPriceAdjustment
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
article_id
string
Article Id of product.
applied_quantity
integer
| int32
Article quantity on which this price adjusment applied.
meta
object
Meta data added in article of price adjustment.
price
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart.
message
string
Product level message which denotes error information to display over the product in cart.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
ProductAvailability
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.
Array of ProductAvailabilitySize
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.
moq
object (CartItemMOQ)
CartItemMOQ
increment_unit
number
| int32
Nullable
maximum
number
| int32
Nullable
minimum
number
| int32
Nullable
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
custom_order
object (CartItemCustomOrder)
CartItemCustomOrder
is_custom_order
boolean
manufacturing_time
number
| int32
manufacturing_time_unit
string
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Array of Charges
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
ChargesAmount
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of 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.
seller_count
number
Number of sellers offering the product.
allow_remove
boolean
If true, the product is allowed to be removed from the cart.
auto_add_to_cart
boolean
In case of bundle product this product is automatically added with parent product if true.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_charge_info
string
Delivery charge information message of the shipment.
common_config
object (CartCommonConfig)
CartCommonConfig
delivery_charges_config
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Array of ChargesThreshold
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)
CartDetailCoupon
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
Nullable
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.
medias
array of object (CartCouponMedias)
Array of CartCouponMedias
alt
string
url
string
type
string
key
string
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
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.
breakup_values
object (CartBreakup)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
uid
string
Nullable
Unique identifier of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
coupon_value
number
| float
Value of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
minimum_cart_value
number
| float
Minumum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
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.
Array of DisplayBreakup
key
string
Key of the price like total_mrp, total, subtotal etc.
value
number
| float
Numeric value of the price.
currency_code
string
Currency code for the price .
currency_symbol
string
Currency symbol for the price.
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.
original
number
| float32
attr
string
meta
object
preset
number
Value for the price which is set from platform if applicable.
loyalty_points
object (LoyaltyPoints)
LoyaltyPoints
is_applied
boolean
Nullable
Whether the loyalty points are applied on the cart .
total
number
| float
Nullable
Total loyalty points available with user.
applicable
number
| float
Nullable
Whether the loyalty points are applicable for the cart .
description
string
Nullable
Description for loyalty points.
message
string
Nullable
raw
object (RawBreakup)
RawBreakup
promotion
number
| float
coupon
number
| float
Coupon amount 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.
fynd_cash
number
| float
Loyalty points applied on cart.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
gift_card
number
| float
Gift cart amount applied on cart.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
total
number
| float
Total payable amount by the customer.
discount
number
| float
Discount amount recieved on cart.
delivery_charge
number
| float
Delivery charge applied to cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
subtotal
number
| float
Selling price amount of all products in cart.
sub_total
number
| float
convenience_fee
number
| float
Convenience fee amount applied to cart.
total_charge
number
| float
Total amount of charges applied on cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
checkout_mode
string
Checkout mode of user cart.
last_modified
string
Last modified timestamp of cart.
price_adjustment_applied
array of object (CartAppliedPriceAdjustment)
Array of CartAppliedPriceAdjustment
remove_articles
boolean
Boolean value indicating if articles should be removed from cart.
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
auto_remove
boolean
Boolean value indicating if auto remove is enabled.
applied_articles_ids
array of string
List of article IDs where the adjustment is applied.
message
string
Message associated with the Price adjustment.
_type
string
Type of the Price Adjustment.
Enum
meta
object
Meta data added in article of price adjustment.
restrictions
object
It contains all the restrictions applied on price adjustments.
_id
string
ID of the price Adjustment.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
gstin
string
Nullable
GSTIN added in 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.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
pan_no
string
Nullable
Permanent Account Number of the user.
custom_cart
object (CustomCart)
CustomCart
id
string
Id of custom cart config.
cart_name
string
Name of custom cart.
cart_type
string
Type of custom cart.
is_universal
boolean
By default all carts are universal, will be false for custom cart.
is_pan_received
boolean
If the customer provides a PAN number, set it to true.
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 .
partial
boolean
When adding multiple items check if all added. True if only few are added.
message
string
Message of add to cart API response.
result
object
Examples
Parameters
i:
"true"
area_code:
"400093"
id:
"65c06fe589db42581e4be72e"
body:
body
Was this section helpful?
POST
Response
Update cart. Customers can modify added product attributes such as quantity and size, as well as remove items from the cart.
Parameters
id
string
The unique identifier of the cart.
i
boolean
Select `true` to retrieve all the items added in the cart.
b
boolean
Select `true` to retrieve the price breakup of cart items.
area_code
string
Customer servicable area_code.
buy_now
boolean
Select `true` to set/initialize buy now cart.
cart_type
string
The type of cart.
Enum
order_type
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
Request body
items
array of object (UpdateProductCart)
List items data that needs to be updated in cart.
Array of UpdateProductCart
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.
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
CartProductIdentifer
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.
price_factory_type_id
string
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.
free_gift_items
array of object (FreeGiftItemCreation)
List of free gift items with updated sizes.
Array of FreeGiftItemCreation
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
Response
200
Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResult` for more details.
UpdateCartDetailResult
message
string
Message of update cart API response.
result
object
cart
object (CartDetailResult)
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart.
uid
string
Unique identifier of the user cart.
coupon_text
string
Coupon text of coupon applied on cart.
id
string
Unique identifier of the user cart.
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
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.
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart.
product
object (CartProduct)
CartProduct
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.
Array of ProductImage
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.
teaser_tag
object
Nullable
Teaser tag or short promotional phrase for the product.
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
action
object (ProductAction)
ProductAction
query
object (ActionQuery)
ActionQuery
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)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart.
tags
array of string
Nullable
Products tags that are added to each product to identify the set of products.
_custom_json
object
Field to add custom json of the product in cart.
type
string
Nullable
Type of 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.
Array of CategoryInfo
uid
integer
| int32
Product Category Id.
name
string
Category name of the product .
attributes
object
Nullable
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
is_set
boolean
Nullable
Whether or not the product is a set of items.
article
object (ProductArticle)
ProductArticle
seller_identifier
string
Nullable
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart.
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
cart_item_meta
object
Meta details of the article added from cart.
parent_item_identifiers
object
Fields to determine parent product of the product.
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.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
gift_card
object (ArticleGiftCard)
ArticleGiftCard
gift_price
number
| float32
Gift price amount applied on article.
display_text
string
Nullable
A gift message for the recipient to be included with the delivery of the order.
gift_message
string
Gift message for the one while receive the delivery of the order with this message.
is_gift_applied
boolean
A flag indicating if the order is a gift.
product_group_tags
array of string
Nullable
List fot the unique identifier for the product grouping.
identifier
object
Nullable
Unique identifier of the article.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
extra_meta
object
Field to update extra meta of the article in cart.
type
string
Type of the data sent in response. Possible value is article.
Enum
_custom_json
object
Field to update custom json of the article in cart.
price
object (ArticlePriceInfo)
ArticlePriceInfo
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
meta
object
Article meta data.
size
string
Size of the article added in cart.
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld.
name
string
Nullable
Store name of the store from where the product is fulfiled .
store_code
string
Nullable
A unique code or identifier for the store, often used for internal reference.
tags
array of string
A list of article tags.
variants
object
Product variant responses, each detailing a specific variant.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
Min Promise in ISO format.
key
string
The attribute key associated with the size.
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
discount_single_quantity
number
| float
Discout amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
price_adjustment_applied
array of object (ArticleAppliedPriceAdjustment)
Array of ArticleAppliedPriceAdjustment
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
article_id
string
Article Id of product.
applied_quantity
integer
| int32
Article quantity on which this price adjusment applied.
meta
object
Meta data added in article of price adjustment.
price
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart.
message
string
Product level message which denotes error information to display over the product in cart.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
ProductAvailability
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.
Array of ProductAvailabilitySize
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.
moq
object (CartItemMOQ)
CartItemMOQ
increment_unit
number
| int32
Nullable
maximum
number
| int32
Nullable
minimum
number
| int32
Nullable
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
custom_order
object (CartItemCustomOrder)
CartItemCustomOrder
is_custom_order
boolean
manufacturing_time
number
| int32
manufacturing_time_unit
string
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Array of Charges
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
ChargesAmount
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of 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.
seller_count
number
Number of sellers offering the product.
allow_remove
boolean
If true, the product is allowed to be removed from the cart.
auto_add_to_cart
boolean
In case of bundle product this product is automatically added with parent product if true.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_charge_info
string
Delivery charge information message of the shipment.
common_config
object (CartCommonConfig)
CartCommonConfig
delivery_charges_config
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Array of ChargesThreshold
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)
CartDetailCoupon
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
Nullable
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.
medias
array of object (CartCouponMedias)
Array of CartCouponMedias
alt
string
url
string
type
string
key
string
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
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.
breakup_values
object (CartBreakup)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
uid
string
Nullable
Unique identifier of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
coupon_value
number
| float
Value of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
minimum_cart_value
number
| float
Minumum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
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.
Array of DisplayBreakup
key
string
Key of the price like total_mrp, total, subtotal etc.
value
number
| float
Numeric value of the price.
currency_code
string
Currency code for the price .
currency_symbol
string
Currency symbol for the price.
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.
original
number
| float32
attr
string
meta
object
preset
number
Value for the price which is set from platform if applicable.
loyalty_points
object (LoyaltyPoints)
LoyaltyPoints
is_applied
boolean
Nullable
Whether the loyalty points are applied on the cart .
total
number
| float
Nullable
Total loyalty points available with user.
applicable
number
| float
Nullable
Whether the loyalty points are applicable for the cart .
description
string
Nullable
Description for loyalty points.
message
string
Nullable
raw
object (RawBreakup)
RawBreakup
promotion
number
| float
coupon
number
| float
Coupon amount 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.
fynd_cash
number
| float
Loyalty points applied on cart.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
gift_card
number
| float
Gift cart amount applied on cart.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
total
number
| float
Total payable amount by the customer.
discount
number
| float
Discount amount recieved on cart.
delivery_charge
number
| float
Delivery charge applied to cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
subtotal
number
| float
Selling price amount of all products in cart.
sub_total
number
| float
convenience_fee
number
| float
Convenience fee amount applied to cart.
total_charge
number
| float
Total amount of charges applied on cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
checkout_mode
string
Checkout mode of user cart.
last_modified
string
Last modified timestamp of cart.
price_adjustment_applied
array of object (CartAppliedPriceAdjustment)
Array of CartAppliedPriceAdjustment
remove_articles
boolean
Boolean value indicating if articles should be removed from cart.
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
auto_remove
boolean
Boolean value indicating if auto remove is enabled.
applied_articles_ids
array of string
List of article IDs where the adjustment is applied.
message
string
Message associated with the Price adjustment.
_type
string
Type of the Price Adjustment.
Enum
meta
object
Meta data added in article of price adjustment.
restrictions
object
It contains all the restrictions applied on price adjustments.
_id
string
ID of the price Adjustment.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
gstin
string
Nullable
GSTIN added in 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.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
pan_no
string
Nullable
Permanent Account Number of the user.
custom_cart
object (CustomCart)
CustomCart
id
string
Id of custom cart config.
cart_name
string
Name of custom cart.
cart_type
string
Type of custom cart.
is_universal
boolean
By default all carts are universal, will be false for custom cart.
is_pan_received
boolean
If the customer provides a PAN number, set it to true.
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 .
success
boolean
True if all items are added successfully. False if partially added or not added.
Examples
Parameters
id:
"65c06fe589db42581e4be72e"
i:
"true"
area_code:
"400093"
body:
body
Was this section helpful?
PUT
Response
Delete all items from the user's cart and resets it to its initial state, providing a clean slate for new selections.
Parameters
id
string
The unique identifier of the cart.
cart_type
string
The type of cart
Enum
Request body
cart_id_list
array of string
Response
200
Success. Returns whether the cart has been deleted or not.
DeleteCartDetailResult
message
string
Message for delete cart response.
success
boolean
True if cart is archived successfully. False if not archived.
Examples
Parameters
id:
"64aed3775b8d4da351584fa2"
body:
body
Was this section helpful?
PUT
Response
Parameters
id
string
The unique identifier of the cart.
buy_now
boolean
Boolean value to get buy_now cart.
Response
200
Success. Returns the total count of items in a user's cart.
CartItemCountResult
user_cart_items_count
integer
| int32
Item count present in cart.
Examples
Parameters
id:
"65c06fe589db42581e4be72e"
Was this section helpful?
GET
Response
Use this API to get the total number of items present in cart.
Parameters
id
string
The unique identifier of the cart
buy_now
boolean
Boolean value to get buy_now cart
Response
200
Success. Returns the total count of items in a user's cart.
CartItemCountResultV2
user_all_cart_articles_quantity_count
integer
| int32
user_all_cart_article_count
integer
| int32
custom_cart_count
object
custom_cart_ordered_count
array of object
Examples
Parameters
id:
"65c06fe589db42581e4be72e"
Was this section helpful?
GET
Response
Update metadata associated with a cart, which includes customer preferences, delivery instructions, or any special requirements related to the cart items.
Parameters
id
string
The unique identifier of the cart.
buy_now
boolean
Whether to get buy_now cart.
Request body
gstin
string
GSTIN number to be added in user cart.
pick_up_customer_details
object
Customer contact details for customer pickup at store.
checkout_mode
string
Checkout mode of user cart.
gift_details
object
Nullable
Gift details is open json which can include gift message .
pan_no
string
Nullable
comment
string
Comment message to be added in user cart.
staff_user_id
string
Nullable
Staff user id.
delivery_slots
object
Delivery slots details includes article level time slot when the shipment can be delivered.
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.
Response
200
400
Returns a message indicating the success of cart meta updation as shown below.
CartMetaResult
message
string
Detailed message.
is_valid
boolean
Whether added meta was vaild.
Examples
Parameters
id:
"65c06fe589db42581e4be72e"
body:
body
Was this section helpful?
PUT
Response
Parameters
No Parameters
Response
200
Cart Config fetched successfully
CartMetaConfigListResult
success
boolean
data
array of object (CartMetaConfigListObject)
Array of CartMetaConfigListObject
id
string
slug
string
created_on
string
| date-time
name
string
article_tags
array of string
Nullable
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Parameters
cart_meta_id
string
Required
CartMeta mongo id for fetching single cart meta data
is_bank_offer
boolean
Boolean flag stating if promotions with bank offer need to be fetched.
Response
200
404
Cart Meta Config Fetched successfully
CartConfigDetailResult
success
boolean
data
object (CartConfigDetailObj)
CartConfigDetailObj
id
string
app_id
string
company_id
integer
| int32
created_on
string
| date-time
updated_on
string
| date-time
last_modified_by
string
min_cart_value
integer
| int32
max_cart_value
integer
| int32
bulk_coupons
boolean
max_cart_items
integer
| int32
gift_display_text
string
delivery_charges
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Array of ChargesThreshold
charges
number
| float
Charges amount to be applied on cart.
threshold
number
| float
Threshold of cart value on which the charge should be applied .
revenue_engine_coupon
boolean
gift_pricing
number
| float
enabled
boolean
is_active
boolean
order_placing
object (OrderPlacing)
OrderPlacing
enabled
boolean
message
string
name
string
article_tags
array of string
allow_coupon_with_rewards
boolean
gst_input
boolean
staff_selection
boolean
placing_for_customer
boolean
hide_on_storefront
boolean
pan_card
object (PanCard)
PanCard
enabled
boolean
cod_threshold_amount
integer
| int32
online_threshold_amount
integer
| int32
slug
string
is_universal
boolean
international_delivery_charges
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Array of ChargesThreshold
charges
number
| float
Charges amount to be applied on cart.
threshold
number
| float
Threshold of cart value on which the charge should be applied .
Examples
Parameters
cart_meta_id:
"61d1db23f5b315cf265126c0"
Was this section helpful?
GET
Response
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
buy_now
boolean
Select `true` to set/initialize buy now cart.
id
string
The unique identifier of the cart.
cart_type
string
The type of cart
Enum
order_type
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
Request body
items
array of object (AddProductCart)
List of items detail which need to be added to cart like item id, item size, and item quantity.
Array of AddProductCart
quantity
integer
| int32
Field to specify the product quantity that user wants to buy.
item_size
string
Field to determine size of the product.
seller_id
integer
| int32
Unique idetifier of the seller selected by the user from which user want to buy a product .
price_factory_type_id
string
parent_item_identifiers
array of object
Fields to determine parent product of the product.
product_group_tags
array of string
Field to specify the product groups of the product that the user is trying to add in cart.
article_id
string
Unique identifier of an article .
article_assignment
object (ArticleAssignment)
ArticleAssignment
level
string
strategy
string
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 .
item_id
integer
| int32
Unique identifier to identify product.
extra_meta
object
Extra meta data to be added at article level while add items to cart.
_custom_json
object
Field to add custom json at article level while add items to cart .
meta
object
Field to add meta data at article level.
pos
boolean
Filed to determine whether user is making request from pos or not.
seller_identifier
string
Add items using seller identifier for store os.
new_cart
boolean
Field to create to new cart whille user adds item to cart.
Response
200
Success. Returns a cart object as shown below. Refer `AddCartDetailResultV2` for more details.
AddCartDetailResultV2
success
boolean
True if all items are added successfully. False if partially added or not added.
cart_id
string
Nullable
Unique identifier of the user cart.
partial
boolean
When adding multiple items check if all added. True if only few are added.
message
string
Message of add to cart API response.
Examples
Parameters
id:
"65c06fe589db42581e4be72e"
body:
body
Was this section helpful?
POST
Response
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
# Enhanced cart checkout process
Enhanced version of checkout process that supports multiple mode of payment(MOP).
Parameters
buy_now
boolean
This indicates the type of cart to checkout.
cart_type
string
The type of cart.
Enum
Request body
custom_meta
object
Custom meta data to be added in order.
customer_details
object (CustomerDetails)
Nullable
Customer details to be added in order.
CustomerDetails
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.
Array of PaymentMethod
payment_meta
object (PaymentMeta)
Required
PaymentMeta
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.
payment_identifier
string
Nullable
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)
StaffCheckout
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.
Response
200
Success. Returns the status of cart checkout. Refer `CartCheckoutResultSchema` for more details.
CartCheckoutResult
payment_confirm_url
string
Nullable
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)
CheckCart
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.
uid
string
Cart id of user cart.
coupon_text
string
Coupon text of the applied coupon on order placed.
id
string
Cart id of the user cart.
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
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.
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart.
product
object (CartProduct)
CartProduct
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.
Array of ProductImage
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.
teaser_tag
object
Nullable
Teaser tag or short promotional phrase for the product.
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
action
object (ProductAction)
ProductAction
query
object (ActionQuery)
ActionQuery
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)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart.
tags
array of string
Nullable
Products tags that are added to each product to identify the set of products.
_custom_json
object
Field to add custom json of the product in cart.
type
string
Nullable
Type of 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.
Array of CategoryInfo
uid
integer
| int32
Product Category Id.
name
string
Category name of the product .
attributes
object
Nullable
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
is_set
boolean
Nullable
Whether or not the product is a set of items.
article
object (ProductArticle)
ProductArticle
seller_identifier
string
Nullable
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart.
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
cart_item_meta
object
Meta details of the article added from cart.
parent_item_identifiers
object
Fields to determine parent product of the product.
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.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
gift_card
object (ArticleGiftCard)
ArticleGiftCard
gift_price
number
| float32
Gift price amount applied on article.
display_text
string
Nullable
A gift message for the recipient to be included with the delivery of the order.
gift_message
string
Gift message for the one while receive the delivery of the order with this message.
is_gift_applied
boolean
A flag indicating if the order is a gift.
product_group_tags
array of string
Nullable
List fot the unique identifier for the product grouping.
identifier
object
Nullable
Unique identifier of the article.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
extra_meta
object
Field to update extra meta of the article in cart.
type
string
Type of the data sent in response. Possible value is article.
Enum
_custom_json
object
Field to update custom json of the article in cart.
price
object (ArticlePriceInfo)
ArticlePriceInfo
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
meta
object
Article meta data.
size
string
Size of the article added in cart.
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld.
name
string
Nullable
Store name of the store from where the product is fulfiled .
store_code
string
Nullable
A unique code or identifier for the store, often used for internal reference.
tags
array of string
A list of article tags.
variants
object
Product variant responses, each detailing a specific variant.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
Min Promise in ISO format.
key
string
The attribute key associated with the size.
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
discount_single_quantity
number
| float
Discout amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
price_adjustment_applied
array of object (ArticleAppliedPriceAdjustment)
Array of ArticleAppliedPriceAdjustment
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
article_id
string
Article Id of product.
applied_quantity
integer
| int32
Article quantity on which this price adjusment applied.
meta
object
Meta data added in article of price adjustment.
price
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart.
message
string
Product level message which denotes error information to display over the product in cart.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
ProductAvailability
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.
Array of ProductAvailabilitySize
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.
moq
object (CartItemMOQ)
CartItemMOQ
increment_unit
number
| int32
Nullable
maximum
number
| int32
Nullable
minimum
number
| int32
Nullable
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
custom_order
object (CartItemCustomOrder)
CartItemCustomOrder
is_custom_order
boolean
manufacturing_time
number
| int32
manufacturing_time_unit
string
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Array of Charges
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
ChargesAmount
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of 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.
seller_count
number
Number of sellers offering the product.
allow_remove
boolean
If true, the product is allowed to be removed from the cart.
auto_add_to_cart
boolean
In case of bundle product this product is automatically added with parent product if true.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_charge_info
string
Delivery charge information message of the shipment.
common_config
object (CartCommonConfig)
CartCommonConfig
delivery_charges_config
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Array of ChargesThreshold
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)
CartDetailCoupon
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
Nullable
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.
medias
array of object (CartCouponMedias)
Array of CartCouponMedias
alt
string
url
string
type
string
key
string
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
message
string
Message of the cart checkout API response.
notification
object
staff_user_id
string
success
boolean
Success flag of checkout cart API response.
breakup_values
object (CartBreakup)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
uid
string
Nullable
Unique identifier of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
coupon_value
number
| float
Value of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
minimum_cart_value
number
| float
Minumum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
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.
Array of DisplayBreakup
key
string
Key of the price like total_mrp, total, subtotal etc.
value
number
| float
Numeric value of the price.
currency_code
string
Currency code for the price .
currency_symbol
string
Currency symbol for the price.
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.
original
number
| float32
attr
string
meta
object
preset
number
Value for the price which is set from platform if applicable.
loyalty_points
object (LoyaltyPoints)
LoyaltyPoints
is_applied
boolean
Nullable
Whether the loyalty points are applied on the cart .
total
number
| float
Nullable
Total loyalty points available with user.
applicable
number
| float
Nullable
Whether the loyalty points are applicable for the cart .
description
string
Nullable
Description for loyalty points.
message
string
Nullable
raw
object (RawBreakup)
RawBreakup
promotion
number
| float
coupon
number
| float
Coupon amount 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.
fynd_cash
number
| float
Loyalty points applied on cart.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
gift_card
number
| float
Gift cart amount applied on cart.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
total
number
| float
Total payable amount by the customer.
discount
number
| float
Discount amount recieved on cart.
delivery_charge
number
| float
Delivery charge applied to cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
subtotal
number
| float
Selling price amount of all products in cart.
sub_total
number
| float
convenience_fee
number
| float
Convenience fee amount applied to cart.
total_charge
number
| float
Total amount of charges applied on cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
is_valid
boolean
Valid flag fotr the checkout response if order placed was valid.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
checkout_mode
string
Checkout mode of user cart.
last_modified
string
Last modified timestamp of cart.
buy_now
boolean
Buy now flag of user cart.
gstin
string
Nullable
GSTIN number added in cart.
applied_promo_details
array of object (AppliedPromotion)
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
pan_no
string
Nullable
custom_cart
object (CustomCart)
CustomCart
id
string
Id of custom cart config.
cart_name
string
Name of custom cart.
cart_type
string
Type of custom cart.
is_universal
boolean
By default all carts are universal, will be false for custom cart.
price_adjustment_applied
array of object (PriceAdjustmentApplied)
Array of PriceAdjustmentApplied
article_id
string
adjusted_value
object
applied_quantity
number
meta
object
article_level_distribution
boolean
type
string
is_pan_received
boolean
If the customer provides a PAN number, set it to true.
pan_config
object
order_id
string
Order id generated after placing order.
custom_cart_meta
object
Custom cart meta details added in cart.
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
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
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
id
string
The unique identifier of the cart.
buy_now
boolean
Whether to get buy_now cart.
slug
string
Product slug to fetch the available coupons.
store_id
string
Unique identifier of a store.
Response
200
400
Success. Returns a coupon object which has a list of all the eligible coupons. Refer `GetCouponResult` for more details.
GetCouponResult
page
object (PageCoupon)
PageCoupon
has_next
boolean
Denotes if next page of coupon is available.
current
integer
| int32
Current page number.
total
integer
| int32
Total pages of coupon availalbe.
total_item_count
integer
| int32
Total coupons are available for the cart.
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.
Array of Coupon
title
string
Coupon Title of the coupon applied denotes name of the coupon.
uid
number
Unique identifier of the coupon.
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.
is_applied
boolean
Flag to determine where the coupon is applied to cart or not.
coupon_type
string
Nullable
Type of the coupon applied to cart.
expires_on
string
Message to display to user for expiry of the coupon .
coupon_value
number
| float
Coupon value of the coupon applied to cart.
sub_title
string
Coupon subtitle of the coupon applied to cart which is used to display.
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart.
is_applicable
boolean
Flag to determine where the coupon is applicable to cart or not.
message
string
Coupon message of the coupon applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
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.
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.
offer_text
string
Offer text of the coupon which highligts coupon offer defined while creating coupon .
coupon_amount
number
| float32
The amount based on cart value.
tags
array of string
Nullable
medias
array of object (CartCouponMedias)
Array of CartCouponMedias
alt
string
url
string
type
string
key
string
Examples
Parameters
id:
"65c06fe589db42581e4be72e"
slug:
"global-desi-aw19gbdst31blakblack-1077515-1f6956"
Was this section helpful?
GET
Response
Parameters
i
boolean
Select `true` to retrieve all the items added in the cart.
b
boolean
Select `true` to retrieve the price breakup of cart items.
p
boolean
Select `true` for getting a payment option in response.
id
string
The unique identifier of the cart.
buy_now
boolean
This is boolean to get buy_now cart.
cart_type
string
The type of cart.
Enum
Request body
coupon_code
string
Required
Coupon code to be applied.
Response
200
Success. Returns coupons applied to the cart along with item details and price breakup. Refer `CartDetailResult` for more details.
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart.
uid
string
Unique identifier of the user cart.
coupon_text
string
Coupon text of coupon applied on cart.
id
string
Unique identifier of the user cart.
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
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.
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart.
product
object (CartProduct)
CartProduct
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.
Array of ProductImage
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.
teaser_tag
object
Nullable
Teaser tag or short promotional phrase for the product.
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
action
object (ProductAction)
ProductAction
query
object (ActionQuery)
ActionQuery
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)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart.
tags
array of string
Nullable
Products tags that are added to each product to identify the set of products.
_custom_json
object
Field to add custom json of the product in cart.
type
string
Nullable
Type of 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.
Array of CategoryInfo
uid
integer
| int32
Product Category Id.
name
string
Category name of the product .
attributes
object
Nullable
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
is_set
boolean
Nullable
Whether or not the product is a set of items.
article
object (ProductArticle)
ProductArticle
seller_identifier
string
Nullable
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart.
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
cart_item_meta
object
Meta details of the article added from cart.
parent_item_identifiers
object
Fields to determine parent product of the product.
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.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
gift_card
object (ArticleGiftCard)
ArticleGiftCard
gift_price
number
| float32
Gift price amount applied on article.
display_text
string
Nullable
A gift message for the recipient to be included with the delivery of the order.
gift_message
string
Gift message for the one while receive the delivery of the order with this message.
is_gift_applied
boolean
A flag indicating if the order is a gift.
product_group_tags
array of string
Nullable
List fot the unique identifier for the product grouping.
identifier
object
Nullable
Unique identifier of the article.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
extra_meta
object
Field to update extra meta of the article in cart.
type
string
Type of the data sent in response. Possible value is article.
Enum
_custom_json
object
Field to update custom json of the article in cart.
price
object (ArticlePriceInfo)
ArticlePriceInfo
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
meta
object
Article meta data.
size
string
Size of the article added in cart.
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld.
name
string
Nullable
Store name of the store from where the product is fulfiled .
store_code
string
Nullable
A unique code or identifier for the store, often used for internal reference.
tags
array of string
A list of article tags.
variants
object
Product variant responses, each detailing a specific variant.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
Min Promise in ISO format.
key
string
The attribute key associated with the size.
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
discount_single_quantity
number
| float
Discout amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
price_adjustment_applied
array of object (ArticleAppliedPriceAdjustment)
Array of ArticleAppliedPriceAdjustment
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
article_id
string
Article Id of product.
applied_quantity
integer
| int32
Article quantity on which this price adjusment applied.
meta
object
Meta data added in article of price adjustment.
price
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart.
message
string
Product level message which denotes error information to display over the product in cart.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
ProductAvailability
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.
Array of ProductAvailabilitySize
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.
moq
object (CartItemMOQ)
CartItemMOQ
increment_unit
number
| int32
Nullable
maximum
number
| int32
Nullable
minimum
number
| int32
Nullable
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
custom_order
object (CartItemCustomOrder)
CartItemCustomOrder
is_custom_order
boolean
manufacturing_time
number
| int32
manufacturing_time_unit
string
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Array of Charges
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
ChargesAmount
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of 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.
seller_count
number
Number of sellers offering the product.
allow_remove
boolean
If true, the product is allowed to be removed from the cart.
auto_add_to_cart
boolean
In case of bundle product this product is automatically added with parent product if true.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_charge_info
string
Delivery charge information message of the shipment.
common_config
object (CartCommonConfig)
CartCommonConfig
delivery_charges_config
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Array of ChargesThreshold
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)
CartDetailCoupon
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
Nullable
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.
medias
array of object (CartCouponMedias)
Array of CartCouponMedias
alt
string
url
string
type
string
key
string
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
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.
breakup_values
object (CartBreakup)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
uid
string
Nullable
Unique identifier of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
coupon_value
number
| float
Value of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
minimum_cart_value
number
| float
Minumum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
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.
Array of DisplayBreakup
key
string
Key of the price like total_mrp, total, subtotal etc.
value
number
| float
Numeric value of the price.
currency_code
string
Currency code for the price .
currency_symbol
string
Currency symbol for the price.
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.
original
number
| float32
attr
string
meta
object
preset
number
Value for the price which is set from platform if applicable.
loyalty_points
object (LoyaltyPoints)
LoyaltyPoints
is_applied
boolean
Nullable
Whether the loyalty points are applied on the cart .
total
number
| float
Nullable
Total loyalty points available with user.
applicable
number
| float
Nullable
Whether the loyalty points are applicable for the cart .
description
string
Nullable
Description for loyalty points.
message
string
Nullable
raw
object (RawBreakup)
RawBreakup
promotion
number
| float
coupon
number
| float
Coupon amount 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.
fynd_cash
number
| float
Loyalty points applied on cart.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
gift_card
number
| float
Gift cart amount applied on cart.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
total
number
| float
Total payable amount by the customer.
discount
number
| float
Discount amount recieved on cart.
delivery_charge
number
| float
Delivery charge applied to cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
subtotal
number
| float
Selling price amount of all products in cart.
sub_total
number
| float
convenience_fee
number
| float
Convenience fee amount applied to cart.
total_charge
number
| float
Total amount of charges applied on cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
checkout_mode
string
Checkout mode of user cart.
last_modified
string
Last modified timestamp of cart.
price_adjustment_applied
array of object (CartAppliedPriceAdjustment)
Array of CartAppliedPriceAdjustment
remove_articles
boolean
Boolean value indicating if articles should be removed from cart.
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
auto_remove
boolean
Boolean value indicating if auto remove is enabled.
applied_articles_ids
array of string
List of article IDs where the adjustment is applied.
message
string
Message associated with the Price adjustment.
_type
string
Type of the Price Adjustment.
Enum
meta
object
Meta data added in article of price adjustment.
restrictions
object
It contains all the restrictions applied on price adjustments.
_id
string
ID of the price Adjustment.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
gstin
string
Nullable
GSTIN added in 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.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
pan_no
string
Nullable
Permanent Account Number of the user.
custom_cart
object (CustomCart)
CustomCart
id
string
Id of custom cart config.
cart_name
string
Name of custom cart.
cart_type
string
Type of custom cart.
is_universal
boolean
By default all carts are universal, will be false for custom cart.
is_pan_received
boolean
If the customer provides a PAN number, set it to true.
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 .
Examples
Parameters
i:
"true"
id:
"65c06fe589db42581e4be72e"
buy_now:
"false"
body:
body
Was this section helpful?
POST
Response
Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total.
Parameters
id
string
The unique identifier of the cart.
buy_now
boolean
Wheter to get buy_now cart.
cart_type
string
The type of cart
Enum
Response
200
Success. Returns coupons removed from the cart along with item details and price breakup. Refer `CartDetailResult` for more details.
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart.
uid
string
Unique identifier of the user cart.
coupon_text
string
Coupon text of coupon applied on cart.
id
string
Unique identifier of the user cart.
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
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.
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart.
product
object (CartProduct)
CartProduct
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.
Array of ProductImage
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.
teaser_tag
object
Nullable
Teaser tag or short promotional phrase for the product.
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
action
object (ProductAction)
ProductAction
query
object (ActionQuery)
ActionQuery
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)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart.
tags
array of string
Nullable
Products tags that are added to each product to identify the set of products.
_custom_json
object
Field to add custom json of the product in cart.
type
string
Nullable
Type of 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.
Array of CategoryInfo
uid
integer
| int32
Product Category Id.
name
string
Category name of the product .
attributes
object
Nullable
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
is_set
boolean
Nullable
Whether or not the product is a set of items.
article
object (ProductArticle)
ProductArticle
seller_identifier
string
Nullable
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart.
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
cart_item_meta
object
Meta details of the article added from cart.
parent_item_identifiers
object
Fields to determine parent product of the product.
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.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
gift_card
object (ArticleGiftCard)
ArticleGiftCard
gift_price
number
| float32
Gift price amount applied on article.
display_text
string
Nullable
A gift message for the recipient to be included with the delivery of the order.
gift_message
string
Gift message for the one while receive the delivery of the order with this message.
is_gift_applied
boolean
A flag indicating if the order is a gift.
product_group_tags
array of string
Nullable
List fot the unique identifier for the product grouping.
identifier
object
Nullable
Unique identifier of the article.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
extra_meta
object
Field to update extra meta of the article in cart.
type
string
Type of the data sent in response. Possible value is article.
Enum
_custom_json
object
Field to update custom json of the article in cart.
price
object (ArticlePriceInfo)
ArticlePriceInfo
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
meta
object
Article meta data.
size
string
Size of the article added in cart.
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld.
name
string
Nullable
Store name of the store from where the product is fulfiled .
store_code
string
Nullable
A unique code or identifier for the store, often used for internal reference.
tags
array of string
A list of article tags.
variants
object
Product variant responses, each detailing a specific variant.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
Min Promise in ISO format.
key
string
The attribute key associated with the size.
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
discount_single_quantity
number
| float
Discout amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
price_adjustment_applied
array of object (ArticleAppliedPriceAdjustment)
Array of ArticleAppliedPriceAdjustment
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
article_id
string
Article Id of product.
applied_quantity
integer
| int32
Article quantity on which this price adjusment applied.
meta
object
Meta data added in article of price adjustment.
price
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart.
message
string
Product level message which denotes error information to display over the product in cart.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
ProductAvailability
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.
Array of ProductAvailabilitySize
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.
moq
object (CartItemMOQ)
CartItemMOQ
increment_unit
number
| int32
Nullable
maximum
number
| int32
Nullable
minimum
number
| int32
Nullable
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
custom_order
object (CartItemCustomOrder)
CartItemCustomOrder
is_custom_order
boolean
manufacturing_time
number
| int32
manufacturing_time_unit
string
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Array of Charges
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
ChargesAmount
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of 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.
seller_count
number
Number of sellers offering the product.
allow_remove
boolean
If true, the product is allowed to be removed from the cart.
auto_add_to_cart
boolean
In case of bundle product this product is automatically added with parent product if true.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_charge_info
string
Delivery charge information message of the shipment.
common_config
object (CartCommonConfig)
CartCommonConfig
delivery_charges_config
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Array of ChargesThreshold
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)
CartDetailCoupon
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
Nullable
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.
medias
array of object (CartCouponMedias)
Array of CartCouponMedias
alt
string
url
string
type
string
key
string
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
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.
breakup_values
object (CartBreakup)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
uid
string
Nullable
Unique identifier of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
coupon_value
number
| float
Value of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
minimum_cart_value
number
| float
Minumum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
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.
Array of DisplayBreakup
key
string
Key of the price like total_mrp, total, subtotal etc.
value
number
| float
Numeric value of the price.
currency_code
string
Currency code for the price .
currency_symbol
string
Currency symbol for the price.
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.
original
number
| float32
attr
string
meta
object
preset
number
Value for the price which is set from platform if applicable.
loyalty_points
object (LoyaltyPoints)
LoyaltyPoints
is_applied
boolean
Nullable
Whether the loyalty points are applied on the cart .
total
number
| float
Nullable
Total loyalty points available with user.
applicable
number
| float
Nullable
Whether the loyalty points are applicable for the cart .
description
string
Nullable
Description for loyalty points.
message
string
Nullable
raw
object (RawBreakup)
RawBreakup
promotion
number
| float
coupon
number
| float
Coupon amount 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.
fynd_cash
number
| float
Loyalty points applied on cart.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
gift_card
number
| float
Gift cart amount applied on cart.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
total
number
| float
Total payable amount by the customer.
discount
number
| float
Discount amount recieved on cart.
delivery_charge
number
| float
Delivery charge applied to cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
subtotal
number
| float
Selling price amount of all products in cart.
sub_total
number
| float
convenience_fee
number
| float
Convenience fee amount applied to cart.
total_charge
number
| float
Total amount of charges applied on cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
checkout_mode
string
Checkout mode of user cart.
last_modified
string
Last modified timestamp of cart.
price_adjustment_applied
array of object (CartAppliedPriceAdjustment)
Array of CartAppliedPriceAdjustment
remove_articles
boolean
Boolean value indicating if articles should be removed from cart.
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
auto_remove
boolean
Boolean value indicating if auto remove is enabled.
applied_articles_ids
array of string
List of article IDs where the adjustment is applied.
message
string
Message associated with the Price adjustment.
_type
string
Type of the Price Adjustment.
Enum
meta
object
Meta data added in article of price adjustment.
restrictions
object
It contains all the restrictions applied on price adjustments.
_id
string
ID of the price Adjustment.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
gstin
string
Nullable
GSTIN added in 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.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
pan_no
string
Nullable
Permanent Account Number of the user.
custom_cart
object (CustomCart)
CustomCart
id
string
Id of custom cart config.
cart_name
string
Name of custom cart.
cart_type
string
Type of custom cart.
is_universal
boolean
By default all carts are universal, will be false for custom cart.
is_pan_received
boolean
If the customer provides a PAN number, set it to true.
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 .
Examples
Parameters
id:
"65c06fe589db42581e4be72e"
buy_now:
"false"
Was this section helpful?
DEL
Response
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_id
integer
The Item ID of the product.
article_id
string
Article Mongo ID.
uid
integer
UID of the product.
slug
string
A short, human-readable, URL-friendly identifier of a product.
cart_type
string
type of the cart
Enum
Response
200
400
Success. Returns a data object containing the seller details and available offers (if exists) on bulk products. Refer `BulkPriceResult` for more details.
BulkPriceResult
data
array of object (BulkPriceOffer)
Actual data to be in response consist of offers from multiple seller.
Array of BulkPriceOffer
offers
array of object (OfferItem)
Offers is the list of Offer item, which consists of margin percentage, price, quantity, offer type and offer price.
Array of OfferItem
price
object (OfferPrice)
OfferPrice
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)
OfferSeller
uid
integer
| int32
Unique identifier for a seller.
name
string
Name of a seller.
article_id
string
Article Mongo ID
Examples
Parameters
item_id:
1077515
article_id:
"5f574baac55aff75976c6efe"
uid:
1077515
slug:
"global-desi-aw19gbdst31blakblack-1077515-1f6956"
Was this section helpful?
GET
Response
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_id
string
The unique identifier of the user cart.
buy_now
boolean
Whether to get buy_now cart.
mobile_no
string
Mobile number of the customer.
checkout_mode
string
Option to checkout for self or for others.
Enum
tags
string
Tag given to an address, e.g. work, home, office, shop.
Enum
is_default
boolean
Select `true` to fetch the default address.
user_id
string
Option to fetch address for the provided user_id.
Response
200
Success. Returns an Address object containing a list of address saved in the account. Refer `GetAddressesResult` for more details.
GetAddressesResult
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.
Array of Address
pincode
number
Nullable
Pincode of address.
phone
string
Phone number for address.
id
string
Id of the address.
area_code_slug
string
Area code slug for address. example pincode is slug for India.
country_code
string
Country code of address.
geo_location
object (GeoLocation)
GeoLocation
latitude
number
| float
Latitude coordinate for address.
Default Value : 0
longitude
number
| float
Longitude coordinate for address.
Default Value : 0
country
string
Country of address.
state
string
State of the address.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
tags
array of string
Tags of address from which it can be identified.
created_by_user_id
string
Created by user id of address.
landmark
string
Landmark of address.
email
string
Nullable
Email address for address data.
area_code
string
Area code of the address.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
meta
object
Metadata of the address.
is_active
boolean
States whether address is active or not.
name
string
Name of person in address data to whom it belongs to.
google_map_point
object
Google map point of the address.
cart_id
string
Unique User Cart Id.
city
string
City of the address.
sector
string
Sector of the address.
state_code
string
State code for address.
area
string
Area description for address.
user_id
string
User id of address for which address is created.
address_type
string
Address type of address.
address
string
Address description for address data.
country_phone_code
string
Country phone code for address.
country_iso_code
string
Country iso code for address.
_custom_json
object
Custom json of the address.
uid
number
Uid of the address.
is_anonymous
boolean
Boolean flag for anonymous user.
app_id
string
sales channel's application id
expire_at
string
| date-time
Nullable
Expire date of user address.
address_id
string
Nullable
Uid of the address.
store_name
string
Nullable
Store name of the address.
validation_config
object (ValidationConfig)
ValidationConfig
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
cart_id:
"65c06fe589db42581e4be72e"
mobile_no:
9915347757
user_id:
"5c5c0b0a3fe3c6d1ae4ea1fc"
Was this section helpful?
GET
Response
Add a new address to their cart to save details such as name, email, contact information, and address.
Parameters
No Parameters
Request body
pincode
number
Nullable
Pincode of address.
phone
string
Phone number for address.
id
string
Id of the address.
area_code_slug
string
Area code slug for address. example pincode is slug for India.
country_code
string
Country code of address.
geo_location
object (GeoLocation)
GeoLocation
latitude
number
| float
Latitude coordinate for address.
Default Value : 0
longitude
number
| float
Longitude coordinate for address.
Default Value : 0
country
string
Country of address.
state
string
State of the address.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
tags
array of string
Tags of address from which it can be identified.
created_by_user_id
string
Created by user id of address.
landmark
string
Landmark of address.
email
string
Nullable
Email address for address data.
area_code
string
Area code of the address.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
meta
object
Metadata of the address.
is_active
boolean
States whether address is active or not.
name
string
Name of person in address data to whom it belongs to.
google_map_point
object
Google map point of the address.
cart_id
string
Unique User Cart Id.
city
string
City of the address.
sector
string
Sector of the address.
state_code
string
State code for address.
area
string
Area description for address.
user_id
string
User id of address for which address is created.
address_type
string
Address type of address.
address
string
Address description for address data.
country_phone_code
string
Country phone code for address.
country_iso_code
string
Country iso code for address.
_custom_json
object
Custom json of the address.
uid
number
Uid of the address.
is_anonymous
boolean
Boolean flag for anonymous user.
app_id
string
sales channel's application id
expire_at
string
| date-time
Nullable
Expire date of user address.
address_id
string
Nullable
Uid of the address.
store_name
string
Nullable
Store name of the address.
Response
200
Success. Returns the address ID, a flag whether the address is set as default, and a success message. Refer `SaveAddressResult` for more details.
SaveAddressResult
id
string
Id of the address.
success
boolean
Success flag of save address Response.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
address_id
Undefined Type
oneOf Schema from below
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
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
id
string
Required
ID allotted to the selected address.
cart_id
string
The unique identifier of the cart.
buy_now
boolean
This is boolean to get buy_now cart.
mobile_no
string
Mobile number of the customer.
checkout_mode
string
Option to checkout for self or for others.
Enum
tags
string
Tag given to an address, e.g. work, home, office, shop.
Enum
is_default
boolean
This is a boolean value. Select `true` to fetch the default address.
user_id
string
Option to fetch address for the provided user_id.
Response
200
Success. Returns an Address object containing a list of address saved in the account. Refer `Address` for more details.
Address
pincode
number
Nullable
Pincode of address.
phone
string
Phone number for address.
id
string
Id of the address.
area_code_slug
string
Area code slug for address. example pincode is slug for India.
country_code
string
Country code of address.
geo_location
object (GeoLocation)
GeoLocation
latitude
number
| float
Latitude coordinate for address.
Default Value : 0
longitude
number
| float
Longitude coordinate for address.
Default Value : 0
country
string
Country of address.
state
string
State of the address.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
tags
array of string
Tags of address from which it can be identified.
created_by_user_id
string
Created by user id of address.
landmark
string
Landmark of address.
email
string
Nullable
Email address for address data.
area_code
string
Area code of the address.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
meta
object
Metadata of the address.
is_active
boolean
States whether address is active or not.
name
string
Name of person in address data to whom it belongs to.
google_map_point
object
Google map point of the address.
cart_id
string
Unique User Cart Id.
city
string
City of the address.
sector
string
Sector of the address.
state_code
string
State code for address.
area
string
Area description for address.
user_id
string
User id of address for which address is created.
address_type
string
Address type of address.
address
string
Address description for address data.
country_phone_code
string
Country phone code for address.
country_iso_code
string
Country iso code for address.
_custom_json
object
Custom json of the address.
uid
number
Uid of the address.
is_anonymous
boolean
Boolean flag for anonymous user.
app_id
string
sales channel's application id
expire_at
string
| date-time
Nullable
Expire date of user address.
address_id
string
Nullable
Uid of the address.
store_name
string
Nullable
Store name of the address.
Examples
Parameters
id:
"65bb5a41feeb84432e132c03"
cart_id:
"65c06fe589db42581e4be72e"
mobile_no:
9915347757
user_id:
"5c5c0b0a3fe3c6d1ae4ea1fc"
Was this section helpful?
GET
Response
Customer can modify the details of a previously saved addresses.
Parameters
id
string
Required
ID allotted to the selected address.
Request body
pincode
number
Nullable
Pincode of address.
phone
string
Phone number for address.
id
string
Id of the address.
area_code_slug
string
Area code slug for address. example pincode is slug for India.
country_code
string
Country code of address.
geo_location
object (GeoLocation)
GeoLocation
latitude
number
| float
Latitude coordinate for address.
Default Value : 0
longitude
number
| float
Longitude coordinate for address.
Default Value : 0
country
string
Country of address.
state
string
State of the address.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
tags
array of string
Tags of address from which it can be identified.
created_by_user_id
string
Created by user id of address.
landmark
string
Landmark of address.
email
string
Nullable
Email address for address data.
area_code
string
Area code of the address.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
meta
object
Metadata of the address.
is_active
boolean
States whether address is active or not.
name
string
Name of person in address data to whom it belongs to.
google_map_point
object
Google map point of the address.
cart_id
string
Unique User Cart Id.
city
string
City of the address.
sector
string
Sector of the address.
state_code
string
State code for address.
area
string
Area description for address.
user_id
string
User id of address for which address is created.
address_type
string
Address type of address.
address
string
Address description for address data.
country_phone_code
string
Country phone code for address.
country_iso_code
string
Country iso code for address.
_custom_json
object
Custom json of the address.
uid
number
Uid of the address.
is_anonymous
boolean
Boolean flag for anonymous user.
app_id
string
sales channel's application id
expire_at
string
| date-time
Nullable
Expire date of user address.
address_id
string
Nullable
Uid of the address.
store_name
string
Nullable
Store name of the address.
Response
200
Success. Returns the address ID and a message indicating a successful address updation.
UpdateAddressResult
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.
address_id
string
Nullable
Examples
Parameters
id:
"65bb5a41feeb84432e132c03"
body:
body
Was this section helpful?
PUT
Response
Delete an existing customer address from the system.
Parameters
id
string
Required
ID allotted to the selected address.
Response
200
Returns a Status object indicating the success or failure of address deletion.
DeleteAddressResult
id
string
Id of the address.
is_deleted
boolean
Deleted flag in delete address response states whether the address was deleted or not.
address_id
string
Examples
Parameters
id:
"65bb5a41feeb84432e132c04"
Was this section helpful?
DEL
Response
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_id
string
The unique identifier of the cart.
buy_now
boolean
Whether to get buy_now cart.
i
boolean
Select `true` to retrieve all the items added in the cart.
b
boolean
Select `true` to retrieve the price breakup of cart items.
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.
Response
200
400
Success. Returns a Cart object as shown below. Refer `CartDetailResult` for more details.
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart.
uid
string
Unique identifier of the user cart.
coupon_text
string
Coupon text of coupon applied on cart.
id
string
Unique identifier of the user cart.
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
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.
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart.
product
object (CartProduct)
CartProduct
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.
Array of ProductImage
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.
teaser_tag
object
Nullable
Teaser tag or short promotional phrase for the product.
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
action
object (ProductAction)
ProductAction
query
object (ActionQuery)
ActionQuery
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)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart.
tags
array of string
Nullable
Products tags that are added to each product to identify the set of products.
_custom_json
object
Field to add custom json of the product in cart.
type
string
Nullable
Type of 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.
Array of CategoryInfo
uid
integer
| int32
Product Category Id.
name
string
Category name of the product .
attributes
object
Nullable
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
is_set
boolean
Nullable
Whether or not the product is a set of items.
article
object (ProductArticle)
ProductArticle
seller_identifier
string
Nullable
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart.
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
cart_item_meta
object
Meta details of the article added from cart.
parent_item_identifiers
object
Fields to determine parent product of the product.
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.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
gift_card
object (ArticleGiftCard)
ArticleGiftCard
gift_price
number
| float32
Gift price amount applied on article.
display_text
string
Nullable
A gift message for the recipient to be included with the delivery of the order.
gift_message
string
Gift message for the one while receive the delivery of the order with this message.
is_gift_applied
boolean
A flag indicating if the order is a gift.
product_group_tags
array of string
Nullable
List fot the unique identifier for the product grouping.
identifier
object
Nullable
Unique identifier of the article.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
extra_meta
object
Field to update extra meta of the article in cart.
type
string
Type of the data sent in response. Possible value is article.
Enum
_custom_json
object
Field to update custom json of the article in cart.
price
object (ArticlePriceInfo)
ArticlePriceInfo
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
meta
object
Article meta data.
size
string
Size of the article added in cart.
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld.
name
string
Nullable
Store name of the store from where the product is fulfiled .
store_code
string
Nullable
A unique code or identifier for the store, often used for internal reference.
tags
array of string
A list of article tags.
variants
object
Product variant responses, each detailing a specific variant.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
Min Promise in ISO format.
key
string
The attribute key associated with the size.
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
discount_single_quantity
number
| float
Discout amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
price_adjustment_applied
array of object (ArticleAppliedPriceAdjustment)
Array of ArticleAppliedPriceAdjustment
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
article_id
string
Article Id of product.
applied_quantity
integer
| int32
Article quantity on which this price adjusment applied.
meta
object
Meta data added in article of price adjustment.
price
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart.
message
string
Product level message which denotes error information to display over the product in cart.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
ProductAvailability
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.
Array of ProductAvailabilitySize
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.
moq
object (CartItemMOQ)
CartItemMOQ
increment_unit
number
| int32
Nullable
maximum
number
| int32
Nullable
minimum
number
| int32
Nullable
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
custom_order
object (CartItemCustomOrder)
CartItemCustomOrder
is_custom_order
boolean
manufacturing_time
number
| int32
manufacturing_time_unit
string
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Array of Charges
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
ChargesAmount
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of 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.
seller_count
number
Number of sellers offering the product.
allow_remove
boolean
If true, the product is allowed to be removed from the cart.
auto_add_to_cart
boolean
In case of bundle product this product is automatically added with parent product if true.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_charge_info
string
Delivery charge information message of the shipment.
common_config
object (CartCommonConfig)
CartCommonConfig
delivery_charges_config
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Array of ChargesThreshold
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)
CartDetailCoupon
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
Nullable
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.
medias
array of object (CartCouponMedias)
Array of CartCouponMedias
alt
string
url
string
type
string
key
string
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
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.
breakup_values
object (CartBreakup)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
uid
string
Nullable
Unique identifier of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
coupon_value
number
| float
Value of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
minimum_cart_value
number
| float
Minumum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
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.
Array of DisplayBreakup
key
string
Key of the price like total_mrp, total, subtotal etc.
value
number
| float
Numeric value of the price.
currency_code
string
Currency code for the price .
currency_symbol
string
Currency symbol for the price.
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.
original
number
| float32
attr
string
meta
object
preset
number
Value for the price which is set from platform if applicable.
loyalty_points
object (LoyaltyPoints)
LoyaltyPoints
is_applied
boolean
Nullable
Whether the loyalty points are applied on the cart .
total
number
| float
Nullable
Total loyalty points available with user.
applicable
number
| float
Nullable
Whether the loyalty points are applicable for the cart .
description
string
Nullable
Description for loyalty points.
message
string
Nullable
raw
object (RawBreakup)
RawBreakup
promotion
number
| float
coupon
number
| float
Coupon amount 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.
fynd_cash
number
| float
Loyalty points applied on cart.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
gift_card
number
| float
Gift cart amount applied on cart.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
total
number
| float
Total payable amount by the customer.
discount
number
| float
Discount amount recieved on cart.
delivery_charge
number
| float
Delivery charge applied to cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
subtotal
number
| float
Selling price amount of all products in cart.
sub_total
number
| float
convenience_fee
number
| float
Convenience fee amount applied to cart.
total_charge
number
| float
Total amount of charges applied on cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
checkout_mode
string
Checkout mode of user cart.
last_modified
string
Last modified timestamp of cart.
price_adjustment_applied
array of object (CartAppliedPriceAdjustment)
Array of CartAppliedPriceAdjustment
remove_articles
boolean
Boolean value indicating if articles should be removed from cart.
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
auto_remove
boolean
Boolean value indicating if auto remove is enabled.
applied_articles_ids
array of string
List of article IDs where the adjustment is applied.
message
string
Message associated with the Price adjustment.
_type
string
Type of the Price Adjustment.
Enum
meta
object
Meta data added in article of price adjustment.
restrictions
object
It contains all the restrictions applied on price adjustments.
_id
string
ID of the price Adjustment.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
gstin
string
Nullable
GSTIN added in 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.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
pan_no
string
Nullable
Permanent Account Number of the user.
custom_cart
object (CustomCart)
CustomCart
id
string
Id of custom cart config.
cart_name
string
Name of custom cart.
cart_type
string
Type of custom cart.
is_universal
boolean
By default all carts are universal, will be false for custom cart.
is_pan_received
boolean
If the customer provides a PAN number, set it to true.
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 .
Examples
Parameters
cart_id:
"65c06fe589db42581e4be72e"
i:
"true"
body:
body
Was this section helpful?
POST
Response
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
GET
# Validate applied coupon
Select a preferred payment mode from available options during the cart checkout process to securely and efficiently complete their transaction.
Parameters
id
string
The unique identifier of the cart.
buy_now
boolean
Whether to get buy_now cart.
order_type
string
This is boolean to get buy_now cart.
Enum
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.
Response
200
Success. Returns a Cart object as shown below. Refer `CartDetailResult` for more details.
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart.
uid
string
Unique identifier of the user cart.
coupon_text
string
Coupon text of coupon applied on cart.
id
string
Unique identifier of the user cart.
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
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.
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart.
product
object (CartProduct)
CartProduct
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.
Array of ProductImage
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.
teaser_tag
object
Nullable
Teaser tag or short promotional phrase for the product.
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
action
object (ProductAction)
ProductAction
query
object (ActionQuery)
ActionQuery
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)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart.
tags
array of string
Nullable
Products tags that are added to each product to identify the set of products.
_custom_json
object
Field to add custom json of the product in cart.
type
string
Nullable
Type of 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.
Array of CategoryInfo
uid
integer
| int32
Product Category Id.
name
string
Category name of the product .
attributes
object
Nullable
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
is_set
boolean
Nullable
Whether or not the product is a set of items.
article
object (ProductArticle)
ProductArticle
seller_identifier
string
Nullable
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart.
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
cart_item_meta
object
Meta details of the article added from cart.
parent_item_identifiers
object
Fields to determine parent product of the product.
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.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
gift_card
object (ArticleGiftCard)
ArticleGiftCard
gift_price
number
| float32
Gift price amount applied on article.
display_text
string
Nullable
A gift message for the recipient to be included with the delivery of the order.
gift_message
string
Gift message for the one while receive the delivery of the order with this message.
is_gift_applied
boolean
A flag indicating if the order is a gift.
product_group_tags
array of string
Nullable
List fot the unique identifier for the product grouping.
identifier
object
Nullable
Unique identifier of the article.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
extra_meta
object
Field to update extra meta of the article in cart.
type
string
Type of the data sent in response. Possible value is article.
Enum
_custom_json
object
Field to update custom json of the article in cart.
price
object (ArticlePriceInfo)
ArticlePriceInfo
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
meta
object
Article meta data.
size
string
Size of the article added in cart.
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld.
name
string
Nullable
Store name of the store from where the product is fulfiled .
store_code
string
Nullable
A unique code or identifier for the store, often used for internal reference.
tags
array of string
A list of article tags.
variants
object
Product variant responses, each detailing a specific variant.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
Min Promise in ISO format.
key
string
The attribute key associated with the size.
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
discount_single_quantity
number
| float
Discout amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
price_adjustment_applied
array of object (ArticleAppliedPriceAdjustment)
Array of ArticleAppliedPriceAdjustment
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
article_id
string
Article Id of product.
applied_quantity
integer
| int32
Article quantity on which this price adjusment applied.
meta
object
Meta data added in article of price adjustment.
price
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart.
message
string
Product level message which denotes error information to display over the product in cart.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
ProductAvailability
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.
Array of ProductAvailabilitySize
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.
moq
object (CartItemMOQ)
CartItemMOQ
increment_unit
number
| int32
Nullable
maximum
number
| int32
Nullable
minimum
number
| int32
Nullable
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
custom_order
object (CartItemCustomOrder)
CartItemCustomOrder
is_custom_order
boolean
manufacturing_time
number
| int32
manufacturing_time_unit
string
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Array of Charges
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
ChargesAmount
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of 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.
seller_count
number
Number of sellers offering the product.
allow_remove
boolean
If true, the product is allowed to be removed from the cart.
auto_add_to_cart
boolean
In case of bundle product this product is automatically added with parent product if true.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_charge_info
string
Delivery charge information message of the shipment.
common_config
object (CartCommonConfig)
CartCommonConfig
delivery_charges_config
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Array of ChargesThreshold
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)
CartDetailCoupon
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
Nullable
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.
medias
array of object (CartCouponMedias)
Array of CartCouponMedias
alt
string
url
string
type
string
key
string
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
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.
breakup_values
object (CartBreakup)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
uid
string
Nullable
Unique identifier of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
coupon_value
number
| float
Value of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
minimum_cart_value
number
| float
Minumum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
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.
Array of DisplayBreakup
key
string
Key of the price like total_mrp, total, subtotal etc.
value
number
| float
Numeric value of the price.
currency_code
string
Currency code for the price .
currency_symbol
string
Currency symbol for the price.
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.
original
number
| float32
attr
string
meta
object
preset
number
Value for the price which is set from platform if applicable.
loyalty_points
object (LoyaltyPoints)
LoyaltyPoints
is_applied
boolean
Nullable
Whether the loyalty points are applied on the cart .
total
number
| float
Nullable
Total loyalty points available with user.
applicable
number
| float
Nullable
Whether the loyalty points are applicable for the cart .
description
string
Nullable
Description for loyalty points.
message
string
Nullable
raw
object (RawBreakup)
RawBreakup
promotion
number
| float
coupon
number
| float
Coupon amount 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.
fynd_cash
number
| float
Loyalty points applied on cart.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
gift_card
number
| float
Gift cart amount applied on cart.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
total
number
| float
Total payable amount by the customer.
discount
number
| float
Discount amount recieved on cart.
delivery_charge
number
| float
Delivery charge applied to cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
subtotal
number
| float
Selling price amount of all products in cart.
sub_total
number
| float
convenience_fee
number
| float
Convenience fee amount applied to cart.
total_charge
number
| float
Total amount of charges applied on cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
checkout_mode
string
Checkout mode of user cart.
last_modified
string
Last modified timestamp of cart.
price_adjustment_applied
array of object (CartAppliedPriceAdjustment)
Array of CartAppliedPriceAdjustment
remove_articles
boolean
Boolean value indicating if articles should be removed from cart.
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
auto_remove
boolean
Boolean value indicating if auto remove is enabled.
applied_articles_ids
array of string
List of article IDs where the adjustment is applied.
message
string
Message associated with the Price adjustment.
_type
string
Type of the Price Adjustment.
Enum
meta
object
Meta data added in article of price adjustment.
restrictions
object
It contains all the restrictions applied on price adjustments.
_id
string
ID of the price Adjustment.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
gstin
string
Nullable
GSTIN added in 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.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
pan_no
string
Nullable
Permanent Account Number of the user.
custom_cart
object (CustomCart)
CustomCart
id
string
Id of custom cart config.
cart_name
string
Name of custom cart.
cart_type
string
Type of custom cart.
is_universal
boolean
By default all carts are universal, will be false for custom cart.
is_pan_received
boolean
If the customer provides a PAN number, set it to true.
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 .
Examples
Parameters
id:
"65c06fe589db42581e4be72e"
body:
body
Was this section helpful?
PUT
Response
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
id
string
The unique identifier of the cart.
buy_now
boolean
Whether to get buy_now cart.
address_id
string
ID allotted to an address.
payment_mode
string
Payment mode selected by the customer.
payment_identifier
string
Identifier of payment like ICIC, PAYTM.
aggregator_name
string
Payment gateway identifier.
merchant_code
string
Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM.
iin
string
Debit/Credit card prefix (first 6 digit).
network
string
Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY.
type
string
Card type, e.g. Credit, Debit.
card_id
string
Saved card token reference id.
cart_type
string
Type of the cart.
Enum
Response
200
Success. Returns a success message and the coupon validity. Refer `PaymentCouponValidate` for more details.
PaymentCouponValidate
success
boolean
Success flag of coupon payment mode validity API response.
message
string
Payment mode valid message for coupon.
coupon_validity
object (CouponValidity)
CouponValidity
title
string
Coupon Title 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.
discount
number
| float
Coupon discount value of the coupon applied.
Examples
Parameters
id:
"65c06fe589db42581e4be72e"
address_id:
"65bb5a41feeb84432e132c03"
payment_mode:
"NB"
payment_identifier:
"ICIC"
aggregator_name:
"Razorpay"
merchant_code:
"NB_ICIC"
Was this section helpful?
GET
Response
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
slug
string
A short, human-readable, URL-friendly identifier of a product.
page_size
integer
Number of offers to be fetched to show.
promotion_group
string
Type of promotion groups.
store_id
integer
Unique identifier of a store.
Response
200
400
Success. Returns a array containing the available offers (if exists) on product via promotions. Refer `PromotionOffersResult` for more details.
PromotionOffersResult
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.
Array of PromotionOffer
id
string
Promotion id of the promotion which is available on product.
buy_rules
object
Buy rules of promotion which is available on product.
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
Datetime ISO String for promotion end date which is available on product.
discount_rules
array of object
Discount rules of promotions which is avaiable on product.
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.
Array of FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
tags
array of string
Tags for promotion.
medias
array of object (Media)
Medias for promotion.
Array of Media
alt
string
Alt text for the media.
logo
string
Logo url for the promotion.
url
string
Image URL for the media.
is_bank_offer
boolean
Indicates whether the promotion is associated with a bank offer.
Examples
Parameters
slug:
"global-desi-aw19gbdst31blakblack-1077515-1f6956"
page_size:
1
promotion_group:
"product"
Was this section helpful?
GET
Response
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
slug
string
Required
A short, human-readable, URL-friendly identifier of a product.
store_id
string
Store uid of assigned store on PDP page. If not passed default first created ladder will be returned.
promotion_id
string
Get ladder information of given promotion id explicitely.
page_size
integer
Number of offers to be fetched to show.
Response
200
400
Success. Returns a object containing the applicable ladder price offers (if exists) on product. Refer `PromotionOffersResult` for more details.
LadderPriceOffers
available_offers
array of object (LadderPriceOffer)
Available ladder promotions offers list.
Array of LadderPriceOffer
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
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.
Array of LadderOfferItem
price
object (LadderPrice)
LadderPrice
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.
Array of FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_type
string
Promotion type of the promotion which is availalbe on product.
Enum
medias
array of object (Media)
Medias for promotion.
Array of Media
alt
string
Alt text for the media.
logo
string
Logo url for the promotion.
url
string
Image URL for the media.
currency
object (CurrencyInfo)
CurrencyInfo
code
string
Currency code of ladder price promotion.
symbol
string
Currency symbol for currency of ladder price product.
store_id
array of number
Examples
Parameters
slug:
"global-desi-aw19gbdst31blakblack-1077515-1f6956"
store_id:
2890
promotion_id:
"61d1db23f5b315cf265126c4"
page_size:
1
Was this section helpful?
GET
Response
Use this API to get top 5 payment offers available for current cart.
Parameters
id
string
Cart id of the user cart.
uid
integer
Cart uid of the user cart.
Response
200
400
Success. Returns a array containing the available offers (if exists) on cart via promotions. Refer `PromotionPaymentOffersResult` for more details.
PromotionPaymentOffersResult
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.
Array of PromotionPaymentOffer
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.
valid_till
string
Datetime ISO String for promotion end date which is available on product.
medias
array of object (Media)
Medias for promotion.
Array of Media
alt
string
Alt text for the media.
logo
string
Logo url for the promotion.
url
string
Image URL for the media.
Examples
Parameters
id:
"65c06fe589db42581e4be72e"
Was this section helpful?
GET
Response
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 reward points.
Users can redeem their accumulated reward points and apply them to the items in their cart, thereby availing discounts on their current purchases.
Parameters
id
string
The unique identifier of the cart.
i
boolean
Select `true` to retrieve all the items added in the cart.
b
boolean
Select `true` to retrieve the price breakup of cart items.
buy_now
boolean
This is boolean to get buy_now cart.
cart_type
string
type of the cart
Enum
Request body
points
boolean
Required
Points to be applied for cart.
Response
200
Success. Returns a Cart object. Check the example shown below or refer `CartDetailResult` for more details.
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart.
uid
string
Unique identifier of the user cart.
coupon_text
string
Coupon text of coupon applied on cart.
id
string
Unique identifier of the user cart.
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
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.
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart.
product
object (CartProduct)
CartProduct
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.
Array of ProductImage
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.
teaser_tag
object
Nullable
Teaser tag or short promotional phrase for the product.
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
action
object (ProductAction)
ProductAction
query
object (ActionQuery)
ActionQuery
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)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart.
tags
array of string
Nullable
Products tags that are added to each product to identify the set of products.
_custom_json
object
Field to add custom json of the product in cart.
type
string
Nullable
Type of 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.
Array of CategoryInfo
uid
integer
| int32
Product Category Id.
name
string
Category name of the product .
attributes
object
Nullable
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
is_set
boolean
Nullable
Whether or not the product is a set of items.
article
object (ProductArticle)
ProductArticle
seller_identifier
string
Nullable
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart.
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
cart_item_meta
object
Meta details of the article added from cart.
parent_item_identifiers
object
Fields to determine parent product of the product.
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.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
gift_card
object (ArticleGiftCard)
ArticleGiftCard
gift_price
number
| float32
Gift price amount applied on article.
display_text
string
Nullable
A gift message for the recipient to be included with the delivery of the order.
gift_message
string
Gift message for the one while receive the delivery of the order with this message.
is_gift_applied
boolean
A flag indicating if the order is a gift.
product_group_tags
array of string
Nullable
List fot the unique identifier for the product grouping.
identifier
object
Nullable
Unique identifier of the article.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
extra_meta
object
Field to update extra meta of the article in cart.
type
string
Type of the data sent in response. Possible value is article.
Enum
_custom_json
object
Field to update custom json of the article in cart.
price
object (ArticlePriceInfo)
ArticlePriceInfo
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
meta
object
Article meta data.
size
string
Size of the article added in cart.
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld.
name
string
Nullable
Store name of the store from where the product is fulfiled .
store_code
string
Nullable
A unique code or identifier for the store, often used for internal reference.
tags
array of string
A list of article tags.
variants
object
Product variant responses, each detailing a specific variant.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
Min Promise in ISO format.
key
string
The attribute key associated with the size.
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
discount_single_quantity
number
| float
Discout amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
price_adjustment_applied
array of object (ArticleAppliedPriceAdjustment)
Array of ArticleAppliedPriceAdjustment
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
article_id
string
Article Id of product.
applied_quantity
integer
| int32
Article quantity on which this price adjusment applied.
meta
object
Meta data added in article of price adjustment.
price
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart.
message
string
Product level message which denotes error information to display over the product in cart.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
ProductAvailability
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.
Array of ProductAvailabilitySize
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.
moq
object (CartItemMOQ)
CartItemMOQ
increment_unit
number
| int32
Nullable
maximum
number
| int32
Nullable
minimum
number
| int32
Nullable
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
custom_order
object (CartItemCustomOrder)
CartItemCustomOrder
is_custom_order
boolean
manufacturing_time
number
| int32
manufacturing_time_unit
string
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Array of Charges
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
ChargesAmount
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of 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.
seller_count
number
Number of sellers offering the product.
allow_remove
boolean
If true, the product is allowed to be removed from the cart.
auto_add_to_cart
boolean
In case of bundle product this product is automatically added with parent product if true.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_charge_info
string
Delivery charge information message of the shipment.
common_config
object (CartCommonConfig)
CartCommonConfig
delivery_charges_config
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Array of ChargesThreshold
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)
CartDetailCoupon
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
Nullable
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.
medias
array of object (CartCouponMedias)
Array of CartCouponMedias
alt
string
url
string
type
string
key
string
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
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.
breakup_values
object (CartBreakup)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
uid
string
Nullable
Unique identifier of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
coupon_value
number
| float
Value of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
minimum_cart_value
number
| float
Minumum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
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.
Array of DisplayBreakup
key
string
Key of the price like total_mrp, total, subtotal etc.
value
number
| float
Numeric value of the price.
currency_code
string
Currency code for the price .
currency_symbol
string
Currency symbol for the price.
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.
original
number
| float32
attr
string
meta
object
preset
number
Value for the price which is set from platform if applicable.
loyalty_points
object (LoyaltyPoints)
LoyaltyPoints
is_applied
boolean
Nullable
Whether the loyalty points are applied on the cart .
total
number
| float
Nullable
Total loyalty points available with user.
applicable
number
| float
Nullable
Whether the loyalty points are applicable for the cart .
description
string
Nullable
Description for loyalty points.
message
string
Nullable
raw
object (RawBreakup)
RawBreakup
promotion
number
| float
coupon
number
| float
Coupon amount 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.
fynd_cash
number
| float
Loyalty points applied on cart.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
gift_card
number
| float
Gift cart amount applied on cart.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
total
number
| float
Total payable amount by the customer.
discount
number
| float
Discount amount recieved on cart.
delivery_charge
number
| float
Delivery charge applied to cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
subtotal
number
| float
Selling price amount of all products in cart.
sub_total
number
| float
convenience_fee
number
| float
Convenience fee amount applied to cart.
total_charge
number
| float
Total amount of charges applied on cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
checkout_mode
string
Checkout mode of user cart.
last_modified
string
Last modified timestamp of cart.
price_adjustment_applied
array of object (CartAppliedPriceAdjustment)
Array of CartAppliedPriceAdjustment
remove_articles
boolean
Boolean value indicating if articles should be removed from cart.
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
auto_remove
boolean
Boolean value indicating if auto remove is enabled.
applied_articles_ids
array of string
List of article IDs where the adjustment is applied.
message
string
Message associated with the Price adjustment.
_type
string
Type of the Price Adjustment.
Enum
meta
object
Meta data added in article of price adjustment.
restrictions
object
It contains all the restrictions applied on price adjustments.
_id
string
ID of the price Adjustment.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
gstin
string
Nullable
GSTIN added in 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.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
pan_no
string
Nullable
Permanent Account Number of the user.
custom_cart
object (CustomCart)
CustomCart
id
string
Id of custom cart config.
cart_name
string
Name of custom cart.
cart_type
string
Type of custom cart.
is_universal
boolean
By default all carts are universal, will be false for custom cart.
is_pan_received
boolean
If the customer provides a PAN number, set it to true.
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 .
Examples
Parameters
id:
"65c06fe589db42581e4be72e"
i:
"true"
buy_now:
"false"
body:
body
Was this section helpful?
POST
Response
Shipment refers to the process of delivering purchased items from the seller's location to the customer's designated address. Shipment details includes seller information, estimated delivery dates, item quantity, order type (Home Delivery or Pick At Store or Digital) and other shipment meta information. Additionally, it provides details about the items included in the shipment.
Operations
GET
# List shipments.
POST
# Checkout cart
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
pick_at_store_uid
integer
ID of the store from where the order will be picked up by the customer, assuming the order_type is `PickAtStore`. This may or may not be the same as the ID of the ordering store.
ordering_store_id
integer
ID of the store where the customer is ordering from.
i
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
p
boolean
Select `true` for getting a payment option in response.
id
string
The unique identifier of the cart.
buy_now
boolean
This is boolean to get buy_now cart.
address_id
string
ID allotted to the selected address.
area_code
string
The PIN Code of the destination address, e.g. 400059.
order_type
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
Response
200
Success. Returns delivery promise along with shipment details and price breakup. Refer `CartShipmentsResult` for more details.
CartShipmentsResult
cart_id
integer
| int32
Cart id of the user cart.
uid
string
Cart id of the user cart.
coupon_text
string
Coupon text of coupon applied on cart.
id
string
Cart id of the user cart.
pan_config
object
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
Min Promise in ISO format.
comment
string
Comment message added in cart.
items
array of object (CartProductInfo)
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart.
product
object (CartProduct)
CartProduct
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.
Array of ProductImage
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.
teaser_tag
object
Nullable
Teaser tag or short promotional phrase for the product.
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
action
object (ProductAction)
ProductAction
query
object (ActionQuery)
ActionQuery
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)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart.
tags
array of string
Nullable
Products tags that are added to each product to identify the set of products.
_custom_json
object
Field to add custom json of the product in cart.
type
string
Nullable
Type of 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.
Array of CategoryInfo
uid
integer
| int32
Product Category Id.
name
string
Category name of the product .
attributes
object
Nullable
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
is_set
boolean
Nullable
Whether or not the product is a set of items.
article
object (ProductArticle)
ProductArticle
seller_identifier
string
Nullable
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart.
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
cart_item_meta
object
Meta details of the article added from cart.
parent_item_identifiers
object
Fields to determine parent product of the product.
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.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
gift_card
object (ArticleGiftCard)
ArticleGiftCard
gift_price
number
| float32
Gift price amount applied on article.
display_text
string
Nullable
A gift message for the recipient to be included with the delivery of the order.
gift_message
string
Gift message for the one while receive the delivery of the order with this message.
is_gift_applied
boolean
A flag indicating if the order is a gift.
product_group_tags
array of string
Nullable
List fot the unique identifier for the product grouping.
identifier
object
Nullable
Unique identifier of the article.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
extra_meta
object
Field to update extra meta of the article in cart.
type
string
Type of the data sent in response. Possible value is article.
Enum
_custom_json
object
Field to update custom json of the article in cart.
price
object (ArticlePriceInfo)
ArticlePriceInfo
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
meta
object
Article meta data.
size
string
Size of the article added in cart.
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld.
name
string
Nullable
Store name of the store from where the product is fulfiled .
store_code
string
Nullable
A unique code or identifier for the store, often used for internal reference.
tags
array of string
A list of article tags.
variants
object
Product variant responses, each detailing a specific variant.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
Min Promise in ISO format.
key
string
The attribute key associated with the size.
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
discount_single_quantity
number
| float
Discout amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
price_adjustment_applied
array of object (ArticleAppliedPriceAdjustment)
Array of ArticleAppliedPriceAdjustment
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
article_id
string
Article Id of product.
applied_quantity
integer
| int32
Article quantity on which this price adjusment applied.
meta
object
Meta data added in article of price adjustment.
price
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart.
message
string
Product level message which denotes error information to display over the product in cart.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
ProductAvailability
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.
Array of ProductAvailabilitySize
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.
moq
object (CartItemMOQ)
CartItemMOQ
increment_unit
number
| int32
Nullable
maximum
number
| int32
Nullable
minimum
number
| int32
Nullable
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
custom_order
object (CartItemCustomOrder)
CartItemCustomOrder
is_custom_order
boolean
manufacturing_time
number
| int32
manufacturing_time_unit
string
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Array of Charges
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
ChargesAmount
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of 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.
seller_count
number
Number of sellers offering the product.
allow_remove
boolean
If true, the product is allowed to be removed from the cart.
auto_add_to_cart
boolean
In case of bundle product this product is automatically added with parent product if true.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_charge_info
string
Delivery charge information message of the shipment.
common_config
object (CartCommonConfig)
CartCommonConfig
delivery_charges_config
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Array of ChargesThreshold
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)
CartDetailCoupon
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
Nullable
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.
medias
array of object (CartCouponMedias)
Array of CartCouponMedias
alt
string
url
string
type
string
key
string
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
message
string
Response message of get shipments API.
notification
object
staff_user_id
string
Nullable
success
boolean
breakup_values
object (CartBreakup)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
uid
string
Nullable
Unique identifier of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
coupon_value
number
| float
Value of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
minimum_cart_value
number
| float
Minumum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
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.
Array of DisplayBreakup
key
string
Key of the price like total_mrp, total, subtotal etc.
value
number
| float
Numeric value of the price.
currency_code
string
Currency code for the price .
currency_symbol
string
Currency symbol for the price.
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.
original
number
| float32
attr
string
meta
object
preset
number
Value for the price which is set from platform if applicable.
loyalty_points
object (LoyaltyPoints)
LoyaltyPoints
is_applied
boolean
Nullable
Whether the loyalty points are applied on the cart .
total
number
| float
Nullable
Total loyalty points available with user.
applicable
number
| float
Nullable
Whether the loyalty points are applicable for the cart .
description
string
Nullable
Description for loyalty points.
message
string
Nullable
raw
object (RawBreakup)
RawBreakup
promotion
number
| float
coupon
number
| float
Coupon amount 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.
fynd_cash
number
| float
Loyalty points applied on cart.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
gift_card
number
| float
Gift cart amount applied on cart.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
total
number
| float
Total payable amount by the customer.
discount
number
| float
Discount amount recieved on cart.
delivery_charge
number
| float
Delivery charge applied to cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
subtotal
number
| float
Selling price amount of all products in cart.
sub_total
number
| float
convenience_fee
number
| float
Convenience fee amount applied to cart.
total_charge
number
| float
Total amount of charges applied on cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
checkout_mode
string
Checkout mode of cart.
last_modified
string
Last modified timestamp of cart.
buy_now
boolean
Buy now flag of user cart.
gstin
string
Nullable
GSTIN number added in cart.
applied_promo_details
array of object (AppliedPromotion)
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
pan_no
string
Nullable
custom_cart
object (CustomCart)
CustomCart
id
string
Id of custom cart config.
cart_name
string
Name of custom cart.
cart_type
string
Type of custom cart.
is_universal
boolean
By default all carts are universal, will be false for custom cart.
price_adjustment_applied
array of object (CartAppliedPriceAdjustment)
Array of CartAppliedPriceAdjustment
remove_articles
boolean
Boolean value indicating if articles should be removed from cart.
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
auto_remove
boolean
Boolean value indicating if auto remove is enabled.
applied_articles_ids
array of string
List of article IDs where the adjustment is applied.
message
string
Message associated with the Price adjustment.
_type
string
Type of the Price Adjustment.
Enum
meta
object
Meta data added in article of price adjustment.
restrictions
object
It contains all the restrictions applied on price adjustments.
_id
string
ID of the price Adjustment.
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.
Array of ShipmentResult
shipments
integer
| int32
Count of shipments that will be shipped.
Default Value : 1
promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
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.
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.
dp_id
string
Nullable
Delivery partner id of the shipment.
items
array of object (CartProductInfo)
Item details in the shipment.
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart.
product
object (CartProduct)
CartProduct
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.
Array of ProductImage
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.
teaser_tag
object
Nullable
Teaser tag or short promotional phrase for the product.
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
action
object (ProductAction)
ProductAction
query
object (ActionQuery)
ActionQuery
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)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart.
tags
array of string
Nullable
Products tags that are added to each product to identify the set of products.
_custom_json
object
Field to add custom json of the product in cart.
type
string
Nullable
Type of 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.
Array of CategoryInfo
uid
integer
| int32
Product Category Id.
name
string
Category name of the product .
attributes
object
Nullable
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
is_set
boolean
Nullable
Whether or not the product is a set of items.
article
object (ProductArticle)
ProductArticle
seller_identifier
string
Nullable
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart.
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
cart_item_meta
object
Meta details of the article added from cart.
parent_item_identifiers
object
Fields to determine parent product of the product.
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.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
gift_card
object (ArticleGiftCard)
ArticleGiftCard
gift_price
number
| float32
Gift price amount applied on article.
display_text
string
Nullable
A gift message for the recipient to be included with the delivery of the order.
gift_message
string
Gift message for the one while receive the delivery of the order with this message.
is_gift_applied
boolean
A flag indicating if the order is a gift.
product_group_tags
array of string
Nullable
List fot the unique identifier for the product grouping.
identifier
object
Nullable
Unique identifier of the article.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
extra_meta
object
Field to update extra meta of the article in cart.
type
string
Type of the data sent in response. Possible value is article.
Enum
_custom_json
object
Field to update custom json of the article in cart.
price
object (ArticlePriceInfo)
ArticlePriceInfo
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
meta
object
Article meta data.
size
string
Size of the article added in cart.
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld.
name
string
Nullable
Store name of the store from where the product is fulfiled .
store_code
string
Nullable
A unique code or identifier for the store, often used for internal reference.
tags
array of string
A list of article tags.
variants
object
Product variant responses, each detailing a specific variant.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
Min Promise in ISO format.
key
string
The attribute key associated with the size.
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
discount_single_quantity
number
| float
Discout amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
price_adjustment_applied
array of object (ArticleAppliedPriceAdjustment)
Array of ArticleAppliedPriceAdjustment
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
article_id
string
Article Id of product.
applied_quantity
integer
| int32
Article quantity on which this price adjusment applied.
meta
object
Meta data added in article of price adjustment.
price
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart.
message
string
Product level message which denotes error information to display over the product in cart.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
ProductAvailability
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.
Array of ProductAvailabilitySize
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.
moq
object (CartItemMOQ)
CartItemMOQ
increment_unit
number
| int32
Nullable
maximum
number
| int32
Nullable
minimum
number
| int32
Nullable
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
custom_order
object (CartItemCustomOrder)
CartItemCustomOrder
is_custom_order
boolean
manufacturing_time
number
| int32
manufacturing_time_unit
string
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Array of Charges
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
ChargesAmount
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of 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.
seller_count
number
Number of sellers offering the product.
allow_remove
boolean
If true, the product is allowed to be removed from the cart.
auto_add_to_cart
boolean
In case of bundle product this product is automatically added with parent product if true.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
fulfillment_type
string
Fulfilment type of shipment.
fulfillment_id
integer
| int32
Fulfilment id of the shipment.
meta
object (ShipmentMeta)
ShipmentMeta
packaging_name
string
Nullable
dimension
object (ShipmentMetaDimension)
ShipmentMetaDimension
height
number
The height of the product.
length
number
The length of the product.
width
number
The width of the product.
assign_dp_from_sb
string
Nullable
dp_sort_key
string
Nullable
shipment_weight
number
Nullable
shipment_volumetric_weight
number
Nullable
shipment_chargeable_weight
number
Nullable
shipping_zone
string
Nullable
debug
string
Nullable
logistics_meta
object (ShipmentLogisticsMeta)
ShipmentLogisticsMeta
account_options
array of object (ShipmentLogisticsMetaAccount)
Array of ShipmentLogisticsMetaAccount
name
string
Nullable
display_name
string
Nullable
fm_priority
number
Nullable
lm_priority
number
Nullable
rvp_priority
number
Nullable
type
string
Nullable
sub_type
string
Nullable
parent_id
string
Nullable
is_active
boolean
Nullable
payment_mode
string
Nullable
assign_dp_from_sb
string
Nullable
internal_account_id
string
Nullable
external_account_id
string
Nullable
f_priority
number
Nullable
r_priority
number
Nullable
dp_shipping_charges
number
Nullable
qc_enabled
boolean
Nullable
area_code
object (ShipmentLogisticsMetaAccountAreaCode)
ShipmentLogisticsMetaAccountAreaCode
from_pincode
string
Nullable
to_pincode
string
Nullable
source
string
Nullable
destination
string
Nullable
operations
array of string
dp_tat
object (ShipmentLogisticsMetaAccountDpTat)
ShipmentLogisticsMetaAccountDpTat
min
number
Nullable
max
number
Nullable
account_info
object
dp_sort_key
string
Nullable
assign_dp_from_sb
string
Nullable
error
object (ShipmentError)
ShipmentError
type
string
Nullable
value
array of string
message
string
Nullable
error
boolean
Error details if any error occurs which includes type of error, error code and error message.
is_pan_received
boolean
If the customer provides a PAN number, set it to true.
custom_cart_meta
object
Custom meta details added cart checkout API payload.
Examples
Parameters
ordering_store_id:
2890
id:
"65c06fe589db42581e4be72e"
address_id:
"65bb5a41feeb84432e132c03"
area_code:
400093
Was this section helpful?
GET
Response
The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement.
Parameters
buy_now
boolean
This indicates the type of cart to checkout.
cart_type
string
The type of cart.
Enum
Request body
custom_meta
array of object (CartCheckoutCustomMeta)
Custom meta data to be added in order.
Array of CartCheckoutCustomMeta
key
string
Required
Key name of custom meta.
value
string
Required
Value to be added in key.
customer_details
object (CustomerDetails)
Customer details to be added in order.
CustomerDetails
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.
id
string
Cart id of the user cart.
payment_auto_confirm
boolean
Payment auto confirm flag if payment need not to be collected from user.
payment_mode
string
Required
Payment mode from which the payment to be done for the order.
aggregator
string
Aggregator name of the payment gateway.
address_id
string
Address id of the user on which the order to be delivered.
callback_url
string
Callback url to be redirected after payment received/failed.
delivery_address
object
Delivery address data which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name.
staff
object (StaffCheckout)
StaffCheckout
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
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
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
Payment params which includes payment identifier and merchant code.
billing_address_id
string
Billing address id of the customer on which the invoice to be generated after the order is placed.
meta
object
Meta data to be added in order.
payment_extra_identifiers
object
Payment extra identifier for the payment mode to do the payment.
iin
string
Issuer Identification Number' number of card if payment mode is card.
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.
Response
200
Success. Returns the status of cart checkout. Refer `CartCheckoutResultSchema` for more details.
CartCheckoutResult
payment_confirm_url
string
Nullable
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)
CheckCart
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.
uid
string
Cart id of user cart.
coupon_text
string
Coupon text of the applied coupon on order placed.
id
string
Cart id of the user cart.
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
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.
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart.
product
object (CartProduct)
CartProduct
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.
Array of ProductImage
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.
teaser_tag
object
Nullable
Teaser tag or short promotional phrase for the product.
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
action
object (ProductAction)
ProductAction
query
object (ActionQuery)
ActionQuery
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)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart.
tags
array of string
Nullable
Products tags that are added to each product to identify the set of products.
_custom_json
object
Field to add custom json of the product in cart.
type
string
Nullable
Type of 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.
Array of CategoryInfo
uid
integer
| int32
Product Category Id.
name
string
Category name of the product .
attributes
object
Nullable
Product attributes defined on platform.
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart.
is_set
boolean
Nullable
Whether or not the product is a set of items.
article
object (ProductArticle)
ProductArticle
seller_identifier
string
Nullable
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart.
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller.
name
string
Nullable
Name of entities like brand or seller.
cart_item_meta
object
Meta details of the article added from cart.
parent_item_identifiers
object
Fields to determine parent product of the product.
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.
uid
string
This unique identifier is assigned to the specific article. This represents item x size x location.
gift_card
object (ArticleGiftCard)
ArticleGiftCard
gift_price
number
| float32
Gift price amount applied on article.
display_text
string
Nullable
A gift message for the recipient to be included with the delivery of the order.
gift_message
string
Gift message for the one while receive the delivery of the order with this message.
is_gift_applied
boolean
A flag indicating if the order is a gift.
product_group_tags
array of string
Nullable
List fot the unique identifier for the product grouping.
identifier
object
Nullable
Unique identifier of the article.
mto_quantity
integer
| int32
Quantity of the product which will specially manufactured as not available in stock.
extra_meta
object
Field to update extra meta of the article in cart.
type
string
Type of the data sent in response. Possible value is article.
Enum
_custom_json
object
Field to update custom json of the article in cart.
price
object (ArticlePriceInfo)
ArticlePriceInfo
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions.
currency_code
string
Currency code for all amounts.
currency_symbol
string
Currency symbol of the currncy used for price.
marked
number
| float
Original price of product.
selling
number
| float
meta
object
Article meta data.
size
string
Size of the article added in cart.
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld.
name
string
Nullable
Store name of the store from where the product is fulfiled .
store_code
string
Nullable
A unique code or identifier for the store, often used for internal reference.
tags
array of string
A list of article tags.
variants
object
Product variant responses, each detailing a specific variant.
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart.
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Nullable
Maximum Delivery promise formatted timestamp.
min
string
Nullable
Minimum Delivery promise formatted timestamp.
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Nullable
Maximum Promise for the shipment.
min
number
| float
Nullable
Minimum delivery promise time for the shipment.
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Nullable
Max promise in ISO format.
min
string
Nullable
Min Promise in ISO format.
key
string
The attribute key associated with the size.
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart.
discount_single_quantity
number
| float
Discout amount applied from coupon for single quantity of the product.
code
string
Coupon code of the coupon applied.
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.
price_adjustment_applied
array of object (ArticleAppliedPriceAdjustment)
Array of ArticleAppliedPriceAdjustment
adjusted_value
object
Value of price adjustment created along with destination currency.
article_level_distribution
boolean
Boolean value true if price adjustment is distributed over articles.
article_id
string
Article Id of product.
applied_quantity
integer
| int32
Article quantity on which this price adjusment applied.
meta
object
Meta data added in article of price adjustment.
price
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied.
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart.
message
string
Product level message which denotes error information to display over the product in cart.
discount
string
Discount amount of the product in cart.
availability
object (ProductAvailability)
ProductAvailability
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.
Array of ProductAvailabilitySize
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.
moq
object (CartItemMOQ)
CartItemMOQ
increment_unit
number
| int32
Nullable
maximum
number
| int32
Nullable
minimum
number
| int32
Nullable
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product .
add_on
number
| float
Price before promotion and coupon amount applied for calculation.
currency_code
string
Currency code of the price defined for the product.
currency_symbol
string
Currency symbol of the price defined for the product.
effective
number
| float
Selling price of the product.
selling
number
| float
Selling price of the product.
selling_price
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user.
custom_order
object (CartItemCustomOrder)
CartItemCustomOrder
is_custom_order
boolean
manufacturing_time
number
| int32
manufacturing_time_unit
string
charges
array of object (Charges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Array of Charges
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
ChargesAmount
value
number
| float
This is the value of amount added.
currency
string
This is destination currency of 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.
seller_count
number
Number of sellers offering the product.
allow_remove
boolean
If true, the product is allowed to be removed from the cart.
auto_add_to_cart
boolean
In case of bundle product this product is automatically added with parent product if true.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
enabled
boolean
Denotes if default payment selection is enable.
default_options
string
Default Selection Payment Mode.
payment_identifier
string
Identifier for Payment Mode.
delivery_charge_info
string
Delivery charge information message of the shipment.
common_config
object (CartCommonConfig)
CartCommonConfig
delivery_charges_config
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
Delivery charge enabled for the cart or not.
charges
array of object (ChargesThreshold)
Charges applicable based on threshold.
Array of ChargesThreshold
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)
CartDetailCoupon
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
Nullable
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.
medias
array of object (CartCouponMedias)
Array of CartCouponMedias
alt
string
url
string
type
string
key
string
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
message
string
Message of the cart checkout API response.
notification
object
staff_user_id
string
success
boolean
Success flag of checkout cart API response.
breakup_values
object (CartBreakup)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon.
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart.
value
number
| float
Coupon value of the coupon applied to cart.
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart.
uid
string
Nullable
Unique identifier of the coupon applied to cart.
coupon_type
string
Nullable
Type of the coupon applied to cart.
sub_title
string
Nullable
Coupon subtitle of the coupon applied to cart which is used to display.
coupon_value
number
| float
Value of the coupon applied to cart.
code
string
Coupon code of the coupon applied.
type
string
Type of the coupon applied to cart.
minimum_cart_value
number
| float
Minumum cart value of cart after which the coupon can be applied.
message
string
Coupon message of the coupon applied to cart.
description
string
Nullable
Coupon description of the coupon applied to cart.
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.
Array of DisplayBreakup
key
string
Key of the price like total_mrp, total, subtotal etc.
value
number
| float
Numeric value of the price.
currency_code
string
Currency code for the price .
currency_symbol
string
Currency symbol for the price.
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.
original
number
| float32
attr
string
meta
object
preset
number
Value for the price which is set from platform if applicable.
loyalty_points
object (LoyaltyPoints)
LoyaltyPoints
is_applied
boolean
Nullable
Whether the loyalty points are applied on the cart .
total
number
| float
Nullable
Total loyalty points available with user.
applicable
number
| float
Nullable
Whether the loyalty points are applicable for the cart .
description
string
Nullable
Description for loyalty points.
message
string
Nullable
raw
object (RawBreakup)
RawBreakup
promotion
number
| float
coupon
number
| float
Coupon amount 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.
fynd_cash
number
| float
Loyalty points applied on cart.
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart.
gift_card
number
| float
Gift cart amount applied on cart.
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD.
total
number
| float
Total payable amount by the customer.
discount
number
| float
Discount amount recieved on cart.
delivery_charge
number
| float
Delivery charge applied to cart.
you_saved
number
| float
Total amount will be saved if customer places the order.
subtotal
number
| float
Selling price amount of all products in cart.
sub_total
number
| float
convenience_fee
number
| float
Convenience fee amount applied to cart.
total_charge
number
| float
Total amount of charges applied on cart.
mop_total
number
| float
Total of payment modes by which payment is going to be done.
is_valid
boolean
Valid flag fotr the checkout response if order placed was valid.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
checkout_mode
string
Checkout mode of user cart.
last_modified
string
Last modified timestamp of cart.
buy_now
boolean
Buy now flag of user cart.
gstin
string
Nullable
GSTIN number added in cart.
applied_promo_details
array of object (AppliedPromotion)
Array of AppliedPromotion
id
string
Promotion id of current promotion.
discount
number
Discount of current promotion.
article_quantity
integer
| int32
Quantity of article on which promotion is applicable.
original_article_quantity
integer
| int32
ownership
object (Ownership)
Ownership of promotion.
Ownership
payable_category
string
Promotion amount payable category.
Enum
payable_by
string
Promotion amount bearable party.
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015.
symbol
string
Currency symbol for currency of user cart prices.
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions.
Array of DiscountRulesApp
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
raw_offer
object (PromoDiscountRuleRawOffer)
PromoDiscountRuleRawOffer
buy_condition
string
discount_type
string
offer
object (PromoDiscountRuleOffer)
PromoDiscountRuleOffer
max_offer_quantity
number
| int32
Nullable
discount_percentage
number
| float32
Nullable
discount_amount
number
Nullable
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
item_criteria
object (PromoDiscountRuleItemCriteria)
PromoDiscountRuleItemCriteria
item_id
array of number
buy_rules
array of string
all_items
boolean
matched_buy_rules
array of string
Matched buy rules for promotion.
applied_free_articles
array of object (AppliedFreeArticles)
Applied free article for free gift item promotions.
Array of AppliedFreeArticles
parent_item_identifier
string
Parent item identifier for free article.
quantity
integer
| int32
Quantity of free articles.
article_id
string
IDs of free articles.
free_gift_item_details
object (FreeGiftItems)
Free gift items details.
FreeGiftItems
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)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
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)
PriceMinMax
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)
ArticlePriceDetails
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.
promotion_name
string
Promotion name of current promotion.
buy_rules
array of object (BuyRules)
Buy rules for promotions.
Array of BuyRules
cart_conditions
object (PromoBuyRuleCartConditions)
PromoBuyRuleCartConditions
cart_quantity
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
cart_total
object (PromoBuyRuleCompareFieldsTypes)
PromoBuyRuleCompareFieldsTypes
greater_than_equals
number
greater_than
number
equals
number
less_than
number
less_than_equals
number
item_id
array of number
item_store
array of number
item_company
array of number
item_brand
array of number
item_exclude_brand
array of number
item_category
array of number
item_exclude_category
array of number
item_l1_category
array of number
item_exclude_l1_category
array of number
item_l2_category
array of number
item_exclude_l2_category
array of number
item_department
array of number
item_exclude_id
array of number
available_zones
array of number
product_tags
array of string
item_criteria
object
Item criteria of promotion.
all_items
boolean
Nullable
mrp_promo
boolean
slug
string
offer_text
string
Offer text of current promotion.
amount
number
| float
Per unit discount amount applied with current promotion.
promotion_type
string
Promotion type of current promotion.
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP.
promotion_group
string
Promotion group for the promotion.
promo_id
string
Promotion id.
meta
object
Meta object for extra data.
code
string
Nullable
Promotion code.
offer_label
string
Nullable
return_allowed
boolean
Nullable
cancellation_allowed
boolean
Nullable
promo_code
string
Nullable
free_quantity
integer
| int32
Nullable
offer_description
string
Nullable
pan_no
string
Nullable
custom_cart
object (CustomCart)
CustomCart
id
string
Id of custom cart config.
cart_name
string
Name of custom cart.
cart_type
string
Type of custom cart.
is_universal
boolean
By default all carts are universal, will be false for custom cart.
price_adjustment_applied
array of object (PriceAdjustmentApplied)
Array of PriceAdjustmentApplied
article_id
string
adjusted_value
object
applied_quantity
number
meta
object
article_level_distribution
boolean
type
string
is_pan_received
boolean
If the customer provides a PAN number, set it to true.
pan_config
object
order_id
string
Order id generated after placing order.
custom_cart_meta
object
Custom cart meta details added in cart.
Examples
Parameters
buy_now:
"false"
body:
body
Was this section helpful?
POST
Response