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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
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 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.
page_size
integer
| int32
The number of items per page.
success
boolean
The request success is defined
message
string
message of the response
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get abandoned carts
getAbandonedCart
Retrieves abandoned cart details linked to a specific customer using a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart.
Parameters
company_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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
i:
false
b:
false
c:
false
Was this section helpful?
GET
Response
Get abandoned cart details
getAbandonedCartDetails
Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it.
Parameters
company_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
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
partial
boolean
When adding multiple items check if all added. True if only few are added.
message
string
Message of add cart API response
result
object
Add to cart result data
items
array of object (CartItemInfo)
List of items that needs to be added in cart.
Array of CartItemInfo
item_id
integer
| int32
Item id of the product that needs to be added/updated/removed.
size
string
Item size of the product that needs to be added/updated/removed.
store_id
integer
| int32
Unique identifier of the store selected by the user from which user want to buy a product.
success
boolean
True if items are added/updated/removed successfully.
message
string
Message for added/updated/removed item.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
Add items to cart
addItems
Customers can modify added product attributes such as quantity and size, as well as remove items from the cart.
Parameters
company_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
items
array of object (UpdateProductCart)
Array of UpdateProductCart
quantity
integer
| int32
Field to update the quantity of the item in cart
item_size
string
Field to update the size of the product in cart
parent_item_identifiers
object
Field to update parent product of the item in cart
meta
object
Field to update meta of the item in cart
extra_meta
object
Field to update extra meta of the product in cart
_custom_json
object
Field to update custom json of the product in cart
item_id
integer
| int32
Item id of the product that needs to be updated
item_index
integer
| int32
Item index determines on which index the product falls to be updated
identifiers
object (CartProductIdentifer)
Required
CartProductIdentifer
identifier
string
Article idenfier generated by cart
article_id
string
article id of the product in cart
free_gift_items
array of object (FreeGiftItemCreation)
List of free gift items with updated sizes.
Array of FreeGiftItemCreation
promotion_id
string
Required
Unique identifier of the free gift promotion.
item_id
string
Required
Unique identifier of the selected free gift item.
item_size
string
Required
Size of the selected free gift item.
operation
string
Required
Cart opertaion type
Enum
Response
200
Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResult` for more details.
UpdateCartDetailResult
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
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
result
object
Contains article related result info
items
array of object (CartItemInfo)
List of items that needs to be updated in cart.
Array of CartItemInfo
item_id
integer
| int32
Item id of the product that needs to be added/updated/removed.
size
string
Item size of the product that needs to be added/updated/removed.
store_id
integer
| int32
Unique identifier of the store selected by the user from which user want to buy a product.
success
boolean
True if items are added/updated/removed successfully.
message
string
Message for added/updated/removed item.
message
string
Message of update cart API response
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Response
Update cart items
updateCart
Share cart link
getCartShareLink
List shared cart items
getCartSharedItems
Update shared cart items
updateCartWithSharedItems
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
from_date
string
| date-time
Cart which are created on or after from_date. Supports ISO date format.
to_date
string
| date-time
Cart which are created on or before to_date. Supports ISO date format.
filter_on
string
on which column to sort on i.e created_on or last_modified
Response
200
Platform user cart list
MultiCartResult
success
boolean
True if get list of cart successfully.
data
array of object (CartList)
List of active carts and their item's count
Array of CartList
cart_id
string
The cart id of user
pick_up_customer_details
object
Customer contact details for customer pickup at store
cart_value
number
| float
Total amount of cart
created_on
string
| date-time
Date format when cart created
user_id
string
User id which is associated with cart
currency_code
string
Active cart currency code
item_counts
integer
Article total count in cart
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
List of carts
getCartList
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
id
string
Cart id of user cart
Request body
user_id
string
Required
User Id of user for which we map with the cart
Response
200
UserCartMappingResult
coupon_text
string
Coupon text of coupon applied on cart
user
object (UserInfo)
UserInfo
gender
string
User gender
modified_on
string
| date-time
Date format of user when user last modified
_id
string
Unique Identifier of user
uid
string
Unique UID of user
external_id
string
Unique external id
mobile
string
10 digit Mobile number of user
last_name
string
| date-time
Last name of user
created_at
string
| date-time
Date format of user when user registered
first_name
string
First name of user
id
string
Unique identifier of the user cart
pan_config
object
Pan card config states at what condition user should enter the pan card
delivery_promise
object (ShipmentPromise)
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Message of the get cart detail API response
breakup_values
object (CartBreakup)
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
custom_cart_meta
object
Custom meta details added cart checkout API payload
applied_promo_details
array of object (AppliedPromotion)
List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Response
Update user of a cart
updateCartUser
Retrieve details of a cart linked to a specific customer using either the customer's ID or a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
id
string
The unique identifier of the cart
user_id
string
Option to fetch cart for the provided user_id.
order_type
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
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.
assign_card_id
integer
Token of user's debit or credit card
buy_now
boolean
This is a boolen value. Select `true` to set/initialize buy now cart
Response
200
400
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
user_id:
"value"
order_type:
"value"
i:
false
b:
false
assign_card_id:
1
buy_now:
false
Was this section helpful?
GET
Response
Get a cart
getCart
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
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.
buy_now
boolean
This is a boolen value. Select `true` to set/initialize buy now cart
order_type
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
id
string
The unique identifier of the cart
Request body
user_id
string
The user id of user, for which we need to add item into cart
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
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
partial
boolean
When adding multiple items check if all added. True if only few are added.
message
string
Message of add cart API response
result
object
Add to cart result data
items
array of object (CartItemInfo)
List of items that needs to be added in cart.
Array of CartItemInfo
item_id
integer
| int32
Item id of the product that needs to be added/updated/removed.
size
string
Item size of the product that needs to be added/updated/removed.
store_id
integer
| int32
Unique identifier of the store selected by the user from which user want to buy a product.
success
boolean
True if items are added/updated/removed successfully.
message
string
Message for added/updated/removed item.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
Add items to cart
platformAddItems
Customers can modify added product attributes such as quantity and size, as well as remove items from the cart.
Parameters
company_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.
order_type
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
b
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
buy_now
boolean
This is a boolen value. Select `true` to set/initialize buy now cart
Request body
user_id
string
The user id of user, for which we need to update the cart
items
array of object (UpdateProductCart)
List items data that needs to be updated in cart
Array of UpdateProductCart
quantity
integer
| int32
Field to update the quantity of the item in cart
item_size
string
Field to update the size of the product in cart
parent_item_identifiers
object
Field to update parent product of the item in cart
meta
object
Field to update meta of the item in cart
extra_meta
object
Field to update extra meta of the product in cart
_custom_json
object
Field to update custom json of the product in cart
item_id
integer
| int32
Item id of the product that needs to be updated
item_index
integer
| int32
Item index determines on which index the product falls to be updated
identifiers
object (CartProductIdentifer)
Required
CartProductIdentifer
identifier
string
Article idenfier generated by cart
article_id
string
article id of the product in cart
free_gift_items
array of object (FreeGiftItemCreation)
List of free gift items with updated sizes.
Array of FreeGiftItemCreation
promotion_id
string
Required
Unique identifier of the free gift promotion.
item_id
string
Required
Unique identifier of the selected free gift item.
item_size
string
Required
Size of the selected free gift item.
operation
string
Required
Field to determine if item to be removed from cart or it needs to be updated
Enum
Response
200
Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResult` for more details.
UpdateCartDetailResult
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
cart_conditions
object
Cart conditions details for promotion
item_criteria
object
Item criteria of promotion
offer_text
string
Offer text of current promotion
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
result
object
Contains article related result info
items
array of object (CartItemInfo)
List of items that needs to be updated in cart.
Array of CartItemInfo
item_id
integer
| int32
Item id of the product that needs to be added/updated/removed.
size
string
Item size of the product that needs to be added/updated/removed.
store_id
integer
| int32
Unique identifier of the store selected by the user from which user want to buy a product.
success
boolean
True if items are added/updated/removed successfully.
message
string
Message for added/updated/removed item.
message
string
Message of update cart API response
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Response
Update cart items
platformUpdateCart
Delete all items from the user's cart and resets it to its initial state, providing a clean slate for new selections.
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.
Request body
cart_id_list
array of string
List of all cart ids, which need to delete
Response
200
Success. Returns whether the cart has been deleted or not.
DeleteCartDetailResult
success
boolean
True if cart is archived successfully. False if not archived.
message
string
Message for delete cart response
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Was this section helpful?
PUT
Response
Delete a cart
deleteCart
Retrieve the total count of items currently present in the customer's 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.
buy_now
boolean
Boolean value to get buy_now cart.
Response
200
Success. Returns the total count of items in a user's cart.
CartItemCountResult
user_cart_items_count
integer
| int32
Item count present in cart
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
buy_now:
false
Was this section helpful?
GET
Response
Get a cart items count
getItemCount
Add or modify metadata associated with a cart, which includes customer preferences, delivery instructions, or any special requirements related to the cart items.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
id
string
The unique identifier of the cart
buy_now
boolean
this is boolean to get buy_now cart
Request body
gstin
string
GSTIN number to be added in user cart
pick_up_customer_details
object
Customer contact details for customer pickup at store
checkout_mode
string
Checkout mode of user cart
gift_details
object
Nullable
Gift details is open json which can include gift message
pan_no
string
Permanent Account Number of the user
comment
string
Comment message to be added in user cart
staff_user_id
string
Nullable
staff user id
Response
200
400
Returns a message indicating the success of cart meta updation as shown below.
CartMetaDetails
is_valid
boolean
Whether added meta was vaild
message
string
Detailed message that used to display
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
buy_now:
false
body:
body
Was this section helpful?
PUT
Response
Update cart metadata
updateCartMeta
Cart meta includes configuration settings for customizing and optimizing the cart experience, such as adjusting item limits, configuring discounts, and managing delivery charges, to meet the needs of sales channels effectively.
Operations
PUT
# Update cart meta
GET
# Get cart meta
POST
# Create a new cart meta
Modify the configuration settings for cart metadata associated with a specific sales channel. Cart meta includes configuration settings such as allowed maximum cart value, allowed minimum cart value, maximum allowed cart items, delivery charges, etc.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
cart_meta_id
string
Required
CartMeta id for fetching single cart meta data for editing
Request body
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
DeliveryCharges
charges
array of object (Charges)
List of delivery changes information of the cart
Array of Charges
charges
integer
| int32
Delivery chanrges applied on the product of cart
threshold
integer
| int32
Threshold of cart value on which the charge should be applied
enabled
boolean
Enable or disable delivery charge on cart
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
Response
200
400
Cart Meta Config updated successfully
CartMetaConfigUpdate
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
DeliveryCharges
charges
array of object (Charges)
List of delivery changes information of the cart
Array of Charges
charges
integer
| int32
Delivery chanrges applied on the product of cart
threshold
integer
| int32
Threshold of cart value on which the charge should be applied
enabled
boolean
Enable or disable delivery charge on cart
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
Examples
Parameters
company_id:
"value"
application_id:
"value"
cart_meta_id:
"value"
body:
body
Was this section helpful?
PUT
Response
Update cart meta
updateCartMetaConfig
Retrieve meta configuration settings tailored for customizing the cart experience within a specific sales channel. Cart meta includes configuration settings such as allowed maximum cart value, allowed minimum cart value, maximum allowed cart items, delivery charges, etc.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
Response
200
400
Cart Meta Config Fetched successfully
CartMetaConfigAdd
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
DeliveryCharges
charges
array of object (Charges)
List of delivery changes information of the cart
Array of Charges
charges
integer
| int32
Delivery chanrges applied on the product of cart
threshold
integer
| int32
Threshold of cart value on which the charge should be applied
enabled
boolean
Enable or disable delivery charge on cart
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
Examples
Parameters
company_id:
"value"
application_id:
"value"
Was this section helpful?
GET
Response
Get cart meta
fetchCartMetaConfig
Create custom meta configurations for carts associated with a specific sales channel. By specifying the company ID and application ID, seller can define unique cart settings, including preferences, rules, and constraints, tailored to their business needs.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
Request body
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
DeliveryCharges
charges
array of object (Charges)
List of delivery changes information of the cart
Array of Charges
charges
integer
| int32
Delivery chanrges applied on the product of cart
threshold
integer
| int32
Threshold of cart value on which the charge should be applied
enabled
boolean
Enable or disable delivery charge on cart
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
Response
201
400
Cart Meta Config Created successfully
CartMetaConfigAdd
min_cart_value
integer
| int32
Minimum order value to checkout
max_cart_value
integer
| int32
Maximum order value to checkout
bulk_coupons
boolean
Indicates bulk coupon applicable for cart
max_cart_items
integer
| int32
Maximum cart items to checkout
gift_display_text
string
Free gift charges text to show
delivery_charges
object (DeliveryCharges)
DeliveryCharges
charges
array of object (Charges)
List of delivery changes information of the cart
Array of Charges
charges
integer
| int32
Delivery chanrges applied on the product of cart
threshold
integer
| int32
Threshold of cart value on which the charge should be applied
enabled
boolean
Enable or disable delivery charge on cart
revenue_engine_coupon
boolean
It define credit coupon applicable for cart
gift_pricing
number
| float
Free gift charges per product
enabled
boolean
Enabled flag for cart configuration
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
POST
Response
Create a new cart meta
createCartMetaConfig
Checkout refers to the final stage of the purchasing process where the customer completes their transaction by paying for the selected items and providing necessary shipping and payment information. During checkout, users review their cart contents, enter billing and shipping addresses, choose payment methods, and confirm their order. It's the pivotal moment when the transaction is finalized, and the goods are prepared for delivery to the customer's designated address.
Operations
POST
# Get and validate cart items
POST
# Checkout cart
POST
# Update cart checkout
POST
# Checkout cart
Retrieve cart details for a provided list of cart items and validate its contents. This ensures accuracy and completeness in cart information, including item quantities, prices, discounts, and applicable taxes.
Parameters
company_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 products in cart
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
Response
200
400
Cart details with breakup
OpenapiCartDetailsResult
is_valid
boolean
Cart validity flag determines the if the response is valid or not
message
string
Message of the cart Open API cart detail response
breakup_values
object (CartBreakup)
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
items
array of object (CartProductInfo)
Items details in cart
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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.
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
POST
Response
Get and validate cart items
fetchAndvalidateCartItems
The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
Request body
payment_mode
string
Payment mode from which the payment to be done for the order
cart_value
number
| float
Required
Total amount of user cart
cart_items
array of object (OpenApiOrderItem)
Required
List of items in user cart
Array of OpenApiOrderItem
cashback_applied
number
| float
Required
Cashback applied on user cart
quantity
integer
| int32
Article quantity in user cart
Default Value : 1
size
string
Required
Size of the article added in cart
coupon_effective_discount
number
| float
Required
Coupon discount applied on article in user cart
amount_paid
number
| float
Required
Amount needs to paid for article in cart
delivery_charges
number
| float
Required
Delivery charges applied on article in cart
price_marked
number
| value >= 0
| float
Required
Original price of product
files
array of object (OpenApiFiles)
List of file url
Array of OpenApiFiles
key
string
Required
Key represents name of file
values
array of string
Required
List of urls path
meta
object (CartItemMeta)
CartItemMeta
primary_item
boolean
Flags indicates item is primary or not
group_id
string
Fields to determine group id of the product
extra_meta
object
Extra meta of the article in cart
product_id
integer
| int32
Required
Product id associated with article in cart
loyalty_discount
number
| float
Loyalty points applied on cart
Default Value : 0
discount
number
| float
Required
Discount value applied on article in cart
price_effective
number
| value >= 0
| float
Required
Current per unit price of product after existing deductions
payment_methods
array of object (MultiTenderPaymentMethod)
Required
Payment methods list used to make the payment
Array of MultiTenderPaymentMethod
mode
string
Required
Payment mode of payment method used to make payment
amount
number
| float
Required
Amount of the payment mode to be paid
meta
object (MultiTenderPaymentMeta)
MultiTenderPaymentMeta
payment_id
string
Nullable
Payment gateway identifier
payment_gateway
string
Nullable
Payment gateway used to do the payment
extra_meta
object
Nullable
Payment extra meta for the payment mode to do the payment
current_status
string
Nullable
Current status of the payment
order_id
string
Nullable
Payment gateway order id
name
string
Name of the payment mode used to make payment
employee_discount
number
| float
Employee discount value applied on article in cart
Default Value : 0
cod_charges
number
| float
Required
Cash On Delivery charges applied on article in cart
shipping_address
object (ShippingAddress)
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
loyalty_discount
number
| float
Loyalty points applied on cart
comment
string
Nullable
Comment message added in cart after order placed
payment_methods
array of object (MultiTenderPaymentMethod)
Required
payment methods list used to make the payment
Array of MultiTenderPaymentMethod
mode
string
Required
Payment mode of payment method used to make payment
amount
number
| float
Required
Amount of the payment mode to be paid
meta
object (MultiTenderPaymentMeta)
MultiTenderPaymentMeta
payment_id
string
Nullable
Payment gateway identifier
payment_gateway
string
Nullable
Payment gateway used to do the payment
extra_meta
object
Nullable
Payment extra meta for the payment mode to do the payment
current_status
string
Nullable
Current status of the payment
order_id
string
Nullable
Payment gateway order id
name
string
Name of the payment mode used to make payment
employee_discount
object
Employee discount value applied on user cart
coupon
string
Coupon text of coupon applied on user cart
cashback_applied
number
| float
Required
Cashback applied on user cart
gstin
string
Nullable
GSTIN number added in cart
billing_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
coupon_code
string
Required
Coupon code to be applied to cart
coupon_value
number
| float
Required
Value of the coupon applied to cart
delivery_charges
number
| float
Required
Delivery charges of the order placed via checkout API
affiliate_order_id
string
Order id generated after placing order
currency_code
string
Currency code for the price
order_id
string
Order id generated after placing order
files
array of object (OpenApiFiles)
List of file url
Array of OpenApiFiles
key
string
Required
Key represents name of file
values
array of string
Required
List of urls path
cod_charges
number
| float
Required
Cash On Delivery charges of the user cart
Response
200
400
Checkout cart and create Fynd order id
OpenApiCheckoutResult
success
boolean
The request success is defined
message
string
Message of the api response
order_ref_id
string
Order id sent in request
order_id
string
Fynd order id
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
POST
Response
Checkout cart
checkoutCart
Overrides the cart's checkout process with a new provided cart items. It provides flexibility in customizing checkout flows to meet specific business requirements, enhancing the user experience and optimizing order processing workflows.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
Request body
cart_id
string
Required
The cart id of user cart
payment_mode
string
Required
Payment mode from which the payment to be done for the order
billing_address
object
Billing address json which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name
merchant_code
string
Required
Merchant code of the payment mode selected to do the payment
payment_identifier
string
Required
Payment identifier of the payment mode selected to do the payment
currency_code
string
Required
Currency code for the price
aggregator
string
Required
Aggregator name of the payment gateway
order_type
string
Required
Order type of the order being placed like pickAtStore or HomeDelivery
Enum
callback_url
string
Callback url to be redirected after payment received/failed
cart_items
array of object (OverrideCartItem)
Required
List of items which includes their size, id, discount and promo details
Array of OverrideCartItem
seller_identifier
string
Seller identifiers of the product size.
quantity
integer
| int32
Item quantity, which you have added into cart
Default Value : 1
size
string
Required
Item size, which you have added into cart
price_marked
number
| value >= 0.01
| float
Required
Original price of product
amount_paid
number
| value >= 0.01
| float
Required
Amount needs to paid for item
promo_list
array of object (OverrideCartItemPromo)
List of promotion applied on item
Array of OverrideCartItemPromo
promo_id
string
Required
Promotion id applied on product
promo_amount
string
Required
Promotion amount applied on product
promo_desc
string
Promotion description applied on product
rwrd_tndr
string
item_list
array of object
List of items
parent_promo_id
string
Parent promotion unique identifier
extra_meta
object
Extra meta to be added while checkout in order
item_id
integer
| int32
Required
Item unique id in user cart
discount
number
| float
Required
Discount amount applied on item
price_effective
number
| value >= 0.01
| float
Required
Current per unit price of product after existing deductions
ordering_store
integer
| int32
Nullable
Ordering store id of the store from which the order is getting placed
Default Value : null
shipping_address
object
Shipping address json which includes name, area, address, phone, area_code, state, country, country code and email
Response
200
Checkout cart and create Fynd order id
OverrideCheckoutResult
data
object
Data of the user cart checkout includes cart data, address, user id, order type etc
cart
object
Cart details in API response which included cart id, items in cart, promise, order type, breakup values etc.
success
string
Success flag of cart override checkout API response
order_id
string
Order id generated after placing order
message
string
Message of the cart override checkout API response
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
POST
Response
Update cart checkout
overrideCart
The checkout cart initiates the order creation process based on the items in the user’s cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement.
Parameters
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
Request body
address_id
string
Address id of the user on which the order to be delivered
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment
payment_params
object
Nullable
Payment params which includes payment identifier and merchant code
custom_meta
array of object (CartCheckoutCustomMeta)
Custom meta data to be added in order
Array of CartCheckoutCustomMeta
key
string
Required
Key name of custom meta
value
string
Required
Value to be added in key
payment_auto_confirm
boolean
Payment auto confirm flag if payment need not to be collected from user
id
string
Required
Cart id of the user cart
pos
boolean
Filed to determine whether user is making request from pos or not
billing_address_id
string
Billing address id of the customer on which the invoice to be generated after the order is placed
merchant_code
string
Merchant code of the payment mode selected to do the payment
aggregator
string
Aggregator name of the payment gateway
pick_at_store_uid
integer
| int32
Nullable
Store id where we have to pick product
Default Value : null
device_id
string
Nullable
Device id
delivery_address
object
Delivery address data which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name
payment_mode
string
Payment mode from which the payment to be done for the order
checkout_mode
string
Mode of checkout used in cart
customer_details
object (CustomerDetails)
CustomerDetails
name
string
Name of customer to be added in customer detail while checkout
email
string
Nullable
Email address of the customer to be added in customer detail while checkout
mobile
string
Required
Mobile number of customer to be added in customer detail while checkout
meta
object
Meta data to be added in order
payment_methods
array of object (PaymentMethod)
Required
Payment methods list used to make the payment
Array of PaymentMethod
mode
string
Required
Payment mode of payment method used to make payment
payment
string
Payment name of payment method used to make payment
payment_meta
object (PaymentMeta)
Required
PaymentMeta
payment_gateway
string
Payment gateway used to do the payment
type
string
Type of card if payment mode is card to do the payment
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment
merchant_code
string
Merchant code of the payment mode selected to do the payment
amount
number
| float
Nullable
Amount of the payment mode to be paid
name
string
Name of the payment mode used to make payment
payment_extra_identifiers
object
Payment extra identifier for the payment mode to do the payment
staff
object (StaffCheckout)
StaffCheckout
employee_code
string
Employee code of staff who does checkout on behalf of customer
_id
string
Required
Id of staff who does checkout on behalf of customer
user
string
Required
User id of the employee who does checkout on behalf of customer
last_name
string
Required
Last name of staff employee who does checkout on behalf of customer
first_name
string
Required
First name of staff emplyee who does checkout on behalf of customer
employee_code
string
Nullable
Employee code of staff who does checkout on behalf of customer
billing_address
object
Billing address json which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name
callback_url
string
Nullable
callback url after payment received/failed
Default Value : null
user_id
string
The user id of user cart
extra_meta
object
Extra meta to be added while checkout in order
order_type
string
Required
Order type of the order being placed like pickAtStore or HomeDelivery
Enum
files
array of object (Files)
List of file url
Array of Files
key
string
Required
Key represents name of file
values
array of string
Required
List of urls path
ordering_store
integer
| int32
Nullable
Ordering store id of the store from which the order is getting placed
iin
string
Issuer Identification Number number of card if payment mode is card to do the payment
network
string
Network of card if payment mode is card to do the payment
type
string
Type of cart if payment mode is card to do the payment
card_id
string
Saved card id if payment mode is card to do the payment
success_callback_url
string
Nullable
Success callback url to be redirected after payment received
failure_callback_url
string
Nullable
Failure callback url to be redirected after payment failed
order_tags
array of object (OrderTag)
Order tags used to identify specific type of order which is tagged using order tags
Array of OrderTag
display_text
string
Display text for order tag
slug
string
Slug to be used for tagging order with any unique value
Response
200
400
Success. Returns the status of cart checkout. Refer `CartCheckoutDetailsSchema` for more details.
CartCheckoutDetails
app_intercept_url
string
App intercept url which is used to redirect on app after payment in confirmed/failed
data
object
Data of the user cart checkout includes cart data, address, user id, order type etc
cart
object (CheckCart)
CheckCart
coupon_text
string
Coupon text of the applied coupon on order placed
cod_message
string
Cash On Delivery message for the order placed
id
string
Cart id of the user cart
store_code
string
Store code from which the order placed
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 added in cart after order placed
user_type
string
User type of the cart who places the order
items
array of object (CartProductInfo)
Items details in cart after order placed
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
CartProduct
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Array of ProductImage
secure_url
string
Secured url of the product image
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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.
error_message
string
Error details if any error occurs which includes type of error, error code and error message
success
boolean
Success flag of checkout cart API response
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
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
order_id
string
Order id generated after placing order
message
string
Message of the cart checkout 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
cod_charges
number
| float
Cash On Delivery charges of the user cart
is_valid
boolean
Valid flag fotr the checkout response if order placed was valid
uid
string
Cart id of user cart
checkout_mode
string
Checkout mode of user cart
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag of user cart
delivery_charge_order_value
integer
| int32
Delivery charge order value
cart_id
integer
| int32
Cart id of the user cart for which the order placed
store_emps
array of object
Store employees data
gstin
string
GSTIN number added in cart
cod_available
boolean
Whether Cash On Delivery available
delivery_charges
number
| float
Delivery charges of the order placed via checkout API
custom_cart_meta
object
Custom meta details added cart checkout API payload
success
boolean
Success flag of cart checkout API response
callback_url
string
Callback url to be redirected after payment received/failed
payment_confirm_url
string
Payment confirm url used to redirect after payment is confirmed
order_id
string
Order id generated after placing order
message
string
Message of the cart checkout v2 API response
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
Checkout cart
platformCheckoutCartV2
Coupons are promotional tools offered by businesses to customers, providing discounts, incentives, or special offers on purchases. Their aim is to attract customers, increase sales, encourage repeat purchases, and promote customer loyalty. Various types of coupons include: X Percentage Value: Offers a discount based on a percentage of the total purchase value. Example: Get 15% off your entire order. X Amount Value: Provides a fixed discount amount regardless of the total purchase value. Example: Save Rs.20 on your purchase. Bundle Percentage Discount: Discounts applied when purchasing a specific combination or quantity of items. Example: Buy 2 shirts and get 20% off each. Bundle Amount Percentage Discount: Similar to bundle percentage discount, but the discount is applied to a specific amount spent. Example: Spend Rs.100 on shoes and receive 25% off your entire order. Buy X Items Get Y Items Free: Offers a certain number of items for free when a specified quantity is purchased. Example: Buy 2 pairs of socks and get 1 pair free. Buy X Items at Absolute Amount: Allows customers to purchase a set number of items at a fixed price. Example: Buy 3 t-shirts for Rs. 250.
Operations
GET
# List of coupons
POST
# Create a coupon
GET
# Get a coupon
PUT
# Update a coupon
DEL
# Delete a coupon which is in draft state
GET
# Check coupon code exists
GET
# List of coupons
POST
# Apply coupon
DEL
# Remove coupon
GET
# Validate applied coupon
Retrieve a list of all created coupons for specific sales channel. It also supports searching based on text search, pagination and other flags to filter coupons.
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
Coupon max records fetched in single request
Default Value : 10
is_archived
boolean
Filter by active or inactive coupon
Default Value : false
title
string
Filter coupon by coupon title
is_public
boolean
Filter coupons which is public
is_display
boolean
Filter coupons which is visible to sales channel
type_slug
string
Filter by coupon type
code
string
Filter by coupon code
created_by
string
Filter by coupon creater user id
reviewed_by
string
Filter by coupon reviewer user id
approved_start_time
string
| date-time
Filter coupon by start time date range when status is approved
approved_end_time
string
| date-time
Filter coupon by end time date range when status is approved
review_start_time
string
Filter coupon by start time date range when status is in review state
review_end_time
string
Filter coupon by end time date range when status is in review state
status
string
Filter your coupons effortlessly by status, such as draft, review and more
Enum
Response
200
Coupon List for sent page_size and page_no
CouponsResult
items
array of object (CouponAdd)
Coupons list for sales channel
Array of CouponAdd
date_meta
object (CouponDateMeta)
CouponDateMeta
modified_on
string
| date-time
Nullable
Date time format when the coupon last modified
Default Value : null
created_on
string
| date-time
Nullable
Date time format when the coupon created
Default Value : null
approved_on
string
| date-time
Nullable
Date time format when the coupon approved
Default Value : null
rejected_on
string
| date-time
Nullable
Date time format when the coupon rejected
Default Value : null
reviewed_on
string
| date-time
Nullable
Date time format when the coupon reviewed
Default Value : null
ownership
object (Ownership)
Ownership
payable_category
string
Coupon amount payable category
Enum
payable_by
string
Nullable
Coupon amount bearable party
author
object (CouponAuthor)
CouponAuthor
created_by
string
Nullable
The user id of user, who has created the coupon
Default Value : null
modified_by
string
Nullable
The user id of user, who has modified the coupon
Default Value : null
approved_by
string
Nullable
The user id of user, who has approved the coupon
Default Value : null
rejected_by
string
Nullable
The user id of user, who has rejected the coupon
Default Value : null
reviewed_by
string
Nullable
The user id of user, who has reviewed the coupon
Default Value : null
state
object (State)
State
is_archived
boolean
Publish or unpublish the coupon
Default Value : false
is_display
boolean
Coupon needs to display or not
Default Value : true
is_public
boolean
Coupon is publicaly available or not
Default Value : true
restrictions
object (Restrictions)
Restrictions
payments
object (PaymentModes)
PaymentModes
codes
array of string
Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM
iins
array of string
Debit/Credit card prefix (first 6 digit)
types
array of string
Card type, e.g. Credit, Debit
networks
array of string
Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY
uses
object (PaymentAllowValue)
PaymentAllowValue
max
integer
| int32
Maximum value need to allow for payment
user_type
string
price_range
object (PriceRange)
PriceRange
max
integer
| int32
Max price valid for article in coupon
Default Value : -1
min
integer
| int32
Min price valid for article in coupon
Default Value : -1
platforms
array of string
List of platform on which coupon allowed like web, android
post_order
object (PostOrder)
PostOrder
cancellation_allowed
boolean
Cancellation allowed in coupon
Default Value : true
return_allowed
boolean
Return allowed in coupon
Default Value : true
bulk_bundle
object (BulkBundleRestriction)
BulkBundleRestriction
multi_store_allowed
boolean
Multi store allowed in bulk bundle coupon or not
user_groups
array of integer
List of user group on which coupon allowed
coupon_allowed
boolean
Allow applying normal coupon if bulk coupon is applied
uses
object (UsesRestriction)
UsesRestriction
maximum
object (UsesRemaining)
UsesRemaining
user
integer
| int32
Define total coupon count per user
total
integer
| int32
Define total coupon counts
app
integer
| int32
Define coupon counts associated with application id
remaining
object (UsesRemaining)
UsesRemaining
user
integer
| int32
Define total coupon count per user
total
integer
| int32
Define total coupon counts
app
integer
| int32
Define coupon counts associated with application id
ordering_stores
array of integer
List of store id on which coupon allowed
validation
object (Validation)
Validation
app_id
array of string
List of sales channel's application id
Default Value :
anonymous
boolean
Coupon applicable for guest user or not
user_registered_after
string
| date-time
Nullable
Coupon applicable for user which is registered after Date Format
Default Value : null
action
object (CouponAction)
CouponAction
action_date
string
| date-time
Nullable
Coupon transaction mode's date time format
Default Value : null
txn_mode
string
Coupon transaction mode like cash, coupon etc
Default Value : coupon
Enum
coupon_type
string
The type of coupon like bulk or single
Enum
coupon_prefix
string
Nullable
Bulk coupon code prefix string
coupon_counts
integer
Counts of bulk coupon
Default Value : 1
tags
array of string
List of tags specify to platform
Default Value :
_schedule
object (CouponSchedule)
CouponSchedule
end
string
| date-time
Nullable
The end date of coupon
Default Value : null
start
string
| date-time
Nullable
The start date of coupon
next_schedule
array of object
List of date time, which we will schedule the promotion
cron
string
Nullable
Schedule the cron to run your job periodically
Default Value : null
status
string
Coupon status like draft, review
Default Value : draft
Enum
duration
integer
| int32
Nullable
Time in minutes for execution
Default Value : null
rule
array of object (Rule)
Array of Rule
key
number
| float
Key defines the number of product should be buy for applicability of cart
value
number
| float
value defines discount percentage in coupon
max
number
| float
max defines maximum number of discount amount in coupon
discount_qty
number
| float
discount_qty defines free quantity as discount in coupon
min
number
| float
min defines minimum number of discount amount in coupon
display_meta
object (DisplayMeta)
DisplayMeta
title
string
Coupon title which is used to display
auto
object (DisplayMetaDict)
DisplayMetaDict
title
string
Coupon title which is used to display
subtitle
string
Coupon sub title which is used to display
apply
object (DisplayMetaDict)
DisplayMetaDict
title
string
Coupon title which is used to display
subtitle
string
Coupon sub title which is used to display
remove
object (DisplayMetaDict)
DisplayMetaDict
title
string
Coupon title which is used to display
subtitle
string
Coupon sub title which is used to display
subtitle
string
Coupon sub title which is used to display
description
string
Detail about the offers in coupon
code
string
Unique code of coupon
type_slug
string
The type slug of coupon discount
identifiers
object (Identifier)
Identifier
brand_id
array of integer
List of brand id available for coupon
email_domain
array of string
List of email domain available for coupon
company_id
array of integer
List of company id available for coupon
store_id
array of integer
List of store id available for coupon
collection_id
array of string
List of collection id available for coupon
item_id
array of integer
List of item id available for coupon
user_id
array of string
List of user id available for coupon
category_id
array of integer
List of category id available for coupon
article_id
array of string
List of article id available for coupon
exclude_brand_id
array of integer
List of brand id should not be available for coupon
validity
object (Validity)
Validity
priority
integer
| int32
Priority of coupon to show in list
rule_definition
object (RuleDefinition)
RuleDefinition
currency_code
string
Currency code like INR
Default Value : INR
auto_apply
boolean
Coupon should be auto apply or not
type
string
Type of coupon like absolute, percentage etc.
Enum
is_exact
boolean
Flag is true then use coupon applicable articles for calculation
Default Value : false
applicable_on
string
Coupon will be applicable on either amount or quantity
Enum
calculate_on
string
Article Price on which coupon calculated like effective price or marked price
Enum
value_type
string
Define the type of coupon value
Enum
scope
array of string
List of item level rule applicable for coupon
Enum
_id
string
Unique identifier of coupon
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.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
List of coupons
getCoupons
Creates a new coupon based on the selected coupon type. Sellers can choose from multiple supported coupon types, including percentage value, fixed amount value, bundled discount, buy X get Y items, and more, along with customizable coupon criteria to meet specific business requirements.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
Request body
date_meta
object (CouponDateMeta)
CouponDateMeta
modified_on
string
| date-time
Nullable
Date time format when the coupon last modified
Default Value : null
created_on
string
| date-time
Nullable
Date time format when the coupon created
Default Value : null
approved_on
string
| date-time
Nullable
Date time format when the coupon approved
Default Value : null
rejected_on
string
| date-time
Nullable
Date time format when the coupon rejected
Default Value : null
reviewed_on
string
| date-time
Nullable
Date time format when the coupon reviewed
Default Value : null
ownership
object (Ownership)
Ownership
payable_category
string
Required
Coupon amount payable category
Enum
payable_by
string
Nullable
Coupon amount bearable party
author
object (CouponAuthor)
CouponAuthor
created_by
string
Nullable
The user id of user, who has created the coupon
Default Value : null
modified_by
string
Nullable
The user id of user, who has modified the coupon
Default Value : null
approved_by
string
Nullable
The user id of user, who has approved the coupon
Default Value : null
rejected_by
string
Nullable
The user id of user, who has rejected the coupon
Default Value : null
reviewed_by
string
Nullable
The user id of user, who has reviewed the coupon
Default Value : null
state
object (State)
State
is_archived
boolean
Publish or unpublish the coupon
Default Value : false
is_display
boolean
Coupon needs to display or not
Default Value : true
is_public
boolean
Coupon is publicaly available or not
Default Value : true
restrictions
object (Restrictions)
Restrictions
payments
object (PaymentModes)
PaymentModes
codes
array of string
Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM
iins
array of string
Debit/Credit card prefix (first 6 digit)
types
array of string
Card type, e.g. Credit, Debit
networks
array of string
Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY
uses
object (PaymentAllowValue)
PaymentAllowValue
max
integer
| int32
Maximum value need to allow for payment
user_type
string
price_range
object (PriceRange)
PriceRange
max
integer
| int32
Max price valid for article in coupon
Default Value : -1
min
integer
| int32
Min price valid for article in coupon
Default Value : -1
platforms
array of string
List of platform on which coupon allowed like web, android
post_order
object (PostOrder)
PostOrder
cancellation_allowed
boolean
Cancellation allowed in coupon
Default Value : true
return_allowed
boolean
Return allowed in coupon
Default Value : true
bulk_bundle
object (BulkBundleRestriction)
BulkBundleRestriction
multi_store_allowed
boolean
Required
Multi store allowed in bulk bundle coupon or not
user_groups
array of integer
List of user group on which coupon allowed
coupon_allowed
boolean
Allow applying normal coupon if bulk coupon is applied
uses
object (UsesRestriction)
UsesRestriction
maximum
object (UsesRemaining)
UsesRemaining
user
integer
| int32
Define total coupon count per user
total
integer
| int32
Define total coupon counts
app
integer
| int32
Define coupon counts associated with application id
remaining
object (UsesRemaining)
UsesRemaining
user
integer
| int32
Define total coupon count per user
total
integer
| int32
Define total coupon counts
app
integer
| int32
Define coupon counts associated with application id
ordering_stores
array of integer
List of store id on which coupon allowed
validation
object (Validation)
Validation
app_id
array of string
List of sales channel's application id
Default Value :
anonymous
boolean
Coupon applicable for guest user or not
user_registered_after
string
| date-time
Nullable
Coupon applicable for user which is registered after Date Format
Default Value : null
action
object (CouponAction)
CouponAction
action_date
string
| date-time
Nullable
Coupon transaction mode's date time format
Default Value : null
txn_mode
string
Coupon transaction mode like cash, coupon etc
Default Value : coupon
Enum
coupon_type
string
The type of coupon like bulk or single
Enum
coupon_prefix
string
Nullable
Bulk coupon code prefix string
coupon_counts
integer
Counts of bulk coupon
Default Value : 1
tags
array of string
List of tags specify to platform
Default Value :
_schedule
object (CouponSchedule)
CouponSchedule
end
string
| date-time
Nullable
The end date of coupon
Default Value : null
start
string
| date-time
Nullable
The start date of coupon
next_schedule
array of object
List of date time, which we will schedule the promotion
cron
string
Nullable
Schedule the cron to run your job periodically
Default Value : null
status
string
Coupon status like draft, review
Default Value : draft
Enum
duration
integer
| int32
Nullable
Time in minutes for execution
Default Value : null
rule
array of object (Rule)
Array of Rule
key
number
| float
Key defines the number of product should be buy for applicability of cart
value
number
| float
value defines discount percentage in coupon
max
number
| float
max defines maximum number of discount amount in coupon
discount_qty
number
| float
discount_qty defines free quantity as discount in coupon
min
number
| float
min defines minimum number of discount amount in coupon
display_meta
object (DisplayMeta)
DisplayMeta
title
string
Coupon title which is used to display
auto
object (DisplayMetaDict)
DisplayMetaDict
title
string
Coupon title which is used to display
subtitle
string
Coupon sub title which is used to display
apply
object (DisplayMetaDict)
DisplayMetaDict
title
string
Coupon title which is used to display
subtitle
string
Coupon sub title which is used to display
remove
object (DisplayMetaDict)
DisplayMetaDict
title
string
Coupon title which is used to display
subtitle
string
Coupon sub title which is used to display
subtitle
string
Coupon sub title which is used to display
description
string
Detail about the offers in coupon
code
string
Required
Unique code of coupon
type_slug
string
Required
The type slug of coupon discount
identifiers
object (Identifier)
Identifier
brand_id
array of integer
List of brand id available for coupon
email_domain
array of string
List of email domain available for coupon
company_id
array of integer
List of company id available for coupon
store_id
array of integer
List of store id available for coupon
collection_id
array of string
List of collection id available for coupon
item_id
array of integer
List of item id available for coupon
user_id
array of string
List of user id available for coupon
category_id
array of integer
List of category id available for coupon
article_id
array of string
List of article id available for coupon
exclude_brand_id
array of integer
List of brand id should not be available for coupon
validity
object (Validity)
Validity
priority
integer
| int32
Priority of coupon to show in list
rule_definition
object (RuleDefinition)
RuleDefinition
currency_code
string
Currency code like INR
Default Value : INR
auto_apply
boolean
Coupon should be auto apply or not
type
string
Type of coupon like absolute, percentage etc.
Enum
is_exact
boolean
Flag is true then use coupon applicable articles for calculation
Default Value : false
applicable_on
string
Coupon will be applicable on either amount or quantity
Enum
calculate_on
string
Article Price on which coupon calculated like effective price or marked price
Enum
value_type
string
Define the type of coupon value
Enum
scope
array of string
List of item level rule applicable for coupon
Enum
_id
string
Unique identifier of coupon
Response
201
400
Coupon Created successfully
CouponCreateResult
success
boolean
Whether the request was successful (true/false)
message
string
Create coupon response message that can shown to creator user
_id
string
Unique identifier for coupon created
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
POST
Response
Create a coupon
createCoupon
Retrieve details of a specific coupon by providing its unique identifier to obtain information such as coupon type, rules, validity period and other related information.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
id
string
Required
Coupon id for fetching single coupon data for editing
Response
200
404
Coupon object for sent coupon id
CouponUpdate
date_meta
object (CouponDateMeta)
CouponDateMeta
modified_on
string
| date-time
Nullable
Date time format when the coupon last modified
Default Value : null
created_on
string
| date-time
Nullable
Date time format when the coupon created
Default Value : null
approved_on
string
| date-time
Nullable
Date time format when the coupon approved
Default Value : null
rejected_on
string
| date-time
Nullable
Date time format when the coupon rejected
Default Value : null
reviewed_on
string
| date-time
Nullable
Date time format when the coupon reviewed
Default Value : null
ownership
object (Ownership)
Ownership
payable_category
string
Coupon amount payable category
Enum
payable_by
string
Nullable
Coupon amount bearable party
author
object (CouponAuthor)
CouponAuthor
created_by
string
Nullable
The user id of user, who has created the coupon
Default Value : null
modified_by
string
Nullable
The user id of user, who has modified the coupon
Default Value : null
approved_by
string
Nullable
The user id of user, who has approved the coupon
Default Value : null
rejected_by
string
Nullable
The user id of user, who has rejected the coupon
Default Value : null
reviewed_by
string
Nullable
The user id of user, who has reviewed the coupon
Default Value : null
state
object (State)
State
is_archived
boolean
Publish or unpublish the coupon
Default Value : false
is_display
boolean
Coupon needs to display or not
Default Value : true
is_public
boolean
Coupon is publicaly available or not
Default Value : true
restrictions
object (Restrictions)
Restrictions
payments
object (PaymentModes)
PaymentModes
codes
array of string
Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM
iins
array of string
Debit/Credit card prefix (first 6 digit)
types
array of string
Card type, e.g. Credit, Debit
networks
array of string
Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY
uses
object (PaymentAllowValue)
PaymentAllowValue
max
integer
| int32
Maximum value need to allow for payment
user_type
string
price_range
object (PriceRange)
PriceRange
max
integer
| int32
Max price valid for article in coupon
Default Value : -1
min
integer
| int32
Min price valid for article in coupon
Default Value : -1
platforms
array of string
List of platform on which coupon allowed like web, android
post_order
object (PostOrder)
PostOrder
cancellation_allowed
boolean
Cancellation allowed in coupon
Default Value : true
return_allowed
boolean
Return allowed in coupon
Default Value : true
bulk_bundle
object (BulkBundleRestriction)
BulkBundleRestriction
multi_store_allowed
boolean
Multi store allowed in bulk bundle coupon or not
user_groups
array of integer
List of user group on which coupon allowed
coupon_allowed
boolean
Allow applying normal coupon if bulk coupon is applied
uses
object (UsesRestriction)
UsesRestriction
maximum
object (UsesRemaining)
UsesRemaining
user
integer
| int32
Define total coupon count per user
total
integer
| int32
Define total coupon counts
app
integer
| int32
Define coupon counts associated with application id
remaining
object (UsesRemaining)
UsesRemaining
user
integer
| int32
Define total coupon count per user
total
integer
| int32
Define total coupon counts
app
integer
| int32
Define coupon counts associated with application id
ordering_stores
array of integer
List of store id on which coupon allowed
validation
object (Validation)
Validation
app_id
array of string
List of sales channel's application id
Default Value :
anonymous
boolean
Coupon applicable for guest user or not
user_registered_after
string
| date-time
Nullable
Coupon applicable for user which is registered after Date Format
Default Value : null
action
object (CouponAction)
CouponAction
action_date
string
| date-time
Nullable
Coupon transaction mode's date time format
Default Value : null
txn_mode
string
Coupon transaction mode like cash, coupon etc
Default Value : coupon
Enum
tags
array of string
List of tags specify to platform
Default Value :
_schedule
object (CouponSchedule)
CouponSchedule
end
string
| date-time
Nullable
The end date of coupon
Default Value : null
start
string
| date-time
Nullable
The start date of coupon
next_schedule
array of object
List of date time, which we will schedule the promotion
cron
string
Nullable
Schedule the cron to run your job periodically
Default Value : null
status
string
Coupon status like draft, review
Default Value : draft
Enum
duration
integer
| int32
Nullable
Time in minutes for execution
Default Value : null
rule
array of object (Rule)
Array of Rule
key
number
| float
Key defines the number of product should be buy for applicability of cart
value
number
| float
value defines discount percentage in coupon
max
number
| float
max defines maximum number of discount amount in coupon
discount_qty
number
| float
discount_qty defines free quantity as discount in coupon
min
number
| float
min defines minimum number of discount amount in coupon
display_meta
object (DisplayMeta)
DisplayMeta
title
string
Coupon title which is used to display
auto
object (DisplayMetaDict)
DisplayMetaDict
title
string
Coupon title which is used to display
subtitle
string
Coupon sub title which is used to display
apply
object (DisplayMetaDict)
DisplayMetaDict
title
string
Coupon title which is used to display
subtitle
string
Coupon sub title which is used to display
remove
object (DisplayMetaDict)
DisplayMetaDict
title
string
Coupon title which is used to display
subtitle
string
Coupon sub title which is used to display
subtitle
string
Coupon sub title which is used to display
description
string
Detail about the offers in coupon
code
string
Unique code that is used to apply coupon
coupon_type
string
The type of coupon like bulk or single
Enum
coupon_prefix
string
Nullable
Bulk coupon code prefix string
coupon_counts
integer
Counts of culk coupon
Default Value : 1
reason
string
Nullable
Coupon rejection reason added by reviewer
type_slug
string
The type slug of coupon discount
identifiers
object (Identifier)
Identifier
brand_id
array of integer
List of brand id available for coupon
email_domain
array of string
List of email domain available for coupon
company_id
array of integer
List of company id available for coupon
store_id
array of integer
List of store id available for coupon
collection_id
array of string
List of collection id available for coupon
item_id
array of integer
List of item id available for coupon
user_id
array of string
List of user id available for coupon
category_id
array of integer
List of category id available for coupon
article_id
array of string
List of article id available for coupon
exclude_brand_id
array of integer
List of brand id should not be available for coupon
validity
object (Validity)
Validity
priority
integer
| int32
Priority of coupon to show in list
rule_definition
object (RuleDefinition)
RuleDefinition
currency_code
string
Currency code like INR
Default Value : INR
auto_apply
boolean
Coupon should be auto apply or not
type
string
Type of coupon like absolute, percentage etc.
Enum
is_exact
boolean
Flag is true then use coupon applicable articles for calculation
Default Value : false
applicable_on
string
Coupon will be applicable on either amount or quantity
Enum
calculate_on
string
Article Price on which coupon calculated like effective price or marked price
Enum
value_type
string
Define the type of coupon value
Enum
scope
array of string
List of item level rule applicable for coupon
Enum
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Was this section helpful?
GET
Response
Get a coupon
getCouponById
Update the details of an existing coupon by specifying its unique identifier. This includes modifying coupon attributes such as discount percentage, validity period, and associated conditions. Leveraging this functionality allows businesses to quickly adapt their promotional strategies to changing market dynamics.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
id
string
Required
Coupon id for fetching single coupon data for editing
Request body
date_meta
object (CouponDateMeta)
CouponDateMeta
modified_on
string
| date-time
Nullable
Date time format when the coupon last modified
Default Value : null
created_on
string
| date-time
Nullable
Date time format when the coupon created
Default Value : null
approved_on
string
| date-time
Nullable
Date time format when the coupon approved
Default Value : null
rejected_on
string
| date-time
Nullable
Date time format when the coupon rejected
Default Value : null
reviewed_on
string
| date-time
Nullable
Date time format when the coupon reviewed
Default Value : null
ownership
object (Ownership)
Ownership
payable_category
string
Required
Coupon amount payable category
Enum
payable_by
string
Nullable
Coupon amount bearable party
author
object (CouponAuthor)
CouponAuthor
created_by
string
Nullable
The user id of user, who has created the coupon
Default Value : null
modified_by
string
Nullable
The user id of user, who has modified the coupon
Default Value : null
approved_by
string
Nullable
The user id of user, who has approved the coupon
Default Value : null
rejected_by
string
Nullable
The user id of user, who has rejected the coupon
Default Value : null
reviewed_by
string
Nullable
The user id of user, who has reviewed the coupon
Default Value : null
state
object (State)
State
is_archived
boolean
Publish or unpublish the coupon
Default Value : false
is_display
boolean
Coupon needs to display or not
Default Value : true
is_public
boolean
Coupon is publicaly available or not
Default Value : true
restrictions
object (Restrictions)
Restrictions
payments
object (PaymentModes)
PaymentModes
codes
array of string
Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM
iins
array of string
Debit/Credit card prefix (first 6 digit)
types
array of string
Card type, e.g. Credit, Debit
networks
array of string
Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY
uses
object (PaymentAllowValue)
PaymentAllowValue
max
integer
| int32
Maximum value need to allow for payment
user_type
string
price_range
object (PriceRange)
PriceRange
max
integer
| int32
Max price valid for article in coupon
Default Value : -1
min
integer
| int32
Min price valid for article in coupon
Default Value : -1
platforms
array of string
List of platform on which coupon allowed like web, android
post_order
object (PostOrder)
PostOrder
cancellation_allowed
boolean
Cancellation allowed in coupon
Default Value : true
return_allowed
boolean
Return allowed in coupon
Default Value : true
bulk_bundle
object (BulkBundleRestriction)
BulkBundleRestriction
multi_store_allowed
boolean
Required
Multi store allowed in bulk bundle coupon or not
user_groups
array of integer
List of user group on which coupon allowed
coupon_allowed
boolean
Allow applying normal coupon if bulk coupon is applied
uses
object (UsesRestriction)
UsesRestriction
maximum
object (UsesRemaining)
UsesRemaining
user
integer
| int32
Define total coupon count per user
total
integer
| int32
Define total coupon counts
app
integer
| int32
Define coupon counts associated with application id
remaining
object (UsesRemaining)
UsesRemaining
user
integer
| int32
Define total coupon count per user
total
integer
| int32
Define total coupon counts
app
integer
| int32
Define coupon counts associated with application id
ordering_stores
array of integer
List of store id on which coupon allowed
validation
object (Validation)
Validation
app_id
array of string
List of sales channel's application id
Default Value :
anonymous
boolean
Coupon applicable for guest user or not
user_registered_after
string
| date-time
Nullable
Coupon applicable for user which is registered after Date Format
Default Value : null
action
object (CouponAction)
CouponAction
action_date
string
| date-time
Nullable
Coupon transaction mode's date time format
Default Value : null
txn_mode
string
Coupon transaction mode like cash, coupon etc
Default Value : coupon
Enum
tags
array of string
List of tags specify to platform
Default Value :
_schedule
object (CouponSchedule)
CouponSchedule
end
string
| date-time
Nullable
The end date of coupon
Default Value : null
start
string
| date-time
Nullable
The start date of coupon
next_schedule
array of object
List of date time, which we will schedule the promotion
cron
string
Nullable
Schedule the cron to run your job periodically
Default Value : null
status
string
Coupon status like draft, review
Default Value : draft
Enum
duration
integer
| int32
Nullable
Time in minutes for execution
Default Value : null
rule
array of object (Rule)
Array of Rule
key
number
| float
Key defines the number of product should be buy for applicability of cart
value
number
| float
value defines discount percentage in coupon
max
number
| float
max defines maximum number of discount amount in coupon
discount_qty
number
| float
discount_qty defines free quantity as discount in coupon
min
number
| float
min defines minimum number of discount amount in coupon
display_meta
object (DisplayMeta)
DisplayMeta
title
string
Coupon title which is used to display
auto
object (DisplayMetaDict)
DisplayMetaDict
title
string
Coupon title which is used to display
subtitle
string
Coupon sub title which is used to display
apply
object (DisplayMetaDict)
DisplayMetaDict
title
string
Coupon title which is used to display
subtitle
string
Coupon sub title which is used to display
remove
object (DisplayMetaDict)
DisplayMetaDict
title
string
Coupon title which is used to display
subtitle
string
Coupon sub title which is used to display
subtitle
string
Coupon sub title which is used to display
description
string
Detail about the offers in coupon
code
string
Required
Unique code that is used to apply coupon
coupon_type
string
The type of coupon like bulk or single
Enum
coupon_prefix
string
Nullable
Bulk coupon code prefix string
coupon_counts
integer
Counts of culk coupon
Default Value : 1
reason
string
Nullable
Coupon rejection reason added by reviewer
type_slug
string
Required
The type slug of coupon discount
identifiers
object (Identifier)
Identifier
brand_id
array of integer
List of brand id available for coupon
email_domain
array of string
List of email domain available for coupon
company_id
array of integer
List of company id available for coupon
store_id
array of integer
List of store id available for coupon
collection_id
array of string
List of collection id available for coupon
item_id
array of integer
List of item id available for coupon
user_id
array of string
List of user id available for coupon
category_id
array of integer
List of category id available for coupon
article_id
array of string
List of article id available for coupon
exclude_brand_id
array of integer
List of brand id should not be available for coupon
validity
object (Validity)
Validity
priority
integer
| int32
Priority of coupon to show in list
rule_definition
object (RuleDefinition)
RuleDefinition
currency_code
string
Currency code like INR
Default Value : INR
auto_apply
boolean
Coupon should be auto apply or not
type
string
Type of coupon like absolute, percentage etc.
Enum
is_exact
boolean
Flag is true then use coupon applicable articles for calculation
Default Value : false
applicable_on
string
Coupon will be applicable on either amount or quantity
Enum
calculate_on
string
Article Price on which coupon calculated like effective price or marked price
Enum
value_type
string
Define the type of coupon value
Enum
scope
array of string
List of item level rule applicable for coupon
Enum
Response
200
404
Coupon updated successfully
CouponCreateResult
success
boolean
Whether the request was successful (true/false)
message
string
Create coupon response message that can shown to creator user
_id
string
Unique identifier for coupon created
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Was this section helpful?
PUT
Response
Update a coupon
updateCoupon
Delete details of a draft coupon by providing its unique identifier to delete information such as coupon type, rules, validity period and other related information.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Application id of sales channel
id
string
Required
Coupon id for fetching single coupon data for deleting
Response
200
404
Coupon deleted for sent coupon id
SuccessMessage
success
boolean
Whether the request was successful (true/false).
message
string
Response message needs to display
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Was this section helpful?
DEL
Response
Delete a coupon which is in draft state
deleteCoupon
Validates the presence of a coupon code for the specified sales channel to verify whether the provided code already exists or not.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
code
string
Coupon code
Response
200
400
Valid response with existing coupon code count
Properties
success
boolean
count
integer
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Check coupon code exists
getCouponCodeExists
Retrieve a list of all available coupons that customer can apply to their carts. It provides details about each coupon, including its code, discount amount, and applicable conditions.
Parameters
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.
buy_now
boolean
This is boolean to get buy_now cart
slug
string
Product slug to fetch the available coupons
store_id
string
Store id
Response
200
Success. Returns a coupon object which has a list of all the eligible coupons. Refer `GetCouponResult` for more details.
GetCouponResult
available_coupon_list
array of object (Coupon)
List of available coupon which can be applied on cart
Array of Coupon
title
string
Coupon Title of the coupon applied denotes name of the coupon
max_discount_value
number
| float
Maximum discount value of the coupon applied to cart
coupon_code
string
Coupon code of the coupon applied on cart
is_applied
boolean
Flag to determine where the coupon is applied to cart or not
coupon_type
string
Nullable
Type of the coupon applied to cart
expires_on
string
Message to display to user for expiry of the coupon
coupon_value
number
| float
Coupon value of the coupon applied to cart
sub_title
string
Coupon subtitle of the coupon applied to cart which is used to display
minimum_cart_value
number
| float
Minimum cart value of the coupon applied to cart
is_applicable
boolean
Flag to determine where the coupon is applicable to cart or not
message
string
Coupon message of the coupon applied to cart
description
string
Nullable
Coupon description of the coupon applied to cart
start_date
string
| date-time
Nullable
Start date of the coupon when the coupon will be live for the users to apply on cart
end_date
string
| date-time
Nullable
End date of the coupon on which the coupon expires
coupon_applicable_message
string
Message which is used to display to the customer if the coupon is applied successfully
page
object (PageCoupon)
PageCoupon
has_next
boolean
Denotes if next page of coupon is available
current
integer
| int32
Current page number
total
integer
| int32
Total pages of coupon availalbe
total_item_count
integer
| int32
Total coupons are available for the cart
has_previous
boolean
Denotes if previous page of the coupon is available
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
buy_now:
false
slug:
"value"
store_id:
"value"
Was this section helpful?
GET
Response
List of coupons
getAppCoupons
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
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.
p
boolean
This is a boolean value. Select `true` for getting a payment option in response.
id
string
The unique identifier of the cart
buy_now
boolean
This is boolean to get buy_now cart
Request body
coupon_code
string
Required
Coupon code to be applied
Response
201
Success. Returns coupons applied to the cart along with item details and price breakup. Refer `CartDetailResult` for more details.
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
Examples
Parameters
company_id:
"value"
application_id:
"value"
i:
false
b:
false
p:
false
id:
"value"
buy_now:
false
body:
body
Was this section helpful?
POST
Response
Apply coupon
applyCoupon
Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
uid
string
The unique identifier of the cart
buy_now
boolean
This is boolean to get buy_now cart
Response
200
Success. Returns coupons removed from the cart along with item details and price breakup. Refer `CartDetailResult` for more details.
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
Examples
Parameters
company_id:
"value"
application_id:
"value"
uid:
"value"
buy_now:
false
Was this section helpful?
DEL
Response
Remove coupon
removeCoupon
Validates the applicability of a coupon code for the selected payment mode for the existing cart. This ensures the coupon's validity before proceeding with the payment process, enhancing user experience and preventing potential errors during transactions.
Parameters
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
buy_now
boolean
This is boolean to get buy_now cart
address_id
string
ID allotted to an address
payment_mode
string
Payment mode selected by the customer
payment_identifier
string
Identifier of payment like ICIC, PAYTM
aggregator_name
string
Payment gateway identifier
merchant_code
string
Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM
Response
200
Success. Returns a success message and the coupon validity. Refer `PaymentCouponValidate` for more details.
PaymentCouponValidate
success
boolean
success flag of coupon payment mode validity API response
message
string
Payment mode valid message for coupon
coupon_validity
object (CouponValidity)
CouponValidity
title
string
Coupon Title of the coupon applied
next_validation_required
boolean
Nullable
Flag for coupon validation required on next page or not
valid
boolean
valid flag which denotes if the applied coupon is valid or not
display_message_en
string
Nullable
Display message for coupon validity
code
string
Nullable
Coupon code of the coupon applied
discount
number
| float
Coupon discount value of the coupon applied
error_en
string
Nullable
Error message for the selected payment mode.
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
buy_now:
false
address_id:
"value"
payment_mode:
"value"
payment_identifier:
"value"
aggregator_name:
"value"
merchant_code:
"value"
Was this section helpful?
GET
Response
Validate applied coupon
validateCouponForPayment
A customer's address refers to the address where the ordered product is to be delivered. It usually includes details such as the recipient's name, contact, street address, city, state or province, PIN code or ZIP code, and country. Each customer can have multiple addresses associated with them. Storing addresses includes validating the address based on the country and its unique identifiers like PIN code, ZIP code, or area code.
Operations
GET
# Get a list of addresses for a customer
POST
# Creates a new address for a customer
GET
# Get details for a single customer address
PUT
# Updates an existing customer address
DEL
# Removes an address from a customer's address list
POST
# Select customer address for order processing
Retrieves a list of all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
cart_id
string
The unique identifier of the cart
buy_now
boolean
This is boolean to get buy_now cart
mobile_no
string
10-digit mobile number of the customer
checkout_mode
string
Option to checkout for `self` or for `others`. By default, it is `self`.
tags
string
Tag given to an address, e.g. work, home, office, shop.
is_default
boolean
This is a boolean value. Select `true` to fetch the default address.
user_id
string
Option to fetch address for the provided user_id.
Response
200
400
Success. Returns an Address object containing a list of address saved in the account. Refer `PlatformGetAddressesDetails` for more details.
PlatformGetAddressesDetails
pii_masking
boolean
Personally Identifiable Information masking flag to denote if the user data in address is masked or not.
address
array of object (PlatformAddress)
List of all address saved by customer
Array of PlatformAddress
phone
string
Phone number for address
id
string
Id of the address
area_code_slug
string
Area code slug for address. example pincode is slug for India
country_code
string
Country code of address
geo_location
object (GeoLocation)
GeoLocation
longitude
number
| float
Longitude coordinate for address
Default Value : 0
latitude
number
| float
Latitude coordinate for address
Default Value : 0
country
string
Country of address
state
string
State of the address
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected
tags
array of string
Tags of address from which it can be identified
created_by_user_id
string
Created by user id of address
landmark
string
Landmark of address
email
string
Email address for address data
area_code
string
Area code of the address
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart
meta
object
Metadata of the address
is_active
boolean
States whether address is active or not
name
string
Name of person in address data to whom it belongs to
google_map_point
object
Google map point of the address
cart_id
string
The cart id of user cart
city
string
City of the address
sector
string
Sector of the address
state_code
string
State code for international address
area
string
Area description for address
user_id
string
User id of address for which address is created
address_type
string
Address type of address
address
string
Address description for address data
country_phone_code
string
Country phone code for address
country_iso_code
string
Country iso code for address
_custom_json
object
Custom json of the address
validation_config
object (ValidationConfig)
ValidationConfig
address_max_limit
integer
| int32
The maximum number of addresses a user can have.
user_address_count
integer
| int32
The total number of addresses saved by a user.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get a list of addresses for a customer
getAddresses
Customers can add a new address to their cart to save details such as name, email, contact information, and address.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
Request body
phone
string
Phone number for address
id
string
Id of the address
area_code_slug
string
Area code slug for address. example pincode is slug for India
country_code
string
Country code of address
geo_location
object (GeoLocation)
GeoLocation
longitude
number
| float
Longitude coordinate for address
Default Value : 0
latitude
number
| float
Latitude coordinate for address
Default Value : 0
country
string
Country of address
state
string
State of the address
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected
tags
array of string
Tags of address from which it can be identified
created_by_user_id
string
Created by user id of address
landmark
string
Landmark of address
email
string
Email address for address data
area_code
string
Area code of the address
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart
meta
object
Metadata of the address
is_active
boolean
States whether address is active or not
name
string
Name of person in address data to whom it belongs to
google_map_point
object
Google map point of the address
cart_id
string
The cart id of user cart
city
string
City of the address
sector
string
Sector of the address
state_code
string
State code for international address
area
string
Area description for address
user_id
string
User id of address for which address is created
address_type
string
Address type of address
address
string
Address description for address data
country_phone_code
string
Country phone code for address
country_iso_code
string
Country iso code for address
_custom_json
object
Custom json of the address
Response
200
400
422
Success. Returns the address ID, a flag whether the address is set as default, and a success message. Refer `SaveAddressDetails` for more details.
SaveAddressDetails
id
string
Id of the address
success
boolean
Success flag of save address Response
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
Creates a new address for a customer
addAddress
Retrieve a specific customer address stored in the system by providing its unique identifier. This API provides detailed information about the address, including the recipient's name, address, city, postal code, and other relevant details.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
id
string
Required
ID allotted to the selected address
cart_id
string
The unique identifier of the cart
buy_now
boolean
This is boolean to get buy_now cart
mobile_no
string
10-digit mobile number of the customer
checkout_mode
string
Option to checkout for self or for others
tags
string
Tag given to an address, e.g. work, home, office, shop.
is_default
boolean
This is a boolean value. Select `true` to fetch the default address.
user_id
string
Option to fetch address for the provided user_id.
Response
200
400
Success. Returns an PlatformAddress object containing a list of address saved in the account. Refer `PlatformAddress` for more details.
PlatformAddress
phone
string
Phone number for address
id
string
Id of the address
area_code_slug
string
Area code slug for address. example pincode is slug for India
country_code
string
Country code of address
geo_location
object (GeoLocation)
GeoLocation
longitude
number
| float
Longitude coordinate for address
Default Value : 0
latitude
number
| float
Latitude coordinate for address
Default Value : 0
country
string
Country of address
state
string
State of the address
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected
tags
array of string
Tags of address from which it can be identified
created_by_user_id
string
Created by user id of address
landmark
string
Landmark of address
email
string
Email address for address data
area_code
string
Area code of the address
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart
meta
object
Metadata of the address
is_active
boolean
States whether address is active or not
name
string
Name of person in address data to whom it belongs to
google_map_point
object
Google map point of the address
cart_id
string
The cart id of user cart
city
string
City of the address
sector
string
Sector of the address
state_code
string
State code for international address
area
string
Area description for address
user_id
string
User id of address for which address is created
address_type
string
Address type of address
address
string
Address description for address data
country_phone_code
string
Country phone code for address
country_iso_code
string
Country iso code for address
_custom_json
object
Custom json of the address
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
cart_id:
"value"
buy_now:
false
mobile_no:
"value"
checkout_mode:
"value"
tags:
"value"
is_default:
false
user_id:
"value"
Was this section helpful?
GET
Response
Get details for a single customer address
getAddressById
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
id
string
Required
ID allotted to the selected address
Request body
phone
string
Phone number for address
id
string
Id of the address
area_code_slug
string
Area code slug for address. example pincode is slug for India
country_code
string
Country code of address
geo_location
object (GeoLocation)
GeoLocation
longitude
number
| float
Longitude coordinate for address
Default Value : 0
latitude
number
| float
Latitude coordinate for address
Default Value : 0
country
string
Country of address
state
string
State of the address
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected
tags
array of string
Tags of address from which it can be identified
created_by_user_id
string
Created by user id of address
landmark
string
Landmark of address
email
string
Email address for address data
area_code
string
Area code of the address
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart
meta
object
Metadata of the address
is_active
boolean
States whether address is active or not
name
string
Name of person in address data to whom it belongs to
google_map_point
object
Google map point of the address
cart_id
string
The cart id of user cart
city
string
City of the address
sector
string
Sector of the address
state_code
string
State code for international address
area
string
Area description for address
user_id
string
User id of address for which address is created
address_type
string
Address type of address
address
string
Address description for address data
country_phone_code
string
Country phone code for address
country_iso_code
string
Country iso code for address
_custom_json
object
Custom json of the address
Response
201
400
Success. Returns the address ID and a message indicating a successful address updation.
UpdateAddressDetails
id
string
ID of an address
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected
success
boolean
Success flag of update address response
is_updated
boolean
Updated flag for update address operation if the address updated or not
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Was this section helpful?
PUT
Response
Updates an existing customer address
updateAddress
Remove an existing customer address from the system.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
id
string
Required
ID allotted to the selected address
user_id
string
Option to delete address for the provided user_id.
Response
201
400
Returns a Status object indicating the success or failure of address deletion.
DeleteAddressResult
id
string
Id of the address
is_deleted
boolean
Deleted flag in delete address response states whether the address was deleted or not
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
user_id:
"value"
Was this section helpful?
DEL
Response
Removes an address from a customer's address list
removeAddress
Select an address from the saved customer addresses and validates the availability of items in the cart. Additionally, it verifies and updates the delivery promise based on the selected address.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
cart_id
string
The unique identifier of the cart
buy_now
boolean
This is boolean to get buy_now 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.
Request body
cart_id
string
Cart id of the user cart for which the select address operation performed
billing_address_id
string
Billing address id selected by user on which shipment bill to be generated
checkout_mode
string
The checkout mode in cart
id
string
Address is selected by user on which shipment to be delivered
user_id
string
Unique Identifier of user
Response
201
400
Success. Returns a Cart object as shown below. Refer `CartDetailResult` for more details. .
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
Examples
Parameters
company_id:
"value"
application_id:
"value"
cart_id:
"value"
buy_now:
false
i:
false
b:
false
body:
body
Was this section helpful?
POST
Response
Select customer address for order processing
selectAddress
Payment mode refers to the method used by customers to pay for their purchases during the checkout process. Payment modes typically include options such as credit card, debit card, digital wallets, bank transfer, cash on delivery (COD), and various online payment platforms like PayPal or Stripe. Customers select their preferred payment mode based on factors such as convenience, security, and availability. The chosen payment mode dictates how the transaction is processed and completed, ensuring a smooth and secure payment experience for the customer.
Operations
PUT
# Select payment mode
PUT
# Select payment mode (latest)
Customers can select a preferred payment mode from available options during the cart checkout process to securely and efficiently complete their transaction.
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
buy_now
boolean
This is boolean to get buy_now cart
order_type
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
Request body
address_id
string
Address id of the user on which the order to be delivered
payment_mode
string
Payment mode from which the payment to be done for the order
aggregator_name
string
Aggregator name of the payment gateway
merchant_code
string
Merchant code of the payment mode selected to do the payment
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment
id
string
Cart id of the user cart
Response
200
Success. Returns a Cart object as shown below. Refer `CartDetailResult` for more details.
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
buy_now:
false
order_type:
"value"
body:
body
Was this section helpful?
PUT
Response
Select payment mode
selectPaymentMode
Selection of payment mode that supports multiple MOP(mode of payment).
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
buy_now
boolean
This is boolean to get buy_now cart
order_type
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
Request body
address_id
string
Address id of the user address selected to deliver the shipment
payment_mode
string
Payment mode of the payment selected to do the payment
aggregator_name
string
Aggregator name of the payment gateway
merchant_code
string
Merchant code of the payment mode selected to do the payment
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment
id
string
Cart id of the user cart for which the update cart payment operation performed
payment_methods
array of object (PaymentMethod)
Array of PaymentMethod
mode
string
Required
Payment mode of payment method used to make payment
payment
string
Payment name of payment method used to make payment
payment_meta
object (PaymentMeta)
Required
PaymentMeta
payment_gateway
string
Payment gateway used to do the payment
type
string
Type of card if payment mode is card to do the payment
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment
merchant_code
string
Merchant code of the payment mode selected to do the payment
amount
number
| float
Nullable
Amount of the payment mode to be paid
name
string
Name of the payment mode used to make payment
payment_extra_identifiers
object
Payment extra identifier for the payment mode to do the payment
Response
200
400
Success. Returns a Cart object as shown below. Refer `CartDetailResult` for more details.
CartDetailResult
cart_id
integer
| int32
Unique identifier of the user cart
uid
string
Unique identifier of the user cart
coupon_text
string
Coupon text of coupon applied on cart
id
string
Unique identifier of the user cart
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom meta details added cart checkout API payload
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
buy_now:
false
order_type:
"value"
body:
body
Was this section helpful?
PUT
Response
Select payment mode (latest)
selectPaymentModeV2
Price adjustment refers to modification of product prices based on various factors such as user behavior, market conditions, or business rules. It allows for real-time adjustments to product pricing, enabling businesses to offer personalized pricing or targeted discounts to individual customers or specific segments of users. For example, suppose a user has paid through a third-party platform, and the business wants to offer them a discount or apply a different pricing strategy. In that case, the Price Adjustment enable developers to incorporate these adjustments into the transaction process, enhancing flexibility and convenience for both users and businesses.
Operations
PUT
# Update price adjustments
DEL
# Remove price adjustments
POST
# Create price adjustments
GET
# Get a list of all price adjustments associated with a cart
Modify price adjustments for specific items in the cart. By providing the seller ID, sales channel ID, and price adjustment ID, seller can apply discounts or other adjustments to the prices of cart items, facilitating dynamic pricing strategies.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
id
string
Required
price adjustment id for fetching single price adjustment data for editing
Request body
modified_by
string
The entity that modified the field
value
number
| float
Required
The amount applied on the cart
message
string
Required
The message associated with the price adjustment
apply_expiry
string
| date-time
The date and time when the expiry should be applied
restrictions
object (PriceAdjustmentRestrictions)
Restrictions applied to this particular item or product, including whether or not cancellation and return are allowed.
PriceAdjustmentRestrictions
post_order
object
This field holds the post-order restrictions, indicated by nested fields ['cancellation_allowed','return_allowed']
article_level_distribution
boolean
Required
Flag indicating whether the distribution should is done at the article level
collection
object (Collection)
Required
Collection
refund_by
string
Required
Bearable party who is refunding the amount
collected_by
string
Required
The party who is collecting the amount
type
string
Required
Type of price adjusment like charge, mop, discount etc.
Enum
allowed_refund
boolean
Flag indicating whether refunds are allowed at cart level
is_authenticated
boolean
Required
Flag indicating whether the user is authenticated
article_ids
array of object (Article)
Required
The list of article object in the price adjustment
Array of Article
value
number
| float
Value of price adjustment for article
code
string
Code to identify price adjustment on article
type
string
Type of price adjusment
article_id
string
Required
Unique identifier of article
quantity
integer
| int32
Total quantity of the article to be considered (currently used only in discount type)
meta
object
Meta data related to article
allowed_refund
boolean
Flag indicating whether refunds are allowed at article level
auto_remove
boolean
This field if set true will remove mop type price adjustment.
meta
object
Additional information regarding price adjustment
cart_id
string
Required
Unique identifier of the cart
distribution_logic
object (DistributionLogic)
DistributionLogic
distribution_level
string
This field defines the distribution level, currently allowed distribution level is (shipment)
Enum
distribution
object (Distribution)
Distribution
type
string
This field defines the distribution type allowed values('multi', 'single')
Enum
logic
string
This field defines the distribution logic allowed values('apportion', 'weighted', 'equally')
Enum
rule
object (DistributionRule)
DistributionRule
conditions
object
This field defines the distribution conditions
Response
200
400
Price Adjustment Updated successfully
GetPriceAdjustmentResult
data
array of object (PriceAdjustment)
Array of PriceAdjustment
value
number
| float
The amount applied on the cart
message
string
The message associated with the price adjustment
apply_expiry
string
| date-time
The date and time when the expiry should be applied
restrictions
object (PriceAdjustmentRestrictions)
This field specifies the restrictions for this item or service, such as whether cancellation and return are permitted, except for `charge` type.
PriceAdjustmentRestrictions
post_order
object
This field holds the post-order restrictions, indicated by nested fields ['cancellation_allowed','return_allowed']
article_level_distribution
boolean
Flag indicating whether the distribution should is done at the article level
id
string
Unique identifier of Price adjustment
collection
object (Collection)
Collection
refund_by
string
Bearable party who is refunding the amount
collected_by
string
The party who is collecting the amount
type
string
Type of price adjusment like charge, discount, mop etc.
Enum
allowed_refund
boolean
Flag indicating whether refunds are allowed at cart level
is_authenticated
boolean
Flag indicating whether the user is authenticated
article_ids
array of object (Article)
The list of article object in the price adjustment
Array of Article
value
number
| float
Value of price adjustment for article
code
string
Code to identify price adjustment on article
type
string
Type of price adjusment
article_id
string
Unique identifier of article
quantity
integer
| int32
Total quantity of the article to be considered (currently used only in discount type)
meta
object
Meta data related to article
allowed_refund
boolean
Flag indicating whether refunds are allowed at article level
auto_remove
boolean
This field if set true will remove mop type price adjustment.
meta
object
Additional information regarding price adjustment
cart_id
string
Unique identifier of the cart
distribution_logic
object (DistributionLogic)
DistributionLogic
distribution_level
string
This field defines the distribution level, currently allowed distribution level is (shipment)
Enum
distribution
object (Distribution)
Distribution
type
string
This field defines the distribution type allowed values('multi', 'single')
Enum
logic
string
This field defines the distribution logic allowed values('apportion', 'weighted', 'equally')
Enum
rule
object (DistributionRule)
DistributionRule
conditions
object
This field defines the distribution conditions
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Was this section helpful?
PUT
Response
Update price adjustments
updatePriceAdjustment
Remove the applied price adjustments for specific items within the cart based on unique price adjustment ID.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
id
string
Required
Price Adjustment id for removing particular price adjustment data
Response
200
400
Price Adjustment data Removed successfully
SuccessMessage
success
boolean
Whether the request was successful (true/false).
message
string
Response message needs to display
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Was this section helpful?
DEL
Response
Remove price adjustments
removePriceAdjustment
Create custom price adjustments for items in the cart, facilitating the application of discounts or promotions. Price adjustments can be tailored based on specific sales channel contexts, enhancing flexibility in pricing strategies.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
Request body
value
number
| float
Required
The amount applied on the cart
message
string
Required
The message associated with the price adjustment
apply_expiry
string
| date-time
The date and time when the expiry should be applied
restrictions
object (PriceAdjustmentRestrictions)
This field accepts the restrictions applied to this particular item or service, including whether or not cancellation and return are allowed, etc
PriceAdjustmentRestrictions
post_order
object
This field holds the post-order restrictions, indicated by nested fields ['cancellation_allowed','return_allowed']
created_by
string
The entity that created the field
article_level_distribution
boolean
Required
Flag indicating whether the distribution should is done at the article level
collection
object (Collection)
Required
Collection
refund_by
string
Required
Bearable party who is refunding the amount
collected_by
string
Required
The party who is collecting the amount
type
string
Required
type of price adjusment
Enum
allowed_refund
boolean
Flag indicating whether refunds are allowed at cart level
is_authenticated
boolean
Required
Flag indicating whether the user is authenticated
article_ids
array of object (Article)
Required
The list of article object in the price adjustment
Array of Article
value
number
| float
Value of price adjustment for article
code
string
Code to identify price adjustment on article
type
string
Type of price adjusment
article_id
string
Required
Unique identifier of article
quantity
integer
| int32
Total quantity of the article to be considered (currently used only in discount type)
meta
object
Meta data related to article
allowed_refund
boolean
Flag indicating whether refunds are allowed at article level
meta
object
Additional information regarding price adjustment
cart_id
string
Required
Unique identifier of the cart
auto_remove
boolean
This field if set true will remove mop type price adjustment.
distribution_logic
object (DistributionLogic)
DistributionLogic
distribution_level
string
This field defines the distribution level, currently allowed distribution level is (shipment)
Enum
distribution
object (Distribution)
Distribution
type
string
This field defines the distribution type allowed values('multi', 'single')
Enum
logic
string
This field defines the distribution logic allowed values('apportion', 'weighted', 'equally')
Enum
rule
object (DistributionRule)
DistributionRule
conditions
object
This field defines the distribution conditions
Response
201
400
Price Adjustment Created successfully
GetPriceAdjustmentResult
data
array of object (PriceAdjustment)
Array of PriceAdjustment
value
number
| float
The amount applied on the cart
message
string
The message associated with the price adjustment
apply_expiry
string
| date-time
The date and time when the expiry should be applied
restrictions
object (PriceAdjustmentRestrictions)
This field specifies the restrictions for this item or service, such as whether cancellation and return are permitted, except for `charge` type.
PriceAdjustmentRestrictions
post_order
object
This field holds the post-order restrictions, indicated by nested fields ['cancellation_allowed','return_allowed']
article_level_distribution
boolean
Flag indicating whether the distribution should is done at the article level
id
string
Unique identifier of Price adjustment
collection
object (Collection)
Collection
refund_by
string
Bearable party who is refunding the amount
collected_by
string
The party who is collecting the amount
type
string
Type of price adjusment like charge, discount, mop etc.
Enum
allowed_refund
boolean
Flag indicating whether refunds are allowed at cart level
is_authenticated
boolean
Flag indicating whether the user is authenticated
article_ids
array of object (Article)
The list of article object in the price adjustment
Array of Article
value
number
| float
Value of price adjustment for article
code
string
Code to identify price adjustment on article
type
string
Type of price adjusment
article_id
string
Unique identifier of article
quantity
integer
| int32
Total quantity of the article to be considered (currently used only in discount type)
meta
object
Meta data related to article
allowed_refund
boolean
Flag indicating whether refunds are allowed at article level
auto_remove
boolean
This field if set true will remove mop type price adjustment.
meta
object
Additional information regarding price adjustment
cart_id
string
Unique identifier of the cart
distribution_logic
object (DistributionLogic)
DistributionLogic
distribution_level
string
This field defines the distribution level, currently allowed distribution level is (shipment)
Enum
distribution
object (Distribution)
Distribution
type
string
This field defines the distribution type allowed values('multi', 'single')
Enum
logic
string
This field defines the distribution logic allowed values('apportion', 'weighted', 'equally')
Enum
rule
object (DistributionRule)
DistributionRule
conditions
object
This field defines the distribution conditions
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
POST
Response
Create price adjustments
addPriceAdjustment
This API helps to get price adjustments data associated to a particular cart
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
cart_id
string
Required
Cart id of user cart
Response
200
Price Adjustments List. See example below for details
GetPriceAdjustmentResult
data
array of object (PriceAdjustment)
Array of PriceAdjustment
value
number
| float
The amount applied on the cart
message
string
The message associated with the price adjustment
apply_expiry
string
| date-time
The date and time when the expiry should be applied
restrictions
object (PriceAdjustmentRestrictions)
This field specifies the restrictions for this item or service, such as whether cancellation and return are permitted, except for `charge` type.
PriceAdjustmentRestrictions
post_order
object
This field holds the post-order restrictions, indicated by nested fields ['cancellation_allowed','return_allowed']
article_level_distribution
boolean
Flag indicating whether the distribution should is done at the article level
id
string
Unique identifier of Price adjustment
collection
object (Collection)
Collection
refund_by
string
Bearable party who is refunding the amount
collected_by
string
The party who is collecting the amount
type
string
Type of price adjusment like charge, discount, mop etc.
Enum
allowed_refund
boolean
Flag indicating whether refunds are allowed at cart level
is_authenticated
boolean
Flag indicating whether the user is authenticated
article_ids
array of object (Article)
The list of article object in the price adjustment
Array of Article
value
number
| float
Value of price adjustment for article
code
string
Code to identify price adjustment on article
type
string
Type of price adjusment
article_id
string
Unique identifier of article
quantity
integer
| int32
Total quantity of the article to be considered (currently used only in discount type)
meta
object
Meta data related to article
allowed_refund
boolean
Flag indicating whether refunds are allowed at article level
auto_remove
boolean
This field if set true will remove mop type price adjustment.
meta
object
Additional information regarding price adjustment
cart_id
string
Unique identifier of the cart
distribution_logic
object (DistributionLogic)
DistributionLogic
distribution_level
string
This field defines the distribution level, currently allowed distribution level is (shipment)
Enum
distribution
object (Distribution)
Distribution
type
string
This field defines the distribution type allowed values('multi', 'single')
Enum
logic
string
This field defines the distribution logic allowed values('apportion', 'weighted', 'equally')
Enum
rule
object (DistributionRule)
DistributionRule
conditions
object
This field defines the distribution conditions
Examples
Parameters
cart_id:
"65c06fe589db42581e4be72e"
Was this section helpful?
GET
Response
Get a list of all price adjustments associated with a cart
getPriceAdjustments
Promotion refers to a marketing campaign designed to incentivize customers to make purchases by offering discounts, bonuses, or other special offers. The aim of promotions is to attract customers, increase sales, clear excess inventory, introduce new products, encourage repeat purchases, and foster customer loyalty. Various types of promotions include: X Percentage Value: Offers a percentage discount based on the total purchase value. Example: Get 20% off orders over Rs. 1000. X Amount Value: Provides a fixed discount amount regardless of the total purchase value. Example: Save Rs. 50 on orders over Rs. 500. Buy X Items Get Y Items Free: Offers free items when a specified quantity is purchased. Example: Buy 2 shirts, get 1 shirt free. Buy X Items at Absolute Amount: Allows purchasing a set number of items at a fixed price. Example: Buy 3 t-shirts for Rs. 500. Free Shipping: Waives shipping fees on orders over Rs. 500. Example: Enjoy free shipping on all orders over Rs. 500. Free Gift Items: Offers complimentary items with qualifying purchases. Example: Get a free tote bag with orders over Rs. 1000. Bundle Percentage Discount: Discounts applied when buying specific combinations or quantities. Example: Buy 2 shirts, get 20% off each. Bundle Amount Discount: Similar to bundle percentage discount, but discount is applied to a specific spending amount. Example: Spend Rs. 1000 on shoes, receive Rs. 200 off entire order. Buy X Amount and Get Y Percentage Off: Offers a percentage discount on the total purchase when a specified amount is spent. Example: Spend Rs. 1500, get 10% off entire order.
Operations
GET
# List of promotions
POST
# Create a promotion
GET
# Get a specific promotion
PUT
# Update a promotion
DEL
# Delete a promotion which is in draft state
GET
# Get promotion and coupon type
GET
# Check promotion code exists
Retrieve a list of all created promotions for specific sales channel. It also supports efficient text search and pagination functionalities, ensuring optimized promotion listing for streamlined navigation and management.
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
Promotion max records fetched in single request
Default Value : 10
q
string
Filter by promotion name or title
is_active
boolean
Filter by active or inactive promotion
Default Value : true
promo_group
string
Filter by promotion group
Enum
promotion_type
string
Filter by promotion type
Enum
fp_panel
string
Filter non extension promotions
promotion_id
string
Filter by promotion id
created_by
string
Filter by promotion creater user id
reviewed_by
string
Filter by promotion reviewer user id
approved_start_time
string
| date-time
Filter promotion by start time date range when status is in approved state
approved_end_time
string
| date-time
Filter promotion by end time date range when status is in approved state
review_start_time
string
| date-time
Filter promotion by start time date range when status is in review state
review_end_time
string
| date-time
Filter promotion by end time date range when status is in review state
status
string
Filter your promotions effortlessly by status, such as draft, review and more
Enum
Response
200
Promotion List for sent page_size and page_no
PromotionsResult
items
array of object (PromotionListItem)
List of promotions
Array of PromotionListItem
stackable
boolean
Allows more than one promotion to get combined benefits
calculate_on
string
Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
Doesn't allow other promotion after current promotion applied on cart or article
Enum
promo_group
string
Group into which promotion fall
Enum
mode
string
Promotion mode, like coupon or promotion
Enum
apply_all_discount
boolean
Prevents more than one promotion discounts
display_meta
object (DisplayMeta1)
DisplayMeta1
description
string
Nullable
Define details about the offer in promotion
offer_label
string
Offer label of promotion that needs to display
Default Value :
name
string
Nullable
Name of promotion that needs to display
offer_text
string
Nullable
Promotion offer text used to display
ownership
object (Ownership1)
Ownership1
payable_category
string
Promotion amount payable category
Enum
payable_by
string
Promotion amount bearable party
promotion_type
string
Type of the promotion
Enum
discount_rules
array of object (DiscountRule)
Discount rules based on which promotion will be applied
Array of DiscountRule
discount_type
string
The type of discount in promotion
Enum
buy_condition
string
Promotion buy rules in offer level
item_criteria
object (ItemCriteria)
ItemCriteria
cart_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
available_zones
array of string
List of all zones on which promotion is applicable
item_exclude_company
array of integer
List of all company id on which promotion is not applicable
item_id
array of integer
List of all item ids on which promotion is applicable
item_l1_category
array of integer
List of all L1 category on which promotion is applicable
cart_total
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_amount
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
item_exclude_id
array of integer
List of all item ids on which promotion is not applicable
all_items
boolean
Boolean flag set true to applicable the promotion for all products
item_exclude_l1_category
array of integer
List of all item ids on which promotion is not applicable
item_size
array of string
List of all item sizes on which promotion is applicable
item_store
array of integer
List of all item store ids on which promotion is applicable
item_exclude_sku
array of string
List of all item sku on which promotion is not applicable
item_department
array of integer
List of all departments ids on which promotion is applicable
item_exclude_store
array of integer
List of all item store ids on which promotion is not applicable
item_brand
array of integer
List of all brand ids on which promotion is applicable
item_exclude_department
array of integer
List of all department ids on which promotion is not applicable
item_exclude_category
array of integer
List of all L3 category on which promotion is not applicable
item_category
array of integer
List of all L3 category on which promotion is applicable
buy_rules
array of string
item_exclude_brand
array of integer
List of all brand ids on which promotion is not applicable
item_l2_category
array of integer
List of all L2 category on which promotion is applicable
item_company
array of integer
List of all company ids on which promotion is applicable
item_tags
array of string
List of all product tags on which promotion is applicable
item_exclude_l2_category
array of integer
List of all L2 category on which promotion is not applicable
item_sku
array of string
List of all item sku on which promotion is applicable
meta
object (ItemSizeMapping)
ItemSizeMapping
item_size_mapping
object
Item size mapping in promotion
offer
object (DiscountOffer)
DiscountOffer
max_discount_amount
number
| float
Maximum discount amount in promotion
discount_price
number
| float
Discount price in promotion
apportion_discount
boolean
Flag to distribute discount for each article
partial_can_ret
boolean
Flag indicated return the product partially
max_usage_per_transaction
integer
| int32
Nullable
Maximum usage per transaction in promotion
min_offer_quantity
integer
| int32
Minimum quantity of offer in promotion
code
string
Unique code of promotion
discount_amount
number
| float
Discount amount in promotion
discount_percentage
number
| float
Discount percentage in promotion
max_offer_quantity
integer
| int32
Maximum quantity of product in promotion
restrictions
object (Restrictions1)
Restrictions1
payments
object (PaymentModes)
PaymentModes
codes
array of string
Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM
iins
array of string
Debit/Credit card prefix (first 6 digit)
types
array of string
Card type, e.g. Credit, Debit
networks
array of string
Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY
uses
object (PaymentAllowValue)
PaymentAllowValue
max
integer
| int32
Maximum value need to allow for payment
user_registered
object (UserRegistered)
UserRegistered
end
string
| date-time
Nullable
End date time format till the user is registerd
start
string
| date-time
Nullable
Start date time format when user is registerd
platforms
array of string
List of platform on which promotion is applicable like android, ios
post_order
object (PostOrder1)
PostOrder1
cancellation_allowed
boolean
Cancellation allowed in promotion after order
Default Value : true
return_allowed
boolean
Return allowed in promotion after order
Default Value : true
user_groups
array of integer
List of user groups on which promotion is applicable
order_quantity
integer
| int32
Prmomotion max order count
anonymous_users
boolean
Set true, if promotion is applicable for guest user
user_id
array of string
List of user id on which promotion is applicable
uses
object (UsesRestriction1)
UsesRestriction1
maximum
object (UsesRemaining1)
UsesRemaining1
user
integer
| int32
Define total promotion count per user
total
integer
| int32
Define total promotions count
remaining
object (UsesRemaining1)
UsesRemaining1
user
integer
| int32
Define total promotion count per user
total
integer
| int32
Define total promotions count
ordering_stores
array of integer
List of store id on which promotion is applicable
currency
string
Currency used for promotion
is_processed
boolean
Flag to verify if promotion is ready to be applied on cart and ready to update promotion
code
string
Unique code of promotion
_schedule
object (PromotionSchedule)
PromotionSchedule
end
string
| date-time
Nullable
Then end date of promotion till valid
start
string
| date-time
Nullable
Then start date of promotion is valid
status
string
Promotion status like draft, review
Enum
published
boolean
The status of promotion is published or not
next_schedule
array of object
List of date time, which we will schedule the promotion
cron
string
Nullable
Schedule the cron to run your job periodically
duration
integer
| int32
Nullable
Time in minutes for execution
post_order_action
object (PromotionAction)
PromotionAction
action_date
string
| date-time
Nullable
Date time format in promotion
action_type
string
The action type of promotion
apply_priority
integer
| int32
Priority based on which promotion are applied on articles
author
object (PromotionAuthor)
PromotionAuthor
created_by
string
Nullable
The user id of user, who has created the promotion
Default Value : null
modified_by
string
Nullable
The user id of user, who has modified the promotion
Default Value : null
approved_by
string
Nullable
The user id of user, who has approved the promotion
Default Value : null
rejected_by
string
Nullable
The user id of user, who has rejected the promotion
Default Value : null
reviewed_by
string
Nullable
The user id of user, who has reviewed the promotion
Default Value : null
visiblility
object (Visibility)
Visibility
coupon_list
boolean
Flag to show promotion on Coupon list
pdp
boolean
Flag to show promotion on PDP page
application_id
string
Application id in which promotion will be used
buy_rules
object (ItemCriteria)
ItemCriteria
cart_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
available_zones
array of string
List of all zones on which promotion is applicable
item_exclude_company
array of integer
List of all company id on which promotion is not applicable
item_id
array of integer
List of all item ids on which promotion is applicable
item_l1_category
array of integer
List of all L1 category on which promotion is applicable
cart_total
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_amount
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
item_exclude_id
array of integer
List of all item ids on which promotion is not applicable
all_items
boolean
Boolean flag set true to applicable the promotion for all products
item_exclude_l1_category
array of integer
List of all item ids on which promotion is not applicable
item_size
array of string
List of all item sizes on which promotion is applicable
item_store
array of integer
List of all item store ids on which promotion is applicable
item_exclude_sku
array of string
List of all item sku on which promotion is not applicable
item_department
array of integer
List of all departments ids on which promotion is applicable
item_exclude_store
array of integer
List of all item store ids on which promotion is not applicable
item_brand
array of integer
List of all brand ids on which promotion is applicable
item_exclude_department
array of integer
List of all department ids on which promotion is not applicable
item_exclude_category
array of integer
List of all L3 category on which promotion is not applicable
item_category
array of integer
List of all L3 category on which promotion is applicable
buy_rules
array of string
item_exclude_brand
array of integer
List of all brand ids on which promotion is not applicable
item_l2_category
array of integer
List of all L2 category on which promotion is applicable
item_company
array of integer
List of all company ids on which promotion is applicable
item_tags
array of string
List of all product tags on which promotion is applicable
item_exclude_l2_category
array of integer
List of all L2 category on which promotion is not applicable
item_sku
array of string
List of all item sku on which promotion is applicable
_custom_json
object
custom data stored in promotion
date_meta
object (PromotionDateMeta)
PromotionDateMeta
modified_on
string
| date-time
Nullable
Date time format when the promotion last modified
Default Value : null
created_on
string
| date-time
Nullable
Date time format when the promotion created
Default Value : null
approved_on
string
| date-time
Nullable
Date time format when the promotion approved
Default Value : null
rejected_on
string
| date-time
Nullable
Date time format when the promotion rejected
Default Value : null
reviewed_on
string
| date-time
Nullable
Date time format when the promotion reviewed
Default Value : null
_id
string
Unique identifier of promotion
tags
array of string
List of tags on which promotion is applicable
Default Value :
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.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
List of promotions
getPromotions
Creates a new promotion based on the selected promotion type. Sellers can choose from multiple supported promotion types, including percentage value, fixed amount value, bundled discount, buy X get Y items, and more, along with customizable promotion criteria to meet specific business requirements.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
Request body
stackable
boolean
Boolean value set true to apply other promotions also
calculate_on
string
Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
promotion should apply on either article or cart.
Enum
promo_group
string
Required
The type of promotion group
Enum
mode
string
Required
Promotion mode, like coupon or promotion
Enum
apply_all_discount
boolean
True means to apply all discount offers
display_meta
object (DisplayMeta1)
DisplayMeta1
description
string
Nullable
Define details about the offer in promotion
offer_label
string
Offer label of promotion that needs to display
Default Value :
name
string
Nullable
Name of promotion that needs to display
offer_text
string
Nullable
Promotion offer text used to display
ownership
object (Ownership1)
Ownership1
payable_category
string
Promotion amount payable category
Enum
payable_by
string
Promotion amount bearable party
promotion_type
string
Required
Type of promotion
Enum
discount_rules
array of object (DiscountRule)
List of discount offers and their applicable conditions
Array of DiscountRule
discount_type
string
Required
The type of discount in promotion
Enum
buy_condition
string
Required
Promotion buy rules in offer level
item_criteria
object (ItemCriteria)
Required
ItemCriteria
cart_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
available_zones
array of string
List of all zones on which promotion is applicable
item_exclude_company
array of integer
List of all company id on which promotion is not applicable
item_id
array of integer
List of all item ids on which promotion is applicable
item_l1_category
array of integer
List of all L1 category on which promotion is applicable
cart_total
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_amount
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
item_exclude_id
array of integer
List of all item ids on which promotion is not applicable
all_items
boolean
Boolean flag set true to applicable the promotion for all products
item_exclude_l1_category
array of integer
List of all item ids on which promotion is not applicable
item_size
array of string
List of all item sizes on which promotion is applicable
item_store
array of integer
List of all item store ids on which promotion is applicable
item_exclude_sku
array of string
List of all item sku on which promotion is not applicable
item_department
array of integer
List of all departments ids on which promotion is applicable
item_exclude_store
array of integer
List of all item store ids on which promotion is not applicable
item_brand
array of integer
List of all brand ids on which promotion is applicable
item_exclude_department
array of integer
List of all department ids on which promotion is not applicable
item_exclude_category
array of integer
List of all L3 category on which promotion is not applicable
item_category
array of integer
List of all L3 category on which promotion is applicable
buy_rules
array of string
item_exclude_brand
array of integer
List of all brand ids on which promotion is not applicable
item_l2_category
array of integer
List of all L2 category on which promotion is applicable
item_company
array of integer
List of all company ids on which promotion is applicable
item_tags
array of string
List of all product tags on which promotion is applicable
item_exclude_l2_category
array of integer
List of all L2 category on which promotion is not applicable
item_sku
array of string
List of all item sku on which promotion is applicable
meta
object (ItemSizeMapping)
ItemSizeMapping
item_size_mapping
object
Item size mapping in promotion
offer
object (DiscountOffer)
Required
DiscountOffer
max_discount_amount
number
| float
Maximum discount amount in promotion
discount_price
number
| float
Discount price in promotion
apportion_discount
boolean
Flag to distribute discount for each article
partial_can_ret
boolean
Flag indicated return the product partially
max_usage_per_transaction
integer
| int32
Nullable
Maximum usage per transaction in promotion
min_offer_quantity
integer
| int32
Minimum quantity of offer in promotion
code
string
Unique code of promotion
discount_amount
number
| float
Discount amount in promotion
discount_percentage
number
| float
Discount percentage in promotion
max_offer_quantity
integer
| int32
Maximum quantity of product in promotion
restrictions
object (Restrictions1)
Restrictions1
payments
object (PaymentModes)
PaymentModes
codes
array of string
Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM
iins
array of string
Debit/Credit card prefix (first 6 digit)
types
array of string
Card type, e.g. Credit, Debit
networks
array of string
Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY
uses
object (PaymentAllowValue)
PaymentAllowValue
max
integer
| int32
Maximum value need to allow for payment
user_registered
object (UserRegistered)
UserRegistered
end
string
| date-time
Nullable
End date time format till the user is registerd
start
string
| date-time
Nullable
Start date time format when user is registerd
platforms
array of string
List of platform on which promotion is applicable like android, ios
post_order
object (PostOrder1)
PostOrder1
cancellation_allowed
boolean
Cancellation allowed in promotion after order
Default Value : true
return_allowed
boolean
Return allowed in promotion after order
Default Value : true
user_groups
array of integer
List of user groups on which promotion is applicable
order_quantity
integer
| int32
Prmomotion max order count
anonymous_users
boolean
Set true, if promotion is applicable for guest user
user_id
array of string
List of user id on which promotion is applicable
uses
object (UsesRestriction1)
UsesRestriction1
maximum
object (UsesRemaining1)
UsesRemaining1
user
integer
| int32
Define total promotion count per user
total
integer
| int32
Define total promotions count
remaining
object (UsesRemaining1)
UsesRemaining1
user
integer
| int32
Define total promotion count per user
total
integer
| int32
Define total promotions count
ordering_stores
array of integer
List of store id on which promotion is applicable
currency
string
Promotion Currency code like INR
code
string
Promotion unique code
_schedule
object (PromotionSchedule)
PromotionSchedule
end
string
| date-time
Nullable
Then end date of promotion till valid
start
string
| date-time
Nullable
Then start date of promotion is valid
status
string
Promotion status like draft, review
Enum
published
boolean
The status of promotion is published or not
next_schedule
array of object
List of date time, which we will schedule the promotion
cron
string
Nullable
Schedule the cron to run your job periodically
duration
integer
| int32
Nullable
Time in minutes for execution
post_order_action
object (PromotionAction)
PromotionAction
action_date
string
| date-time
Nullable
Date time format in promotion
action_type
string
The action type of promotion
apply_priority
integer
| int32
Promotion applicable priority
author
object (PromotionAuthor)
PromotionAuthor
created_by
string
Nullable
The user id of user, who has created the promotion
Default Value : null
modified_by
string
Nullable
The user id of user, who has modified the promotion
Default Value : null
approved_by
string
Nullable
The user id of user, who has approved the promotion
Default Value : null
rejected_by
string
Nullable
The user id of user, who has rejected the promotion
Default Value : null
reviewed_by
string
Nullable
The user id of user, who has reviewed the promotion
Default Value : null
visiblility
object (Visibility)
Visibility
coupon_list
boolean
Flag to show promotion on Coupon list
pdp
boolean
Flag to show promotion on PDP page
application_id
string
Required
Current application id of sales channel
buy_rules
object (ItemCriteria)
ItemCriteria
cart_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
available_zones
array of string
List of all zones on which promotion is applicable
item_exclude_company
array of integer
List of all company id on which promotion is not applicable
item_id
array of integer
List of all item ids on which promotion is applicable
item_l1_category
array of integer
List of all L1 category on which promotion is applicable
cart_total
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_amount
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
item_exclude_id
array of integer
List of all item ids on which promotion is not applicable
all_items
boolean
Boolean flag set true to applicable the promotion for all products
item_exclude_l1_category
array of integer
List of all item ids on which promotion is not applicable
item_size
array of string
List of all item sizes on which promotion is applicable
item_store
array of integer
List of all item store ids on which promotion is applicable
item_exclude_sku
array of string
List of all item sku on which promotion is not applicable
item_department
array of integer
List of all departments ids on which promotion is applicable
item_exclude_store
array of integer
List of all item store ids on which promotion is not applicable
item_brand
array of integer
List of all brand ids on which promotion is applicable
item_exclude_department
array of integer
List of all department ids on which promotion is not applicable
item_exclude_category
array of integer
List of all L3 category on which promotion is not applicable
item_category
array of integer
List of all L3 category on which promotion is applicable
buy_rules
array of string
item_exclude_brand
array of integer
List of all brand ids on which promotion is not applicable
item_l2_category
array of integer
List of all L2 category on which promotion is applicable
item_company
array of integer
List of all company ids on which promotion is applicable
item_tags
array of string
List of all product tags on which promotion is applicable
item_exclude_l2_category
array of integer
List of all L2 category on which promotion is not applicable
item_sku
array of string
List of all item sku on which promotion is applicable
_custom_json
object
Set extra properties in promotion
date_meta
object (PromotionDateMeta)
PromotionDateMeta
modified_on
string
| date-time
Nullable
Date time format when the promotion last modified
Default Value : null
created_on
string
| date-time
Nullable
Date time format when the promotion created
Default Value : null
approved_on
string
| date-time
Nullable
Date time format when the promotion approved
Default Value : null
rejected_on
string
| date-time
Nullable
Date time format when the promotion rejected
Default Value : null
reviewed_on
string
| date-time
Nullable
Date time format when the promotion reviewed
Default Value : null
tags
array of string
List of tags applicable for promotion
Default Value :
Response
201
400
Creates a discount promotion which applies on user cart.
PromotionAddResult
stackable
boolean
Boolean value set true to apply other promotions also
calculate_on
string
Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
promotion should apply on either article or cart.
Enum
promo_group
string
The type of promotion group
Enum
mode
string
Promotion mode, like coupon or promotion
Enum
is_processed
boolean
Flag to verify if promotion is ready to be applied on cart and ready to update promotion
apply_all_discount
boolean
True means to apply all discount offers
display_meta
object (DisplayMeta1)
DisplayMeta1
description
string
Nullable
Define details about the offer in promotion
offer_label
string
Offer label of promotion that needs to display
Default Value :
name
string
Nullable
Name of promotion that needs to display
offer_text
string
Nullable
Promotion offer text used to display
ownership
object (Ownership1)
Ownership1
payable_category
string
Promotion amount payable category
Enum
payable_by
string
Promotion amount bearable party
promotion_type
string
Type of promotion
Enum
discount_rules
array of object (DiscountRule)
List of discount offers and their applicable conditions
Array of DiscountRule
discount_type
string
The type of discount in promotion
Enum
buy_condition
string
Promotion buy rules in offer level
item_criteria
object (ItemCriteria)
ItemCriteria
cart_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
available_zones
array of string
List of all zones on which promotion is applicable
item_exclude_company
array of integer
List of all company id on which promotion is not applicable
item_id
array of integer
List of all item ids on which promotion is applicable
item_l1_category
array of integer
List of all L1 category on which promotion is applicable
cart_total
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_amount
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
item_exclude_id
array of integer
List of all item ids on which promotion is not applicable
all_items
boolean
Boolean flag set true to applicable the promotion for all products
item_exclude_l1_category
array of integer
List of all item ids on which promotion is not applicable
item_size
array of string
List of all item sizes on which promotion is applicable
item_store
array of integer
List of all item store ids on which promotion is applicable
item_exclude_sku
array of string
List of all item sku on which promotion is not applicable
item_department
array of integer
List of all departments ids on which promotion is applicable
item_exclude_store
array of integer
List of all item store ids on which promotion is not applicable
item_brand
array of integer
List of all brand ids on which promotion is applicable
item_exclude_department
array of integer
List of all department ids on which promotion is not applicable
item_exclude_category
array of integer
List of all L3 category on which promotion is not applicable
item_category
array of integer
List of all L3 category on which promotion is applicable
buy_rules
array of string
item_exclude_brand
array of integer
List of all brand ids on which promotion is not applicable
item_l2_category
array of integer
List of all L2 category on which promotion is applicable
item_company
array of integer
List of all company ids on which promotion is applicable
item_tags
array of string
List of all product tags on which promotion is applicable
item_exclude_l2_category
array of integer
List of all L2 category on which promotion is not applicable
item_sku
array of string
List of all item sku on which promotion is applicable
meta
object (ItemSizeMapping)
ItemSizeMapping
item_size_mapping
object
Item size mapping in promotion
offer
object (DiscountOffer)
DiscountOffer
max_discount_amount
number
| float
Maximum discount amount in promotion
discount_price
number
| float
Discount price in promotion
apportion_discount
boolean
Flag to distribute discount for each article
partial_can_ret
boolean
Flag indicated return the product partially
max_usage_per_transaction
integer
| int32
Nullable
Maximum usage per transaction in promotion
min_offer_quantity
integer
| int32
Minimum quantity of offer in promotion
code
string
Unique code of promotion
discount_amount
number
| float
Discount amount in promotion
discount_percentage
number
| float
Discount percentage in promotion
max_offer_quantity
integer
| int32
Maximum quantity of product in promotion
restrictions
object (Restrictions1)
Restrictions1
payments
object (PaymentModes)
PaymentModes
codes
array of string
Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM
iins
array of string
Debit/Credit card prefix (first 6 digit)
types
array of string
Card type, e.g. Credit, Debit
networks
array of string
Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY
uses
object (PaymentAllowValue)
PaymentAllowValue
max
integer
| int32
Maximum value need to allow for payment
user_registered
object (UserRegistered)
UserRegistered
end
string
| date-time
Nullable
End date time format till the user is registerd
start
string
| date-time
Nullable
Start date time format when user is registerd
platforms
array of string
List of platform on which promotion is applicable like android, ios
post_order
object (PostOrder1)
PostOrder1
cancellation_allowed
boolean
Cancellation allowed in promotion after order
Default Value : true
return_allowed
boolean
Return allowed in promotion after order
Default Value : true
user_groups
array of integer
List of user groups on which promotion is applicable
order_quantity
integer
| int32
Prmomotion max order count
anonymous_users
boolean
Set true, if promotion is applicable for guest user
user_id
array of string
List of user id on which promotion is applicable
uses
object (UsesRestriction1)
UsesRestriction1
maximum
object (UsesRemaining1)
UsesRemaining1
user
integer
| int32
Define total promotion count per user
total
integer
| int32
Define total promotions count
remaining
object (UsesRemaining1)
UsesRemaining1
user
integer
| int32
Define total promotion count per user
total
integer
| int32
Define total promotions count
ordering_stores
array of integer
List of store id on which promotion is applicable
currency
string
Promotion Currency code like INR
code
string
Promotion unique code
_schedule
object (PromotionSchedule)
PromotionSchedule
end
string
| date-time
Nullable
Then end date of promotion till valid
start
string
| date-time
Nullable
Then start date of promotion is valid
status
string
Promotion status like draft, review
Enum
published
boolean
The status of promotion is published or not
next_schedule
array of object
List of date time, which we will schedule the promotion
cron
string
Nullable
Schedule the cron to run your job periodically
duration
integer
| int32
Nullable
Time in minutes for execution
post_order_action
object (PromotionAction)
PromotionAction
action_date
string
| date-time
Nullable
Date time format in promotion
action_type
string
The action type of promotion
apply_priority
integer
| int32
Promotion applicable priority
author
object (PromotionAuthor)
PromotionAuthor
created_by
string
Nullable
The user id of user, who has created the promotion
Default Value : null
modified_by
string
Nullable
The user id of user, who has modified the promotion
Default Value : null
approved_by
string
Nullable
The user id of user, who has approved the promotion
Default Value : null
rejected_by
string
Nullable
The user id of user, who has rejected the promotion
Default Value : null
reviewed_by
string
Nullable
The user id of user, who has reviewed the promotion
Default Value : null
visiblility
object (Visibility)
Visibility
coupon_list
boolean
Flag to show promotion on Coupon list
pdp
boolean
Flag to show promotion on PDP page
application_id
string
Current application id of sales channel
buy_rules
object (ItemCriteria)
ItemCriteria
cart_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
available_zones
array of string
List of all zones on which promotion is applicable
item_exclude_company
array of integer
List of all company id on which promotion is not applicable
item_id
array of integer
List of all item ids on which promotion is applicable
item_l1_category
array of integer
List of all L1 category on which promotion is applicable
cart_total
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_amount
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
item_exclude_id
array of integer
List of all item ids on which promotion is not applicable
all_items
boolean
Boolean flag set true to applicable the promotion for all products
item_exclude_l1_category
array of integer
List of all item ids on which promotion is not applicable
item_size
array of string
List of all item sizes on which promotion is applicable
item_store
array of integer
List of all item store ids on which promotion is applicable
item_exclude_sku
array of string
List of all item sku on which promotion is not applicable
item_department
array of integer
List of all departments ids on which promotion is applicable
item_exclude_store
array of integer
List of all item store ids on which promotion is not applicable
item_brand
array of integer
List of all brand ids on which promotion is applicable
item_exclude_department
array of integer
List of all department ids on which promotion is not applicable
item_exclude_category
array of integer
List of all L3 category on which promotion is not applicable
item_category
array of integer
List of all L3 category on which promotion is applicable
buy_rules
array of string
item_exclude_brand
array of integer
List of all brand ids on which promotion is not applicable
item_l2_category
array of integer
List of all L2 category on which promotion is applicable
item_company
array of integer
List of all company ids on which promotion is applicable
item_tags
array of string
List of all product tags on which promotion is applicable
item_exclude_l2_category
array of integer
List of all L2 category on which promotion is not applicable
item_sku
array of string
List of all item sku on which promotion is applicable
_custom_json
object
Set extra properties in promotion
date_meta
object (PromotionDateMeta)
PromotionDateMeta
modified_on
string
| date-time
Nullable
Date time format when the promotion last modified
Default Value : null
created_on
string
| date-time
Nullable
Date time format when the promotion created
Default Value : null
approved_on
string
| date-time
Nullable
Date time format when the promotion approved
Default Value : null
rejected_on
string
| date-time
Nullable
Date time format when the promotion rejected
Default Value : null
reviewed_on
string
| date-time
Nullable
Date time format when the promotion reviewed
Default Value : null
tags
array of string
List of tags applicable for promotion
Default Value :
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Create a promotion
createPromotion
Retrieve details of a specific promotion by providing its unique identifier to obtain information such as promotion type, rules, validity period and other related information.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
id
string
Required
Promotion id for fetching single promotion data for editing
Response
200
404
Promotion object for sent promotion id
PromotionUpdateResult
stackable
boolean
Set true to apply other promotions in cart
calculate_on
string
Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
promotion should apply on either article or cart.
Enum
reason
string
Nullable
Promotion rejection reason added by reviewer
is_processed
boolean
Flag to verify if promotion is ready to be applied on cart and ready to update promotion
promo_group
string
The type of promotion group
Enum
mode
string
Promotion mode
Enum
apply_all_discount
boolean
True means to apply all discount offers
display_meta
object (DisplayMeta1)
DisplayMeta1
description
string
Nullable
Define details about the offer in promotion
offer_label
string
Offer label of promotion that needs to display
Default Value :
name
string
Nullable
Name of promotion that needs to display
offer_text
string
Nullable
Promotion offer text used to display
ownership
object (Ownership1)
Ownership1
payable_category
string
Promotion amount payable category
Enum
payable_by
string
Promotion amount bearable party
promotion_type
string
The Promotion type like amount, bogo and percentage etc.
Enum
discount_rules
array of object (DiscountRule)
List of discount offers and their applicable conditions
Array of DiscountRule
discount_type
string
The type of discount in promotion
Enum
buy_condition
string
Promotion buy rules in offer level
item_criteria
object (ItemCriteria)
ItemCriteria
cart_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
available_zones
array of string
List of all zones on which promotion is applicable
item_exclude_company
array of integer
List of all company id on which promotion is not applicable
item_id
array of integer
List of all item ids on which promotion is applicable
item_l1_category
array of integer
List of all L1 category on which promotion is applicable
cart_total
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_amount
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
item_exclude_id
array of integer
List of all item ids on which promotion is not applicable
all_items
boolean
Boolean flag set true to applicable the promotion for all products
item_exclude_l1_category
array of integer
List of all item ids on which promotion is not applicable
item_size
array of string
List of all item sizes on which promotion is applicable
item_store
array of integer
List of all item store ids on which promotion is applicable
item_exclude_sku
array of string
List of all item sku on which promotion is not applicable
item_department
array of integer
List of all departments ids on which promotion is applicable
item_exclude_store
array of integer
List of all item store ids on which promotion is not applicable
item_brand
array of integer
List of all brand ids on which promotion is applicable
item_exclude_department
array of integer
List of all department ids on which promotion is not applicable
item_exclude_category
array of integer
List of all L3 category on which promotion is not applicable
item_category
array of integer
List of all L3 category on which promotion is applicable
buy_rules
array of string
item_exclude_brand
array of integer
List of all brand ids on which promotion is not applicable
item_l2_category
array of integer
List of all L2 category on which promotion is applicable
item_company
array of integer
List of all company ids on which promotion is applicable
item_tags
array of string
List of all product tags on which promotion is applicable
item_exclude_l2_category
array of integer
List of all L2 category on which promotion is not applicable
item_sku
array of string
List of all item sku on which promotion is applicable
meta
object (ItemSizeMapping)
ItemSizeMapping
item_size_mapping
object
Item size mapping in promotion
offer
object (DiscountOffer)
DiscountOffer
max_discount_amount
number
| float
Maximum discount amount in promotion
discount_price
number
| float
Discount price in promotion
apportion_discount
boolean
Flag to distribute discount for each article
partial_can_ret
boolean
Flag indicated return the product partially
max_usage_per_transaction
integer
| int32
Nullable
Maximum usage per transaction in promotion
min_offer_quantity
integer
| int32
Minimum quantity of offer in promotion
code
string
Unique code of promotion
discount_amount
number
| float
Discount amount in promotion
discount_percentage
number
| float
Discount percentage in promotion
max_offer_quantity
integer
| int32
Maximum quantity of product in promotion
restrictions
object (Restrictions1)
Restrictions1
payments
object (PaymentModes)
PaymentModes
codes
array of string
Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM
iins
array of string
Debit/Credit card prefix (first 6 digit)
types
array of string
Card type, e.g. Credit, Debit
networks
array of string
Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY
uses
object (PaymentAllowValue)
PaymentAllowValue
max
integer
| int32
Maximum value need to allow for payment
user_registered
object (UserRegistered)
UserRegistered
end
string
| date-time
Nullable
End date time format till the user is registerd
start
string
| date-time
Nullable
Start date time format when user is registerd
platforms
array of string
List of platform on which promotion is applicable like android, ios
post_order
object (PostOrder1)
PostOrder1
cancellation_allowed
boolean
Cancellation allowed in promotion after order
Default Value : true
return_allowed
boolean
Return allowed in promotion after order
Default Value : true
user_groups
array of integer
List of user groups on which promotion is applicable
order_quantity
integer
| int32
Prmomotion max order count
anonymous_users
boolean
Set true, if promotion is applicable for guest user
user_id
array of string
List of user id on which promotion is applicable
uses
object (UsesRestriction1)
UsesRestriction1
maximum
object (UsesRemaining1)
UsesRemaining1
user
integer
| int32
Define total promotion count per user
total
integer
| int32
Define total promotions count
remaining
object (UsesRemaining1)
UsesRemaining1
user
integer
| int32
Define total promotion count per user
total
integer
| int32
Define total promotions count
ordering_stores
array of integer
List of store id on which promotion is applicable
currency
string
Promotion Currency code like INR
code
string
Promotion unique code
_schedule
object (PromotionSchedule)
PromotionSchedule
end
string
| date-time
Nullable
Then end date of promotion till valid
start
string
| date-time
Nullable
Then start date of promotion is valid
status
string
Promotion status like draft, review
Enum
published
boolean
The status of promotion is published or not
next_schedule
array of object
List of date time, which we will schedule the promotion
cron
string
Nullable
Schedule the cron to run your job periodically
duration
integer
| int32
Nullable
Time in minutes for execution
post_order_action
object (PromotionAction)
PromotionAction
action_date
string
| date-time
Nullable
Date time format in promotion
action_type
string
The action type of promotion
apply_priority
integer
| int32
Promotion applicable priority
author
object (PromotionAuthor)
PromotionAuthor
created_by
string
Nullable
The user id of user, who has created the promotion
Default Value : null
modified_by
string
Nullable
The user id of user, who has modified the promotion
Default Value : null
approved_by
string
Nullable
The user id of user, who has approved the promotion
Default Value : null
rejected_by
string
Nullable
The user id of user, who has rejected the promotion
Default Value : null
reviewed_by
string
Nullable
The user id of user, who has reviewed the promotion
Default Value : null
visiblility
object (Visibility)
Visibility
coupon_list
boolean
Flag to show promotion on Coupon list
pdp
boolean
Flag to show promotion on PDP page
application_id
string
Current application id of sales channel
buy_rules
object (ItemCriteria)
ItemCriteria
cart_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
available_zones
array of string
List of all zones on which promotion is applicable
item_exclude_company
array of integer
List of all company id on which promotion is not applicable
item_id
array of integer
List of all item ids on which promotion is applicable
item_l1_category
array of integer
List of all L1 category on which promotion is applicable
cart_total
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_amount
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
item_exclude_id
array of integer
List of all item ids on which promotion is not applicable
all_items
boolean
Boolean flag set true to applicable the promotion for all products
item_exclude_l1_category
array of integer
List of all item ids on which promotion is not applicable
item_size
array of string
List of all item sizes on which promotion is applicable
item_store
array of integer
List of all item store ids on which promotion is applicable
item_exclude_sku
array of string
List of all item sku on which promotion is not applicable
item_department
array of integer
List of all departments ids on which promotion is applicable
item_exclude_store
array of integer
List of all item store ids on which promotion is not applicable
item_brand
array of integer
List of all brand ids on which promotion is applicable
item_exclude_department
array of integer
List of all department ids on which promotion is not applicable
item_exclude_category
array of integer
List of all L3 category on which promotion is not applicable
item_category
array of integer
List of all L3 category on which promotion is applicable
buy_rules
array of string
item_exclude_brand
array of integer
List of all brand ids on which promotion is not applicable
item_l2_category
array of integer
List of all L2 category on which promotion is applicable
item_company
array of integer
List of all company ids on which promotion is applicable
item_tags
array of string
List of all product tags on which promotion is applicable
item_exclude_l2_category
array of integer
List of all L2 category on which promotion is not applicable
item_sku
array of string
List of all item sku on which promotion is applicable
_custom_json
object
Set extra properties in promotion
date_meta
object (PromotionDateMeta)
PromotionDateMeta
modified_on
string
| date-time
Nullable
Date time format when the promotion last modified
Default Value : null
created_on
string
| date-time
Nullable
Date time format when the promotion created
Default Value : null
approved_on
string
| date-time
Nullable
Date time format when the promotion approved
Default Value : null
rejected_on
string
| date-time
Nullable
Date time format when the promotion rejected
Default Value : null
reviewed_on
string
| date-time
Nullable
Date time format when the promotion reviewed
Default Value : null
tags
array of string
List of tags applicable for promotion
Default Value :
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Was this section helpful?
GET
Response
Get a specific promotion
getPromotionById
Update the details of an existing promotion by specifying its unique identifier. This includes modifying promotion attributes such as discount percentage, validity period, and associated conditions. Leveraging this functionality allows businesses to quickly adapt their promotional strategies to changing market dynamics.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
id
string
Required
Promotion identifier for fetching single promotion data for editing
Request body
stackable
boolean
Set true to apply other promotions in cart
calculate_on
string
Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
promotion should apply on either article or cart.
Enum
reason
string
Nullable
Promotion rejection reason added by reviewer
promo_group
string
Required
The type of promotion group
Enum
mode
string
Required
Promotion mode
Enum
apply_all_discount
boolean
True means to apply all discount offers
display_meta
object (DisplayMeta1)
DisplayMeta1
description
string
Nullable
Define details about the offer in promotion
offer_label
string
Offer label of promotion that needs to display
Default Value :
name
string
Nullable
Name of promotion that needs to display
offer_text
string
Nullable
Promotion offer text used to display
ownership
object (Ownership1)
Ownership1
payable_category
string
Promotion amount payable category
Enum
payable_by
string
Promotion amount bearable party
promotion_type
string
Required
The Promotion type like amount, bogo and percentage etc.
Enum
discount_rules
array of object (DiscountRule)
List of discount offers and their applicable conditions
Array of DiscountRule
discount_type
string
Required
The type of discount in promotion
Enum
buy_condition
string
Required
Promotion buy rules in offer level
item_criteria
object (ItemCriteria)
Required
ItemCriteria
cart_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
available_zones
array of string
List of all zones on which promotion is applicable
item_exclude_company
array of integer
List of all company id on which promotion is not applicable
item_id
array of integer
List of all item ids on which promotion is applicable
item_l1_category
array of integer
List of all L1 category on which promotion is applicable
cart_total
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_amount
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
item_exclude_id
array of integer
List of all item ids on which promotion is not applicable
all_items
boolean
Boolean flag set true to applicable the promotion for all products
item_exclude_l1_category
array of integer
List of all item ids on which promotion is not applicable
item_size
array of string
List of all item sizes on which promotion is applicable
item_store
array of integer
List of all item store ids on which promotion is applicable
item_exclude_sku
array of string
List of all item sku on which promotion is not applicable
item_department
array of integer
List of all departments ids on which promotion is applicable
item_exclude_store
array of integer
List of all item store ids on which promotion is not applicable
item_brand
array of integer
List of all brand ids on which promotion is applicable
item_exclude_department
array of integer
List of all department ids on which promotion is not applicable
item_exclude_category
array of integer
List of all L3 category on which promotion is not applicable
item_category
array of integer
List of all L3 category on which promotion is applicable
buy_rules
array of string
item_exclude_brand
array of integer
List of all brand ids on which promotion is not applicable
item_l2_category
array of integer
List of all L2 category on which promotion is applicable
item_company
array of integer
List of all company ids on which promotion is applicable
item_tags
array of string
List of all product tags on which promotion is applicable
item_exclude_l2_category
array of integer
List of all L2 category on which promotion is not applicable
item_sku
array of string
List of all item sku on which promotion is applicable
meta
object (ItemSizeMapping)
ItemSizeMapping
item_size_mapping
object
Item size mapping in promotion
offer
object (DiscountOffer)
Required
DiscountOffer
max_discount_amount
number
| float
Maximum discount amount in promotion
discount_price
number
| float
Discount price in promotion
apportion_discount
boolean
Flag to distribute discount for each article
partial_can_ret
boolean
Flag indicated return the product partially
max_usage_per_transaction
integer
| int32
Nullable
Maximum usage per transaction in promotion
min_offer_quantity
integer
| int32
Minimum quantity of offer in promotion
code
string
Unique code of promotion
discount_amount
number
| float
Discount amount in promotion
discount_percentage
number
| float
Discount percentage in promotion
max_offer_quantity
integer
| int32
Maximum quantity of product in promotion
restrictions
object (Restrictions1)
Restrictions1
payments
object (PaymentModes)
PaymentModes
codes
array of string
Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM
iins
array of string
Debit/Credit card prefix (first 6 digit)
types
array of string
Card type, e.g. Credit, Debit
networks
array of string
Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY
uses
object (PaymentAllowValue)
PaymentAllowValue
max
integer
| int32
Maximum value need to allow for payment
user_registered
object (UserRegistered)
UserRegistered
end
string
| date-time
Nullable
End date time format till the user is registerd
start
string
| date-time
Nullable
Start date time format when user is registerd
platforms
array of string
List of platform on which promotion is applicable like android, ios
post_order
object (PostOrder1)
PostOrder1
cancellation_allowed
boolean
Cancellation allowed in promotion after order
Default Value : true
return_allowed
boolean
Return allowed in promotion after order
Default Value : true
user_groups
array of integer
List of user groups on which promotion is applicable
order_quantity
integer
| int32
Prmomotion max order count
anonymous_users
boolean
Set true, if promotion is applicable for guest user
user_id
array of string
List of user id on which promotion is applicable
uses
object (UsesRestriction1)
UsesRestriction1
maximum
object (UsesRemaining1)
UsesRemaining1
user
integer
| int32
Define total promotion count per user
total
integer
| int32
Define total promotions count
remaining
object (UsesRemaining1)
UsesRemaining1
user
integer
| int32
Define total promotion count per user
total
integer
| int32
Define total promotions count
ordering_stores
array of integer
List of store id on which promotion is applicable
currency
string
Promotion Currency code like INR
code
string
Promotion unique code
_schedule
object (PromotionSchedule)
PromotionSchedule
end
string
| date-time
Nullable
Then end date of promotion till valid
start
string
| date-time
Nullable
Then start date of promotion is valid
status
string
Promotion status like draft, review
Enum
published
boolean
The status of promotion is published or not
next_schedule
array of object
List of date time, which we will schedule the promotion
cron
string
Nullable
Schedule the cron to run your job periodically
duration
integer
| int32
Nullable
Time in minutes for execution
post_order_action
object (PromotionAction)
PromotionAction
action_date
string
| date-time
Nullable
Date time format in promotion
action_type
string
The action type of promotion
apply_priority
integer
| int32
Promotion applicable priority
author
object (PromotionAuthor)
PromotionAuthor
created_by
string
Nullable
The user id of user, who has created the promotion
Default Value : null
modified_by
string
Nullable
The user id of user, who has modified the promotion
Default Value : null
approved_by
string
Nullable
The user id of user, who has approved the promotion
Default Value : null
rejected_by
string
Nullable
The user id of user, who has rejected the promotion
Default Value : null
reviewed_by
string
Nullable
The user id of user, who has reviewed the promotion
Default Value : null
visiblility
object (Visibility)
Visibility
coupon_list
boolean
Flag to show promotion on Coupon list
pdp
boolean
Flag to show promotion on PDP page
application_id
string
Required
Current application id of sales channel
buy_rules
object (ItemCriteria)
ItemCriteria
cart_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
available_zones
array of string
List of all zones on which promotion is applicable
item_exclude_company
array of integer
List of all company id on which promotion is not applicable
item_id
array of integer
List of all item ids on which promotion is applicable
item_l1_category
array of integer
List of all L1 category on which promotion is applicable
cart_total
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_amount
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
item_exclude_id
array of integer
List of all item ids on which promotion is not applicable
all_items
boolean
Boolean flag set true to applicable the promotion for all products
item_exclude_l1_category
array of integer
List of all item ids on which promotion is not applicable
item_size
array of string
List of all item sizes on which promotion is applicable
item_store
array of integer
List of all item store ids on which promotion is applicable
item_exclude_sku
array of string
List of all item sku on which promotion is not applicable
item_department
array of integer
List of all departments ids on which promotion is applicable
item_exclude_store
array of integer
List of all item store ids on which promotion is not applicable
item_brand
array of integer
List of all brand ids on which promotion is applicable
item_exclude_department
array of integer
List of all department ids on which promotion is not applicable
item_exclude_category
array of integer
List of all L3 category on which promotion is not applicable
item_category
array of integer
List of all L3 category on which promotion is applicable
buy_rules
array of string
item_exclude_brand
array of integer
List of all brand ids on which promotion is not applicable
item_l2_category
array of integer
List of all L2 category on which promotion is applicable
item_company
array of integer
List of all company ids on which promotion is applicable
item_tags
array of string
List of all product tags on which promotion is applicable
item_exclude_l2_category
array of integer
List of all L2 category on which promotion is not applicable
item_sku
array of string
List of all item sku on which promotion is applicable
_custom_json
object
Set extra properties in promotion
date_meta
object (PromotionDateMeta)
PromotionDateMeta
modified_on
string
| date-time
Nullable
Date time format when the promotion last modified
Default Value : null
created_on
string
| date-time
Nullable
Date time format when the promotion created
Default Value : null
approved_on
string
| date-time
Nullable
Date time format when the promotion approved
Default Value : null
rejected_on
string
| date-time
Nullable
Date time format when the promotion rejected
Default Value : null
reviewed_on
string
| date-time
Nullable
Date time format when the promotion reviewed
Default Value : null
tags
array of string
List of tags applicable for promotion
Default Value :
Response
200
404
Promotion updated successfully
PromotionUpdateResult
stackable
boolean
Set true to apply other promotions in cart
calculate_on
string
Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
promotion should apply on either article or cart.
Enum
reason
string
Nullable
Promotion rejection reason added by reviewer
is_processed
boolean
Flag to verify if promotion is ready to be applied on cart and ready to update promotion
promo_group
string
The type of promotion group
Enum
mode
string
Promotion mode
Enum
apply_all_discount
boolean
True means to apply all discount offers
display_meta
object (DisplayMeta1)
DisplayMeta1
description
string
Nullable
Define details about the offer in promotion
offer_label
string
Offer label of promotion that needs to display
Default Value :
name
string
Nullable
Name of promotion that needs to display
offer_text
string
Nullable
Promotion offer text used to display
ownership
object (Ownership1)
Ownership1
payable_category
string
Promotion amount payable category
Enum
payable_by
string
Promotion amount bearable party
promotion_type
string
The Promotion type like amount, bogo and percentage etc.
Enum
discount_rules
array of object (DiscountRule)
List of discount offers and their applicable conditions
Array of DiscountRule
discount_type
string
The type of discount in promotion
Enum
buy_condition
string
Promotion buy rules in offer level
item_criteria
object (ItemCriteria)
ItemCriteria
cart_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
available_zones
array of string
List of all zones on which promotion is applicable
item_exclude_company
array of integer
List of all company id on which promotion is not applicable
item_id
array of integer
List of all item ids on which promotion is applicable
item_l1_category
array of integer
List of all L1 category on which promotion is applicable
cart_total
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_amount
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
item_exclude_id
array of integer
List of all item ids on which promotion is not applicable
all_items
boolean
Boolean flag set true to applicable the promotion for all products
item_exclude_l1_category
array of integer
List of all item ids on which promotion is not applicable
item_size
array of string
List of all item sizes on which promotion is applicable
item_store
array of integer
List of all item store ids on which promotion is applicable
item_exclude_sku
array of string
List of all item sku on which promotion is not applicable
item_department
array of integer
List of all departments ids on which promotion is applicable
item_exclude_store
array of integer
List of all item store ids on which promotion is not applicable
item_brand
array of integer
List of all brand ids on which promotion is applicable
item_exclude_department
array of integer
List of all department ids on which promotion is not applicable
item_exclude_category
array of integer
List of all L3 category on which promotion is not applicable
item_category
array of integer
List of all L3 category on which promotion is applicable
buy_rules
array of string
item_exclude_brand
array of integer
List of all brand ids on which promotion is not applicable
item_l2_category
array of integer
List of all L2 category on which promotion is applicable
item_company
array of integer
List of all company ids on which promotion is applicable
item_tags
array of string
List of all product tags on which promotion is applicable
item_exclude_l2_category
array of integer
List of all L2 category on which promotion is not applicable
item_sku
array of string
List of all item sku on which promotion is applicable
meta
object (ItemSizeMapping)
ItemSizeMapping
item_size_mapping
object
Item size mapping in promotion
offer
object (DiscountOffer)
DiscountOffer
max_discount_amount
number
| float
Maximum discount amount in promotion
discount_price
number
| float
Discount price in promotion
apportion_discount
boolean
Flag to distribute discount for each article
partial_can_ret
boolean
Flag indicated return the product partially
max_usage_per_transaction
integer
| int32
Nullable
Maximum usage per transaction in promotion
min_offer_quantity
integer
| int32
Minimum quantity of offer in promotion
code
string
Unique code of promotion
discount_amount
number
| float
Discount amount in promotion
discount_percentage
number
| float
Discount percentage in promotion
max_offer_quantity
integer
| int32
Maximum quantity of product in promotion
restrictions
object (Restrictions1)
Restrictions1
payments
object (PaymentModes)
PaymentModes
codes
array of string
Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM
iins
array of string
Debit/Credit card prefix (first 6 digit)
types
array of string
Card type, e.g. Credit, Debit
networks
array of string
Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY
uses
object (PaymentAllowValue)
PaymentAllowValue
max
integer
| int32
Maximum value need to allow for payment
user_registered
object (UserRegistered)
UserRegistered
end
string
| date-time
Nullable
End date time format till the user is registerd
start
string
| date-time
Nullable
Start date time format when user is registerd
platforms
array of string
List of platform on which promotion is applicable like android, ios
post_order
object (PostOrder1)
PostOrder1
cancellation_allowed
boolean
Cancellation allowed in promotion after order
Default Value : true
return_allowed
boolean
Return allowed in promotion after order
Default Value : true
user_groups
array of integer
List of user groups on which promotion is applicable
order_quantity
integer
| int32
Prmomotion max order count
anonymous_users
boolean
Set true, if promotion is applicable for guest user
user_id
array of string
List of user id on which promotion is applicable
uses
object (UsesRestriction1)
UsesRestriction1
maximum
object (UsesRemaining1)
UsesRemaining1
user
integer
| int32
Define total promotion count per user
total
integer
| int32
Define total promotions count
remaining
object (UsesRemaining1)
UsesRemaining1
user
integer
| int32
Define total promotion count per user
total
integer
| int32
Define total promotions count
ordering_stores
array of integer
List of store id on which promotion is applicable
currency
string
Promotion Currency code like INR
code
string
Promotion unique code
_schedule
object (PromotionSchedule)
PromotionSchedule
end
string
| date-time
Nullable
Then end date of promotion till valid
start
string
| date-time
Nullable
Then start date of promotion is valid
status
string
Promotion status like draft, review
Enum
published
boolean
The status of promotion is published or not
next_schedule
array of object
List of date time, which we will schedule the promotion
cron
string
Nullable
Schedule the cron to run your job periodically
duration
integer
| int32
Nullable
Time in minutes for execution
post_order_action
object (PromotionAction)
PromotionAction
action_date
string
| date-time
Nullable
Date time format in promotion
action_type
string
The action type of promotion
apply_priority
integer
| int32
Promotion applicable priority
author
object (PromotionAuthor)
PromotionAuthor
created_by
string
Nullable
The user id of user, who has created the promotion
Default Value : null
modified_by
string
Nullable
The user id of user, who has modified the promotion
Default Value : null
approved_by
string
Nullable
The user id of user, who has approved the promotion
Default Value : null
rejected_by
string
Nullable
The user id of user, who has rejected the promotion
Default Value : null
reviewed_by
string
Nullable
The user id of user, who has reviewed the promotion
Default Value : null
visiblility
object (Visibility)
Visibility
coupon_list
boolean
Flag to show promotion on Coupon list
pdp
boolean
Flag to show promotion on PDP page
application_id
string
Current application id of sales channel
buy_rules
object (ItemCriteria)
ItemCriteria
cart_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
available_zones
array of string
List of all zones on which promotion is applicable
item_exclude_company
array of integer
List of all company id on which promotion is not applicable
item_id
array of integer
List of all item ids on which promotion is applicable
item_l1_category
array of integer
List of all L1 category on which promotion is applicable
cart_total
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_quantity
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
cart_unique_item_amount
object (CompareObject)
CompareObject
equals
number
| float
Nullable
Nummeric value must be equal to cart level rules
greater_than
number
| float
Nullable
Nummeric value must be greater than cart level rules
less_than_equals
number
| float
Nullable
Nummeric value must be less than or equal to cart level rules
less_than
number
| float
Nullable
Nummeric value must be less than cart level rules
greater_than_equals
number
| float
Nullable
Nummeric value must be greater than or equal to cart level rules
item_exclude_id
array of integer
List of all item ids on which promotion is not applicable
all_items
boolean
Boolean flag set true to applicable the promotion for all products
item_exclude_l1_category
array of integer
List of all item ids on which promotion is not applicable
item_size
array of string
List of all item sizes on which promotion is applicable
item_store
array of integer
List of all item store ids on which promotion is applicable
item_exclude_sku
array of string
List of all item sku on which promotion is not applicable
item_department
array of integer
List of all departments ids on which promotion is applicable
item_exclude_store
array of integer
List of all item store ids on which promotion is not applicable
item_brand
array of integer
List of all brand ids on which promotion is applicable
item_exclude_department
array of integer
List of all department ids on which promotion is not applicable
item_exclude_category
array of integer
List of all L3 category on which promotion is not applicable
item_category
array of integer
List of all L3 category on which promotion is applicable
buy_rules
array of string
item_exclude_brand
array of integer
List of all brand ids on which promotion is not applicable
item_l2_category
array of integer
List of all L2 category on which promotion is applicable
item_company
array of integer
List of all company ids on which promotion is applicable
item_tags
array of string
List of all product tags on which promotion is applicable
item_exclude_l2_category
array of integer
List of all L2 category on which promotion is not applicable
item_sku
array of string
List of all item sku on which promotion is applicable
_custom_json
object
Set extra properties in promotion
date_meta
object (PromotionDateMeta)
PromotionDateMeta
modified_on
string
| date-time
Nullable
Date time format when the promotion last modified
Default Value : null
created_on
string
| date-time
Nullable
Date time format when the promotion created
Default Value : null
approved_on
string
| date-time
Nullable
Date time format when the promotion approved
Default Value : null
rejected_on
string
| date-time
Nullable
Date time format when the promotion rejected
Default Value : null
reviewed_on
string
| date-time
Nullable
Date time format when the promotion reviewed
Default Value : null
tags
array of string
List of tags applicable for promotion
Default Value :
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Was this section helpful?
PUT
Response
Update a promotion
updatePromotion
Delete details of a draft promotion by providing its unique identifier to delete information such as promotion type, rules, validity period and other related information.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Application id of sales channel
id
string
Required
Promotion id for fetching single promotion data for deleting
Response
200
404
Promotion deleted for sent id
SuccessMessage
success
boolean
Whether the request was successful (true/false).
message
string
Response message needs to display
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Was this section helpful?
DEL
Response
Delete a promotion which is in draft state
deletePromotion
Retrieve the configuration settings related to promotions and coupons for a specific seller. It provides details of the supported types of coupons and promotions along with their descriptions, examples, and related attributes.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
entity_type
string
Entity type as promotion or coupon
Enum
is_hidden
boolean
Promotion coupon config shown or not
Response
200
Success. Returns a list of all the curently active coupons/promos
ActivePromosResult
entity_slug
string
A short, human-readable, URL-friendly identifier of Promotion or coupon
title
string
Name of the promotion or coupon
modified_on
string
| date-time
Coupon or promotion modification date
example
string
Discount offers examples
entity_type
string
Type of entity to be selected from : ['coupon', 'promotion']
created_on
string
| date-time
Coupon or modification creation date
is_hidden
boolean
If the promo is active or not
type
string
Coupon or promotion type
subtitle
string
Small description of the current offer
description
string
The description of the offer in the form of an HTML
Examples
Parameters
company_id:
"value"
application_id:
"value"
entity_type:
"value"
is_hidden:
false
Was this section helpful?
GET
Response
Get promotion and coupon type
getPromosCouponConfig
Validates the presence of a promotion code for the specified sales channel to verify whether the provided code already exists or not.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
code
string
Promotion code
Response
200
400
Valid response with existing promotion code count
Properties
success
boolean
count
integer
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Check promotion code exists
getPromotionCodeExists
Promotion offers are special incentives or discounts provided to customers to encourage purchases or enhance their shopping experience. These offers can take various forms, such as percentage discounts, fixed-price discounts, free shipping, buy-one-get-one (BOGO) deals. Ladder pricing, also known as tiered pricing, refers to a pricing strategy where the price of a product varies depending on the quantity purchased or other specified criteria. With ladder pricing, customers are incentivized to buy more by offering discounts or reduced prices for larger quantities or higher purchase volumes. For example, a retailer might offer a discounted price per unit for purchasing 10 items instead of just one.
Operations
GET
# List of all available promotion offers
GET
# Fetch available promotions payment offers
Retrieve a list of all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id
slug
string
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/
page_size
integer
Number of offers to be fetched to show
promotion_group
string
Type of promotion groups
store_id
integer
Unique identifier of a store
cart_type
string
The type of cart
Response
200
400
Success. Returns a array containing the available offers (if exists) on product via promotions. Refer `PromotionOffersDetails` for more details.
PromotionOffersDetails
available_promotions
array of object (PromotionOffer)
List of available promotion for product
Array of PromotionOffer
id
string
Promotion unique identifier
buy_rules
object
Buy rules of promotions
offer_text
string
Offer title of promotion that used to display
promotion_type
string
Type of Promotion like percentage, amount, bogo etc.
Enum
promotion_name
string
Name of the promotion
promotion_group
string
Group of promotion belongs to
valid_till
string
| date-time
Datetime ISOString for promotion end date
discount_rules
array of object
Discount rules of promotions
free_gift_items
array of object (FreeGiftItems)
Details of free gift items
Array of 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
description
string
Offer details including T&C
Examples
Parameters
company_id:
"value"
application_id:
"value"
slug:
"value"
page_size:
1
promotion_group:
"value"
store_id:
1
cart_type:
"value"
Was this section helpful?
GET
Response
List of all available promotion offers
getPromotionOffers
Use this API to get top 5 payment offers available for current product
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
id
string
Cart id of the user cart
uid
integer
Cart uid of the user cart
Response
200
400
Success. Returns a array containing the available offers (if exists) on product via promotions. Refer `PromotionPaymentOffersDetails` for more details.
PromotionPaymentOffersDetails
success
boolean
Indicates if operation is successful or not.
promotions
array of object (PromotionPaymentOffer)
Array of PromotionPaymentOffer
application_id
string
Application id of the sales channel
buy_rules
array of object
Buy rules of promotions
calculate_on
string
Price on which promotion calculated
description
string
Offer details including T&C
discount_rules
array of object
Discount rules of promotions
id
string
Promotion unique identifier
offer_text
string
Offer title of promotion that used to display
promotion_group
string
Group of promotion belongs to
promotion_type
string
Type of Promotion like bogo, amount, percentage etc.
Enum
promotion_name
string
Name of the promotion
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
uid:
1
Was this section helpful?
GET
Response
Fetch available promotions payment offers
getPromotionPaymentOffers
A selling location represents a geographical location where your stores, pop-up stores, headquarters, and warehouses exist. Find in-stock locations for products Additionally, the API retrieves detailed location information by ID, offering comprehensive store details for enhanced user convenience
Operations
GET
# Get Store Address
Retrieve store details by entering the unique identifier of the pickup stores. Store details include the seller's name, contact information such as email address or phone number and business address.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
store_uid
integer
Required
The unique identifier of the store
Response
200
Success. Returns available store information with its address as shown below.
StoreDetails
items
array of object (PickupStoreDetail)
List of items need to pickup from store
Array of PickupStoreDetail
country
string
Country of address
state
string
State of the address
city
string
City of the address
phone
string
Phone number for address
area_code
string
Area code of the address
uid
integer
| int32
Uid of the address
area_code_slug
string
Area code slug for address. example pincode is slug for India
address_type
string
Address type of address
area
string
Area description for address
id
integer
| int32
Id of the address
store_manager_name
string
Name of store manager
name
string
Name of person in address data to whom it belongs to
store_code
string
Store code from which the order placed
landmark
string
Landmark of address
email
string
Email address for address data
pincode
integer
| int32
Address pincode
address
string
Address description for address data
Examples
Parameters
company_id:
"value"
application_id:
"value"
store_uid:
1
Was this section helpful?
GET
Response
Get Store Address
getStoreAddressByUid
Shipment refers to the process of delivering purchased items from the seller's location to the customer’s designated address. Shipment details includes seller information, estimated delivery dates, item quantity, order type (Home Delivery or Pick At Store or Digital) and other shipment meta information. Additionally, it provides details about the items included in the shipment.
Operations
GET
# Get shipments details
PUT
# Update shipments
GET
# Get delivery modes
Use this API to get shipment details, expected delivery date, items and price breakup of the shipment.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
pick_at_store_uid
integer
ID of the store from where the order will be picked up by the customer, assuming the order_type is `PickAtStore`. This may or may not be the same as the ID of the ordering store.
ordering_store_id
integer
ID of the store where the customer is ordering from.
i
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
p
boolean
This is a boolean value. Select `true` for getting a payment option in response.
id
string
The unique identifier of the cart
address_id
string
ID allotted to the selected address
area_code
string
The PIN Code of the destination address, e.g. 400059
order_type
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
Enum
Response
200
Success. Returns delivery promise along with shipment details and price breakup. Refer `PlatformCartShipmentsResult` for more details.
PlatformCartShipmentsResult
coupon_text
string
Coupon text of coupon applied on cart
id
string
Cart id 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 added in cart
items
array of object (CartProductInfo)
List of items in cart
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Response message of get shipments API
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
staff_user_id
string
Nullable
Staff employee user id if cart is created by staff employee for the customer
is_valid
boolean
Cart validity flag determines the if the response is valid or not
shipments
array of object (PlatformShipmentDetails)
List of shipments that will be shipped
Array of PlatformShipmentDetails
shipments
integer
| int32
Count of shipments that will be shipped
Default Value : 1
fulfillment_id
integer
| int32
Fulfilment id of the shipment
items
array of object (CartProductInfo)
Item details in the shipment
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
CartProduct
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Array of ProductImage
secure_url
string
Secured url of the product image
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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.
dp_options
object
Nullable
Delivery partner options that are available to deliver the shipment
Default Value : null
shipment_type
string
Shipment type of the shipment returned in get shipments API like single_shipment or multiple shipment. Single Shipment means 1 item in 1 shipment and vice versa in the other one
order_type
string
Order type of the shipment like pickAtStore or HomeDelivery
Enum
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered
Default Value : null
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.
dp_id
string
Nullable
Delivery partner id of the shipment
Default Value : null
fulfillment_type
string
Fulfilment type of shipment
articles
array of object (ShipmentArticle)
List of articles in shipment
Array of ShipmentArticle
meta
string
Article meta data for shipment
quantity
string
Article quantity for shipment
article_id
string
Article unique id for shipment
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
checkout_mode
string
Checkout mode of cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag of user cart
gstin
string
GSTIN number added in 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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
error
boolean
Error details if any error occurs which includes type of error, error code and error message
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom cart meta details added in cart
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get shipments details
getShipments
Update the quantity or delivery type of the shipments. Customers can switch the order type from Home Delivery to Pick At Store and vice versa.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
i
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
p
boolean
This is a boolean value. Select `true` for getting a payment option in response.
id
string
The unique identifier of the cart
address_id
string
ID allotted to an address
area_code
string
The PIN Code of the destination address, e.g. 400059
order_type
string
The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.
Request body
shipments
array of object (UpdateCartShipmentItem)
Required
List of Shipments which includes shipment data like shipment items, shipment promise, Shipment type, shipment order type, shipment dp options etc
Array of UpdateCartShipmentItem
quantity
integer
| int32
Quantity of product in shipment
shipment_type
string
Required
Shipment delivery type
article_uid
string
Required
Article unique id for shipment
Response
200
Success. Returns delivery promise along with shipment details and price breakup. Refer `PlatformCartShipmentsResult` for more details.
PlatformCartShipmentsResult
coupon_text
string
Coupon text of coupon applied on cart
id
string
Cart id 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 added in cart
items
array of object (CartProductInfo)
List of items in cart
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process
message
string
Response message of get shipments API
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
staff_user_id
string
Nullable
Staff employee user id if cart is created by staff employee for the customer
is_valid
boolean
Cart validity flag determines the if the response is valid or not
shipments
array of object (PlatformShipmentDetails)
List of shipments that will be shipped
Array of PlatformShipmentDetails
shipments
integer
| int32
Count of shipments that will be shipped
Default Value : 1
fulfillment_id
integer
| int32
Fulfilment id of the shipment
items
array of object (CartProductInfo)
Item details in the shipment
Array of CartProductInfo
quantity
integer
| int32
Quantity of the product added in cart
product
object (CartProduct)
CartProduct
slug
string
Unique product url name generated via product name and other meta data
images
array of object (ProductImage)
Product Images urls of different types like secure url, aspect ration url and url
Array of ProductImage
secure_url
string
Secured url of the product image
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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
delivery_promise
object (ShipmentPromise)
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.
max_quantity
object (ProductMaxQuantityInfo)
ProductMaxQuantityInfo
item
number
Nullable
The total quantity of the item available across all stores for all sellers. If no data is available, this field will be null.
item_seller
number
Nullable
The total quantity of the item available across all stores for the specified seller. If no seller data is available, this field will be null.
item_store
number
Nullable
The total quantity of the item available for a specific store. If no store data is available, this field will be null.
price_per_unit
object (ProductPriceInfo)
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.
dp_options
object
Nullable
Delivery partner options that are available to deliver the shipment
Default Value : null
shipment_type
string
Shipment type of the shipment returned in get shipments API like single_shipment or multiple shipment. Single Shipment means 1 item in 1 shipment and vice versa in the other one
order_type
string
Order type of the shipment like pickAtStore or HomeDelivery
Enum
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered
Default Value : null
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.
dp_id
string
Nullable
Delivery partner id of the shipment
Default Value : null
fulfillment_type
string
Fulfilment type of shipment
articles
array of object (ShipmentArticle)
List of articles in shipment
Array of ShipmentArticle
meta
string
Article meta data for shipment
quantity
string
Article quantity for shipment
article_id
string
Article unique id for shipment
currency
object (CartCurrency)
CartCurrency
code
string
Currency code defined by ISO 4217:2015
symbol
string
Currency symbol for currency of user cart prices
checkout_mode
string
Checkout mode of cart
last_modified
string
| date
Last modified timestamp of cart
buy_now
boolean
Buy now flag of user cart
gstin
string
GSTIN number added in 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
offer_label
string
Offer label of the applied promotion, to be used as display text.
amount
number
| float
Per unit discount amount applied with current promotion
float_amount
string
Per unit discount amount with decimal values applied with current promotion.
promotion_type
string
Promotion type of current promotion
Enum
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_group
string
Promotion group for the promotion
promo_id
string
Promotion unique identifier
meta
object
Meta object for extra data
code
string
Nullable
Promotion unique code
error
boolean
Error details if any error occurs which includes type of error, error code and error message
pan_no
string
Permanent Account Number of the user
custom_cart_meta
object
Custom cart meta details added in cart
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Response
Update shipments
updateShipments
Retrieve a list of delivery modes (home delivery/store pickup) along with a list of available pickup stores for a given cart at a specified PIN Code.
Parameters
company_id
string
Required
Current company id
application_id
string
Required
Current Application id of sales channel
area_code
string
Required
The PIN Code of the destination address, e.g. 400059
id
string
The unique identifier of the cart
Response
200
Success. Returns the available delivery mode available for a given PIN Code, along with the UID of all the eligible pickup stores.
CartDeliveryModesDetails
pickup_stores
array of integer
Store pick up available store uids
available_modes
array of string
Available delivery modes
Examples
Parameters
company_id:
"value"
application_id:
"value"
area_code:
"value"
id:
"value"
Was this section helpful?
GET
Response