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
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
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_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
Request body
cart_items
array of object (CartItem)
Required
List of items in open api cart response
Array of CartItem
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
ShippingAddress
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
Required
Area code of the address
Minimum Length : 1
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
Response
200
Cart details with pincode validity information at item level
OpenApiCartServiceabilityResult
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
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
CartProduct
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Array of ProductImage
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Tags
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
ProductAction
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
ActionQuery
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
Array of CategoryInfo
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)
ProductArticle
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)
BaseInfo
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.
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)
ArticlePriceInfo
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions
currency_code
string
Currency code for all amounts
currency_symbol
string
currency symbol of the currncy used for price
marked
number
| float
Original price of product
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions
currency_code
string
Currency code for all amounts
currency_symbol
string
currency symbol of the currncy used for price
marked
number
| float
Original price of product
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
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
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Array of AppliedPromotion
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Ownership2
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Array of DiscountRulesApp
offer
object
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
Array of AppliedFreeArticles
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
FreeGiftItems
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
PriceMinMax
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
ArticlePriceDetails
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
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
Array of BuyRules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
amount
number
| float
Per unit discount amount applied with current promotion
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
PromiseISOFormat
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)
CouponDetails
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart
discount_single_quantity
number
| float
Discout amount applied from coupon for single quantity of the product
code
string
Coupon code of the coupon applied
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart
price
object (ProductPriceInfo)
ProductPriceInfo
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product
add_on
number
| float
Price before promotion and coupon amount applied for calculation
currency_code
string
currency code of the price defined for the product
currency_symbol
string
currency symbol of the price defined for the product
effective
number
| float
Selling price of the product
selling
number
| float
Selling price of the product
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product
add_on
number
| float
Price before promotion and coupon amount applied for calculation
currency_code
string
currency code of the price defined for the product
currency_symbol
string
currency symbol of the price defined for the product
effective
number
| float
Selling price of the product
selling
number
| float
Selling price of the product
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart
message
string
Product level message which denotes error information to display over the product in cart
discount
string
Discount amount of the product in cart
availability
object (ProductAvailability)
ProductAvailability
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
Array of ProductAvailabilitySize
display
string
Display size of the product
value
string
Actual value of the size
is_available
boolean
Available flag for the size of the product if that is available
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.
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product
add_on
number
| float
Price before promotion and coupon amount applied for calculation
currency_code
string
currency code of the price defined for the product
currency_symbol
string
currency symbol of the price defined for the product
effective
number
| float
Selling price of the product
selling
number
| float
Selling price of the product
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product
add_on
number
| float
Price before promotion and coupon amount applied for calculation
currency_code
string
currency code of the price defined for the product
currency_symbol
string
currency symbol of the price defined for the product
effective
number
| float
Selling price of the product
selling
number
| float
Selling price of the product
promo_meta
object (PromoMeta)
PromoMeta
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user
custom_order
object
Whether MTO (Make to Order) is enabled or not.
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
PromiseISOFormat
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)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart
value
number
| float
Coupon value of the coupon applied to cart
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart
uid
string
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
Array of DisplayBreakup
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)
LoyaltyPoints
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
raw
object (RawBreakup)
RawBreakup
coupon
number
| float
Coupon amount applied to cart
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart
fynd_cash
number
| float
Loyalty points applied on cart
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart
gift_card
number
| float
Gift cart amount applied on cart
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD
total
number
| float
Total payable amount by the customer
discount
number
| float
Discount amount recieved on cart
delivery_charge
number
| float
Delivery charge applied to cart
you_saved
number
| float
Total amount will be saved if customer places the order
subtotal
number
| float
Selling price amount of all products in cart
convenience_fee
number
| float
Convenience fee amount applied to cart
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
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_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
page_no
integer
current page no as per pagination
Default Value : 0
page_size
integer
Cart max records fetched in single request
Default Value : 10
from_date
string
| date-time
Cart which are created on or after from_date
to_date
string
| date-time
Cart which are created on or before to_date
anonymous_cart
boolean
Filter by `anonymous_cart`
last_id
string
pagination is done based on the last_object_id
sort_on
string
on which column to sort on i.e created_on or last_modified
Response
200
Abandoned Cart List for sent page_size and page_no
AbandonedCartResult
items
array of object (AbandonedCart)
List of items in abandon cart
Array of AbandonedCart
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)
Page
item_total
integer
| int32
The total number of items on the page.
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, such as 'PageType'.
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.
Was this section helpful?
GET
Response
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_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
id
string
The unique identifier of the cart
i
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
b
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
c
boolean
This is a boolean value. Select `true` to retrieve the cod charges in breakup of cart items.
Response
200
Success. Returns a Cart object. Check the example shown below or refer `CartDetailResult` for more details.
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
PromiseISOFormat
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
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
CartProduct
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Array of ProductImage
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Tags
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
ProductAction
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
ActionQuery
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
Array of CategoryInfo
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)
ProductArticle
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)
BaseInfo
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.
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)
ArticlePriceInfo
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions
currency_code
string
Currency code for all amounts
currency_symbol
string
currency symbol of the currncy used for price
marked
number
| float
Original price of product
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions
currency_code
string
Currency code for all amounts
currency_symbol
string
currency symbol of the currncy used for price
marked
number
| float
Original price of product
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
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
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Array of AppliedPromotion
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Ownership2
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Array of DiscountRulesApp
offer
object
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
Array of AppliedFreeArticles
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
FreeGiftItems
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
PriceMinMax
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
ArticlePriceDetails
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
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
Array of BuyRules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
amount
number
| float
Per unit discount amount applied with current promotion
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
PromiseISOFormat
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)
CouponDetails
discount_total_quantity
number
| float
Total discount earned from coupon applied to cart
discount_single_quantity
number
| float
Discout amount applied from coupon for single quantity of the product
code
string
Coupon code of the coupon applied
bulk_offer
object
Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart
price
object (ProductPriceInfo)
ProductPriceInfo
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product
add_on
number
| float
Price before promotion and coupon amount applied for calculation
currency_code
string
currency code of the price defined for the product
currency_symbol
string
currency symbol of the price defined for the product
effective
number
| float
Selling price of the product
selling
number
| float
Selling price of the product
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product
add_on
number
| float
Price before promotion and coupon amount applied for calculation
currency_code
string
currency code of the price defined for the product
currency_symbol
string
currency symbol of the price defined for the product
effective
number
| float
Selling price of the product
selling
number
| float
Selling price of the product
coupon_message
string
Message for the coupon denotes which coupon is applied and empty if not applied
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart
message
string
Product level message which denotes error information to display over the product in cart
discount
string
Discount amount of the product in cart
availability
object (ProductAvailability)
ProductAvailability
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
Array of ProductAvailabilitySize
display
string
Display size of the product
value
string
Actual value of the size
is_available
boolean
Available flag for the size of the product if that is available
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.
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
converted
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product
add_on
number
| float
Price before promotion and coupon amount applied for calculation
currency_code
string
currency code of the price defined for the product
currency_symbol
string
currency symbol of the price defined for the product
effective
number
| float
Selling price of the product
selling
number
| float
Selling price of the product
base
object (ProductPrice)
ProductPrice
marked
number
| float
Maximum price of the product
add_on
number
| float
Price before promotion and coupon amount applied for calculation
currency_code
string
currency code of the price defined for the product
currency_symbol
string
currency symbol of the price defined for the product
effective
number
| float
Selling price of the product
selling
number
| float
Selling price of the product
promo_meta
object (PromoMeta)
PromoMeta
message
string
Loyalty points message denotes how much loyalty points and applied and how much left with the user
custom_order
object
Whether MTO (Make to Order) is enabled or not.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
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)
CartCommonConfig
delivery_charges_config
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
Delivery charge enabled for the cart or not
charges
array of object (ChargesThreshold)
Charges applicable based on threshold
Array of ChargesThreshold
charges
number
| float
Charges amount to be applied on cart
threshold
number
| float
Threshold of cart value on which the charge should be applied
coupon
object (CartDetailCoupon)
CartDetailCoupon
cashback_amount
number
| float
Fields denotes cashback amount applied to cart
cashback_message_primary
string
Primary cashback message for coupon applied to cart
cashback_message_secondary
string
Secondary cashback message for coupon applied to cart
coupon_code
string
Coupon code to be applied to cart
coupon_description
string
Coupon description of the coupon applied to cart
coupon_id
string
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)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
Coupon Title of the coupon applied denotes name of the coupon
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart
value
number
| float
Coupon value of the coupon applied to cart
is_applied
boolean
Applied flag which denotes if any coupon is applied to cart
uid
string
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
Array of DisplayBreakup
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)
LoyaltyPoints
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
raw
object (RawBreakup)
RawBreakup
coupon
number
| float
Coupon amount applied to cart
gst_charges
number
| float
GST charges applied on cart
mrp_total
number
| float
Maximum price total amount of all products in cart
fynd_cash
number
| float
Loyalty points applied on cart
vog
number
| float
Total value of goods after all discount, coupons and promotion applied of all products in cart
gift_card
number
| float
Gift cart amount applied on cart
cod_charge
number
| float
Cod charge value applied to cart. This is applied when user select payment mode as COD
total
number
| float
Total payable amount by the customer
discount
number
| float
Discount amount recieved on cart
delivery_charge
number
| float
Delivery charge applied to cart
you_saved
number
| float
Total amount will be saved if customer places the order
subtotal
number
| float
Selling price amount of all products in cart
convenience_fee
number
| float
Convenience fee amount applied to cart
is_valid
boolean
Cart validity flag determines the if the response is valid or not
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
checkout_mode
string
Checkout mode of user cart
last_modified
string
| 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
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
Array of AppliedPromotion
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Ownership2
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Array of DiscountRulesApp
offer
object
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
Array of AppliedFreeArticles
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
FreeGiftItems
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
PriceMinMax
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
ArticlePriceDetails
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
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
Array of BuyRules
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
amount
number
| float
Per unit discount amount applied with current promotion
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion 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
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
i:
false
b:
false
c:
false
Was this section helpful?
GET
Response
Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
cart_id
string
Required
Current Cart id of user cart
b
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
Request body
new_cart
boolean
Field to create to new cart whille user adds item to cart
items
array of object (AddProductCart)
List of items detail which need to be added to cart like item id, item size, and item quantity
Array of AddProductCart
quantity
integer
| int32
Field to specify the product quantity that user wants to buy
item_size
string
Field to determine size of the product
seller_id
integer
| int32
Unique 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
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
Response
200
Success. Returns a cart object as shown below. Refer `AddCartDetailResult` for more details.
AddCartDetailResult
success
boolean
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResult)
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
Maximum Delivery promise formatted timestamp
min
string
Minimum Delivery promise formatted timestamp
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
Maximum Promise for the shipment
min
number
| float
Minimum delivery promise time for the shipment
iso
object (PromiseISOFormat)
PromiseISOFormat
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
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
CartProduct
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Array of ProductImage
secure_url
string
Secured url of the product image
url
string
Bucket link url for product image
aspect_ratio
string
Aspect ratio of the product image
teaser_tag
object (Tags)
Tags
tags
object
Tags is a lable or batch that is attached to a product in cart
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
Unique identifier of entities like brand or seller
name
string
Name of entities like brand or seller
action
object (ProductAction)
ProductAction
type
string
Type of action
url
string
Url of the product to render the product
query
object (ActionQuery)
ActionQuery
product_slug
array of string
Contains list of product slug
page
object (ProductActionPage)
ProductActionPage
type
string
Entity of page to be redirected on click
params
object (ProductActionParams)
ProductActionParams
slug
array of string
Unique product url name generated via product name and other meta data.
uid
integer
| int32
Unique identifier of the product in cart
tags
array of string
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
Array of CategoryInfo
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)
ProductArticle
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)
BaseInfo
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.
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)
ArticlePriceInfo
converted
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions
currency_code
string
Currency code for all amounts
currency_symbol
string
currency symbol of the currncy used for price
marked
number
| float
Original price of product
base
object (BasePrice)
BasePrice
effective
number
| float
Current per unit price of product after existing deductions
currency_code
string
Currency code for all amounts
currency_symbol
string
currency symbol of the currncy used for price
marked
number
| float
Original price of product
meta
object
Meta data of article in cart
size
string
Size of the article added in cart
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
Unique identifiers of the store from where product is fulfileld
name
string
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
tags
array of string
A list of article tags
promotions_applied
array of object (AppliedPromotion)
List of applicable promotion for the product in cart
Array of AppliedPromotion
article_quantity
integer
| int32
Quantity of article on which promotion is applicable
ownership
object (Ownership2)
Ownership of promotion
Ownership2
payable_category
string
Promotion amount payable category
payable_by
string
Promotion amount bearable party
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Array of DiscountRulesApp
offer
object
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
Array of AppliedFreeArticles
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
FreeGiftItems
item_slug
string
Free gift product slug
item_name
string
Free gift product name
item_price_details
object (ItemPriceDetails)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
effective
object (PriceMinMax)
PriceMinMax
min
number
| float
Min price of article added in user cart
max
number
| float
Max price of article added in user cart
currency
string
The currency code for price
article_price
object (ArticlePriceDetails)
ArticlePriceDetails
marked
number
| float
The Marked Price refers to the initial price of the free gift article before product discount.
effective
number
| float
The Effective Price refers to the final amount of the free gift article after applying the product discount.
item_brand_name
string
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
Array of BuyRules