Note: You are viewing an older version of the documentation. Click here to go the latest version
Cart
Handles shopping carts, including adding, removing, and updating items, as well as calculating totals.
The cart provides detailed information about selected items, including their name, quantity, price breakup, applied discounts, and any relevant attributes like size, product image, or tags. It also displays availability status, estimated shipping time, and seller information. This helps customers track their products throughout the order journey.
Operations
POST
# Check cart serviceability
POST
# Check COD serviceability and charges for cart
GET
# Get abandoned carts
GET
# Get abandoned cart details
POST
# Add items to cart
PUT
# Update cart items
POST
# Share cart link
GET
# List shared cart items
POST
# Update shared cart items
GET
# List of carts
PUT
# Update user of a cart
GET
# Get a cart
POST
# Add items to cart
PUT
# Update cart items
PATCH
# Update cart breakup values
PUT
# Delete a cart
GET
# Get a cart items count
PUT
# Update cart metadata
Verify the serviceability of items in the cart at a specific pin code and ensure accurate delivery promises. System checks each item's availability and delivery feasibility, providing real-time information on serviceability and estimated delivery times.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
bodyrequestBody
object (OpenApiCartServiceabilityCreation)
Required
Hide
Shipping detail from API response schema which includes list of items, shipping address
cart_items
array of object (CartItem)
Required
List of items in open api cart response
Show
Information of product in cart like their quantity, size and product id
quantity
integer
| int32
Quantity of product in cart
product_id
string
Required
Unique identifier of product in cart
size
string
Required
Size of product in cart
shipping_address
object (ShippingAddress)
Required
Show
Shipping address details, consists of pincode, phone, address id, country code, geo location, country, state, city, landmark, email etc
country
string
Nullable
Country of address
state
string
Nullable
State of the address
city
string
Nullable
City of the address
phone
integer
| int32
Phone number for address
area_code
string
Area code of the address
country_iso_code
string
Country iso code for address
country_phone_code
string
Country phone code for address
meta
object
Metadata of the address
address_type
string
Address type of address
area
string
Area description for address
area_code_slug
string
Area code slug for address. example pincode is slug for India
Default Value : pincode
name
string
Name of person in address data to whom it belongs to
landmark
string
Landmark of address
email
string
Email address for address data
country_code
string
Country code of address
Default Value : IND
pincode
integer
| int32
Pincode for address data
address
string
Address description for address data
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
Request body
cart_items
array of object (CartItem)
Required
List of items in open api cart response
Show
Information of product in cart like their quantity, size and product id
quantity
integer
| int32
Quantity of product in cart
product_id
string
Required
Unique identifier of product in cart
size
string
Required
Size of product in cart
shipping_address
object (ShippingAddress)
Required
Show
Shipping address details, consists of pincode, phone, address id, country code, geo location, country, state, city, landmark, email etc
country
string
Nullable
Country of address
state
string
Nullable
State of the address
city
string
Nullable
City of the address
phone
integer
| int32
Phone number for address
area_code
string
Area code of the address
country_iso_code
string
Country iso code for address
country_phone_code
string
Country phone code for address
meta
object
Metadata of the address
address_type
string
Address type of address
area
string
Area description for address
area_code_slug
string
Area code slug for address. example pincode is slug for India
Default Value : pincode
name
string
Name of person in address data to whom it belongs to
landmark
string
Landmark of address
email
string
Email address for address data
country_code
string
Country code of address
Default Value : IND
pincode
integer
| int32
Pincode for address data
address
string
Address description for address data
POST
Response
200
Cart details with pincode validity information at item level
Hide
Cart serviciability API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment common config, coupon, coupon text, gstin etc.
is_valid
boolean
Cart validity flag determines the if the response is valid or not
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categoreis,, images, item code, tags, item id, item name, etc
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Show
Product images data in different formats
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
Show
Schema of Action Object to render the product.
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
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
Show
Category information schema which denotes category name and category id
uid
integer
| int32
Unique identifier of Product Category
name
string
Category name of the product
attributes
object
Product attributes defined on platform
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request)
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart
is_set
boolean
Whether or not the product is a set of items
article
object (ProductArticle)
Show
Detailed information of the product added in cart
seller_identifier
string
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
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
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift
product_group_tags
array of string
List fot the unique identifier for the product grouping.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
identifier
object
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
_custom_json
object
Field to update custom json of the article in cart
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article
converted
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
base
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
Show
Product store information of the product added in cart
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
Store name of the store from where the product is fulfiled
store_code
string
A unique code or identifier for the store, often used for internal reference
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
Undefined Type
The store's operational hours for each day of the week.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
The attribute key associated with the size
coupon
object (CouponDetails)
Show
Coupon actual price breakup details
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
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
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)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
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
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability
Show
Product sizes availability
display
string
Display size of the product
value
string
Actual value of the size
is_available
boolean
Available flag for the size of the product if that is available
out_of_stock
boolean
Denotes if the product is available in stock
sizes
array of string
All sizes of the product
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
promo_meta
object (PromoMeta)
Show
Loyalty points message data
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user
custom_order
object
Whether MTO (Make to Order) is enabled or not.
item_type
string
Type of the item in cart.
Enum
charges
array of object (ArticleCharges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
message
string
Message of the cart detail API response
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, and loyalty points
coupon
object (CouponBreakup)
Show
Coupon details of the coupon applied to cart that incluedes coupon id, coupon title, description, coupon code, applied message etc.
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
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
Minimum cart value of the coupon applied to cart
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
Show
Display price breakup schema denotes price currency, key, value, message to display as breakup on UI
key
string
key of the price like total_mrp, total, subtotal etc
value
number
| float
Numeric value for 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
loyalty_points
object (LoyaltyPoints)
Show
Loyalty points data which determines how much loyalty points applied to cart and total loyalty points customer has in his account
is_applied
boolean
Whether the loyalty points are applied on the cart
total
number
| float
Total loyalty points available with user
applicable
number
| float
Whether the loyalty points are applicable for the cart
description
string
Description for loyalty points
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage points amount applied on the cart.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Title to show how many earn points are gained for this order.
title
string
Unique title for loyalty program applicable.
discount_amount
number
| float
Engage discount amount applied on the cart as payment mode
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convinience fee, coupon amount, delivery charge, discount, loyalty points,engage points, gift card, gst charge, etc.
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
engage_amount
number
| float
Engage points amount applied on the cart.
engage_mop_amount
number
| float
Engage mop amount applied on the 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 received 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
convenience_fee
number
| float
Convenience fee amount applied to cart
store_credit
number
| float
Store credit redeemed on the cart
Examples
Parameters
Parameters are not required.
Response
Check cart serviceability
checkCartServiceability
Check whether Cash on Delivery (COD) is available for the given cart items at a specific pin code, and return the applicable COD charges. Performs a pincode-level serviceability check via the logistics layer and computes COD fee based on cart value and payment configuration.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
bodyrequestBody
object (PlatformCartCODServiceabilityCreation)
Required
Hide
Shipping detail from API request schema which includes list of items and shipping address
cart_items
array of object (CartItem)
Required
List of items in the cart
Show
Information of product in cart like their quantity, size and product id
quantity
integer
| int32
Quantity of product in cart
product_id
string
Required
Unique identifier of product in cart
size
string
Required
Size of product in cart
shipping_address
object (ShippingAddress)
Required
Show
Shipping address details, consists of pincode, phone, address id, country code, geo location, country, state, city, landmark, email etc
country
string
Nullable
Country of address
state
string
Nullable
State of the address
city
string
Nullable
City of the address
phone
integer
| int32
Phone number for address
area_code
string
Area code of the address
country_iso_code
string
Country iso code for address
country_phone_code
string
Country phone code for address
meta
object
Metadata of the address
address_type
string
Address type of address
area
string
Area description for address
area_code_slug
string
Area code slug for address. example pincode is slug for India
Default Value : pincode
name
string
Name of person in address data to whom it belongs to
landmark
string
Landmark of address
email
string
Email address for address data
country_code
string
Country code of address
Default Value : IND
pincode
integer
| int32
Pincode for address data
address
string
Address description for address data
Request body
cart_items
array of object (CartItem)
Required
List of items in the cart
Show
Information of product in cart like their quantity, size and product id
quantity
integer
| int32
Quantity of product in cart
product_id
string
Required
Unique identifier of product in cart
size
string
Required
Size of product in cart
shipping_address
object (ShippingAddress)
Required
Show
Shipping address details, consists of pincode, phone, address id, country code, geo location, country, state, city, landmark, email etc
country
string
Nullable
Country of address
state
string
Nullable
State of the address
city
string
Nullable
City of the address
phone
integer
| int32
Phone number for address
area_code
string
Area code of the address
country_iso_code
string
Country iso code for address
country_phone_code
string
Country phone code for address
meta
object
Metadata of the address
address_type
string
Address type of address
area
string
Area description for address
area_code_slug
string
Area code slug for address. example pincode is slug for India
Default Value : pincode
name
string
Name of person in address data to whom it belongs to
landmark
string
Landmark of address
email
string
Email address for address data
country_code
string
Country code of address
Default Value : IND
pincode
integer
| int32
Pincode for address data
address
string
Address description for address data
POST
Response
200
Cart details with COD availability and charges at pincode level
Hide
Cart COD serviceability API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment common config, coupon, coupon text, gstin etc along with COD availability and charges.
is_valid
boolean
Cart validity flag determines the if the response is valid or not
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categoreis,, images, item code, tags, item id, item name, etc
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Show
Product images data in different formats
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
Show
Schema of Action Object to render the product.
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
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
Show
Category information schema which denotes category name and category id
uid
integer
| int32
Unique identifier of Product Category
name
string
Category name of the product
attributes
object
Product attributes defined on platform
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request)
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart
is_set
boolean
Whether or not the product is a set of items
article
object (ProductArticle)
Show
Detailed information of the product added in cart
seller_identifier
string
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
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
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift
product_group_tags
array of string
List fot the unique identifier for the product grouping.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
identifier
object
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
_custom_json
object
Field to update custom json of the article in cart
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article
converted
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
base
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
Show
Product store information of the product added in cart
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
Store name of the store from where the product is fulfiled
store_code
string
A unique code or identifier for the store, often used for internal reference
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
The attribute key associated with the size
coupon
object (CouponDetails)
Show
Coupon actual price breakup details
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
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
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)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
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
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability
Show
Product sizes availability
display
string
Display size of the product
value
string
Actual value of the size
is_available
boolean
Available flag for the size of the product if that is available
out_of_stock
boolean
Denotes if the product is available in stock
sizes
array of string
All sizes of the product
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
promo_meta
object (PromoMeta)
Show
Loyalty points message data
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user
custom_order
object
Whether MTO (Make to Order) is enabled or not.
item_type
string
Type of the item in cart.
Enum
charges
array of object (ArticleCharges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
message
string
Message of the cart detail API response
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, and loyalty points
coupon
object (CouponBreakup)
Show
Coupon details of the coupon applied to cart that incluedes coupon id, coupon title, description, coupon code, applied message etc.
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
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
Minimum cart value of the coupon applied to cart
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
Show
Display price breakup schema denotes price currency, key, value, message to display as breakup on UI
key
string
key of the price like total_mrp, total, subtotal etc
value
number
| float
Numeric value for 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
loyalty_points
object (LoyaltyPoints)
Show
Loyalty points data which determines how much loyalty points applied to cart and total loyalty points customer has in his account
is_applied
boolean
Whether the loyalty points are applied on the cart
total
number
| float
Total loyalty points available with user
applicable
number
| float
Whether the loyalty points are applicable for the cart
description
string
Description for loyalty points
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage points amount applied on the cart.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Title to show how many earn points are gained for this order.
title
string
Unique title for loyalty program applicable.
discount_amount
number
| float
Engage discount amount applied on the cart as payment mode
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convinience fee, coupon amount, delivery charge, discount, loyalty points,engage points, gift card, gst charge, etc.
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
engage_amount
number
| float
Engage points amount applied on the cart.
engage_mop_amount
number
| float
Engage mop amount applied on the 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 received 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
convenience_fee
number
| float
Convenience fee amount applied to cart
store_credit
number
| float
Store credit redeemed on the cart
is_cod_available
boolean
Indicates whether Cash on Delivery is available for the given cart items at the requested pincode, based on logistics serviceability and payment configuration
Examples
Parameters
Parameters are not required.
Response
Check COD serviceability and charges for cart
checkCODServiceability
Retrieve the list of abandoned carts that have been active for the specified period of time and have not yet been archived for the specific sales channel.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
page_noquery
integer
current page no as per pagination
Default Value : 0
page_sizequery
integer
Cart max records fetched in single request
Default Value : 10
from_datequery
string
| date-time
Cart which are created on or after from_date
to_datequery
string
| date-time
Cart which are created on or before to_date
anonymous_cartquery
boolean
Filter by `anonymous_cart`
last_idquery
string
pagination is done based on the last_object_id
sort_onquery
string
on which column to sort on i.e created_on or last_modified
GET
Response
200
Abandoned Cart List for sent page_size and page_no
Hide
Abandon cart api response schema hich includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
items
array of object (AbandonedCart)
List of items in abandon cart
Show
Abandoned cart deatil response schema
expire_at
string
| date-time
Expire details of user cart
promotion
object
Promotion object details like amount, mode, currency and list of promotions in user cart
is_default
boolean
User cart default status
comment
string
Nullable
Comment message to be added in user cart
articles
array of object
List of articles in user cart
coupon
object
Nullable
Coupon data of user cart which denotes if coupon is applied, coupon code, coupon amount, coupon title and coupon message
bulk_coupon_discount
number
| float
Nullable
Total bulk discount amount applied in user cart
_id
string
Unique identifier of the user cart
fynd_credits
object
Fynd credit points applied in user cart
fc_index_map
array of integer
Flat article index in user cart
order_id
string
Order id generated in user cart
discount
number
| float
Discount amount of the product in cart
cod_charges
object
Cash On Delivery charges of the user cart
payments
object
Nullable
Payment object selected in user cart
payment_mode
string
Nullable
Payment mode of the payment selected to do the payment
shipments
array of object
Shipment details for the items in a cart, specific to the selected address.
pick_up_customer_details
object
Nullable
Customer contact details for customer pickup at store
uid
integer
| int32
Unique Identifier of user cart
checkout_mode
string
Checkout mode of user cart
cart_value
number
| float
Total amount of user cart
is_archive
boolean
Flag to indicate cart is archived or not
created_on
string
| date-time
Date time format when user cart created
last_modified
string
| date-time
Date time format when user cart last modified
meta
object
Nullable
Extra meta data of user cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
is_active
boolean
Flag indicates user cart is active or not
cashback
object
Cart level cashback data which denotes cashback amount and cashback message
payment_methods
array of object
Payment methods list used to make the payment
gstin
string
Nullable
GSTIN added in user cart
delivery_charges
object
Delivery charges of user cart
merge_qty
boolean
Nullable
Flag indicates cart has merged article or not
user_id
string
User Id of user cart
app_id
string
Application id of user cart
result
object
Define the list of items with updated status
page
object (Page)
Show
An object representing a page with pagination details.
item_total
integer
| int32
The total number of all items across all pages.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, can be 'cursor' or 'number'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
success
boolean
The request success is defined
message
string
message of the response
Examples
Parameters
Parameters are not required.
Response
Get abandoned carts
getAbandonedCart
Retrieves abandoned cart details linked to a specific customer using a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart
iquery
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
bquery
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
cquery
boolean
This is a boolean value. Select `true` to retrieve the cod charges in breakup of cart items.
GET
Response
200
Success. Returns a Cart object. Check the example shown below or refer `CartDetailResult` for more details.
Hide
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categoreis,, images, item code, tags, item id, item name, etc
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Show
Product images data in different formats
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
Show
Schema of Action Object to render the product.
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
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
Show
Category information schema which denotes category name and category id
uid
integer
| int32
Unique identifier of Product Category
name
string
Category name of the product
attributes
object
Product attributes defined on platform
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request)
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart
is_set
boolean
Whether or not the product is a set of items
article
object (ProductArticle)
Show
Detailed information of the product added in cart
seller_identifier
string
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
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
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift
product_group_tags
array of string
List fot the unique identifier for the product grouping.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
identifier
object
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
_custom_json
object
Field to update custom json of the article in cart
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article
converted
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
base
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
Show
Product store information of the product added in cart
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
Store name of the store from where the product is fulfiled
store_code
string
A unique code or identifier for the store, often used for internal reference
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
The attribute key associated with the size
coupon
object (CouponDetails)
Show
Coupon actual price breakup details
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
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
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)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
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
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability
Show
Product sizes availability
display
string
Display size of the product
value
string
Actual value of the size
is_available
boolean
Available flag for the size of the product if that is available
out_of_stock
boolean
Denotes if the product is available in stock
sizes
array of string
All sizes of the product
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
promo_meta
object (PromoMeta)
Show
Loyalty points message data
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user
custom_order
object
Whether MTO (Make to Order) is enabled or not.
item_type
string
Type of the item in cart.
Enum
charges
array of object (ArticleCharges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment selection lock config for the user cart
payment_identifier
string
Identifier for Payment Mode
default_options
string
Default Selection Payment Mode
enabled
boolean
Denotes if default payment selection is enable
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag
enabled
boolean
Delivery charge enabled for the cart or not
charges
array of object (ChargesThreshold)
Charges applicable based on threshold
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold
charges
number
| float
Charges amount to be applied on cart
threshold
number
| float
Threshold of cart value on which the charge should be applied
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value
cashback_amount
number
| float
Fields denotes cashback amount applied to cart
cashback_message_primary
string
Primary cashback message for coupon applied to cart
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart
coupon_code
string
Coupon code to be applied to cart
coupon_description
string
Coupon description of the coupon applied to cart
coupon_id
string
Unique identifier of the coupon applied to cart
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart
coupon_title
string
Coupon title of the coupon applied
coupon_type
string
Type of the coupon applied to cart
coupon_value
number
| float
Value of the coupon applied to cart
discount
number
| float
Total discount earned from coupon applied to cart
is_applied
boolean
Flag to determine where the coupon is applied to cart or not
is_valid
boolean
Determine where the coupon applied to cart is valid
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart
message
string
Coupon message of the coupon applied to cart
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, and loyalty points
coupon
object (CouponBreakup)
Show
Coupon details of the coupon applied to cart that incluedes coupon id, coupon title, description, coupon code, applied message etc.
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
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
Minimum cart value of the coupon applied to cart
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
Show
Display price breakup schema denotes price currency, key, value, message to display as breakup on UI
key
string
key of the price like total_mrp, total, subtotal etc
value
number
| float
Numeric value for 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
loyalty_points
object (LoyaltyPoints)
Show
Loyalty points data which determines how much loyalty points applied to cart and total loyalty points customer has in his account
is_applied
boolean
Whether the loyalty points are applied on the cart
total
number
| float
Total loyalty points available with user
applicable
number
| float
Whether the loyalty points are applicable for the cart
description
string
Description for loyalty points
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage points amount applied on the cart.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Title to show how many earn points are gained for this order.
title
string
Unique title for loyalty program applicable.
discount_amount
number
| float
Engage discount amount applied on the cart as payment mode
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convinience fee, coupon amount, delivery charge, discount, loyalty points,engage points, gift card, gst charge, etc.
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
engage_amount
number
| float
Engage points amount applied on the cart.
engage_mop_amount
number
| float
Engage mop amount applied on the 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 received 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
convenience_fee
number
| float
Convenience fee amount applied to cart
store_credit
number
| float
Store credit redeemed on the cart
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
i:
false
b:
false
c:
false
Response
Get abandoned cart details
getAbandonedCartDetails
Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
cart_idpath
string
Required
Current Cart id of user cart
bquery
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
bodyrequestBody
object (AddCartCreation)
Required
Specify the item details as shown below. Refer `AddCartCreation` for more details.
Hide
Add to cart request schema which has items data to be added in cart and new cart boolean value flag
new_cart
boolean
Field to create to new cart whille user adds item to cart
items
array of object (AddProductCart)
List of items detail which need to be added to cart like item id, item size, and item quantity
Show
Items data list to be added in cart which includes item id, article id, item size, meta, parent item identifier, article assignment and custom json
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 identifier of the seller selected by the user from which user want to buy a product
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
Field to determine how article assignment should happen by article assignment level and strategy
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
force_new_line_item
boolean
Field used to decide the product add as a separate product in 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
fulfillment_option_slug
string
specifies the fulfillment method, indicating whether an order is for home delivery or store pickup
pickup_store_id
integer
| int32
Unique identifier of the pickup store selected by the user from which user wants to pickup the product.
Request body
new_cart
boolean
Field to create to new cart whille user adds item to cart
items
array of object (AddProductCart)
List of items detail which need to be added to cart like item id, item size, and item quantity
Show
Items data list to be added in cart which includes item id, article id, item size, meta, parent item identifier, article assignment and custom json
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 identifier of the seller selected by the user from which user want to buy a product
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
Field to determine how article assignment should happen by article assignment level and strategy
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
force_new_line_item
boolean
Field used to decide the product add as a separate product in 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
fulfillment_option_slug
string
specifies the fulfillment method, indicating whether an order is for home delivery or store pickup
pickup_store_id
integer
| int32
Unique identifier of the pickup store selected by the user from which user wants to pickup the product.
POST
Response
200
Success. Returns a cart object as shown below. Refer `AddCartDetailResult` for more details.
Hide
Update cart detail response schema denotes cart data and message of the add product into cart
success
boolean
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResult)
Show
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categoreis,, images, item code, tags, item id, item name, etc
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Show
Product images data in different formats
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
Show
Schema of Action Object to render the product.
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
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
Show
Category information schema which denotes category name and category id
uid
integer
| int32
Unique identifier of Product Category
name
string
Category name of the product
attributes
object
Product attributes defined on platform
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request)
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart
is_set
boolean
Whether or not the product is a set of items
article
object (ProductArticle)
Show
Detailed information of the product added in cart
seller_identifier
string
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
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
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift
product_group_tags
array of string
List fot the unique identifier for the product grouping.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
identifier
object
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
_custom_json
object
Field to update custom json of the article in cart
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article
converted
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
base
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
Show
Product store information of the product added in cart
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
Store name of the store from where the product is fulfiled
store_code
string
A unique code or identifier for the store, often used for internal reference
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
The attribute key associated with the size
coupon
object (CouponDetails)
Show
Coupon actual price breakup details
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
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
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)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
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
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability
Show
Product sizes availability
display
string
Display size of the product
value
string
Actual value of the size
is_available
boolean
Available flag for the size of the product if that is available
out_of_stock
boolean
Denotes if the product is available in stock
sizes
array of string
All sizes of the product
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
promo_meta
object (PromoMeta)
Show
Loyalty points message data
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user
custom_order
object
Whether MTO (Make to Order) is enabled or not.
item_type
string
Type of the item in cart.
Enum
charges
array of object (ArticleCharges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment selection lock config for the user cart
payment_identifier
string
Identifier for Payment Mode
default_options
string
Default Selection Payment Mode
enabled
boolean
Denotes if default payment selection is enable
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag
enabled
boolean
Delivery charge enabled for the cart or not
charges
array of object (ChargesThreshold)
Charges applicable based on threshold
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold
charges
number
| float
Charges amount to be applied on cart
threshold
number
| float
Threshold of cart value on which the charge should be applied
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value
cashback_amount
number
| float
Fields denotes cashback amount applied to cart
cashback_message_primary
string
Primary cashback message for coupon applied to cart
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart
coupon_code
string
Coupon code to be applied to cart
coupon_description
string
Coupon description of the coupon applied to cart
coupon_id
string
Unique identifier of the coupon applied to cart
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart
coupon_title
string
Coupon title of the coupon applied
coupon_type
string
Type of the coupon applied to cart
coupon_value
number
| float
Value of the coupon applied to cart
discount
number
| float
Total discount earned from coupon applied to cart
is_applied
boolean
Flag to determine where the coupon is applied to cart or not
is_valid
boolean
Determine where the coupon applied to cart is valid
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart
message
string
Coupon message of the coupon applied to cart
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, and loyalty points
coupon
object (CouponBreakup)
Show
Coupon details of the coupon applied to cart that incluedes coupon id, coupon title, description, coupon code, applied message etc.
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
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
Minimum cart value of the coupon applied to cart
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
Show
Display price breakup schema denotes price currency, key, value, message to display as breakup on UI
key
string
key of the price like total_mrp, total, subtotal etc
value
number
| float
Numeric value for 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
loyalty_points
object (LoyaltyPoints)
Show
Loyalty points data which determines how much loyalty points applied to cart and total loyalty points customer has in his account
is_applied
boolean
Whether the loyalty points are applied on the cart
total
number
| float
Total loyalty points available with user
applicable
number
| float
Whether the loyalty points are applicable for the cart
description
string
Description for loyalty points
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage points amount applied on the cart.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Title to show how many earn points are gained for this order.
title
string
Unique title for loyalty program applicable.
discount_amount
number
| float
Engage discount amount applied on the cart as payment mode
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convinience fee, coupon amount, delivery charge, discount, loyalty points,engage points, gift card, gst charge, etc.
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
engage_amount
number
| float
Engage points amount applied on the cart.
engage_mop_amount
number
| float
Engage mop amount applied on the 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 received 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
convenience_fee
number
| float
Convenience fee amount applied to cart
store_credit
number
| float
Store credit redeemed on the cart
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
partial
boolean
When adding multiple items check if all added. True if only few are added.
message
string
Message of add cart API response
result
object
Add to cart result data
items
array of object (CartItemInfo)
List of items that needs to be added in cart.
Show
item_id
integer
| int32
Item id of the product that needs to be added/updated/removed.
size
string
Item size of the product that needs to be added/updated/removed.
store_id
integer
| int32
Unique identifier of the store selected by the user from which user want to buy a product.
success
boolean
True if items are added/updated/removed successfully.
message
string
Message for added/updated/removed item.
Examples
Parameters
Parameters are not required.
Response
Add items to cart
addItems
Customers can modify added product attributes such as quantity and size, as well as remove items from the cart.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
cart_idpath
string
Required
Current Cart id of user cart
bquery
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
bodyrequestBody
object (UpdateCartCreation)
Required
Specify the item details and operation as shown below. Refer `UpdateCartCreation` for more details.
Hide
Request schema to update the items in cart
items
array of object (UpdateProductCart)
Show
Update cart product request schema details which includes artidcle id, custom json, extra meta, identifiers, item id, item size, item index, meta, parent item identifiers and quantity
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
parent_item_identifiers
object
Field to update parent product of the item in cart
meta
object
Field to update meta of the item in cart
extra_meta
object
Field to update extra meta of the product in cart
_custom_json
object
Field to update custom json of the product in cart
force_new_line_item
boolean
Field used to decide the product add as a separate product in cart
item_id
integer
| int32
Item id of the product that needs to be updated
item_index
integer
| int32
Item index determines on which index the product falls to be updated
identifiers
object (CartProductIdentifer)
Required
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
identifier
string
Article idenfier generated by cart
article_id
string
article id of the product in cart
fulfillment_option_slug
string
specifies the fulfillment method, indicating whether an order is for home delivery or store pickup
pickup_store_id
integer
| int32
Unique identifier of the pickup store selected by the user from which user
free_gift_items
array of object (FreeGiftItemCreation)
List of free gift items with updated sizes.
Show
Request schema for free gift product that should be applied on cart
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
Cart opertaion type
Enum
Request body
items
array of object (UpdateProductCart)
Show
Update cart product request schema details which includes artidcle id, custom json, extra meta, identifiers, item id, item size, item index, meta, parent item identifiers and quantity
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
parent_item_identifiers
object
Field to update parent product of the item in cart
meta
object
Field to update meta of the item in cart
extra_meta
object
Field to update extra meta of the product in cart
_custom_json
object
Field to update custom json of the product in cart
force_new_line_item
boolean
Field used to decide the product add as a separate product in cart
item_id
integer
| int32
Item id of the product that needs to be updated
item_index
integer
| int32
Item index determines on which index the product falls to be updated
identifiers
object (CartProductIdentifer)
Required
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
identifier
string
Article idenfier generated by cart
article_id
string
article id of the product in cart
fulfillment_option_slug
string
specifies the fulfillment method, indicating whether an order is for home delivery or store pickup
pickup_store_id
integer
| int32
Unique identifier of the pickup store selected by the user from which user
free_gift_items
array of object (FreeGiftItemCreation)
List of free gift items with updated sizes.
Show
Request schema for free gift product that should be applied on cart
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
Cart opertaion type
Enum
PUT
Response
200
Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResult` for more details.
Hide
Update cart detail response schema denotes cart data and message of the update cart API response
success
boolean
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResult)
Show
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categoreis,, images, item code, tags, item id, item name, etc
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Show
Product images data in different formats
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
Show
Schema of Action Object to render the product.
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
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
Show
Category information schema which denotes category name and category id
uid
integer
| int32
Unique identifier of Product Category
name
string
Category name of the product
attributes
object
Product attributes defined on platform
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request)
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart
is_set
boolean
Whether or not the product is a set of items
article
object (ProductArticle)
Show
Detailed information of the product added in cart
seller_identifier
string
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
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
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift
product_group_tags
array of string
List fot the unique identifier for the product grouping.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
identifier
object
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
_custom_json
object
Field to update custom json of the article in cart
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article
converted
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
base
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
Show
Product store information of the product added in cart
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
Store name of the store from where the product is fulfiled
store_code
string
A unique code or identifier for the store, often used for internal reference
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
The attribute key associated with the size
coupon
object (CouponDetails)
Show
Coupon actual price breakup details
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
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
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)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
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
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability
Show
Product sizes availability
display
string
Display size of the product
value
string
Actual value of the size
is_available
boolean
Available flag for the size of the product if that is available
out_of_stock
boolean
Denotes if the product is available in stock
sizes
array of string
All sizes of the product
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
promo_meta
object (PromoMeta)
Show
Loyalty points message data
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user
custom_order
object
Whether MTO (Make to Order) is enabled or not.
item_type
string
Type of the item in cart.
Enum
charges
array of object (ArticleCharges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment selection lock config for the user cart
payment_identifier
string
Identifier for Payment Mode
default_options
string
Default Selection Payment Mode
enabled
boolean
Denotes if default payment selection is enable
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag
enabled
boolean
Delivery charge enabled for the cart or not
charges
array of object (ChargesThreshold)
Charges applicable based on threshold
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold
charges
number
| float
Charges amount to be applied on cart
threshold
number
| float
Threshold of cart value on which the charge should be applied
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value
cashback_amount
number
| float
Fields denotes cashback amount applied to cart
cashback_message_primary
string
Primary cashback message for coupon applied to cart
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart
coupon_code
string
Coupon code to be applied to cart
coupon_description
string
Coupon description of the coupon applied to cart
coupon_id
string
Unique identifier of the coupon applied to cart
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart
coupon_title
string
Coupon title of the coupon applied
coupon_type
string
Type of the coupon applied to cart
coupon_value
number
| float
Value of the coupon applied to cart
discount
number
| float
Total discount earned from coupon applied to cart
is_applied
boolean
Flag to determine where the coupon is applied to cart or not
is_valid
boolean
Determine where the coupon applied to cart is valid
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart
message
string
Coupon message of the coupon applied to cart
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, and loyalty points
coupon
object (CouponBreakup)
Show
Coupon details of the coupon applied to cart that incluedes coupon id, coupon title, description, coupon code, applied message etc.
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
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
Minimum cart value of the coupon applied to cart
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
Show
Display price breakup schema denotes price currency, key, value, message to display as breakup on UI
key
string
key of the price like total_mrp, total, subtotal etc
value
number
| float
Numeric value for 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
loyalty_points
object (LoyaltyPoints)
Show
Loyalty points data which determines how much loyalty points applied to cart and total loyalty points customer has in his account
is_applied
boolean
Whether the loyalty points are applied on the cart
total
number
| float
Total loyalty points available with user
applicable
number
| float
Whether the loyalty points are applicable for the cart
description
string
Description for loyalty points
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage points amount applied on the cart.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Title to show how many earn points are gained for this order.
title
string
Unique title for loyalty program applicable.
discount_amount
number
| float
Engage discount amount applied on the cart as payment mode
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convinience fee, coupon amount, delivery charge, discount, loyalty points,engage points, gift card, gst charge, etc.
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
engage_amount
number
| float
Engage points amount applied on the cart.
engage_mop_amount
number
| float
Engage mop amount applied on the 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 received 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
convenience_fee
number
| float
Convenience fee amount applied to cart
store_credit
number
| float
Store credit redeemed on the cart
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
result
object
Contains article related result info
items
array of object (CartItemInfo)
List of items that needs to be updated in cart.
Show
item_id
integer
| int32
Item id of the product that needs to be added/updated/removed.
size
string
Item size of the product that needs to be added/updated/removed.
store_id
integer
| int32
Unique identifier of the store selected by the user from which user want to buy a product.
success
boolean
True if items are added/updated/removed successfully.
message
string
Message for added/updated/removed item.
message
string
Message of update cart API response
Response
Update cart items
updateCart
Generate a unique shareable link for the customer's cart for a specific sales channel. This link enables easy sharing of the cart contents with other users, facilitating collaborative shopping experiences.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
bodyrequestBody
object (GetShareCartLinkCreation)
Required
Pass object to generate share cart snapshot Cart id for sharing cart. meta Staff, or dering store and other store related data meta data to merge
Hide
Cart share link request schema used to get the share link to share cart to any other user. This includes cart id and meta json
id
string
Cart uid for generating sharing
meta
object
Staff, Ordering store or any other data. This data will be used to generate link as well as sent as shared details.
Request body
id
string
Cart uid for generating sharing
meta
object
Staff, Ordering store or any other data. This data will be used to generate link as well as sent as shared details.
POST
Response
200
Returns a URL to share and a token as shown below.
Hide
Cart share link response schema which includes url and token
token
string
Short url unique id of the cart which is opted to share with other user
share_url
string
Short shareable final url which can populate shared cart items in one's cart or replaced one's cart with shared cart items
Examples
Parameters
Parameters are not required.
Response
Share cart link
getCartShareLink
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
tokenpath
string
Required
Token of the shared short link
GET
Response
200
404
Success. Returns a Cart object as per the valid token. Refer `SharedCartResult` for more details.
Hide
Shared cart response schema which included error or cart data
cart
object (SharedCart)
Show
Share cart detail includes checkout mode, cart id , payment selection lock config, delivery promise, comment message, items , breakup values and other cart data of shared cart
coupon_text
string
Coupon text of the applied coupon on user cart
id
string
Cart id of shared cart
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
Comment message added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categoreis,, images, item code, tags, item id, item name, etc
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Show
Product images data in different formats
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
Show
Schema of Action Object to render the product.
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
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
Show
Category information schema which denotes category name and category id
uid
integer
| int32
Unique identifier of Product Category
name
string
Category name of the product
attributes
object
Product attributes defined on platform
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request)
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart
is_set
boolean
Whether or not the product is a set of items
article
object (ProductArticle)
Show
Detailed information of the product added in cart
seller_identifier
string
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
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
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift
product_group_tags
array of string
List fot the unique identifier for the product grouping.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
identifier
object
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
_custom_json
object
Field to update custom json of the article in cart
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article
converted
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
base
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
Show
Product store information of the product added in cart
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
Store name of the store from where the product is fulfiled
store_code
string
A unique code or identifier for the store, often used for internal reference
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
The attribute key associated with the size
coupon
object (CouponDetails)
Show
Coupon actual price breakup details
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
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
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)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
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
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability
Show
Product sizes availability
display
string
Display size of the product
value
string
Actual value of the size
is_available
boolean
Available flag for the size of the product if that is available
out_of_stock
boolean
Denotes if the product is available in stock
sizes
array of string
All sizes of the product
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
promo_meta
object (PromoMeta)
Show
Loyalty points message data
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user
custom_order
object
Whether MTO (Make to Order) is enabled or not.
item_type
string
Type of the item in cart.
Enum
charges
array of object (ArticleCharges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
shared_cart_details
object (SharedCartDetails)
Show
Shared cart details schema included token, user, created on, source and meta
source
object
Share link device and other source information
user
object
User details of who generated share link
token
string
Short link id of the user cart that needs to be shared
created_on
string
| date-time
created on timestamp of user cart
meta
object
Meta data sent while generating share cart link
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment selection lock config for the user cart
payment_identifier
string
Identifier for Payment Mode
default_options
string
Default Selection Payment Mode
enabled
boolean
Denotes if default payment selection is enable
delivery_charge_info
string
Delivery charge info message of the user cart
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the get shared cart API response
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, and loyalty points
coupon
object (CouponBreakup)
Show
Coupon details of the coupon applied to cart that incluedes coupon id, coupon title, description, coupon code, applied message etc.
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
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
Minimum cart value of the coupon applied to cart
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
Show
Display price breakup schema denotes price currency, key, value, message to display as breakup on UI
key
string
key of the price like total_mrp, total, subtotal etc
value
number
| float
Numeric value for 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
loyalty_points
object (LoyaltyPoints)
Show
Loyalty points data which determines how much loyalty points applied to cart and total loyalty points customer has in his account
is_applied
boolean
Whether the loyalty points are applied on the cart
total
number
| float
Total loyalty points available with user
applicable
number
| float
Whether the loyalty points are applicable for the cart
description
string
Description for loyalty points
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage points amount applied on the cart.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Title to show how many earn points are gained for this order.
title
string
Unique title for loyalty program applicable.
discount_amount
number
| float
Engage discount amount applied on the cart as payment mode
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convinience fee, coupon amount, delivery charge, discount, loyalty points,engage points, gift card, gst charge, etc.
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
engage_amount
number
| float
Engage points amount applied on the cart.
engage_mop_amount
number
| float
Engage mop amount applied on the 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 received 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
convenience_fee
number
| float
Convenience fee amount applied to cart
store_credit
number
| float
Store credit redeemed on the cart
is_valid
boolean
Valid flag for get shared cart detail API
uid
string
Cart id of the user cart
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
last_modified
string
| date
Last modified timestamp of user cart
buy_now
boolean
Buy now flag of user cart
cart_id
integer
| int32
Cart id of user cart for generating cart sharing token
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
custom_cart_meta
object
Custom cart meta of user cart added via update cart meta API
error
string
Error details if any error occurs which includes type of error, error code and error message
Examples
Parameters
company_id:
"value"
application_id:
"value"
token:
"value"
Response
List shared cart items
getCartSharedItems
Customer can either merge or replace shared cart items with existing cart.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
tokenpath
string
Required
Token of the shared short link
actionpath
string
Required
Operation to perform on the existing cart merge or replace.
Enum
cart_idquery
string
The unique identifier of the cart
POST
Response
200
Success. Returns a merged or replaced cart as per the valid token. Refer `SharedCartResult` for more details.
Hide
Shared cart response schema which included error or cart data
cart
object (SharedCart)
Show
Share cart detail includes checkout mode, cart id , payment selection lock config, delivery promise, comment message, items , breakup values and other cart data of shared cart
coupon_text
string
Coupon text of the applied coupon on user cart
id
string
Cart id of shared cart
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
Comment message added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categoreis,, images, item code, tags, item id, item name, etc
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Show
Product images data in different formats
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
Show
Schema of Action Object to render the product.
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
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
Show
Category information schema which denotes category name and category id
uid
integer
| int32
Unique identifier of Product Category
name
string
Category name of the product
attributes
object
Product attributes defined on platform
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request)
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart
is_set
boolean
Whether or not the product is a set of items
article
object (ProductArticle)
Show
Detailed information of the product added in cart
seller_identifier
string
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
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
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift
product_group_tags
array of string
List fot the unique identifier for the product grouping.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
identifier
object
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
_custom_json
object
Field to update custom json of the article in cart
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article
converted
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
base
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
Show
Product store information of the product added in cart
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
Store name of the store from where the product is fulfiled
store_code
string
A unique code or identifier for the store, often used for internal reference
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
The attribute key associated with the size
coupon
object (CouponDetails)
Show
Coupon actual price breakup details
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
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
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)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
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
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability
Show
Product sizes availability
display
string
Display size of the product
value
string
Actual value of the size
is_available
boolean
Available flag for the size of the product if that is available
out_of_stock
boolean
Denotes if the product is available in stock
sizes
array of string
All sizes of the product
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
promo_meta
object (PromoMeta)
Show
Loyalty points message data
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user
custom_order
object
Whether MTO (Make to Order) is enabled or not.
item_type
string
Type of the item in cart.
Enum
charges
array of object (ArticleCharges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
shared_cart_details
object (SharedCartDetails)
Show
Shared cart details schema included token, user, created on, source and meta
source
object
Share link device and other source information
user
object
User details of who generated share link
token
string
Short link id of the user cart that needs to be shared
created_on
string
| date-time
created on timestamp of user cart
meta
object
Meta data sent while generating share cart link
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment selection lock config for the user cart
payment_identifier
string
Identifier for Payment Mode
default_options
string
Default Selection Payment Mode
enabled
boolean
Denotes if default payment selection is enable
delivery_charge_info
string
Delivery charge info message of the user cart
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the get shared cart API response
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, and loyalty points
coupon
object (CouponBreakup)
Show
Coupon details of the coupon applied to cart that incluedes coupon id, coupon title, description, coupon code, applied message etc.
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
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
Minimum cart value of the coupon applied to cart
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
Show
Display price breakup schema denotes price currency, key, value, message to display as breakup on UI
key
string
key of the price like total_mrp, total, subtotal etc
value
number
| float
Numeric value for 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
loyalty_points
object (LoyaltyPoints)
Show
Loyalty points data which determines how much loyalty points applied to cart and total loyalty points customer has in his account
is_applied
boolean
Whether the loyalty points are applied on the cart
total
number
| float
Total loyalty points available with user
applicable
number
| float
Whether the loyalty points are applicable for the cart
description
string
Description for loyalty points
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage points amount applied on the cart.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Title to show how many earn points are gained for this order.
title
string
Unique title for loyalty program applicable.
discount_amount
number
| float
Engage discount amount applied on the cart as payment mode
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convinience fee, coupon amount, delivery charge, discount, loyalty points,engage points, gift card, gst charge, etc.
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
engage_amount
number
| float
Engage points amount applied on the cart.
engage_mop_amount
number
| float
Engage mop amount applied on the 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 received 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
convenience_fee
number
| float
Convenience fee amount applied to cart
store_credit
number
| float
Store credit redeemed on the cart
is_valid
boolean
Valid flag for get shared cart detail API
uid
string
Cart id of the user cart
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
last_modified
string
| date
Last modified timestamp of user cart
buy_now
boolean
Buy now flag of user cart
cart_id
integer
| int32
Cart id of user cart for generating cart sharing token
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
custom_cart_meta
object
Custom cart meta of user cart added via update cart meta API
error
string
Error details if any error occurs which includes type of error, error code and error message
Examples
Parameters
Parameters are not required.
Response
Update shared cart items
updateCartWithSharedItems
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
from_datequery
string
| date-time
Cart which are created on or after from_date. Supports ISO date format.
to_datequery
string
| date-time
Cart which are created on or before to_date. Supports ISO date format.
filter_onquery
string
on which column to sort on i.e created_on or last_modified
GET
Response
200
Platform user cart list
Hide
Get list of active cart which is associated with user
success
boolean
True if get list of cart successfully.
data
array of object (CartList)
List of active carts and their item's count
Show
List of active carts in response
cart_id
string
The cart id of user
pick_up_customer_details
object
Customer contact details for customer pickup at store
cart_value
number
| float
Total amount of cart
created_on
string
| date-time
Date format when cart created
user_id
string
User id which is associated with cart
currency_code
string
Active cart currency code
item_counts
integer
Article total count in cart
Examples
Parameters
Parameters are not required.
Response
List of carts
getCartList
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
Cart id of user cart
bodyrequestBody
object (UpdateUserCartMapping)
Required
Customer id to map with cart.
Hide
Map or unmap a customer user ID with the user cart
user_id
string
Nullable
Customer user ID to associate with the cart. Send null to remove existing mapping of customer from cart.
Request body
user_id
string
Nullable
Customer user ID to associate with the cart. Send null to remove existing mapping of customer from cart.
PUT
Response
200
Hide
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment common config, coupon, coupon text, gstin etc.
coupon_text
string
Coupon text of coupon applied on cart
user
object (UserInfo)
Show
Detail of user for which we have created cart
gender
string
User gender
modified_on
string
| date-time
Date format of user when user last modified
_id
string
Unique Identifier of user
uid
string
Unique UID of user
external_id
string
Unique external id
mobile
string
10 digit Mobile number of user
last_name
string
| date-time
Last name of user
created_at
string
| date-time
Date format of user when user registered
first_name
string
First name of user
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categoreis,, images, item code, tags, item id, item name, etc
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Show
Product images data in different formats
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
Show
Schema of Action Object to render the product.
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
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
Show
Category information schema which denotes category name and category id
uid
integer
| int32
Unique identifier of Product Category
name
string
Category name of the product
attributes
object
Product attributes defined on platform
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request)
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart
is_set
boolean
Whether or not the product is a set of items
article
object (ProductArticle)
Show
Detailed information of the product added in cart
seller_identifier
string
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
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
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift
product_group_tags
array of string
List fot the unique identifier for the product grouping.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
identifier
object
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
_custom_json
object
Field to update custom json of the article in cart
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article
converted
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
base
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
Show
Product store information of the product added in cart
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
Store name of the store from where the product is fulfiled
store_code
string
A unique code or identifier for the store, often used for internal reference
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
The attribute key associated with the size
coupon
object (CouponDetails)
Show
Coupon actual price breakup details
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
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
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)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
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
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability
Show
Product sizes availability
display
string
Display size of the product
value
string
Actual value of the size
is_available
boolean
Available flag for the size of the product if that is available
out_of_stock
boolean
Denotes if the product is available in stock
sizes
array of string
All sizes of the product
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
promo_meta
object (PromoMeta)
Show
Loyalty points message data
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user
custom_order
object
Whether MTO (Make to Order) is enabled or not.
item_type
string
Type of the item in cart.
Enum
charges
array of object (ArticleCharges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment selection lock config for the user cart
payment_identifier
string
Identifier for Payment Mode
default_options
string
Default Selection Payment Mode
enabled
boolean
Denotes if default payment selection is enable
delivery_charge_info
string
Delivery charge in information message on shipment
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the get cart detail API response
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, and loyalty points
coupon
object (CouponBreakup)
Show
Coupon details of the coupon applied to cart that incluedes coupon id, coupon title, description, coupon code, applied message etc.
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
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
Minimum cart value of the coupon applied to cart
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
Show
Display price breakup schema denotes price currency, key, value, message to display as breakup on UI
key
string
key of the price like total_mrp, total, subtotal etc
value
number
| float
Numeric value for 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
loyalty_points
object (LoyaltyPoints)
Show
Loyalty points data which determines how much loyalty points applied to cart and total loyalty points customer has in his account
is_applied
boolean
Whether the loyalty points are applied on the cart
total
number
| float
Total loyalty points available with user
applicable
number
| float
Whether the loyalty points are applicable for the cart
description
string
Description for loyalty points
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage points amount applied on the cart.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Title to show how many earn points are gained for this order.
title
string
Unique title for loyalty program applicable.
discount_amount
number
| float
Engage discount amount applied on the cart as payment mode
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convinience fee, coupon amount, delivery charge, discount, loyalty points,engage points, gift card, gst charge, etc.
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
engage_amount
number
| float
Engage points amount applied on the cart.
engage_mop_amount
number
| float
Engage mop amount applied on the 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 received 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
convenience_fee
number
| float
Convenience fee amount applied to cart
store_credit
number
| float
Store credit redeemed on the cart
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
custom_cart_meta
object
Custom meta details added cart checkout API payload
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
Examples
Parameters
Parameters are not required.
Response
Update user of a cart
updateCartUser
Retrieve details of a cart linked to a specific customer using either the customer's ID or a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart
user_idquery
string
Option to fetch cart for the provided user_id.
order_typequery
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
iquery
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
bquery
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
assign_card_idquery
integer
Token of user's debit or credit card
buy_nowquery
boolean
This is a boolen value. Select `true` to set/initialize buy now cart
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-anonymous-cart
string
Anonymous cart header used to perform operations on cross-platform anonymous cart. When enabled, the system fetches the cart only based on cart_id instead of user_id.
GET
Response
200
400
Success. Returns a Cart object. Check the example shown below or refer `CartDetailResult` for more details.
Hide
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categoreis,, images, item code, tags, item id, item name, etc
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Show
Product images data in different formats
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
Show
Schema of Action Object to render the product.
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
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
Show
Category information schema which denotes category name and category id
uid
integer
| int32
Unique identifier of Product Category
name
string
Category name of the product
attributes
object
Product attributes defined on platform
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request)
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart
is_set
boolean
Whether or not the product is a set of items
article
object (ProductArticle)
Show
Detailed information of the product added in cart
seller_identifier
string
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
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
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift
product_group_tags
array of string
List fot the unique identifier for the product grouping.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
identifier
object
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
_custom_json
object
Field to update custom json of the article in cart
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article
converted
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
base
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
Show
Product store information of the product added in cart
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
Store name of the store from where the product is fulfiled
store_code
string
A unique code or identifier for the store, often used for internal reference
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
The attribute key associated with the size
coupon
object (CouponDetails)
Show
Coupon actual price breakup details
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
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
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)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
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
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability
Show
Product sizes availability
display
string
Display size of the product
value
string
Actual value of the size
is_available
boolean
Available flag for the size of the product if that is available
out_of_stock
boolean
Denotes if the product is available in stock
sizes
array of string
All sizes of the product
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
promo_meta
object (PromoMeta)
Show
Loyalty points message data
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user
custom_order
object
Whether MTO (Make to Order) is enabled or not.
item_type
string
Type of the item in cart.
Enum
charges
array of object (ArticleCharges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment selection lock config for the user cart
payment_identifier
string
Identifier for Payment Mode
default_options
string
Default Selection Payment Mode
enabled
boolean
Denotes if default payment selection is enable
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag
enabled
boolean
Delivery charge enabled for the cart or not
charges
array of object (ChargesThreshold)
Charges applicable based on threshold
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold
charges
number
| float
Charges amount to be applied on cart
threshold
number
| float
Threshold of cart value on which the charge should be applied
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value
cashback_amount
number
| float
Fields denotes cashback amount applied to cart
cashback_message_primary
string
Primary cashback message for coupon applied to cart
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart
coupon_code
string
Coupon code to be applied to cart
coupon_description
string
Coupon description of the coupon applied to cart
coupon_id
string
Unique identifier of the coupon applied to cart
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart
coupon_title
string
Coupon title of the coupon applied
coupon_type
string
Type of the coupon applied to cart
coupon_value
number
| float
Value of the coupon applied to cart
discount
number
| float
Total discount earned from coupon applied to cart
is_applied
boolean
Flag to determine where the coupon is applied to cart or not
is_valid
boolean
Determine where the coupon applied to cart is valid
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart
message
string
Coupon message of the coupon applied to cart
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, and loyalty points
coupon
object (CouponBreakup)
Show
Coupon details of the coupon applied to cart that incluedes coupon id, coupon title, description, coupon code, applied message etc.
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
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
Minimum cart value of the coupon applied to cart
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
Show
Display price breakup schema denotes price currency, key, value, message to display as breakup on UI
key
string
key of the price like total_mrp, total, subtotal etc
value
number
| float
Numeric value for 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
loyalty_points
object (LoyaltyPoints)
Show
Loyalty points data which determines how much loyalty points applied to cart and total loyalty points customer has in his account
is_applied
boolean
Whether the loyalty points are applied on the cart
total
number
| float
Total loyalty points available with user
applicable
number
| float
Whether the loyalty points are applicable for the cart
description
string
Description for loyalty points
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage points amount applied on the cart.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Title to show how many earn points are gained for this order.
title
string
Unique title for loyalty program applicable.
discount_amount
number
| float
Engage discount amount applied on the cart as payment mode
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convinience fee, coupon amount, delivery charge, discount, loyalty points,engage points, gift card, gst charge, etc.
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
engage_amount
number
| float
Engage points amount applied on the cart.
engage_mop_amount
number
| float
Engage mop amount applied on the 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 received 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
convenience_fee
number
| float
Convenience fee amount applied to cart
store_credit
number
| float
Store credit redeemed on the cart
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
user_id:
"value"
order_type:
"value"
i:
false
b:
false
assign_card_id:
1
buy_now:
false
x-ordering-source:
"value"
x-ordering-source-type:
"value"
x-anonymous-cart:
"value"
Response
Get a cart
getCart
Adds product items to a customer's shopping cart. If the customer does not have an existing cart, a new one is created automatically. - The `new_cart` flag forces creation of a new cart even if one already exists. - The `default_cart` flag determines whether the item is added to the user's default storefront-visible cart. If `true`, the item is added to the user's default cart that is accessible via the storefront. If `false`, an existing active cart is fetched if available; otherwise, a new hidden cart is created.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
iquery
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
bquery
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
include_cart_calculationquery
boolean
Set to `false` to skip recalculating and fetching the updated cart after the edit. Defaults to `true`.
buy_nowquery
boolean
This is a boolen value. Select `true` to set/initialize buy now cart
order_typequery
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
idquery
string
The unique identifier of the cart
bodyrequestBody
object (PlatformAddCartDetails)
Required
Specify the item details as shown below. Refer `PlatformAddCartDetails` for more details.
Hide
Schema for adding items to a cart. Contains user details, cart creation flags, and the list of items to be added.
user_id
string
The unique identifier of the user for whom items are being added to the cart
new_cart
boolean
Indicates whether a new cart should be created. If `true`, a new cart is created even if one already exists.
default_cart
boolean
Determines whether the item is added to the user's default visible cart on the storefront. If `true`, the item is added to the user's default cart that is accessible via the storefront. If `false`, an existing active cart is fetched if available; otherwise, a new hidden cart is created. Defaults to `true`.
items
array of object (AddProductCart)
List of items detail which need to be added to cart like item id, item size, and item quantity
Show
Items data list to be added in cart which includes item id, article id, item size, meta, parent item identifier, article assignment and custom json
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 identifier of the seller selected by the user from which user want to buy a product
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
Field to determine how article assignment should happen by article assignment level and strategy
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
force_new_line_item
boolean
Field used to decide the product add as a separate product in 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
fulfillment_option_slug
string
specifies the fulfillment method, indicating whether an order is for home delivery or store pickup
pickup_store_id
integer
| int32
Unique identifier of the pickup store selected by the user from which user wants to pickup the product.
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-anonymous-cart
string
Anonymous cart header used to perform operations on cross-platform anonymous cart. When enabled, the system fetches the cart only based on cart_id instead of user_id.
Request body
user_id
string
The unique identifier of the user for whom items are being added to the cart
new_cart
boolean
Indicates whether a new cart should be created. If `true`, a new cart is created even if one already exists.
default_cart
boolean
Determines whether the item is added to the user's default visible cart on the storefront. If `true`, the item is added to the user's default cart that is accessible via the storefront. If `false`, an existing active cart is fetched if available; otherwise, a new hidden cart is created. Defaults to `true`.
items
array of object (AddProductCart)
List of items detail which need to be added to cart like item id, item size, and item quantity
Show
Items data list to be added in cart which includes item id, article id, item size, meta, parent item identifier, article assignment and custom json
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 identifier of the seller selected by the user from which user want to buy a product
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
Field to determine how article assignment should happen by article assignment level and strategy
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
force_new_line_item
boolean
Field used to decide the product add as a separate product in 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
fulfillment_option_slug
string
specifies the fulfillment method, indicating whether an order is for home delivery or store pickup
pickup_store_id
integer
| int32
Unique identifier of the pickup store selected by the user from which user wants to pickup the product.
POST
Response
200
Success. Returns a cart object as shown below. Refer `AddCartDetailResult` for more details.
Hide
Update cart detail response schema denotes cart data and message of the add product into cart
success
boolean
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResult)
Show
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categoreis,, images, item code, tags, item id, item name, etc
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Show
Product images data in different formats
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
Show
Schema of Action Object to render the product.
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
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
Show
Category information schema which denotes category name and category id
uid
integer
| int32
Unique identifier of Product Category
name
string
Category name of the product
attributes
object
Product attributes defined on platform
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request)
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart
is_set
boolean
Whether or not the product is a set of items
article
object (ProductArticle)
Show
Detailed information of the product added in cart
seller_identifier
string
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
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
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift
product_group_tags
array of string
List fot the unique identifier for the product grouping.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
identifier
object
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
_custom_json
object
Field to update custom json of the article in cart
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article
converted
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
base
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
Show
Product store information of the product added in cart
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
Store name of the store from where the product is fulfiled
store_code
string
A unique code or identifier for the store, often used for internal reference
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
The attribute key associated with the size
coupon
object (CouponDetails)
Show
Coupon actual price breakup details
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
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
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)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
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
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability
Show
Product sizes availability
display
string
Display size of the product
value
string
Actual value of the size
is_available
boolean
Available flag for the size of the product if that is available
out_of_stock
boolean
Denotes if the product is available in stock
sizes
array of string
All sizes of the product
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
promo_meta
object (PromoMeta)
Show
Loyalty points message data
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user
custom_order
object
Whether MTO (Make to Order) is enabled or not.
item_type
string
Type of the item in cart.
Enum
charges
array of object (ArticleCharges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment selection lock config for the user cart
payment_identifier
string
Identifier for Payment Mode
default_options
string
Default Selection Payment Mode
enabled
boolean
Denotes if default payment selection is enable
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag
enabled
boolean
Delivery charge enabled for the cart or not
charges
array of object (ChargesThreshold)
Charges applicable based on threshold
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold
charges
number
| float
Charges amount to be applied on cart
threshold
number
| float
Threshold of cart value on which the charge should be applied
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value
cashback_amount
number
| float
Fields denotes cashback amount applied to cart
cashback_message_primary
string
Primary cashback message for coupon applied to cart
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart
coupon_code
string
Coupon code to be applied to cart
coupon_description
string
Coupon description of the coupon applied to cart
coupon_id
string
Unique identifier of the coupon applied to cart
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart
coupon_title
string
Coupon title of the coupon applied
coupon_type
string
Type of the coupon applied to cart
coupon_value
number
| float
Value of the coupon applied to cart
discount
number
| float
Total discount earned from coupon applied to cart
is_applied
boolean
Flag to determine where the coupon is applied to cart or not
is_valid
boolean
Determine where the coupon applied to cart is valid
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart
message
string
Coupon message of the coupon applied to cart
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, and loyalty points
coupon
object (CouponBreakup)
Show
Coupon details of the coupon applied to cart that incluedes coupon id, coupon title, description, coupon code, applied message etc.
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
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
Minimum cart value of the coupon applied to cart
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
Show
Display price breakup schema denotes price currency, key, value, message to display as breakup on UI
key
string
key of the price like total_mrp, total, subtotal etc
value
number
| float
Numeric value for 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
loyalty_points
object (LoyaltyPoints)
Show
Loyalty points data which determines how much loyalty points applied to cart and total loyalty points customer has in his account
is_applied
boolean
Whether the loyalty points are applied on the cart
total
number
| float
Total loyalty points available with user
applicable
number
| float
Whether the loyalty points are applicable for the cart
description
string
Description for loyalty points
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage points amount applied on the cart.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Title to show how many earn points are gained for this order.
title
string
Unique title for loyalty program applicable.
discount_amount
number
| float
Engage discount amount applied on the cart as payment mode
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convinience fee, coupon amount, delivery charge, discount, loyalty points,engage points, gift card, gst charge, etc.
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
engage_amount
number
| float
Engage points amount applied on the cart.
engage_mop_amount
number
| float
Engage mop amount applied on the 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 received 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
convenience_fee
number
| float
Convenience fee amount applied to cart
store_credit
number
| float
Store credit redeemed on the cart
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
partial
boolean
When adding multiple items check if all added. True if only few are added.
message
string
Message of add cart API response
result
object
Add to cart result data
items
array of object (CartItemInfo)
List of items that needs to be added in cart.
Show
item_id
integer
| int32
Item id of the product that needs to be added/updated/removed.
size
string
Item size of the product that needs to be added/updated/removed.
store_id
integer
| int32
Unique identifier of the store selected by the user from which user want to buy a product.
success
boolean
True if items are added/updated/removed successfully.
message
string
Message for added/updated/removed item.
Examples
Parameters
Parameters are not required.
Response
Add items to cart
platformAddItems
Customers can modify added product attributes such as quantity and size, as well as remove items from the cart.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart
iquery
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
order_typequery
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
bquery
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
include_cart_calculationquery
boolean
Set to `false` to skip recalculating and fetching the updated cart after the edit. Defaults to `true`.
buy_nowquery
boolean
This is a boolen value. Select `true` to set/initialize buy now cart
bodyrequestBody
object (PlatformUpdateCartDetails)
Required
Specify the item details and operation as shown below. Refer `PlatformUpdateCartDetails` for more details.
Hide
Update cart request data that involves items in cart and operation to be performed for items specified
user_id
string
The user id of user, for which we need to update the cart
items
array of object (UpdateProductCart)
List items data that needs to be updated in cart
Show
Update cart product request schema details which includes artidcle id, custom json, extra meta, identifiers, item id, item size, item index, meta, parent item identifiers and quantity
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
parent_item_identifiers
object
Field to update parent product of the item in cart
meta
object
Field to update meta of the item in cart
extra_meta
object
Field to update extra meta of the product in cart
_custom_json
object
Field to update custom json of the product in cart
force_new_line_item
boolean
Field used to decide the product add as a separate product in cart
item_id
integer
| int32
Item id of the product that needs to be updated
item_index
integer
| int32
Item index determines on which index the product falls to be updated
identifiers
object (CartProductIdentifer)
Required
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
identifier
string
Article idenfier generated by cart
article_id
string
article id of the product in cart
fulfillment_option_slug
string
specifies the fulfillment method, indicating whether an order is for home delivery or store pickup
pickup_store_id
integer
| int32
Unique identifier of the pickup store selected by the user from which user
free_gift_items
array of object (FreeGiftItemCreation)
List of free gift items with updated sizes.
Show
Request schema for free gift product that should be applied on cart
promotion_id
string
Required
Unique identifier of the free gift promotion.
item_id
string
Required
Unique identifier of the selected free gift item.
item_size
string
Required
Size of the selected free gift item.
operation
string
Required
Field to determine if item to be removed from cart or it needs to be updated
Enum
free_gift_items_operation
string
Field to determine if free gift item to be removed from cart or it needs to be added.
Enum
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-anonymous-cart
string
Anonymous cart header used to perform operations on cross-platform anonymous cart. When enabled, the system fetches the cart only based on cart_id instead of user_id.
Request body
user_id
string
The user id of user, for which we need to update the cart
items
array of object (UpdateProductCart)
List items data that needs to be updated in cart
Show
Update cart product request schema details which includes artidcle id, custom json, extra meta, identifiers, item id, item size, item index, meta, parent item identifiers and quantity
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
parent_item_identifiers
object
Field to update parent product of the item in cart
meta
object
Field to update meta of the item in cart
extra_meta
object
Field to update extra meta of the product in cart
_custom_json
object
Field to update custom json of the product in cart
force_new_line_item
boolean
Field used to decide the product add as a separate product in cart
item_id
integer
| int32
Item id of the product that needs to be updated
item_index
integer
| int32
Item index determines on which index the product falls to be updated
identifiers
object (CartProductIdentifer)
Required
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
identifier
string
Article idenfier generated by cart
article_id
string
article id of the product in cart
fulfillment_option_slug
string
specifies the fulfillment method, indicating whether an order is for home delivery or store pickup
pickup_store_id
integer
| int32
Unique identifier of the pickup store selected by the user from which user
free_gift_items
array of object (FreeGiftItemCreation)
List of free gift items with updated sizes.
Show
Request schema for free gift product that should be applied on cart
promotion_id
string
Required
Unique identifier of the free gift promotion.
item_id
string
Required
Unique identifier of the selected free gift item.
item_size
string
Required
Size of the selected free gift item.
operation
string
Required
Field to determine if item to be removed from cart or it needs to be updated
Enum
free_gift_items_operation
string
Field to determine if free gift item to be removed from cart or it needs to be added.
Enum
PUT
Response
200
Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResult` for more details.
Hide
Update cart detail response schema denotes cart data and message of the update cart API response
success
boolean
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResult)
Show
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categoreis,, images, item code, tags, item id, item name, etc
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Show
Product images data in different formats
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
Show
Schema of Action Object to render the product.
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
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
Show
Category information schema which denotes category name and category id
uid
integer
| int32
Unique identifier of Product Category
name
string
Category name of the product
attributes
object
Product attributes defined on platform
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request)
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart
is_set
boolean
Whether or not the product is a set of items
article
object (ProductArticle)
Show
Detailed information of the product added in cart
seller_identifier
string
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
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
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift
product_group_tags
array of string
List fot the unique identifier for the product grouping.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
identifier
object
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
_custom_json
object
Field to update custom json of the article in cart
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article
converted
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
base
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
Show
Product store information of the product added in cart
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
Store name of the store from where the product is fulfiled
store_code
string
A unique code or identifier for the store, often used for internal reference
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
The attribute key associated with the size
coupon
object (CouponDetails)
Show
Coupon actual price breakup details
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
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
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)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
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
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability
Show
Product sizes availability
display
string
Display size of the product
value
string
Actual value of the size
is_available
boolean
Available flag for the size of the product if that is available
out_of_stock
boolean
Denotes if the product is available in stock
sizes
array of string
All sizes of the product
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
promo_meta
object (PromoMeta)
Show
Loyalty points message data
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user
custom_order
object
Whether MTO (Make to Order) is enabled or not.
item_type
string
Type of the item in cart.
Enum
charges
array of object (ArticleCharges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment selection lock config for the user cart
payment_identifier
string
Identifier for Payment Mode
default_options
string
Default Selection Payment Mode
enabled
boolean
Denotes if default payment selection is enable
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag
enabled
boolean
Delivery charge enabled for the cart or not
charges
array of object (ChargesThreshold)
Charges applicable based on threshold
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold
charges
number
| float
Charges amount to be applied on cart
threshold
number
| float
Threshold of cart value on which the charge should be applied
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value
cashback_amount
number
| float
Fields denotes cashback amount applied to cart
cashback_message_primary
string
Primary cashback message for coupon applied to cart
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart
coupon_code
string
Coupon code to be applied to cart
coupon_description
string
Coupon description of the coupon applied to cart
coupon_id
string
Unique identifier of the coupon applied to cart
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart
coupon_title
string
Coupon title of the coupon applied
coupon_type
string
Type of the coupon applied to cart
coupon_value
number
| float
Value of the coupon applied to cart
discount
number
| float
Total discount earned from coupon applied to cart
is_applied
boolean
Flag to determine where the coupon is applied to cart or not
is_valid
boolean
Determine where the coupon applied to cart is valid
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart
message
string
Coupon message of the coupon applied to cart
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, and loyalty points
coupon
object (CouponBreakup)
Show
Coupon details of the coupon applied to cart that incluedes coupon id, coupon title, description, coupon code, applied message etc.
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
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
Minimum cart value of the coupon applied to cart
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
Show
Display price breakup schema denotes price currency, key, value, message to display as breakup on UI
key
string
key of the price like total_mrp, total, subtotal etc
value
number
| float
Numeric value for 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
loyalty_points
object (LoyaltyPoints)
Show
Loyalty points data which determines how much loyalty points applied to cart and total loyalty points customer has in his account
is_applied
boolean
Whether the loyalty points are applied on the cart
total
number
| float
Total loyalty points available with user
applicable
number
| float
Whether the loyalty points are applicable for the cart
description
string
Description for loyalty points
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage points amount applied on the cart.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Title to show how many earn points are gained for this order.
title
string
Unique title for loyalty program applicable.
discount_amount
number
| float
Engage discount amount applied on the cart as payment mode
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convinience fee, coupon amount, delivery charge, discount, loyalty points,engage points, gift card, gst charge, etc.
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
engage_amount
number
| float
Engage points amount applied on the cart.
engage_mop_amount
number
| float
Engage mop amount applied on the 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 received 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
convenience_fee
number
| float
Convenience fee amount applied to cart
store_credit
number
| float
Store credit redeemed on the cart
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
result
object
Contains article related result info
items
array of object (CartItemInfo)
List of items that needs to be updated in cart.
Show
item_id
integer
| int32
Item id of the product that needs to be added/updated/removed.
size
string
Item size of the product that needs to be added/updated/removed.
store_id
integer
| int32
Unique identifier of the store selected by the user from which user want to buy a product.
success
boolean
True if items are added/updated/removed successfully.
message
string
Message for added/updated/removed item.
message
string
Message of update cart API response
Response
Update cart items
platformUpdateCart
Updates the cart breakup based on the enabled features and user preferences. This endpoint allows customers to modify how their cart totals are calculated — including options such as applying store credits, loyalty points, discounts, and other promotional benefits. The API recalculates and returns the updated breakup reflecting the selected configurations in real-time.
Parameters
company_idpath
string
Required
Unique identifier of the company associated with the current cart.
application_idpath
string
Required
Unique identifier of the sales channel (e.g., website, app) for which the cart belongs.
idquery
string
Unique identifier of the cart for which the breakup needs to be updated.
iquery
boolean
Set to `true` to include all items currently added to the cart in the response.
bquery
boolean
Set to `true` to include the detailed price breakup of each cart item in the response.
include_cart_calculationquery
boolean
Set to `false` to skip recalculating and fetching the updated cart after the edit. Defaults to `true`.
buy_nowquery
boolean
Set to `true` to initialize a "Buy Now" cart flow, enabling direct checkout for a single item.
bodyrequestBody
object (UpdateCartBreakup)
Required
Specify the features and preferences to be applied when recalculating the cart breakup. Refer to the `UpdateCartBreakup` schema for details on supported options.
Hide
Update cart breakup data
store_credit
boolean
Select `true` to include store credit in cart breakup
Headers
x-ordering-source
string
Identifier for the ordering source (e.g., web, mobile app, POS). Used to determine the origin of the order request and apply source-specific rules.
x-ordering-source-type
string
Identifier for the ordering source type (e.g., storefront, store_os_pos, kiosk). Used to determine the source type for order governance and validations.
x-anonymous-cart
string
Anonymous cart header used to perform operations on cross-platform anonymous cart. When enabled, the system fetches the cart only based on cart_id instead of user_id.
Request body
store_credit
boolean
Select `true` to include store credit in cart breakup
PATCH
Response
200
400
Success. Updates and returns a cart object as shown below. Refer `CartDetailResult` for more details.
Hide
Cart API response schema which includes applied promo details, breakup values, buy_now, cart id, checkout mode, comment, common config, coupon, coupon text, gstin etc.
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
Comment message to be added in user cart
items
array of object (CartProductInfo)
Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categoreis,, images, item code, tags, item id, item name, etc
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Show
Product images data in different formats
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
Show
Schema of Action Object to render the product.
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
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
Show
Category information schema which denotes category name and category id
uid
integer
| int32
Unique identifier of Product Category
name
string
Category name of the product
attributes
object
Product attributes defined on platform
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request)
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart
is_set
boolean
Whether or not the product is a set of items
article
object (ProductArticle)
Show
Detailed information of the product added in cart
seller_identifier
string
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
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
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift
product_group_tags
array of string
List fot the unique identifier for the product grouping.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
identifier
object
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
_custom_json
object
Field to update custom json of the article in cart
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article
converted
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
base
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
Show
Product store information of the product added in cart
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
Store name of the store from where the product is fulfiled
store_code
string
A unique code or identifier for the store, often used for internal reference
fulfillment_option
object (FulfillmentOptionSchema)
Show
Delivery service option with ID, type, name, and default status.
slug
string
Unique identifier for the delivery type.
description
string
Description of the delivery service.
is_default
boolean
Indicates if this is the default delivery option.
id
string
Unique ID of the delivery service.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
pickup_store_detail
object (PickupStoreDetailSchema)
Show
Provides details about a store where customers can pick up their orders.
store_id
integer
A unique identifier for the store.
name
string
The name of the store or pickup location.
pincode
string
The postal code of the store's location.
distance
number
The distance between the store and the customer's location.
address
string
The full address of the store.
store_hours
object
The store's operational hours for each day of the week.
item_index
integer
| int32
Specify the index of article in cart.
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
Show
Shipment level promise information which denotes time in 3 different formats i.e formatted time, timestamp and iso format
formatted
object (PromiseFormatted)
Show
Min and Max Delivery promise formatted timestamp
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
Show
Shipment level promise times
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
Show
Promise in ISO format.
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
The attribute key associated with the size
coupon
object (CouponDetails)
Show
Coupon actual price breakup details
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
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied
identifiers
object (CartProductIdentifer)
Show
Product identifiers uniquely generated by cart to uniquely identify the product in cart
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)
Show
Availability information of the product like deliverable, out of stock, valid product etc.
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
deliverable
boolean
Deliverable flag denotes if the product is deliverable or not
available_sizes
array of object (ProductAvailabilitySize)
Product sizes availability
Show
Product sizes availability
display
string
Display size of the product
value
string
Actual value of the size
is_available
boolean
Available flag for the size of the product if that is available
out_of_stock
boolean
Denotes if the product is available in stock
sizes
array of string
All sizes of the product
moq
object
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
max_quantity
object (ProductMaxQuantityInfo)
Show
Represents the maximum quantity details for an item based on store, seller, or overall availability.
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
Show
Price of single quantity product for seller currency and customer currency
converted
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
base
object (ProductPrice)
Show
Per quantity price of the product
marked
number
| float
Original MRP of 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
Price of the product after applying inventory discount and before applying promotion, coupon and engage discount.
selling
number
| float
Selling price of the product
final_price
number
| float
Final price of the product in cart after applying all discounts such as promotion, coupon and engage discount."
discount
number
| float
Net discount applied on product, contains total discount amount including promotions, coupons and engage discount [excluding inventory discount].
promo_meta
object (PromoMeta)
Show
Loyalty points message data
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user
custom_order
object
Whether MTO (Make to Order) is enabled or not.
item_type
string
Type of the item in cart.
Enum
charges
array of object (ArticleCharges)
Charges information which denotes types of charges and amount of charge applied to that product in cart.
Show
Charges information which denotes types of charges and amount of charge applied to that product in cart.
meta
object
Meta data realted to charges price adjustment.
amount
object (ChargesAmount)
Show
Charges amount data which deffently denotes amount of charges in seller currency and customer currency.
base_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
ordering_currency
object (CurrencyValue)
Show
Currency value information containing currency code and amount.
currency
string
Currency code.
value
number
| float
Numeric amount value.
name
string
Name of the charge applied.
allow_refund
boolean
Whether refund is allowed or not for the charge.
code
string
Code of the charge applied.
type
string
Type of the charge applied.
added_on
string
| date-time
Nullable
Date and time when the item was added to the cart.
payment_selection_lock
object (PaymentSelectionLock)
Show
Payment selection lock config for the user cart
payment_identifier
string
Identifier for Payment Mode
default_options
string
Default Selection Payment Mode
enabled
boolean
Denotes if default payment selection is enable
delivery_charge_info
string
Delivery charge in information message on shipment
common_config
object (CartCommonConfig)
Show
Cart common config which determines delivery charge config
delivery_charges_config
object (DeliveryChargesConfig)
Show
Delivery charge config which includes charges applicable condition and enabled flag
enabled
boolean
Delivery charge enabled for the cart or not
charges
array of object (ChargesThreshold)
Charges applicable based on threshold
Show
Charges threshhold data which denotes how much charge will be applied on cart value threshold
charges
number
| float
Charges amount to be applied on cart
threshold
number
| float
Threshold of cart value on which the charge should be applied
coupon
object (CartDetailCoupon)
Show
Cart level coupon data which denoes cashback amount, coupon code, coupon description, coupon sub title, and coupon value
cashback_amount
number
| float
Fields denotes cashback amount applied to cart
cashback_message_primary
string
Primary cashback message for coupon applied to cart
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart
coupon_code
string
Coupon code to be applied to cart
coupon_description
string
Coupon description of the coupon applied to cart
coupon_id
string
Unique identifier of the coupon applied to cart
coupon_subtitle
string
Coupon subtitle of the coupon applied to cart
coupon_title
string
Coupon title of the coupon applied
coupon_type
string
Type of the coupon applied to cart
coupon_value
number
| float
Value of the coupon applied to cart
discount
number
| float
Total discount earned from coupon applied to cart
is_applied
boolean
Flag to determine where the coupon is applied to cart or not
is_valid
boolean
Determine where the coupon applied to cart is valid
maximum_discount_value
number
| float
Maximum discount value of the coupon applied to cart
message
string
Coupon message of the coupon applied to cart
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the cart detail API response
notification
object
Notification object which denotes notification data for user cart
staff_user_id
string
Staff employee user id if cart is created by staff employee for the customer
success
boolean
Success flag of get cart detail API response
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, and loyalty points
coupon
object (CouponBreakup)
Show
Coupon details of the coupon applied to cart that incluedes coupon id, coupon title, description, coupon code, applied message etc.
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
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
Minimum cart value of the coupon applied to cart
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
Show
Display price breakup schema denotes price currency, key, value, message to display as breakup on UI
key
string
key of the price like total_mrp, total, subtotal etc
value
number
| float
Numeric value for 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
loyalty_points
object (LoyaltyPoints)
Show
Loyalty points data which determines how much loyalty points applied to cart and total loyalty points customer has in his account
is_applied
boolean
Whether the loyalty points are applied on the cart
total
number
| float
Total loyalty points available with user
applicable
number
| float
Whether the loyalty points are applicable for the cart
description
string
Description for loyalty points
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage points amount applied on the cart.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Title to show how many earn points are gained for this order.
title
string
Unique title for loyalty program applicable.
discount_amount
number
| float
Engage discount amount applied on the cart as payment mode
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convinience fee, coupon amount, delivery charge, discount, loyalty points,engage points, gift card, gst charge, etc.
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
engage_amount
number
| float
Engage points amount applied on the cart.
engage_mop_amount
number
| float
Engage mop amount applied on the 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 received 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
convenience_fee
number
| float
Convenience fee amount applied to cart
store_credit
number
| float
Store credit redeemed on the cart
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
checkout_mode
string
Checkout mode of user cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now
gstin
string
GSTIN added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Show
Fields to determine the applied promotions details on a product
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Show
Ownership details of the promotion who burns the cash
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
Show
Currency data of the cart for prices
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Show
Promotion's discount rule and offer details
offer
object
Offer detail for promotion
raw_offer
object
Raw offer details for promotion
item_criteria
object
Item criteria of promotion
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
Show
Promotion's free articles details
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
| int32
Free article quantity in promotion
article_id
string
Unique identifier of free article
free_gift_item_details
object (FreeGiftItems)
Free gift items details in promotion
Show
Response schema for free gift items which includes product name, slug, price and sizes etc.
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
Show
Item price details which inclued effective, marked, currency
marked
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
Show
Price detail schema of cart which include min and max price of article
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
Show
Pricing information for the free gift article, including both the initial marked price and the final effective price after applying the product discount.
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
Free gift product brand name
item_id
integer
| int32
Free gift product id
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
List of free gift product images URL
promotion_name
string
Promotion name of current promotion
buy_rules
array of object (BuyRules)
Buy rules for promotions
Show
Promotion cart and item level rules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
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 unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
loyalty_meta
object
Nullable
Free-form metadata stored against the loyalty redemption for this cart. Contains fields passed via the applyLoyaltyPoints meta input (e.g. points, redeem_rule_id) and is forwarded to the loyalty engine on each cart calculation.
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
free_gift_selection_available
boolean
Determines if the cart has available promotion free gift items to choose on its added items
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
i:
false
b:
false
include_cart_calculation:
false
buy_now:
false
body:
body
x-ordering-source:
"value"
x-ordering-source-type:
"value"
x-anonymous-cart:
"value"
Response
Update cart breakup values
updateCartBreakup
Delete all items from the user's cart and resets it to its initial state, providing a clean slate for new selections.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart.
bodyrequestBody
object (DeleteCartDetails)
Required
Specify cart id list to archive/delete carts. Refer `DeleteCartDetails` for more details.
Hide
Delete carts for user
cart_id_list
array of string
List of all cart ids, which need to delete
Request body
cart_id_list
array of string
List of all cart ids, which need to delete
PUT
Response
200
Success. Returns whether the cart has been deleted or not.
Hide
Delete cart response which includes message and success flag
success
boolean
True if cart is archived successfully. False if not archived.
message
string
Message for delete cart response
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Response
Delete a cart
deleteCart
Retrieve the total count of items currently present in the customer's cart.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart.
buy_nowquery
boolean
Boolean value to get buy_now cart.
GET
Response
200
Success. Returns the total count of items in a user's cart.
Hide
Request schema to return the total number of items in cart
user_cart_items_count
integer
| int32
Item count present in cart
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
buy_now:
false
Response
Get a cart items count
getItemCount
Add or modify metadata associated with a cart, which includes customer preferences, delivery instructions, or any special requirements related to the cart items.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
idquery
string
The unique identifier of the cart
buy_nowquery
boolean
this is boolean to get buy_now cart
bodyrequestBody
object (PlatformCartMetaCreation)
Required
gstin:Pass gstin number to claim GST credit, e.g. 27AAPFU0939F1ZV checkout_mode:Pass checkout mode for current order as described below. self:Customer him self placing order staff:Placing order on behalf of customer comment:Set comments to be passed to order team during adding items, e.g. leave the package with my neighbour.
Hide
Cart meta request schema to update the cart meta detail like delivery slots, comment message, GSTIN and custom cart meta
gstin
string
GSTIN number to be added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
pick_up_customer_details
object
Customer contact details for customer pickup at store
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
checkout_mode
string
Checkout mode of user cart
gift_details
object
Nullable
Gift details is open json which can include gift message
pan_no
string
Permanent Account Number of the user
comment
string
Comment message to be added in user cart
staff_user_id
string
Nullable
staff user id
Request body
gstin
string
GSTIN number to be added in user cart
ship_to_gst_details
object (ShipToGstDetails)
Nullable
Show
Ship-to GST and trade name details used for bill-to ship-to e-way bill generation.
gstin
string
Nullable
Ship-to GSTIN for bill-to ship-to e-way bill generation.
trade_name
string
Nullable
Ship-to trade name for bill-to ship-to e-way bill generation.
pick_up_customer_details
object
Customer contact details for customer pickup at store
alternate_pickup_person
object (PlatformAlternatePickupPerson)
Show
Details of an alternate person authorized to pick up the order.
enabled
boolean
Indicates whether an alternate pickup person is enabled.
name
string
Name of the alternate pickup person.
email
string
| email
Email address of the alternate pickup person.
phone
string
Phone number of the alternate pickup person.
country_phone_code
string
Country phone code of the alternate pickup person (e.g., "+91").
checkout_mode
string
Checkout mode of user cart
gift_details
object
Nullable
Gift details is open json which can include gift message
pan_no
string
Permanent Account Number of the user
comment
string
Comment message to be added in user cart
staff_user_id
string
Nullable
staff user id
PUT
Response
200
400
Returns a message indicating the success of cart meta updation as shown below.
Hide
Cart meta response schema
is_valid
boolean
Whether added meta was vaild
message
string
Detailed message that used to display
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
buy_now:
false
body:
body
Response
Update cart metadata
updateCartMeta
Cart meta includes configuration settings for customizing and optimizing the cart experience, such as adjusting item limits, configuring discounts, and managing delivery charges, to meet the needs of sales channels effectively.
Operations
PUT
# Update cart meta
GET
# Get cart meta
POST
# Create a new cart meta
Modify the configuration settings for cart metadata associated with a specific sales channel. Cart meta includes configuration settings such as allowed maximum cart value, allowed minimum cart value, maximum allowed cart items, delivery charges, etc.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
cart_meta_idpath
string
Required
CartMeta id for fetching single cart meta data for editing
bodyrequestBody
object (CartMetaConfigUpdate)
Required
Hide
Update meta information related to cart
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
Show
Delivery charge config which includes charges applicable condition and enabled flag
charges
array of object (Charges)
List of delivery changes information of the cart
Show
Charges threshhold data which denotes how much charge will be applied on cart value
charges
integer
| int32
Delivery chanrges applied on the product of cart
threshold
integer
| int32
Threshold of cart value on which the charge should be applied
enabled
boolean
Enable or disable delivery charge on cart
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
Request body
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
Show
Delivery charge config which includes charges applicable condition and enabled flag
charges
array of object (Charges)
List of delivery changes information of the cart
Show
Charges threshhold data which denotes how much charge will be applied on cart value
charges
integer
| int32
Delivery chanrges applied on the product of cart
threshold
integer
| int32
Threshold of cart value on which the charge should be applied
enabled
boolean
Enable or disable delivery charge on cart
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
PUT
Response
200
400
Cart Meta Config updated successfully
Hide
Update meta information related to cart
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
Show
Delivery charge config which includes charges applicable condition and enabled flag
charges
array of object (Charges)
List of delivery changes information of the cart
Show
Charges threshhold data which denotes how much charge will be applied on cart value
charges
integer
| int32
Delivery chanrges applied on the product of cart
threshold
integer
| int32
Threshold of cart value on which the charge should be applied
enabled
boolean
Enable or disable delivery charge on cart
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
Examples
Parameters
company_id:
"value"
application_id:
"value"
cart_meta_id:
"value"
body:
body
Response
Update cart meta
updateCartMetaConfig
Retrieve meta configuration settings tailored for customizing the cart experience within a specific sales channel. Cart meta includes configuration settings such as allowed maximum cart value, allowed minimum cart value, maximum allowed cart items, delivery charges, etc.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
GET
Response
200
400
Cart Meta Config Fetched successfully
Hide
Add meta information related to cart
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
Show
Delivery charge config which includes charges applicable condition and enabled flag
charges
array of object (Charges)
List of delivery changes information of the cart
Show
Charges threshhold data which denotes how much charge will be applied on cart value
charges
integer
| int32
Delivery chanrges applied on the product of cart
threshold
integer
| int32
Threshold of cart value on which the charge should be applied
enabled
boolean
Enable or disable delivery charge on cart
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
Examples
Parameters
company_id:
"value"
application_id:
"value"
Response
Get cart meta
fetchCartMetaConfig
Create custom meta configurations for carts associated with a specific sales channel. By specifying the company ID and application ID, seller can define unique cart settings, including preferences, rules, and constraints, tailored to their business needs.
Parameters
company_idpath
string
Required
Current company id
application_idpath
string
Required
Current Application id of sales channel
bodyrequestBody
object (CartMetaConfigAdd)
Required
Hide
Add meta information related to cart
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
Show
Delivery charge config which includes charges applicable condition and enabled flag
charges
array of object (Charges)
List of delivery changes information of the cart
Show
Charges threshhold data which denotes how much charge will be applied on cart value
charges
integer
| int32
Delivery chanrges applied on the product of cart
threshold
integer
| int32
Threshold of cart value on which the charge should be applied
enabled
boolean
Enable or disable delivery charge on cart
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
Request body
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
Show
Delivery charge config which includes charges applicable condition and enabled flag
charges
array of object (Charges)
List of delivery changes information of the cart
Show
Charges threshhold data which denotes how much charge will be applied on cart value
charges
integer
| int32
Delivery chanrges applied on the product of cart
threshold
integer
| int32
Threshold of cart value on which the charge should be applied
enabled
boolean
Enable or disable delivery charge on cart
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
POST
Response
201
400
Cart Meta Config Created successfully
Hide
Add meta information related to cart
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
Show
Delivery charge config which includes charges applicable condition and enabled flag
charges
array of object (Charges)
List of delivery changes information of the cart
Show
Charges threshhold data which denotes how much charge will be applied on cart value
charges
integer
| int32
Delivery chanrges applied on the product of cart
threshold
integer
| int32
Threshold of cart value on which the charge should be applied
enabled
boolean
Enable or disable delivery charge on cart
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Response
Create a new cart meta
createCartMetaConfig
Checkout refers to the final stage of the purchasing process where the customer completes their transaction by paying for the selected items and providing necessary shipping and payment information. During checkout, users review their cart contents, enter billing and shipping addresses, choose payment methods, and confirm their order. It's the pivotal moment when the transaction is finalized, and the goods are prepared for delivery to the customer's designated address.
Operations
POST
# Get and validate cart items
POST
# Headless Checkout
POST
# Update cart checkout
POST
# Checkout cart
Retrieve cart details for a provided list of cart items and validate its contents. This ensures accuracy and completeness in cart information, including item quantities, prices, discounts, and applicable taxes.
Parameters
company_idpath
string
Required
Unique identifier of the company
application_idpath
string
Required
Unique identifier of the sales channel application
bodyrequestBody
object (OpenapiCartDetailsCreation)
Required
Hide
Request schema to validate the products in cart and their contents.
cart_items
array of object (CartItem)
Required
List of products in cart
Show
Information of product in cart like their quantity, size and product id
quantity
integer
| int32
Quantity of product in cart
product_id
string
Required
Unique identifier of product in cart
size
string
Required
Size of product in cart
Headers
x-ordering-source
string
Ordering source header, to be used to identify source of order creation.
x-ordering-source-type
string
Ordering source type header, to be used to identify source type of order creation.
x-location-detail
string
Location details for the cart checkout
x-currency-code
string
Currency code for transactions.
Default Value : INR
Request body
cart_items
array of object (CartItem)
Required
List of products in cart
Show
Information of product in cart like their quantity, size and product id
quantity
integer
| int32
Quantity of product in cart
product_id
string
Required
Unique identifier of product in cart
size
string
Required
Size of product in cart
POST
Response
200
400
Cart details with breakup
Hide
Open Api cart detail response
is_valid
boolean
Cart validity flag determines the if the response is valid or not
message
string
Message of the cart Open API cart detail response
breakup_values
object (CartBreakup)
Show
Price breakup of cart which denotes different values like coupon, display, and loyalty points
coupon
object (CouponBreakup)
Show
Coupon details of the coupon applied to cart that incluedes coupon id, coupon title, description, coupon code, applied message etc.
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
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
Minimum cart value of the coupon applied to cart
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
Show
Display price breakup schema denotes price currency, key, value, message to display as breakup on UI
key
string
key of the price like total_mrp, total, subtotal etc
value
number
| float
Numeric value for 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
loyalty_points
object (LoyaltyPoints)
Show
Loyalty points data which determines how much loyalty points applied to cart and total loyalty points customer has in his account
is_applied
boolean
Whether the loyalty points are applied on the cart
total
number
| float
Total loyalty points available with user
applicable
number
| float
Whether the loyalty points are applicable for the cart
description
string
Description for loyalty points
total_points
number
| float
Total engage points available.
points
number
| float
Engage points applied on the cart.
amount
number
| float
Engage points amount applied on the cart.
mop_amount
number
| float
Engage discount amount applied on the cart as payment mode.
earn_points
number
| float
Engage points that can be earned on the cart. for ex. (You’ll earn 56 points from this order!)
earn_points_amount
number
| float
Engage points amount that can be earned on the cart. for ex. or ex. (You’ll earn ₹56 from this order!)
earn_title
string
Title to show how many earn points are gained for this order.
title
string
Unique title for loyalty program applicable.
discount_amount
number
| float
Engage discount amount applied on the cart as payment mode
meta
object
Nullable
Free-form metadata returned by the loyalty engine in its response. Structure varies; may include rule details, campaign info, or any additional fields Engage sends back.
raw
object (RawBreakup)
Show
Price raw breakup of the cart which denotes cod charge, convinience fee, coupon amount, delivery charge, discount, loyalty points,engage points, gift card, gst charge, etc.
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
engage_amount
number
| float
Engage points amount applied on the cart.
engage_mop_amount
number
| float
Engage mop amount applied on the 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 received 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
convenience_fee
number
| float
Convenience fee amount applied to cart
store_credit
number
| float
Store credit redeemed on the cart
items
array of object (CartProductInfo)
Items details in cart
Show
Product information of the products in cart which includes article information, charges applied, coupon data, delivery promise, discount etc
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
Show
Cart product data structure which includes product data as action, attributes, brand, categoreis,, images, item code, tags, item id, item name, etc
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Show
Product images data in different formats
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Show
List of labels or batches attached to a product in cart
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
Show
Schema of Action Object to render the product.
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
Show
Action query schema which includes list of product slugs
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
Show
Redirection Page details from item in cart
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
Show
Parameters of the redirection page
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
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
Show
Category information schema which denotes category name and category id
uid
integer
| int32
Unique identifier of Product Category
name
string
Category name of the product
attributes
object
Product attributes defined on platform
product_ean_id
string
European Article Number of the product (limited upto 50 EAN identifier in a single request)
parent_item_identifiers
object
Parent item information of the product which identifies the parent of the product in cart
is_set
boolean
Whether or not the product is a set of items
article
object (ProductArticle)
Show
Detailed information of the product added in cart
seller_identifier
string
List of identifiers used by sellers for the product size.
quantity
integer
| int32
Quantity of the article added in cart
seller
object (BaseInfo)
Show
Basic information which provides basic info like uid of any entity like brand or seller and name of the entity
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
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
Gift card detail if gift card applied to the product which indicates gift price, gift applicable flag and display message for the gift
product_group_tags
array of string
List fot the unique identifier for the product grouping.
force_new_line_item
boolean
Flag to indicate the item as a separate article in cart
identifier
object
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
_custom_json
object
Field to update custom json of the article in cart
price
object (ArticlePriceInfo)
Show
Article level price details which includes base and converted prices of article
converted
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
base
object (BasePrice)
Show
Base price information like currency code, currncy symbol, effctive and marked, selling prices
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
meta
object
Meta data of article in cart
size
string
Size of the article added in cart