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 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
Request body
cart_items
array of object (CartItem)
Required
Array of CartItem
quantity
integer
| int32
product_id
string
Required
size
string
Required
shipping_address
object (ShippingAddress)
Required
ShippingAddress
country
string
Nullable
state
string
Nullable
city
string
Nullable
phone
integer
| int32
area_code
string
Required
country_iso_code
string
country_phone_code
string
meta
object
address_type
string
area
string
area_code_slug
string
Default Value : pincode
name
string
landmark
string
email
string
country_code
string
Default Value : IND
pincode
integer
| int32
address
string
Response
200
Cart details with pincode validity information at item level
OpenApiCartServiceabilityResponse
is_valid
boolean
items
array of object (CartProductInfo)
Array of CartProductInfo
quantity
integer
| int32
product
object (CartProduct)
CartProduct
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Array of ProductImage
secure_url
string
url
string
aspect_ratio
string
teaser_tag
object (Tags)
Tags
tags
object
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
name
string
action
object (ProductAction)
ProductAction
type
string
url
string
query
object (ActionQuery)
ActionQuery
product_slug
array of string
Contains list of product slug
uid
integer
| int32
tags
array of string
_custom_json
object
type
string
name
string
item_code
string
Nullable
categories
array of object (CategoryInfo)
Array of CategoryInfo
uid
integer
| int32
Product Category Id
name
string
attributes
object
product_ean_id
string
parent_item_identifiers
object
is_set
boolean
article
object (ProductArticle)
ProductArticle
seller_identifier
string
quantity
integer
| int32
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
name
string
cart_item_meta
object
parent_item_identifiers
object
is_gift_visible
boolean
uid
string
gift_card
object
product_group_tags
array of string
identifier
object
mto_quantity
integer
| int32
extra_meta
object
type
string
_custom_json
object
price
object (ArticlePriceInfo)
ArticlePriceInfo
converted
object (BasePrice)
BasePrice
effective
number
| float
currency_code
string
currency_symbol
string
marked
number
| float
base
object (BasePrice)
BasePrice
effective
number
| float
currency_code
string
currency_symbol
string
marked
number
| float
meta
object
size
string
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
name
string
store_code
string
tags
array of string
a list of article tags
promotions_applied
array of object (AppliedPromotion)
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
promo amount payable category
payable_by
string
promo amount bearable party
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Array of DiscountRulesApp
offer
object
offer 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
article_id
string
free article id
free_gift_item_details
object (FreeGiftItems)
Free gift items details
FreeGiftItems
item_slug
string
item slug
item_name
string
Item name
item_price_details
object (ItemPriceDetails)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
min
number
| float
max
number
| float
effective
object (PriceMinMax)
PriceMinMax
min
number
| float
max
number
| float
currency
string
item_brand_name
string
item brand name
item_id
integer
| int32
Item id
item_images_url
array of string
item 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
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion id
meta
object
Meta object for extra data
code
string
Nullable
Promotion code
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
min
string
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
min
number
| float
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
discount_single_quantity
number
| float
code
string
bulk_offer
object
price
object (ProductPriceInfo)
ProductPriceInfo
converted
object (ProductPrice)
ProductPrice
marked
number
| float
add_on
number
| float
currency_code
string
currency_symbol
string
effective
number
| float
selling
number
| float
base
object (ProductPrice)
ProductPrice
marked
number
| float
add_on
number
| float
currency_code
string
currency_symbol
string
effective
number
| float
selling
number
| float
coupon_message
string
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart
message
string
discount
string
availability
object (ProductAvailability)
ProductAvailability
is_valid
boolean
other_store_quantity
integer
| int32
deliverable
boolean
available_sizes
array of object (ProductAvailabilitySize)
Array of ProductAvailabilitySize
display
string
value
string
is_available
boolean
out_of_stock
boolean
sizes
array of string
moq
object
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
converted
object (ProductPrice)
ProductPrice
marked
number
| float
add_on
number
| float
currency_code
string
currency_symbol
string
effective
number
| float
selling
number
| float
base
object (ProductPrice)
ProductPrice
marked
number
| float
add_on
number
| float
currency_code
string
currency_symbol
string
effective
number
| float
selling
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
custom_order
object
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
min
string
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
min
number
| float
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
message
string
breakup_values
object (CartBreakup)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
max_discount_value
number
| float
value
number
| float
is_applied
boolean
uid
string
coupon_type
string
Nullable
sub_title
string
Nullable
coupon_value
number
| float
code
string
type
string
minimum_cart_value
number
| float
message
string
description
string
Nullable
display
array of object (DisplayBreakup)
Array of DisplayBreakup
key
string
value
number
| float
currency_code
string
currency_symbol
string
display
string
message
array of string
loyalty_points
object (LoyaltyPoints)
LoyaltyPoints
is_applied
boolean
total
number
| float
applicable
number
| float
description
string
raw
object (RawBreakup)
RawBreakup
coupon
number
| float
gst_charges
number
| float
mrp_total
number
| float
fynd_cash
number
| float
vog
number
| float
gift_card
number
| float
cod_charge
number
| float
total
number
| float
discount
number
| float
delivery_charge
number
| float
you_saved
number
| float
subtotal
number
| float
convenience_fee
number
| float
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Check cart serviceability
checkCartServiceability
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
page_no
integer
current page no as per pagination
Default Value : 0
page_size
integer
Coupon max records fetched in single request
Default Value : 10
from_date
string
Cart which are created on or after from_date
to_date
string
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
AbandonedCartResponse
items
array of object (AbandonedCart)
Array of AbandonedCart
expire_at
string
| date-time
promotion
object
is_default
boolean
comment
string
Nullable
articles
array of object
coupon
object
Nullable
bulk_coupon_discount
number
| float
Nullable
_id
string
fynd_credits
object
fc_index_map
array of integer
order_id
string
discount
number
| float
cod_charges
object
payments
object
Nullable
payment_mode
string
Nullable
shipments
array of object
pick_up_customer_details
object
Nullable
uid
integer
| int32
checkout_mode
string
cart_value
number
| float
is_archive
boolean
created_on
string
| date-time
last_modified
string
| date-time
meta
object
Nullable
buy_now
boolean
is_active
boolean
cashback
object
payment_methods
array of object
gstin
string
Nullable
delivery_charges
object
merge_qty
boolean
Nullable
user_id
string
app_id
string
result
object
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
Loading...
Response
Loading...
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_id
string
Required
Current company id
application_id
string
Required
Current Application _id
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 `CartDetailResponse` for more details.
CartDetailResponse
cart_id
integer
| int32
uid
string
coupon_text
string
id
string
pan_config
object
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
min
string
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
min
number
| float
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
items
array of object (CartProductInfo)
Array of CartProductInfo
quantity
integer
| int32
product
object (CartProduct)
CartProduct
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Array of ProductImage
secure_url
string
url
string
aspect_ratio
string
teaser_tag
object (Tags)
Tags
tags
object
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
name
string
action
object (ProductAction)
ProductAction
type
string
url
string
query
object (ActionQuery)
ActionQuery
product_slug
array of string
Contains list of product slug
uid
integer
| int32
tags
array of string
_custom_json
object
type
string
name
string
item_code
string
Nullable
categories
array of object (CategoryInfo)
Array of CategoryInfo
uid
integer
| int32
Product Category Id
name
string
attributes
object
product_ean_id
string
parent_item_identifiers
object
is_set
boolean
article
object (ProductArticle)
ProductArticle
seller_identifier
string
quantity
integer
| int32
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
name
string
cart_item_meta
object
parent_item_identifiers
object
is_gift_visible
boolean
uid
string
gift_card
object
product_group_tags
array of string
identifier
object
mto_quantity
integer
| int32
extra_meta
object
type
string
_custom_json
object
price
object (ArticlePriceInfo)
ArticlePriceInfo
converted
object (BasePrice)
BasePrice
effective
number
| float
currency_code
string
currency_symbol
string
marked
number
| float
base
object (BasePrice)
BasePrice
effective
number
| float
currency_code
string
currency_symbol
string
marked
number
| float
meta
object
size
string
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
name
string
store_code
string
tags
array of string
a list of article tags
promotions_applied
array of object (AppliedPromotion)
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
promo amount payable category
payable_by
string
promo amount bearable party
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Array of DiscountRulesApp
offer
object
offer 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
article_id
string
free article id
free_gift_item_details
object (FreeGiftItems)
Free gift items details
FreeGiftItems
item_slug
string
item slug
item_name
string
Item name
item_price_details
object (ItemPriceDetails)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
min
number
| float
max
number
| float
effective
object (PriceMinMax)
PriceMinMax
min
number
| float
max
number
| float
currency
string
item_brand_name
string
item brand name
item_id
integer
| int32
Item id
item_images_url
array of string
item 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
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion id
meta
object
Meta object for extra data
code
string
Nullable
Promotion code
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
min
string
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
min
number
| float
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
discount_single_quantity
number
| float
code
string
bulk_offer
object
price
object (ProductPriceInfo)
ProductPriceInfo
converted
object (ProductPrice)
ProductPrice
marked
number
| float
add_on
number
| float
currency_code
string
currency_symbol
string
effective
number
| float
selling
number
| float
base
object (ProductPrice)
ProductPrice
marked
number
| float
add_on
number
| float
currency_code
string
currency_symbol
string
effective
number
| float
selling
number
| float
coupon_message
string
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart
message
string
discount
string
availability
object (ProductAvailability)
ProductAvailability
is_valid
boolean
other_store_quantity
integer
| int32
deliverable
boolean
available_sizes
array of object (ProductAvailabilitySize)
Array of ProductAvailabilitySize
display
string
value
string
is_available
boolean
out_of_stock
boolean
sizes
array of string
moq
object
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
converted
object (ProductPrice)
ProductPrice
marked
number
| float
add_on
number
| float
currency_code
string
currency_symbol
string
effective
number
| float
selling
number
| float
base
object (ProductPrice)
ProductPrice
marked
number
| float
add_on
number
| float
currency_code
string
currency_symbol
string
effective
number
| float
selling
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
custom_order
object
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
payment_identifier
string
default_options
string
enabled
boolean
delivery_charge_info
string
common_config
object (CartCommonConfig)
CartCommonConfig
delivery_charges_config
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
charges
array of object (ChargesThreshold)
Array of ChargesThreshold
charges
number
| float
threshold
number
| float
coupon
object (CartDetailCoupon)
CartDetailCoupon
cashback_amount
number
| float
cashback_message_primary
string
cashback_message_secondary
string
coupon_code
string
coupon_description
string
coupon_id
string
coupon_subtitle
string
coupon_title
string
coupon_type
string
coupon_value
number
| float
discount
number
| float
is_applied
boolean
is_valid
boolean
maximum_discount_value
number
| float
message
string
minimum_cart_value
number
| float
restrict_checkout
boolean
message
string
notification
object
staff_user_id
string
success
boolean
breakup_values
object (CartBreakup)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
max_discount_value
number
| float
value
number
| float
is_applied
boolean
uid
string
coupon_type
string
Nullable
sub_title
string
Nullable
coupon_value
number
| float
code
string
type
string
minimum_cart_value
number
| float
message
string
description
string
Nullable
display
array of object (DisplayBreakup)
Array of DisplayBreakup
key
string
value
number
| float
currency_code
string
currency_symbol
string
display
string
message
array of string
loyalty_points
object (LoyaltyPoints)
LoyaltyPoints
is_applied
boolean
total
number
| float
applicable
number
| float
description
string
raw
object (RawBreakup)
RawBreakup
coupon
number
| float
gst_charges
number
| float
mrp_total
number
| float
fynd_cash
number
| float
vog
number
| float
gift_card
number
| float
cod_charge
number
| float
total
number
| float
discount
number
| float
delivery_charge
number
| float
you_saved
number
| float
subtotal
number
| float
convenience_fee
number
| float
is_valid
boolean
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
checkout_mode
string
last_modified
string
| date
buy_now
boolean
gstin
string
applied_promo_details
array of object (AppliedPromotion)
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
promo amount payable category
payable_by
string
promo amount bearable party
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Array of DiscountRulesApp
offer
object
offer 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
article_id
string
free article id
free_gift_item_details
object (FreeGiftItems)
Free gift items details
FreeGiftItems
item_slug
string
item slug
item_name
string
Item name
item_price_details
object (ItemPriceDetails)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
min
number
| float
max
number
| float
effective
object (PriceMinMax)
PriceMinMax
min
number
| float
max
number
| float
currency
string
item_brand_name
string
item brand name
item_id
integer
| int32
Item id
item_images_url
array of string
item 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
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion id
meta
object
Meta object for extra data
code
string
Nullable
Promotion code
pan_no
string
custom_cart_meta
object
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
i:
false
b:
false
c:
false
Was this section helpful?
GET
Loading...
Response
Loading...
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_id
string
Required
Current company id
application_id
string
Required
Current Application _id
cart_id
string
Required
Current Cart _id
b
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
Request body
new_cart
boolean
items
array of object (AddProductCart)
Array of AddProductCart
quantity
integer
| int32
item_size
string
seller_id
integer
| int32
parent_item_identifiers
array of object
product_group_tags
array of string
article_id
string
article_assignment
object
store_id
integer
| int32
display
string
item_id
integer
| int32
extra_meta
object
_custom_json
object
meta
object
pos
boolean
seller_identifier
string
Add items using seller identifier for store os
Response
200
Success. Returns a cart object as shown below. Refer `AddCartDetailResponse` for more details.
AddCartDetailResponse
success
boolean
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResponse)
CartDetailResponse
cart_id
integer
| int32
uid
string
coupon_text
string
id
string
pan_config
object
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
min
string
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
min
number
| float
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
items
array of object (CartProductInfo)
Array of CartProductInfo
quantity
integer
| int32
product
object (CartProduct)
CartProduct
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Array of ProductImage
secure_url
string
url
string
aspect_ratio
string
teaser_tag
object (Tags)
Tags
tags
object
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
name
string
action
object (ProductAction)
ProductAction
type
string
url
string
query
object (ActionQuery)
ActionQuery
product_slug
array of string
Contains list of product slug
uid
integer
| int32
tags
array of string
_custom_json
object
type
string
name
string
item_code
string
Nullable
categories
array of object (CategoryInfo)
Array of CategoryInfo
uid
integer
| int32
Product Category Id
name
string
attributes
object
product_ean_id
string
parent_item_identifiers
object
is_set
boolean
article
object (ProductArticle)
ProductArticle
seller_identifier
string
quantity
integer
| int32
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
name
string
cart_item_meta
object
parent_item_identifiers
object
is_gift_visible
boolean
uid
string
gift_card
object
product_group_tags
array of string
identifier
object
mto_quantity
integer
| int32
extra_meta
object
type
string
_custom_json
object
price
object (ArticlePriceInfo)
ArticlePriceInfo
converted
object (BasePrice)
BasePrice
effective
number
| float
currency_code
string
currency_symbol
string
marked
number
| float
base
object (BasePrice)
BasePrice
effective
number
| float
currency_code
string
currency_symbol
string
marked
number
| float
meta
object
size
string
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
name
string
store_code
string
tags
array of string
a list of article tags
promotions_applied
array of object (AppliedPromotion)
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
promo amount payable category
payable_by
string
promo amount bearable party
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Array of DiscountRulesApp
offer
object
offer 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
article_id
string
free article id
free_gift_item_details
object (FreeGiftItems)
Free gift items details
FreeGiftItems
item_slug
string
item slug
item_name
string
Item name
item_price_details
object (ItemPriceDetails)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
min
number
| float
max
number
| float
effective
object (PriceMinMax)
PriceMinMax
min
number
| float
max
number
| float
currency
string
item_brand_name
string
item brand name
item_id
integer
| int32
Item id
item_images_url
array of string
item 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
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion id
meta
object
Meta object for extra data
code
string
Nullable
Promotion code
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
min
string
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
min
number
| float
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
key
string
coupon
object (CouponDetails)
CouponDetails
discount_total_quantity
number
| float
discount_single_quantity
number
| float
code
string
bulk_offer
object
price
object (ProductPriceInfo)
ProductPriceInfo
converted
object (ProductPrice)
ProductPrice
marked
number
| float
add_on
number
| float
currency_code
string
currency_symbol
string
effective
number
| float
selling
number
| float
base
object (ProductPrice)
ProductPrice
marked
number
| float
add_on
number
| float
currency_code
string
currency_symbol
string
effective
number
| float
selling
number
| float
coupon_message
string
identifiers
object (CartProductIdentifer)
CartProductIdentifer
identifier
string
Article idenfier generated by cart
message
string
discount
string
availability
object (ProductAvailability)
ProductAvailability
is_valid
boolean
other_store_quantity
integer
| int32
deliverable
boolean
available_sizes
array of object (ProductAvailabilitySize)
Array of ProductAvailabilitySize
display
string
value
string
is_available
boolean
out_of_stock
boolean
sizes
array of string
moq
object
price_per_unit
object (ProductPriceInfo)
ProductPriceInfo
converted
object (ProductPrice)
ProductPrice
marked
number
| float
add_on
number
| float
currency_code
string
currency_symbol
string
effective
number
| float
selling
number
| float
base
object (ProductPrice)
ProductPrice
marked
number
| float
add_on
number
| float
currency_code
string
currency_symbol
string
effective
number
| float
selling
number
| float
promo_meta
object (PromoMeta)
PromoMeta
message
string
custom_order
object
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
payment_identifier
string
default_options
string
enabled
boolean
delivery_charge_info
string
common_config
object (CartCommonConfig)
CartCommonConfig
delivery_charges_config
object (DeliveryChargesConfig)
DeliveryChargesConfig
enabled
boolean
charges
array of object (ChargesThreshold)
Array of ChargesThreshold
charges
number
| float
threshold
number
| float
coupon
object (CartDetailCoupon)
CartDetailCoupon
cashback_amount
number
| float
cashback_message_primary
string
cashback_message_secondary
string
coupon_code
string
coupon_description
string
coupon_id
string
coupon_subtitle
string
coupon_title
string
coupon_type
string
coupon_value
number
| float
discount
number
| float
is_applied
boolean
is_valid
boolean
maximum_discount_value
number
| float
message
string
minimum_cart_value
number
| float
restrict_checkout
boolean
message
string
notification
object
staff_user_id
string
success
boolean
breakup_values
object (CartBreakup)
CartBreakup
coupon
object (CouponBreakup)
CouponBreakup
title
string
Nullable
max_discount_value
number
| float
value
number
| float
is_applied
boolean
uid
string
coupon_type
string
Nullable
sub_title
string
Nullable
coupon_value
number
| float
code
string
type
string
minimum_cart_value
number
| float
message
string
description
string
Nullable
display
array of object (DisplayBreakup)
Array of DisplayBreakup
key
string
value
number
| float
currency_code
string
currency_symbol
string
display
string
message
array of string
loyalty_points
object (LoyaltyPoints)
LoyaltyPoints
is_applied
boolean
total
number
| float
applicable
number
| float
description
string
raw
object (RawBreakup)
RawBreakup
coupon
number
| float
gst_charges
number
| float
mrp_total
number
| float
fynd_cash
number
| float
vog
number
| float
gift_card
number
| float
cod_charge
number
| float
total
number
| float
discount
number
| float
delivery_charge
number
| float
you_saved
number
| float
subtotal
number
| float
convenience_fee
number
| float
is_valid
boolean
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
checkout_mode
string
last_modified
string
| date
buy_now
boolean
gstin
string
applied_promo_details
array of object (AppliedPromotion)
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
promo amount payable category
payable_by
string
promo amount bearable party
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Array of DiscountRulesApp
offer
object
offer 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
article_id
string
free article id
free_gift_item_details
object (FreeGiftItems)
Free gift items details
FreeGiftItems
item_slug
string
item slug
item_name
string
Item name
item_price_details
object (ItemPriceDetails)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
min
number
| float
max
number
| float
effective
object (PriceMinMax)
PriceMinMax
min
number
| float
max
number
| float
currency
string
item_brand_name
string
item brand name
item_id
integer
| int32
Item id
item_images_url
array of string
item 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
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion id
meta
object
Meta object for extra data
code
string
Nullable
Promotion code
pan_no
string
custom_cart_meta
object
partial
boolean
When adding multiple items check if all added. True if only few are added.
message
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
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_id
string
Required
Current company id
application_id
string
Required
Current Application _id
cart_id
string
Required
Current Cart _id
b
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
Request body
items
array of object (UpdateProductCart)
Array of UpdateProductCart
quantity
integer
| int32
item_size
string
parent_item_identifiers
object
meta
object
extra_meta
object
_custom_json
object
item_id
integer
| int32
item_index
integer
| int32
identifiers
object (CartProductIdentifer)
Required
CartProductIdentifer
identifier
string
Article idenfier generated by cart
article_id
string
operation
string
Required
Enum
Response
200
Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResponse` for more details.
UpdateCartDetailResponse
success
boolean
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResponse)
CartDetailResponse
cart_id
integer
| int32
uid
string
coupon_text
string
id
string
pan_config
object
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string
min
string
timestamp
object (PromiseTimestamp)
PromiseTimestamp
max
number
| float
min
number
| float
iso
object (PromiseISOFormat)
PromiseISOFormat
max
string
Max promise in ISO format.
min
string
Min Promise in ISO format.
comment
string
items
array of object (CartProductInfo)
Array of CartProductInfo
quantity
integer
| int32
product
object (CartProduct)
CartProduct
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Array of ProductImage
secure_url
string
url
string
aspect_ratio
string
teaser_tag
object (Tags)
Tags
tags
object
brand
object (BaseInfo)
BaseInfo
uid
integer
| int32
name
string
action
object (ProductAction)
ProductAction
type
string
url
string
query
object (ActionQuery)
ActionQuery
product_slug
array of string
Contains list of product slug
uid
integer
| int32
tags
array of string
_custom_json
object
type
string
name
string
item_code
string
Nullable
categories
array of object (CategoryInfo)
Array of CategoryInfo
uid
integer
| int32
Product Category Id
name
string
attributes
object
product_ean_id
string
parent_item_identifiers
object
is_set
boolean
article
object (ProductArticle)
ProductArticle
seller_identifier
string
quantity
integer
| int32
seller
object (BaseInfo)
BaseInfo
uid
integer
| int32
name
string
cart_item_meta
object
parent_item_identifiers
object
is_gift_visible
boolean
uid
string
gift_card
object
product_group_tags
array of string
identifier
object
mto_quantity
integer
| int32
extra_meta
object
type
string
_custom_json
object
price
object (ArticlePriceInfo)
ArticlePriceInfo
converted
object (BasePrice)
BasePrice
effective
number
| float
currency_code
string
currency_symbol
string
marked
number
| float
base
object (BasePrice)
BasePrice
effective
number
| float
currency_code
string
currency_symbol
string
marked
number
| float
meta
object
size
string
store
object (StoreInfo)
StoreInfo
uid
integer
| int32
name
string
store_code
string
tags
array of string
a list of article tags
promotions_applied
array of object (AppliedPromotion)
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
promo amount payable category
payable_by
string
promo amount bearable party
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
discount_rules
array of object (DiscountRulesApp)
Discount rules for promotions
Array of DiscountRulesApp
offer
object
offer 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
article_id
string
free article id
free_gift_item_details
object (FreeGiftItems)
Free gift items details
FreeGiftItems
item_slug
string
item slug
item_name
string
Item name
item_price_details
object (ItemPriceDetails)
ItemPriceDetails
marked
object (PriceMinMax)
PriceMinMax
min
number
| float
max
number
| float
effective
object (PriceMinMax)
PriceMinMax
min
number
| float
max
number
| float
currency
string
item_brand_name
string
item brand name
item_id
integer
| int32
Item id
item_images_url
array of string
item 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
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion id
meta
object
Meta object for extra data
code
string
Nullable
Promotion code
delivery_promise
object (ShipmentPromise)
ShipmentPromise
formatted
object (PromiseFormatted)
PromiseFormatted
max
string