Cart

Handles shopping carts, including adding, removing, and updating items, as well as calculating totals.

Cart

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

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promo-coupons

# Get promotion and coupon type

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_configuration/{cart_meta_id}

# Get cart meta configuration by id

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_configuration/{cart_meta_id}

# Update cart metadata configuration.

DEL

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_configuration/{cart_meta_id}

# Delete cart meta configuration

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_configuration

# Fetch cart meta configuration

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_configuration

# Create new cart meta configuration

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/abandoned/carts

# Get abandoned carts

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/share-cart

# Share cart link

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/share-cart/{token}

# Get details of a shared cart

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/share-cart/{token}/{action}

# Update shared cart items

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart-list

# Get cart list for store os user

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/update-user

# Update cart user details.

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/basic

# Count items in the customer's cart

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/detail

# Add items to cart

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/detail

# Update cart items

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_archive

# Delete a cart

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/platform-pos-coupon

# List coupons

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/platform-pos-coupon

# Apply a coupon to the cart.

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/meta

# Update cart metadata

GET

Get promotion and coupon type

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.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

entity_type

string

entity_type as promotion or coupon

Enum

is_hidden

boolean

promo-coupon config shown or not

Response

200

Success. Returns a list of all the curently active coupons/promos

ActivePromosResponseObject

status

string

items

array of object (ActivePromos)

Array of ActivePromos

_id

string

entity_slug

string

title

string

Name of the promotion

modified_on

string

| date-time

Coupon 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 creation date

is_hidden

boolean

If the promo is active or not

type

string

Coupon type

subtitle

string

Small description of the current offer

description

string

The description of the offer in the form of an HTML

Examples

Parameters

Parameters are not required.

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promo-coupons

Response

GET

Get cart meta configuration by id

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application id

cart_meta_id

string

Required

CartMeta mongo _id for fetching single cart meta data for editing

Response

200

404

Cart Meta Config Fetched successfully

CartMetaConfigDetailObject

success

boolean

data

object (CartMetaConfigUpdate)

CartMetaConfigUpdate

min_cart_value

integer

| int32

max_cart_value

integer

| int32

bulk_coupons

boolean

max_cart_items

integer

| int32

gift_display_text

string

delivery_charges

object (DeliveryCharges)

DeliveryCharges

charges

array of object (Charges)

Array of Charges

charges

integer

| int32

threshold

integer

| int32

enabled

boolean

international_delivery_charges

object (DeliveryCharges)

DeliveryCharges

charges

array of object (Charges)

Array of Charges

charges

integer

| int32

threshold

integer

| int32

enabled

boolean

revenue_engine_coupon

boolean

gift_pricing

number

| float

enabled

boolean

app_id

string

is_active

boolean

slug

string

is_universal

boolean

company_id

number

updated_on

string

| date-time

last_modified_by

string

order_placing

object (OrderPlacing)

OrderPlacing

enabled

boolean

message

string

name

string

article_tags

array of string

allow_coupon_with_rewards

boolean

gst_input

boolean

staff_selection

boolean

placing_for_customer

boolean

pan_card

object (PanCard)

PanCard

enabled

boolean

cod_threshold_amount

integer

| int32

online_threshold_amount

integer

| int32

empty_cart

boolean

string

hide_on_storefront

boolean

created_on

string

| date-time

Examples

Parameters

cart_meta_id:

"61d1db23f5b315cf265126c0"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_configuration/{cart_meta_id}

Response

PUT

Update cart metadata configuration.

Modify the configuration settings for cart metadata.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

cart_meta_id

string

Required

CartMeta mongo _id for fetching single cart meta data for editing

Request body

min_cart_value

integer

| int32

max_cart_value

integer

| int32

bulk_coupons

boolean

max_cart_items

integer

| int32

gift_display_text

string

delivery_charges

object (DeliveryCharges)

DeliveryCharges

charges

array of object (Charges)

Array of Charges

charges

integer

| int32

threshold

integer

| int32

enabled

boolean

international_delivery_charges

object (DeliveryCharges)

DeliveryCharges

charges

array of object (Charges)

Array of Charges

charges

integer

| int32

threshold

integer

| int32

enabled

boolean

revenue_engine_coupon

boolean

gift_pricing

number

| float

enabled

boolean

app_id

string

is_active

boolean

slug

string

is_universal

boolean

company_id

number

updated_on

string

| date-time

last_modified_by

string

order_placing

object (OrderPlacing)

OrderPlacing

enabled

boolean

message

string

name

string

article_tags

array of string

allow_coupon_with_rewards

boolean

gst_input

boolean

staff_selection

boolean

placing_for_customer

boolean

pan_card

object (PanCard)

PanCard

enabled

boolean

cod_threshold_amount

integer

| int32

online_threshold_amount

integer

| int32

empty_cart

boolean

string

hide_on_storefront

boolean

created_on

string

| date-time

Response

200

404

Cart Meta Config updated successfully

CartMetaConfigUpdate

min_cart_value

integer

| int32

max_cart_value

integer

| int32

bulk_coupons

boolean

max_cart_items

integer

| int32

gift_display_text

string

delivery_charges

object (DeliveryCharges)

DeliveryCharges

charges

array of object (Charges)

Array of Charges

charges

integer

| int32

threshold

integer

| int32

enabled

boolean

international_delivery_charges

object (DeliveryCharges)

DeliveryCharges

charges

array of object (Charges)

Array of Charges

charges

integer

| int32

threshold

integer

| int32

enabled

boolean

revenue_engine_coupon

boolean

gift_pricing

number

| float

enabled

boolean

app_id

string

is_active

boolean

slug

string

is_universal

boolean

company_id

number

updated_on

string

| date-time

last_modified_by

string

order_placing

object (OrderPlacing)

OrderPlacing

enabled

boolean

message

string

name

string

article_tags

array of string

allow_coupon_with_rewards

boolean

gst_input

boolean

staff_selection

boolean

placing_for_customer

boolean

pan_card

object (PanCard)

PanCard

enabled

boolean

cod_threshold_amount

integer

| int32

online_threshold_amount

integer

| int32

empty_cart

boolean

string

hide_on_storefront

boolean

created_on

string

| date-time

Examples

Parameters

cart_meta_id:

"61d1db23f5b315cf265126c0"

body:

body

Was this section helpful?

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_configuration/{cart_meta_id}

Response

DEL

Delete cart meta configuration

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

cart_meta_id

string

Required

CartMeta mongo _id for fetching single cart meta data for editing

Response

200

404

Cart Meta Config deleted successfully

SuccessMessage

success

boolean

message

string

Examples

Parameters

cart_meta_id:

"61d1db23f5b315cf265126c1"

Was this section helpful?

DEL

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_configuration/{cart_meta_id}

Response

GET

Fetch cart meta configuration

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Response

200

Cart Meta Config updated successfully

CartMetaConfigListResponseObject

success

boolean

data

array of object (CartMetaConfigListObject)

Array of CartMetaConfigListObject

string

app_id

string

company_id

integer

| int32

created_on

string

| date-time

updated_on

string

| date-time

last_modified_by

string

min_cart_value

integer

| int32

max_cart_value

integer

| int32

bulk_coupons

boolean

max_cart_items

integer

| int32

gift_display_text

string

delivery_charges

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

revenue_engine_coupon

boolean

gift_pricing

number

| float

enabled

boolean

is_active

boolean

order_placing

object (OrderPlacing)

OrderPlacing

enabled

boolean

message

string

name

string

article_tags

array of string

allow_coupon_with_rewards

boolean

gst_input

boolean

staff_selection

boolean

placing_for_customer

boolean

hide_on_storefront

boolean

pan_card

object (PanCard)

PanCard

enabled

boolean

cod_threshold_amount

integer

| int32

online_threshold_amount

integer

| int32

slug

string

is_universal

boolean

empty_cart

boolean

international_delivery_charges

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

Examples

Parameters

Parameters are not required.

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_configuration

Response

POST

Create new cart meta configuration

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.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

min_cart_value

integer

| int32

max_cart_value

integer

| int32

bulk_coupons

boolean

max_cart_items

integer

| int32

gift_display_text

string

delivery_charges

object (DeliveryCharges)

DeliveryCharges

charges

array of object (Charges)

Array of Charges

charges

integer

| int32

threshold

integer

| int32

enabled

boolean

international_delivery_charges

object (DeliveryCharges)

DeliveryCharges

charges

array of object (Charges)

Array of Charges

charges

integer

| int32

threshold

integer

| int32

enabled

boolean

revenue_engine_coupon

boolean

gift_pricing

number

| float

enabled

boolean

app_id

string

slug

string

Required

is_universal

boolean

company_id

number

updated_on

string

| date-time

last_modified_by

string

name

string

Required

is_active

boolean

order_placing

object (OrderPlacing)

OrderPlacing

enabled

boolean

message

string

article_tags

array of string

allow_coupon_with_rewards

boolean

gst_input

boolean

staff_selection

boolean

placing_for_customer

boolean

pan_card

object (PanCard)

PanCard

enabled

boolean

cod_threshold_amount

integer

| int32

online_threshold_amount

integer

| int32

empty_cart

boolean

hide_on_storefront

boolean

Response

200

400

Cart Meta Config Created successfully

CartMetaConfigAddResponseObject

success

boolean

data

object (CartMetaConfigAdd)

CartMetaConfigAdd

min_cart_value

integer

| int32

max_cart_value

integer

| int32

bulk_coupons

boolean

max_cart_items

integer

| int32

gift_display_text

string

delivery_charges

object (DeliveryCharges)

DeliveryCharges

charges

array of object (Charges)

Array of Charges

charges

integer

| int32

threshold

integer

| int32

enabled

boolean

international_delivery_charges

object (DeliveryCharges)

DeliveryCharges

charges

array of object (Charges)

Array of Charges

charges

integer

| int32

threshold

integer

| int32

enabled

boolean

revenue_engine_coupon

boolean

gift_pricing

number

| float

enabled

boolean

app_id

string

slug

string

is_universal

boolean

company_id

number

updated_on

string

| date-time

last_modified_by

string

name

string

is_active

boolean

order_placing

object (OrderPlacing)

OrderPlacing

enabled

boolean

message

string

article_tags

array of string

allow_coupon_with_rewards

boolean

gst_input

boolean

staff_selection

boolean

placing_for_customer

boolean

pan_card

object (PanCard)

PanCard

enabled

boolean

cod_threshold_amount

integer

| int32

online_threshold_amount

integer

| int32

empty_cart

boolean

hide_on_storefront

boolean

Examples

Parameters

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_configuration

Response

GET

Get abandoned carts

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.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

page_no

integer

current page no as per pagination

Default Value : 0

page_size

integer

Coupon max records fetched in single request

Default Value : 10

from_date

string

| 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

Enum

Response

200

Abandoned Cart List for sent page_size and page_no

AbandonedCartResponseObject

items

array of object (AbandonedCart)

Array of AbandonedCart

expire_at

string

| date-time

promotion

object

is_default

boolean

comment

string

Nullable

articles

array of object

coupon

object

Nullable

bulk_coupon_discount

number

| float

Nullable

_id

string

fynd_credits

object

fc_index_map

array of integer

order_id

string

discount

number

| float

cod_charges

object

payments

object

Nullable

payment_mode

string

Nullable

shipments

array of object

pick_up_customer_details

object

Nullable

uid

integer

| int32

checkout_mode

string

cart_value

number

| float

is_archive

boolean

created_on

string

| date-time

last_modified

string

| date-time

meta

object

Nullable

buy_now

boolean

is_active

boolean

cashback

object

payment_methods

array of object

gstin

string

Nullable

delivery_charges

object

merge_qty

boolean

Nullable

user_id

string

app_id

string

result

object

page

object (Page)

Page

has_next

boolean

true if more records are present for next pages

item_total

integer

| int32

Total coupon count in system

current

integer

| int32

Current page no

next_id

string

Cursor id for next set of records.

page

integer

| int32

Page requested

last_id

string

Nullable

Last objects id

type

string

size

integer

| int32

Current request page size

has_previous

boolean

true if more records are present for previous pages. Sent for cursor pagination

success

boolean

the request success is defined

message

string

message of the response

Examples

Parameters

from_date:

"2024-02-05T10:49:33.168"

to_date:

"2024-02-05T10:49:33.168"

last_id:

"65c06fe589db42581e4be72e"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/abandoned/carts

Response

POST

Share cart link

Generate a unique shareable link for the customer's cart for a specific sales channel. This link enables easy sharing of the cart contents with other users, facilitating collaborative shopping experiences.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

string

Cart uid for generating sharing

meta

object

Staff, Ordering store or any other data. This data will be used to generate link as well as sent as shared details.

Response

200

Returns a URL to share and a token as shown below.

GetShareCartLinkResponseObject

token

string

Short url unique id

share_url

string

Short shareable final url

Examples

Parameters

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/share-cart

Response

GET

Get details of a shared cart

Use this API to get the shared cart details as per the token generated using the share-cart API.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

token

string

Required

Token of the shared short link

Response

200

404

Success. Returns a Cart object as per the valid token. Refer `SharedCartResponseObject` for more details.

SharedCartResponseObject

cart

object (SharedCart)

SharedCart

cart_id

integer

| int32

Unique identifier of the user cart.

uid

string

Unique identifier of the user cart.

coupon_text

string

Coupon text of the applied coupon on user cart.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message added in 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

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge info message of the user cart.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get shared cart 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

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of address on which address to be used for which checkout mode of cart.

last_modified

string

Last modified timestamp 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.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

shared_cart_details

object (SharedCartDetails)

SharedCartDetails

source

object

Share link device and other source information

user

object

User details of who generated share link

token

string

Short link id

created_on

string

| date-time

meta

object

Meta data sent while generating share cart link

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart_meta

object

Custom cart meta of user cart added via update cart meta API.

error

string

Examples

Parameters

token:

"5McSFzjO"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/share-cart/{token}

Response

POST

Update shared cart items

Customer can either merge or replace shared cart items with existing cart.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

token

string

Required

Token of the shared short link

action

string

Required

Operation to perform on the existing cart merge or replace.

Enum

cart_id

string

The unique identifier of the cart

Response

200

404

Success. Returns a merged or replaced cart as per the valid token. Refer `SharedCartResponseObject` for more details.

SharedCartResponseObject

cart

object (SharedCart)

SharedCart

cart_id

integer

| int32

Unique identifier of the user cart.

uid

string

Unique identifier of the user cart.

coupon_text

string

Coupon text of the applied coupon on user cart.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message added in 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

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge info message of the user cart.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get shared cart 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

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of address on which address to be used for which checkout mode of cart.

last_modified

string

Last modified timestamp 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.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

shared_cart_details

object (SharedCartDetails)

SharedCartDetails

source

object

Share link device and other source information

user

object

User details of who generated share link

token

string

Short link id

created_on

string

| date-time

meta

object

Meta data sent while generating share cart link

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart_meta

object

Custom cart meta of user cart added via update cart meta API.

error

string

Examples

Parameters

token:

"5McSFzjO"

action:

"merge"

cart_id:

"65c06fe589db42581e4be72e"

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/share-cart/{token}/{action}

Response

GET

Get cart list for store os user

Retrieve the list of active carts associated with a specific customer

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

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

Enum

Response

200

400

Platform user cart list

MultiCartResponseObject

success

boolean

data

array of object (CartList)

Array of CartList

cart_id

string

pick_up_customer_details

object

cart_value

number

| float

created_on

string

| date-time

user_id

string

currency_code

string

item_counts

integer

Examples

Parameters

from_date:

"2024-02-05T10:49:33.168"

to_date:

"2024-02-07T10:49:33.168"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart-list

Response

PUT

Update cart user details.

Modify the cart user to a new valid customer for the provided customer ID.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

cart id

Request body

user_id

string

Required

Response

200

UserCartMappingResponseObject

is_valid

boolean

message

string

success

boolean

cart

object (CartDetailResponseObject)

CartDetailResponseObject

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.

string

Unique identifier of the user cart.

error_message

string

Error message of the predicted shipment.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Staff employee user id if cart is created by staff employee for the customer.

success

boolean

Success flag of get cart detail API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

Last modified timestamp of cart.

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

buy_now

boolean

Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

custom_cart_meta

object

Custom meta details added cart checkout API payload .

error_code

string

Nullable

Error code corresponding to error in cart.

user

object (CartMappingUserInfo)

CartMappingUserInfo

_id

string

Nullable

uid

string

Nullable

first_name

string

Nullable

last_name

string

Nullable

mobile

string

Nullable

gender

string

Nullable

created_at

string

| date-time

Nullable

modified_on

string

| date-time

Nullable

external_id

string

Nullable

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

Examples

Parameters

id:

"65c06fe589db42581e4be72e"

body:

body

Was this section helpful?

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/update-user

Response

GET

Count items in the customer's cart

Use this API to get the total number of items present in cart.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart.

buy_now

boolean

Boolean value to get buy_now cart.

cart_type

string

The type of cart

Enum

Response

200

Success. Returns the total count of items in a user's cart.

CartItemCountResponseObject

user_cart_items_count

integer

| int32

Item count present in cart

user_cart_article_count

integer

| int32

Article count present in cart.

Examples

Parameters

id:

"65c06fe589db42581e4be72e"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/basic

Response

POST

Add items to cart

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.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

boolean

This is a boolean value. Select `true` to retrieve all the items added in the cart.

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

string

The unique identifier of the cart

cart_type

string

The type of cart

Enum

Request body

user_id

string

new_cart

boolean

items

array of object (AddProductCart)

Array of AddProductCart

quantity

integer

| int32

item_size

string

seller_id

integer

| int32

parent_item_identifiers

array of object

price_factory_type_id

string

product_group_tags

array of string

article_id

string

article_assignment

object (ArticleAssignment)

ArticleAssignment

level

string

strategy

string

store_id

integer

| int32

display

string

item_id

integer

| int32

extra_meta

object

_custom_json

object

meta

object

pos

boolean

seller_identifier

string

Add items using seller identifier for store os

Response

200

Success. Returns a cart object as shown below. Refer `AddCartDetailResponseObject` for more details.

AddCartDetailResponseObject

success

boolean

true if all items are added successfully. false if partially added or not added.

cart

object (CartDetailResponseObject)

CartDetailResponseObject

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.

string

Unique identifier of the user cart.

error_message

string

Error message of the predicted shipment.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Staff employee user id if cart is created by staff employee for the customer.

success

boolean

Success flag of get cart detail API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

Last modified timestamp of cart.

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

buy_now

boolean

Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

custom_cart_meta

object

Custom meta details added cart checkout API payload .

error_code

string

Nullable

Error code corresponding to error in cart.

partial

boolean

When adding multiple items check if all added. true if only few are added.

message

string

result

object

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

"true"

id:

"65c06fe589db42581e4be72e"

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/detail

Response

PUT

Update cart items

Customers can modify added product attributes such as quantity and size, as well as remove items from the cart.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart

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.

Enum

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

cart_type

string

The type of cart

Enum

Request body

user_id

string

items

array of object (UpdateProductCart)

Array of UpdateProductCart

quantity

integer

| int32

item_size

string

parent_item_identifiers

object

meta

object

extra_meta

object

_custom_json

object

price_factory_type_id

string

item_id

integer

| int32

item_index

integer

| int32

Required

identifiers

object (CartProductIdentifer)

Required

CartProductIdentifer

identifier

string

Article idenfier generated by cart

article_id

string

operation

string

Required

Enum

Response

200

Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResponseObject` for more details.

UpdateCartDetailResponseObject

success

boolean

true if all items are added successfully. false if partially added or not added.

cart

object (CartDetailResponseObject)

CartDetailResponseObject

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.

string

Unique identifier of the user cart.

error_message

string

Error message of the predicted shipment.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Staff employee user id if cart is created by staff employee for the customer.

success

boolean

Success flag of get cart detail API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

Last modified timestamp of cart.

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

buy_now

boolean

Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

custom_cart_meta

object

Custom meta details added cart checkout API payload .

error_code

string

Nullable

Error code corresponding to error in cart.

message

string

result

object

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

id:

"65c06fe589db42581e4be72e"

"true"

body:

body

Was this section helpful?

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/detail

Response

PUT

Delete a cart

Delete all items from the user's cart and resets it to its initial state, providing a clean slate for new selections.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart.

cart_type

string

The type of cart

Enum

Request body

cart_id_list

array of string

Response

200

Success. Returns whether the cart has been deleted or not.

DeleteCartDetailResponseObject

success

boolean

true if cart is archived successfully. false if not archived.

message

string

Examples

Parameters

id:

"64aed3775b8d4da351584fa2"

body:

body

Was this section helpful?

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart_archive

Response

GET

List coupons

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.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _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

400

Success. Returns a coupon object which has a list of all the eligible coupons. Refer `GetCouponResponseObject` for more details.

GetCouponResponseObject

available_coupon_list

array of object (Coupon)

Array of Coupon

title

string

max_discount_value

number

| float

coupon_code

string

is_applied

boolean

coupon_type

string

Nullable

expires_on

string

coupon_value

number

| float

sub_title

string

minimum_cart_value

number

| float

is_applicable

boolean

message

string

description

string

Nullable

start_date

string

| date-time

Nullable

end_date

string

| date-time

Nullable

coupon_applicable_message

string

is_bank_offer

boolean

offer_text

string

coupon_amount

number

| float32

tags

array of string

Nullable

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

page

object (PageCoupon)

PageCoupon

has_next

boolean

current

integer

| int32

total

integer

| int32

total_item_count

integer

| int32

has_previous

boolean

Examples

Parameters

id:

"65c06fe589db42581e4be72e"

slug:

"global-desi-aw19gbdst31blakblack-1077515-1f6956"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/platform-pos-coupon

Response

POST

Apply a coupon to the cart.

Apply a coupon code to the customer's cart to trigger discounts on eligible items

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

boolean

This is a boolean value. Select `true` to retrieve all the items added in the cart.

boolean

This is a boolean value. Select `true` to retrieve the price breakup of cart items.

boolean

This is a boolean value. Select `true` for getting a payment option in response.

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

200

Success. Returns coupons applied to the cart along with item details and price breakup. Refer `CartDetailResponseObject` for more details.

CartDetailResponseObject

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.

string

Unique identifier of the user cart.

error_message

string

Error message of the predicted shipment.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Staff employee user id if cart is created by staff employee for the customer.

success

boolean

Success flag of get cart detail API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

Last modified timestamp of cart.

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

buy_now

boolean

Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

custom_cart_meta

object

Custom meta details added cart checkout API payload .

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

"true"

id:

"65c06fe589db42581e4be72e"

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/platform-pos-coupon

Response

PUT

Update cart metadata

Add or modify metadata associated with a cart, which includes customer preferences, delivery instructions, or any special requirements related to the cart items.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart

buy_now

boolean

this is boolean to get buy_now cart

user_id

string

Option to update cart meta for the provided user_id

Request body

gstin

string

pick_up_customer_details

object

Customer contact details for customer pickup at store

checkout_mode

string

gift_details

object

Nullable

pan_no

string

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

comment

string

staff_user_id

string

Nullable

staff user id

delivery_slots

object

custom_cart_meta

object

Response

200

400

Returns a message indicating the success of cart meta updation as shown below.

CartMetaResponseObject

is_valid

boolean

message

string

Examples

Parameters

id:

"65c06fe589db42581e4be72e"

body:

body

Was this section helpful?

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/meta

Response

Checkout

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

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart/validate

# Get and validate cart items

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart/serviceability

# Check cart serviceability

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart/checkout

# Checkout cart

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/abandoned/cart/detail

# Get abandoned cart details

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/abandoned/carts/{cart_id}

# Add items to abandoned cart

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/abandoned/carts/{cart_id}

# Update cart items

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/checkout/over-ride

# Create Fynd order with overriding cart details

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/detail

# Fetch all items added to the customer cart using cart id

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/checkout

# Checkout cart

POST

/service/platform/cart/v2.0/company/{company_id}/application/{application_id}/checkout

# Cart checkout (latest)

POST

Get and validate cart items

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.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

cart_items

array of object (CartItem)

Required

Array of CartItem

quantity

integer

| int32

product_id

string

Required

size

string

Required

Response

200

400

Cart details with breakup

OpenapiCartDetailsResponseObject

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.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Staff employee user id if cart is created by staff employee for the customer.

success

boolean

Success flag of get cart detail API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

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

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart_meta

object

Custom meta details added cart checkout API payload.

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart/validate

Response

POST

Check cart serviceability

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.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

cart_items

array of object (CartItem)

Required

Array of CartItem

quantity

integer

| int32

product_id

string

Required

size

string

Required

shipping_address

object (ShippingAddress)

Required

ShippingAddress

country

string

Nullable

state

string

Nullable

city

string

Nullable

phone

integer

| int32

area_code

string

Required

country_iso_code

string

country_phone_code

string

meta

object

address_type

string

area

string

area_code_slug

string

Default Value : pincode

name

string

landmark

string

country_code

string

Default Value : IND

pincode

integer

| int32

address

string

Response

200

Cart details with pincode validity information at item level

OpenApiCartServiceabilityResponseObject

cart_id

integer

| int32

Unique identifier of the user cart.

uid

string

Unique identifier of the user cart.

coupon_text

string

Coupon text of the applied coupon on user cart.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message added in 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

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge info message of the user cart.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get shared cart 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

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of address on which address to be used for which checkout mode of cart.

last_modified

string

Last modified timestamp 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.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart_meta

object

Custom cart meta of user cart added via update cart meta API.

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart/serviceability

Response

POST

Checkout cart

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.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

body

object (OpenApiPlatformCheckoutReq)

Required

OpenApiPlatformCheckoutReq

payment_mode

string

cart_value

number

| float

Required

cart_items

array of object (OpenApiOrderItem)

Required

Array of OpenApiOrderItem

cashback_applied

number

| float

Required

quantity

integer

| int32

Default Value : 1

size

string

Required

coupon_effective_discount

number

| float

Required

amount_paid

number

| float

Required

delivery_charges

number

| float

Required

price_marked

number

| value >= 0

| float

Required

files

array of object (OpenApiFiles)

Array of OpenApiFiles

key

string

Required

values

array of string

Required

meta

object (CartItemMeta)

CartItemMeta

primary_item

boolean

group_id

string

extra_meta

object

product_id

integer

| int32

Required

loyalty_discount

number

| float

Default Value : 0

discount

number

| float

Required

price_effective

number

| value >= 0

| float

Required

payment_methods

array of object (MultiTenderPaymentMethod)

Required

Array of MultiTenderPaymentMethod

mode

string

Required

amount

number

| float

Required

Payment amount

meta

object (MultiTenderPaymentMeta)

MultiTenderPaymentMeta

payment_id

string

Nullable

payment_gateway

string

Nullable

extra_meta

object

Nullable

current_status

string

Nullable

order_id

string

Nullable

name

string

Payment mode name

employee_discount

number

| float

Default Value : 0

cod_charges

number

| float

Required

shipping_address

object (ShippingAddress)

ShippingAddress

country

string

Nullable

state

string

Nullable

city

string

Nullable

phone

integer

| int32

area_code

string

Required

country_iso_code

string

country_phone_code

string

meta

object

address_type

string

area

string

area_code_slug

string

Default Value : pincode

name

string

landmark

string

country_code

string

Default Value : IND

pincode

integer

| int32

address

string

loyalty_discount

number

| float

comment

string

Nullable

payment_methods

array of object (MultiTenderPaymentMethod)

Required

Array of MultiTenderPaymentMethod

mode

string

Required

amount

number

| float

Required

Payment amount

meta

object (MultiTenderPaymentMeta)

MultiTenderPaymentMeta

payment_id

string

Nullable

payment_gateway

string

Nullable

extra_meta

object

Nullable

current_status

string

Nullable

order_id

string

Nullable

name

string

Payment mode name

employee_discount

object

coupon

string

cashback_applied

number

| float

Required

gstin

string

Nullable

billing_address

object (ShippingAddress)

Required

ShippingAddress

country

string

Nullable

state

string

Nullable

city

string

Nullable

phone

integer

| int32

area_code

string

Required

country_iso_code

string

country_phone_code

string

meta

object

address_type

string

area

string

area_code_slug

string

Default Value : pincode

name

string

landmark

string

country_code

string

Default Value : IND

pincode

integer

| int32

address

string

coupon_code

string

Required

coupon_value

number

| float

Required

delivery_charges

number

| float

Required

affiliate_order_id

string

currency_code

string

order_id

string

files

array of object (OpenApiFiles)

Array of OpenApiFiles

key

string

Required

values

array of string

Required

cod_charges

number

| float

Required

platform_order_id

string

extra_meta

object

Request body

payment_mode

string

cart_value

number

| float

Required

cart_items

array of object (OpenApiOrderItem)

Required

Array of OpenApiOrderItem

cashback_applied

number

| float

Required

quantity

integer

| int32

Default Value : 1

size

string

Required

coupon_effective_discount

number

| float

Required

amount_paid

number

| float

Required

delivery_charges

number

| float

Required

price_marked

number

| value >= 0

| float

Required

files

array of object (OpenApiFiles)

Array of OpenApiFiles

key

string

Required

values

array of string

Required

meta

object (CartItemMeta)

CartItemMeta

primary_item

boolean

group_id

string

extra_meta

object

product_id

integer

| int32

Required

loyalty_discount

number

| float

Default Value : 0

discount

number

| float

Required

price_effective

number

| value >= 0

| float

Required

payment_methods

array of object (MultiTenderPaymentMethod)

Required

Array of MultiTenderPaymentMethod

mode

string

Required

amount

number

| float

Required

Payment amount

meta

object (MultiTenderPaymentMeta)

MultiTenderPaymentMeta

payment_id

string

Nullable

payment_gateway

string

Nullable

extra_meta

object

Nullable

current_status

string

Nullable

order_id

string

Nullable

name

string

Payment mode name

employee_discount

number

| float

Default Value : 0

cod_charges

number

| float

Required

shipping_address

object (ShippingAddress)

ShippingAddress

country

string

Nullable

state

string

Nullable

city

string

Nullable

phone

integer

| int32

area_code

string

Required

country_iso_code

string

country_phone_code

string

meta

object

address_type

string

area

string

area_code_slug

string

Default Value : pincode

name

string

landmark

string

country_code

string

Default Value : IND

pincode

integer

| int32

address

string

loyalty_discount

number

| float

comment

string

Nullable

payment_methods

array of object (MultiTenderPaymentMethod)

Required

Array of MultiTenderPaymentMethod

mode

string

Required

amount

number

| float

Required

Payment amount

meta

object (MultiTenderPaymentMeta)

MultiTenderPaymentMeta

payment_id

string

Nullable

payment_gateway

string

Nullable

extra_meta

object

Nullable

current_status

string

Nullable

order_id

string

Nullable

name

string

Payment mode name

employee_discount

object

coupon

string

cashback_applied

number

| float

Required

gstin

string

Nullable

billing_address

object (ShippingAddress)

Required

ShippingAddress

country

string

Nullable

state

string

Nullable

city

string

Nullable

phone

integer

| int32

area_code

string

Required

country_iso_code

string

country_phone_code

string

meta

object

address_type

string

area

string

area_code_slug

string

Default Value : pincode

name

string

landmark

string

country_code

string

Default Value : IND

pincode

integer

| int32

address

string

coupon_code

string

Required

coupon_value

number

| float

Required

delivery_charges

number

| float

Required

affiliate_order_id

string

currency_code

string

order_id

string

files

array of object (OpenApiFiles)

Array of OpenApiFiles

key

string

Required

values

array of string

Required

cod_charges

number

| float

Required

platform_order_id

string

extra_meta

object

Response

200

400

Checkout cart and create Fynd order id

OpenApiCheckoutResponseObject

success

boolean

message

string

order_ref_id

string

Nullable

Order id sent in request

order_id

string

Fynd order id

Examples

Parameters

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/cart/checkout

Response

GET

Get abandoned cart details

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.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart

boolean

This is a boolean value. Select `true` to retrieve all the items added in the cart.

boolean

This is a boolean value. Select `true` to retrieve the price breakup of cart items.

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 `CartDetailResponseObject` for more details.

CartDetailResponseObject

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.

string

Unique identifier of the user cart.

error_message

string

Error message of the predicted shipment.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Staff employee user id if cart is created by staff employee for the customer.

success

boolean

Success flag of get cart detail API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

Last modified timestamp of cart.

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

buy_now

boolean

Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

custom_cart_meta

object

Custom meta details added cart checkout API payload .

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

id:

"65c06fe589db42581e4be72e"

true

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/abandoned/cart/detail

Response

POST

Add items to abandoned cart

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.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

cart_id

string

Required

Current Cart _id

boolean

This is a boolean value. Select `true` to retrieve the price breakup of cart items.

Request body

new_cart

boolean

items

array of object (AddProductCart)

Array of AddProductCart

quantity

integer

| int32

item_size

string

seller_id

integer

| int32

parent_item_identifiers

array of object

price_factory_type_id

string

product_group_tags

array of string

article_id

string

article_assignment

object (ArticleAssignment)

ArticleAssignment

level

string

strategy

string

store_id

integer

| int32

display

string

item_id

integer

| int32

extra_meta

object

_custom_json

object

meta

object

pos

boolean

seller_identifier

string

Add items using seller identifier for store os

Response

200

Success. Returns a cart object as shown below. Refer `AddCartDetailResponseObject` for more details.

AddCartDetailResponseObject

success

boolean

true if all items are added successfully. false if partially added or not added.

cart

object (CartDetailResponseObject)

CartDetailResponseObject

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.

string

Unique identifier of the user cart.

error_message

string

Error message of the predicted shipment.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Staff employee user id if cart is created by staff employee for the customer.

success

boolean

Success flag of get cart detail API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

Last modified timestamp of cart.

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

buy_now

boolean

Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

custom_cart_meta

object

Custom meta details added cart checkout API payload .

error_code

string

Nullable

Error code corresponding to error in cart.

partial

boolean

When adding multiple items check if all added. true if only few are added.

message

string

result

object

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

cart_id:

"65c06fe589db42581e4be72e"

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/abandoned/carts/{cart_id}

Response

PUT

Update cart items

Customers can modify added product attributes such as quantity and size, as well as remove items from the cart.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

cart_id

string

Required

Current Cart _id

boolean

This is a boolean value. Select `true` to retrieve the price breakup of cart items.

Request body

items

array of object (UpdateProductCart)

Array of UpdateProductCart

quantity

integer

| int32

item_size

string

parent_item_identifiers

object

meta

object

extra_meta

object

_custom_json

object

price_factory_type_id

string

item_id

integer

| int32

item_index

integer

| int32

Required

identifiers

object (CartProductIdentifer)

Required

CartProductIdentifer

identifier

string

Article idenfier generated by cart

article_id

string

operation

string

Required

Enum

Response

200

Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResponseObject` for more details.

UpdateCartDetailResponseObject

success

boolean

true if all items are added successfully. false if partially added or not added.

cart

object (CartDetailResponseObject)

CartDetailResponseObject

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.

string

Unique identifier of the user cart.

error_message

string

Error message of the predicted shipment.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Staff employee user id if cart is created by staff employee for the customer.

success

boolean

Success flag of get cart detail API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

Last modified timestamp of cart.

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

buy_now

boolean

Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

custom_cart_meta

object

Custom meta details added cart checkout API payload .

error_code

string

Nullable

Error code corresponding to error in cart.

message

string

result

object

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

cart_id:

"65c06fe589db42581e4be72e"

body:

body

Was this section helpful?

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/abandoned/carts/{cart_id}

Response

POST

Create Fynd order with overriding cart details

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.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

cart_id

string

Required

payment_mode

string

Required

billing_address

object

merchant_code

string

Required

payment_identifier

string

Required

currency_code

string

Required

aggregator

string

Required

order_type

string

Required

callback_url

string

cart_items

array of object (OverrideCartItem)

Required

Array of OverrideCartItem

seller_identifier

string

quantity

number

size

string

Required

price_marked

number

Required

amount_paid

number

Required

promo_list

array of object (OverrideCartItemPromo)

Array of OverrideCartItemPromo

restrictions

object

promo_id

string

Required

promo_amount

string

Required

promo_desc

string

rwrd_tndr

string

item_list

array of object

parent_promo_id

string

extra_meta

object

item_id

integer

Required

discount

number

Required

price_effective

number

Required

ordering_store

integer

| int32

Nullable

Default Value : null

shipping_address

object

Response

200

Checkout cart and create Fynd order id

OverrideCheckoutResponseObject

data

object

cart

object

success

boolean

order_id

string

message

string

callback_url

string

payment_confirm_url

string

app_intercept_url

string

Examples

Parameters

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/checkout/over-ride

Response

GET

Fetch all items added to the customer cart using cart id

Use this API to get details of all the items added to a cart.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart

user_id

string

Option to fetch cart for the provided user_id.

boolean

This is a boolean value. Select `true` to retrieve all the items added in the cart.

boolean

This is a boolean value. Select `true` to retrieve the price breakup of cart items.

assign_card_id

number

Token of user's debit or credit card

buy_now

boolean

This is a boolen value. Select `true` to set/initialize buy now cart

cart_type

string

The type of cart

Enum

Response

200

400

Success. Returns a Cart object. Check the example shown below or refer `CartDetailResponseObject` for more details.

CartDetailResponseObject

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.

string

Unique identifier of the user cart.

error_message

string

Error message of the predicted shipment.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Staff employee user id if cart is created by staff employee for the customer.

success

boolean

Success flag of get cart detail API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

Last modified timestamp of cart.

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

buy_now

boolean

Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

custom_cart_meta

object

Custom meta details added cart checkout API payload .

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

id:

"65c06fe589db42581e4be72e"

user_id:

"5c5c0b0a3fe3c6d1ae4ea1fc"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/detail

Response

POST

Checkout cart

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.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart

cart_type

string

The type of cart

Enum

Request body

custom_meta

array of object (CartCheckoutCustomMeta)

Array of CartCheckoutCustomMeta

key

string

Required

value

string

Required

address_id

string

payment_identifier

string

Nullable

payment_params

object

Nullable

payment_auto_confirm

boolean

string

Required

pos

boolean

billing_address_id

string

merchant_code

string

aggregator

string

pick_at_store_uid

integer

| int32

Nullable

Default Value : null

device_id

string

Nullable

delivery_address

object

payment_mode

string

Required

checkout_mode

string

customer_details

object (CustomerDetails)

Nullable

Customer details

CustomerDetails

name

string

Nullable

mobile

string

Required

meta

object

staff

object (StaffCheckout)

StaffCheckout

employee_code

string

_id

string

Required

user

string

Required

last_name

string

Required

first_name

string

Required

employee_code

string

Nullable

billing_address

object

callback_url

string

Nullable

Default Value : null

user_id

string

Nullable

extra_meta

object

order_type

string

Required

files

array of object (Files)

List of file url

Array of Files

key

string

Required

values

array of string

Required

ordering_store

integer

| int32

Nullable

payment_extra_identifiers

object

iin

string

network

string

type

string

card_id

string

Response

200

Success. Returns the status of cart checkout. Refer `CartCheckoutResponseObject` for more details.

CartCheckoutResponseObject

app_intercept_url

string

error_message

string

Error message of the checkout API.

data

object

cart

object (CheckCart)

CheckCart

cart_id

integer

| int32

Cart id of the user cart for which the order placed.

uid

string

Cart id of user cart.

coupon_text

string

Coupon text of the applied coupon on order placed.

string

Cart id of the user cart.

error_message

string

Error message of the cart checkout API response.

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message added in cart after order placed.

items

array of object (CartProductInfo)

Items details in cart after order placed.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the cart checkout 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 checkout cart API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

is_valid

boolean

Valid flag fotr the checkout response if order placed was valid.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

checkout_mode

string

Checkout mode of user cart.

last_modified

string

Last modified timestamp of cart.

buy_now

boolean

Buy now flag of user cart.

gstin

string

Nullable

GSTIN number added in cart.

applied_promo_details

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

price_adjustment_applied

array of object (PriceAdjustmentApplied)

Array of PriceAdjustmentApplied

applied_articles_ids

array of object

adjusted_value

object

applied_quantity

number

meta

object

article_level_distribution

boolean

type

string

remove_articles

boolean

auto_remove

boolean

message

string

restrictions

object

_id

string

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

pan_config

object

Pan card config states at what condition user should enter the pan card.

order_id

string

Order id generated after placing order.

custom_cart_meta

object

Custom cart meta details added in cart.

cod_available

boolean

Whether Cash On Delivery available it true.

delivery_charges

number

| float

Delivery charges of the order placed via checkout API.

error_code

string

Nullable

Error code corresponding to error in cart.

success

boolean

callback_url

string

payment_confirm_url

string

Nullable

order_id

string

message

string

Examples

Parameters

id:

"65c06fe589db42581e4be72e"

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/checkout

Response

POST

Cart checkout (latest)

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.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart

cart_type

string

The type of cart

Enum

Request body

address_id

string

payment_identifier

string

Nullable

payment_params

object

Nullable

custom_meta

object

payment_auto_confirm

boolean

string

Required

pos

boolean

billing_address_id

string

merchant_code

string

aggregator

string

pick_at_store_uid

integer

| int32

Nullable

Default Value : null

device_id

string

Nullable

delivery_address

object

payment_mode

string

checkout_mode

string

customer_details

object (CustomerDetails)

Nullable

Customer details

CustomerDetails

name

string

Nullable

mobile

string

Required

meta

object

payment_methods

array of object (PaymentMethod)

Required

Array of PaymentMethod

mode

string

Required

payment

string

payment_meta

object (PaymentMeta)

Required

PaymentMeta

payment_gateway

string

type

string

payment_identifier

string

Nullable

merchant_code

string

payment_identifier

string

Nullable

amount

number

| float

Nullable

name

string

payment_extra_identifiers

object

staff

object (StaffCheckout)

StaffCheckout

employee_code

string

_id

string

Required

user

string

Required

last_name

string

Required

first_name

string

Required

employee_code

string

Nullable

billing_address

object

callback_url

string

Nullable

Default Value : null

user_id

string

Nullable

extra_meta

object

order_type

string

Required

files

array of object (Files)

List of file url

Array of Files

key

string

Required

values

array of string

Required

ordering_store

integer

| int32

Nullable

iin

string

network

string

type

string

card_id

string

Response

200

Success. Returns the status of cart checkout. Refer `CartCheckoutResponseSchema` for more details.

CartCheckoutResponseObject

app_intercept_url

string

error_message

string

Error message of the checkout API.

data

object

cart

object (CheckCart)

CheckCart

cart_id

integer

| int32

Cart id of the user cart for which the order placed.

uid

string

Cart id of user cart.

coupon_text

string

Coupon text of the applied coupon on order placed.

string

Cart id of the user cart.

error_message

string

Error message of the cart checkout API response.

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message added in cart after order placed.

items

array of object (CartProductInfo)

Items details in cart after order placed.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the cart checkout 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 checkout cart API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

is_valid

boolean

Valid flag fotr the checkout response if order placed was valid.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

checkout_mode

string

Checkout mode of user cart.

last_modified

string

Last modified timestamp of cart.

buy_now

boolean

Buy now flag of user cart.

gstin

string

Nullable

GSTIN number added in cart.

applied_promo_details

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

price_adjustment_applied

array of object (PriceAdjustmentApplied)

Array of PriceAdjustmentApplied

applied_articles_ids

array of object

adjusted_value

object

applied_quantity

number

meta

object

article_level_distribution

boolean

type

string

remove_articles

boolean

auto_remove

boolean

message

string

restrictions

object

_id

string

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

pan_config

object

Pan card config states at what condition user should enter the pan card.

order_id

string

Order id generated after placing order.

custom_cart_meta

object

Custom cart meta details added in cart.

cod_available

boolean

Whether Cash On Delivery available it true.

delivery_charges

number

| float

Delivery charges of the order placed via checkout API.

error_code

string

Nullable

Error code corresponding to error in cart.

success

boolean

callback_url

string

payment_confirm_url

string

Nullable

order_id

string

message

string

Examples

Parameters

id:

"65c06fe589db42581e4be72e"

body:

body

Was this section helpful?

POST

/service/platform/cart/v2.0/company/{company_id}/application/{application_id}/checkout

Response

Coupon

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

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon

# Create a new coupon.

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon

# Retrieve available coupons.

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon-tags

# Get a list of all coupon tags associated with a application.

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon/{id}

# Get coupon details by ID

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon/{id}

# Update a coupon

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon_code_exists

# Check if coupon is already created with coupon code

DEL

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/platform-pos-coupon

# Remove Applied Coupon for platform pos user

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/payment/validate/

# Validate applied coupon

POST

Create a new coupon.

Generate and add a new coupon to the cart.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

body

object (CouponAdd)

Required

CouponAdd

date_meta

object (CouponDateMeta)

CouponDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

ownership

object (Ownership)

Required

Ownership

payable_category

string

Required

Promotion amount payable category.

Enum

payable_by

string

Required

Promotion amount bearable party.

author

object (CouponAuthor)

CouponAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

state

object (State)

State

is_archived

boolean

Default Value : false

is_display

boolean

Default Value : true

is_public

boolean

Default Value : true

is_active

boolean

Default Value : true

restrictions

object (Restrictions)

Restrictions

payments

object

user_type

string

price_range

object (PriceRange)

PriceRange

max

integer

| int32

Default Value : -1

min

integer

| int32

Default Value : -1

platforms

array of string

post_order

object (PostOrder)

PostOrder

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

bulk_bundle

object (BulkBundleRestriction)

BulkBundleRestriction

multi_store_allowed

boolean

Required

user_groups

array of integer

coupon_allowed

boolean

uses

object (UsesRestriction)

UsesRestriction

maximum

object (UsesRemaining)

UsesRemaining

user

integer

| int32

total

integer

| int32

app

integer

| int32

remaining

object (UsesRemaining)

UsesRemaining

user

integer

| int32

total

integer

| int32

app

integer

| int32

ordering_stores

array of integer

validation

object (Validation)

Validation

app_id

array of string

Default Value :

anonymous

boolean

user_registered_after

string

| date-time

Nullable

Default Value : null

action

object (CouponAction)

CouponAction

action_date

string

| date-time

Nullable

Default Value : null

txn_mode

string

Default Value : coupon

Enum

tags

array of string

Default Value :

_schedule

object (CouponSchedule)

CouponSchedule

end

string

start

string

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

Default Value : null

duration

integer

| int32

Nullable

Default Value : null

status

string

Enum

rule

array of object (Rule)

Required

Array of Rule

key

number

| float

value

number

| float

max

number

| float

discount_qty

number

| float

min

number

| float

display_meta

object (DisplayMeta)

Required

DisplayMeta

title

string

auto

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

apply

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

remove

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

subtitle

string

description

string

code

string

Required

type_slug

string

Required

identifiers

object (Identifier)

Required

Identifier

brand_id

array of integer

company_id

array of integer

store_id

array of integer

collection_id

array of string

item_id

array of integer

user_id

array of string

category_id

array of integer

article_id

array of string

exclude_brand_id

array of integer

email_domain

array of string

validity

object (Validity)

Required

Validity

priority

integer

| int32

rule_definition

object (RuleDefinition)

Required

RuleDefinition

currency_code

string

Default Value : INR

auto_apply

boolean

type

string

Required

Enum

is_exact

boolean

Default Value : false

applicable_on

string

Required

Enum

calculate_on

string

Enum

value_type

string

Enum

scope

array of string

Enum

_id

string

Coupon id

is_plt_bypass

boolean

Declare to true if the coupon should bypass the PLT rules

Request body

date_meta

object (CouponDateMeta)

CouponDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

ownership

object (Ownership)

Required

Ownership

payable_category

string

Required

Promotion amount payable category.

Enum

payable_by

string

Required

Promotion amount bearable party.

author

object (CouponAuthor)

CouponAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

state

object (State)

State

is_archived

boolean

Default Value : false

is_display

boolean

Default Value : true

is_public

boolean

Default Value : true

is_active

boolean

Default Value : true

restrictions

object (Restrictions)

Restrictions

payments

object

user_type

string

price_range

object (PriceRange)

PriceRange

max

integer

| int32

Default Value : -1

min

integer

| int32

Default Value : -1

platforms

array of string

post_order

object (PostOrder)

PostOrder

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

bulk_bundle

object (BulkBundleRestriction)

BulkBundleRestriction

multi_store_allowed

boolean

Required

user_groups

array of integer

coupon_allowed

boolean

uses

object (UsesRestriction)

UsesRestriction

maximum

object (UsesRemaining)

UsesRemaining

user

integer

| int32

total

integer

| int32

app

integer

| int32

remaining

object (UsesRemaining)

UsesRemaining

user

integer

| int32

total

integer

| int32

app

integer

| int32

ordering_stores

array of integer

validation

object (Validation)

Validation

app_id

array of string

Default Value :

anonymous

boolean

user_registered_after

string

| date-time

Nullable

Default Value : null

action

object (CouponAction)

CouponAction

action_date

string

| date-time

Nullable

Default Value : null

txn_mode

string

Default Value : coupon

Enum

tags

array of string

Default Value :

_schedule

object (CouponSchedule)

CouponSchedule

end

string

start

string

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

Default Value : null

duration

integer

| int32

Nullable

Default Value : null

status

string

Enum

rule

array of object (Rule)

Required

Array of Rule

key

number

| float

value

number

| float

max

number

| float

discount_qty

number

| float

min

number

| float

display_meta

object (DisplayMeta)

Required

DisplayMeta

title

string

auto

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

apply

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

remove

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

subtitle

string

description

string

code

string

Required

type_slug

string

Required

identifiers

object (Identifier)

Required

Identifier

brand_id

array of integer

company_id

array of integer

store_id

array of integer

collection_id

array of string

item_id

array of integer

user_id

array of string

category_id

array of integer

article_id

array of string

exclude_brand_id

array of integer

email_domain

array of string

validity

object (Validity)

Required

Validity

priority

integer

| int32

rule_definition

object (RuleDefinition)

Required

RuleDefinition

currency_code

string

Default Value : INR

auto_apply

boolean

type

string

Required

Enum

is_exact

boolean

Default Value : false

applicable_on

string

Required

Enum

calculate_on

string

Enum

value_type

string

Enum

scope

array of string

Enum

_id

string

Coupon id

is_plt_bypass

boolean

Declare to true if the coupon should bypass the PLT rules

Response

201

400

Coupon Created successfully

CouponDetailResponseObject

success

boolean

message

string

data

object (CouponDetailObj)

CouponDetailObj

coupon_type

string

coupon_prefix

string

coupon_counts

number

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

date_meta

object (CouponDateMeta)

CouponDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

ownership

object (Ownership)

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

author

object (CouponAuthor)

CouponAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

state

object (State)

State

is_archived

boolean

Default Value : false

is_display

boolean

Default Value : true

is_public

boolean

Default Value : true

is_active

boolean

Default Value : true

restrictions

object (Restrictions)

Restrictions

payments

object

user_type

string

price_range

object (PriceRange)

PriceRange

max

integer

| int32

Default Value : -1

min

integer

| int32

Default Value : -1

platforms

array of string

post_order

object (PostOrder)

PostOrder

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

bulk_bundle

object (BulkBundleRestriction)

BulkBundleRestriction

multi_store_allowed

boolean

user_groups

array of integer

coupon_allowed

boolean

uses

object (UsesRestriction)

UsesRestriction

maximum

object (UsesRemaining)

UsesRemaining

user

integer

| int32

total

integer

| int32

app

integer

| int32

remaining

object (UsesRemaining)

UsesRemaining

user

integer

| int32

total

integer

| int32

app

integer

| int32

ordering_stores

array of integer

validation

object (Validation)

Validation

app_id

array of string

Default Value :

anonymous

boolean

user_registered_after

string

| date-time

Nullable

Default Value : null

action

object (CouponAction)

CouponAction

action_date

string

| date-time

Nullable

Default Value : null

txn_mode

string

Default Value : coupon

Enum

tags

array of string

Default Value :

_schedule

object (CouponSchedule)

CouponSchedule

end

string

start

string

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

Default Value : null

duration

integer

| int32

Nullable

Default Value : null

status

string

Enum

rule

array of object (Rule)

Array of Rule

key

number

| float

value

number

| float

max

number

| float

discount_qty

number

| float

min

number

| float

display_meta

object (DisplayMeta)

DisplayMeta

title

string

auto

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

apply

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

remove

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

subtitle

string

description

string

code

string

type_slug

string

identifiers

object (Identifier)

Identifier

brand_id

array of integer

company_id

array of integer

store_id

array of integer

collection_id

array of string

item_id

array of integer

user_id

array of string

category_id

array of integer

article_id

array of string

exclude_brand_id

array of integer

email_domain

array of string

validity

object (Validity)

Validity

priority

integer

| int32

rule_definition

object (RuleDefinition)

RuleDefinition

currency_code

string

Default Value : INR

auto_apply

boolean

type

string

Enum

is_exact

boolean

Default Value : false

applicable_on

string

Enum

calculate_on

string

Enum

value_type

string

Enum

scope

array of string

Enum

_id

string

Coupon id

is_archived

boolean

Examples

Parameters

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon

Response

GET

Retrieve available coupons.

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.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

page_no

integer

current page no as per pagination

Default Value : 0

page_size

integer

Coupon max records fetched in single request

Default Value : 10

is_archived

boolean

Filter by active or inactive coupon

Default Value : false

title

string

Filter by `title`

is_public

boolean

Filter by `is_public`

is_display

boolean

Filter by `is_display`

type_slug

string

Filter by coupon type

code

string

Filter by `code`

Response

200

Coupon List for sent page_size and page_no

CouponsResponseObject

draft

number

Nullable

review

number

Nullable

rejected

number

Nullable

approved

number

Nullable

items

array of object (CouponObj)

Array of CouponObj

draft

number

Nullable

review

number

Nullable

rejected

number

Nullable

approved

number

Nullable

date_meta

object (CouponDateMeta)

CouponDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

ownership

object (Ownership)

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

author

object (CouponAuthor)

CouponAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

state

object (State)

State

is_archived

boolean

Default Value : false

is_display

boolean

Default Value : true

is_public

boolean

Default Value : true

is_active

boolean

Default Value : true

_schedule

object (CouponSchedule)

CouponSchedule

end

string

start

string

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

Default Value : null

duration

integer

| int32

Nullable

Default Value : null

status

string

Enum

display_meta

object (DisplayMeta)

DisplayMeta

title

string

auto

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

apply

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

remove

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

subtitle

string

description

string

code

string

type_slug

string

rule_definition

object (RuleDefinition)

RuleDefinition

currency_code

string

Default Value : INR

auto_apply

boolean

type

string

Enum

is_exact

boolean

Default Value : false

applicable_on

string

Enum

calculate_on

string

Enum

value_type

string

Enum

scope

array of string

Enum

_id

string

Coupon id

medias

array of object (CouponMedias)

Array of CouponMedias

alt

string

url

string

type

string

key

string

identifiers

object (Identifier)

Identifier

brand_id

array of integer

company_id

array of integer

store_id

array of integer

collection_id

array of string

item_id

array of integer

user_id

array of string

category_id

array of integer

article_id

array of string

exclude_brand_id

array of integer

email_domain

array of string

validity

object (Validity)

Validity

priority

integer

| int32

rule

array of object (Rule)

Array of Rule

key

number

| float

value

number

| float

max

number

| float

discount_qty

number

| float

min

number

| float

is_archived

boolean

page

object (Page)

Page

has_next

boolean

true if more records are present for next pages

item_total

integer

| int32

Total coupon count in system

current

integer

| int32

Current page no

next_id

string

Cursor id for next set of records.

page

integer

| int32

Page requested

last_id

string

Nullable

Last objects id

type

string

size

integer

| int32

Current request page size

has_previous

boolean

true if more records are present for previous pages. Sent for cursor pagination

success

boolean

Examples

Parameters

page_no:

page_size:

is_public:

true

is_display:

true

type_slug:

"bundle_quantity_absolute"

code:

"1001off"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon

Response

GET

Get a list of all coupon tags associated with a application.

This API helps to get coupon tags data associated to a particular application.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

integer

Required

ID of the application for which tags are to be fetched.

Response

200

Tag List. See example below for details

TagsViewResponseObject

success

boolean

items

array of string

Default Value :

Examples

Parameters

Parameters are not required.

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon-tags

Response

GET

Get coupon details by ID

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.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

Coupon mongo _id for fetching single coupon data for editing

Response

200

404

Coupon object for sent `id`

CouponUpdate

date_meta

object (CouponDateMeta)

CouponDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

coupon_type

string

Enum

coupon_prefix

string

coupon_counts

number

medias

array of object (CouponMedias)

Array of CouponMedias

alt

string

url

string

type

string

key

string

ownership

object (Ownership)

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

author

object (CouponAuthor)

CouponAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

state

object (State)

State

is_archived

boolean

Default Value : false

is_display

boolean

Default Value : true

is_public

boolean

Default Value : true

is_active

boolean

Default Value : true

restrictions

object (Restrictions)

Restrictions

payments

object

user_type

string

price_range

object (PriceRange)

PriceRange

max

integer

| int32

Default Value : -1

min

integer

| int32

Default Value : -1

platforms

array of string

post_order

object (PostOrder)

PostOrder

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

bulk_bundle

object (BulkBundleRestriction)

BulkBundleRestriction

multi_store_allowed

boolean

user_groups

array of integer

coupon_allowed

boolean

uses

object (UsesRestriction)

UsesRestriction

maximum

object (UsesRemaining)

UsesRemaining

user

integer

| int32

total

integer

| int32

app

integer

| int32

remaining

object (UsesRemaining)

UsesRemaining

user

integer

| int32

total

integer

| int32

app

integer

| int32

ordering_stores

array of integer

validation

object (Validation)

Validation

app_id

array of string

Default Value :

anonymous

boolean

user_registered_after

string

| date-time

Nullable

Default Value : null

action

object (CouponAction)

CouponAction

action_date

string

| date-time

Nullable

Default Value : null

txn_mode

string

Default Value : coupon

Enum

tags

array of string

Default Value :

_schedule

object (CouponSchedule)

CouponSchedule

end

string

start

string

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

Default Value : null

duration

integer

| int32

Nullable

Default Value : null

status

string

Enum

rule

array of object (Rule)

Array of Rule

key

number

| float

value

number

| float

max

number

| float

discount_qty

number

| float

min

number

| float

display_meta

object (DisplayMeta)

DisplayMeta

title

string

auto

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

apply

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

remove

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

subtitle

string

description

string

code

string

type_slug

string

identifiers

object (Identifier)

Identifier

brand_id

array of integer

company_id

array of integer

store_id

array of integer

collection_id

array of string

item_id

array of integer

user_id

array of string

category_id

array of integer

article_id

array of string

exclude_brand_id

array of integer

email_domain

array of string

validity

object (Validity)

Validity

priority

integer

| int32

rule_definition

object (RuleDefinition)

RuleDefinition

currency_code

string

Default Value : INR

auto_apply

boolean

type

string

Enum

is_exact

boolean

Default Value : false

applicable_on

string

Enum

calculate_on

string

Enum

value_type

string

Enum

scope

array of string

Enum

_id

string

is_archived

boolean

is_plt_bypass

boolean

Declare to true if the coupon should bypass the PLT rules

Examples

Parameters

id:

"5f92ac427715e600016115f1"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon/{id}

Response

PUT

Update a coupon

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.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

Coupon mongo _id for fetching single coupon data for editing

body

object (CouponUpdate)

Required

CouponUpdate

date_meta

object (CouponDateMeta)

CouponDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

coupon_type

string

Enum

coupon_prefix

string

coupon_counts

number

medias

array of object (CouponMedias)

Array of CouponMedias

alt

string

url

string

type

string

key

string

ownership

object (Ownership)

Required

Ownership

payable_category

string

Required

Promotion amount payable category.

Enum

payable_by

string

Required

Promotion amount bearable party.

author

object (CouponAuthor)

CouponAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

state

object (State)

State

is_archived

boolean

Default Value : false

is_display

boolean

Default Value : true

is_public

boolean

Default Value : true

is_active

boolean

Default Value : true

restrictions

object (Restrictions)

Restrictions

payments

object

user_type

string

price_range

object (PriceRange)

PriceRange

max

integer

| int32

Default Value : -1

min

integer

| int32

Default Value : -1

platforms

array of string

post_order

object (PostOrder)

PostOrder

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

bulk_bundle

object (BulkBundleRestriction)

BulkBundleRestriction

multi_store_allowed

boolean

Required

user_groups

array of integer

coupon_allowed

boolean

uses

object (UsesRestriction)

UsesRestriction

maximum

object (UsesRemaining)

UsesRemaining

user

integer

| int32

total

integer

| int32

app

integer

| int32

remaining

object (UsesRemaining)

UsesRemaining

user

integer

| int32

total

integer

| int32

app

integer

| int32

ordering_stores

array of integer

validation

object (Validation)

Validation

app_id

array of string

Default Value :

anonymous

boolean

user_registered_after

string

| date-time

Nullable

Default Value : null

action

object (CouponAction)

CouponAction

action_date

string

| date-time

Nullable

Default Value : null

txn_mode

string

Default Value : coupon

Enum

tags

array of string

Default Value :

_schedule

object (CouponSchedule)

CouponSchedule

end

string

start

string

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

Default Value : null

duration

integer

| int32

Nullable

Default Value : null

status

string

Enum

rule

array of object (Rule)

Required

Array of Rule

key

number

| float

value

number

| float

max

number

| float

discount_qty

number

| float

min

number

| float

display_meta

object (DisplayMeta)

Required

DisplayMeta

title

string

auto

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

apply

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

remove

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

subtitle

string

description

string

code

string

Required

type_slug

string

Required

identifiers

object (Identifier)

Required

Identifier

brand_id

array of integer

company_id

array of integer

store_id

array of integer

collection_id

array of string

item_id

array of integer

user_id

array of string

category_id

array of integer

article_id

array of string

exclude_brand_id

array of integer

email_domain

array of string

validity

object (Validity)

Required

Validity

priority

integer

| int32

rule_definition

object (RuleDefinition)

Required

RuleDefinition

currency_code

string

Default Value : INR

auto_apply

boolean

type

string

Required

Enum

is_exact

boolean

Default Value : false

applicable_on

string

Required

Enum

calculate_on

string

Enum

value_type

string

Enum

scope

array of string

Enum

_id

string

is_archived

boolean

is_plt_bypass

boolean

Declare to true if the coupon should bypass the PLT rules

Request body

date_meta

object (CouponDateMeta)

CouponDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

coupon_type

string

Enum

coupon_prefix

string

coupon_counts

number

medias

array of object (CouponMedias)

Array of CouponMedias

alt

string

url

string

type

string

key

string

ownership

object (Ownership)

Required

Ownership

payable_category

string

Required

Promotion amount payable category.

Enum

payable_by

string

Required

Promotion amount bearable party.

author

object (CouponAuthor)

CouponAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

state

object (State)

State

is_archived

boolean

Default Value : false

is_display

boolean

Default Value : true

is_public

boolean

Default Value : true

is_active

boolean

Default Value : true

restrictions

object (Restrictions)

Restrictions

payments

object

user_type

string

price_range

object (PriceRange)

PriceRange

max

integer

| int32

Default Value : -1

min

integer

| int32

Default Value : -1

platforms

array of string

post_order

object (PostOrder)

PostOrder

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

bulk_bundle

object (BulkBundleRestriction)

BulkBundleRestriction

multi_store_allowed

boolean

Required

user_groups

array of integer

coupon_allowed

boolean

uses

object (UsesRestriction)

UsesRestriction

maximum

object (UsesRemaining)

UsesRemaining

user

integer

| int32

total

integer

| int32

app

integer

| int32

remaining

object (UsesRemaining)

UsesRemaining

user

integer

| int32

total

integer

| int32

app

integer

| int32

ordering_stores

array of integer

validation

object (Validation)

Validation

app_id

array of string

Default Value :

anonymous

boolean

user_registered_after

string

| date-time

Nullable

Default Value : null

action

object (CouponAction)

CouponAction

action_date

string

| date-time

Nullable

Default Value : null

txn_mode

string

Default Value : coupon

Enum

tags

array of string

Default Value :

_schedule

object (CouponSchedule)

CouponSchedule

end

string

start

string

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

Default Value : null

duration

integer

| int32

Nullable

Default Value : null

status

string

Enum

rule

array of object (Rule)

Required

Array of Rule

key

number

| float

value

number

| float

max

number

| float

discount_qty

number

| float

min

number

| float

display_meta

object (DisplayMeta)

Required

DisplayMeta

title

string

auto

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

apply

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

remove

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

subtitle

string

description

string

code

string

Required

type_slug

string

Required

identifiers

object (Identifier)

Required

Identifier

brand_id

array of integer

company_id

array of integer

store_id

array of integer

collection_id

array of string

item_id

array of integer

user_id

array of string

category_id

array of integer

article_id

array of string

exclude_brand_id

array of integer

email_domain

array of string

validity

object (Validity)

Required

Validity

priority

integer

| int32

rule_definition

object (RuleDefinition)

Required

RuleDefinition

currency_code

string

Default Value : INR

auto_apply

boolean

type

string

Required

Enum

is_exact

boolean

Default Value : false

applicable_on

string

Required

Enum

calculate_on

string

Enum

value_type

string

Enum

scope

array of string

Enum

_id

string

is_archived

boolean

is_plt_bypass

boolean

Declare to true if the coupon should bypass the PLT rules

Response

200

404

Coupon updated successfully

CouponDetailResponseObject

success

boolean

message

string

data

object (CouponDetailObj)

CouponDetailObj

coupon_type

string

coupon_prefix

string

coupon_counts

number

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

date_meta

object (CouponDateMeta)

CouponDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

ownership

object (Ownership)

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

author

object (CouponAuthor)

CouponAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

state

object (State)

State

is_archived

boolean

Default Value : false

is_display

boolean

Default Value : true

is_public

boolean

Default Value : true

is_active

boolean

Default Value : true

restrictions

object (Restrictions)

Restrictions

payments

object

user_type

string

price_range

object (PriceRange)

PriceRange

max

integer

| int32

Default Value : -1

min

integer

| int32

Default Value : -1

platforms

array of string

post_order

object (PostOrder)

PostOrder

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

bulk_bundle

object (BulkBundleRestriction)

BulkBundleRestriction

multi_store_allowed

boolean

user_groups

array of integer

coupon_allowed

boolean

uses

object (UsesRestriction)

UsesRestriction

maximum

object (UsesRemaining)

UsesRemaining

user

integer

| int32

total

integer

| int32

app

integer

| int32

remaining

object (UsesRemaining)

UsesRemaining

user

integer

| int32

total

integer

| int32

app

integer

| int32

ordering_stores

array of integer

validation

object (Validation)

Validation

app_id

array of string

Default Value :

anonymous

boolean

user_registered_after

string

| date-time

Nullable

Default Value : null

action

object (CouponAction)

CouponAction

action_date

string

| date-time

Nullable

Default Value : null

txn_mode

string

Default Value : coupon

Enum

tags

array of string

Default Value :

_schedule

object (CouponSchedule)

CouponSchedule

end

string

start

string

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

Default Value : null

duration

integer

| int32

Nullable

Default Value : null

status

string

Enum

rule

array of object (Rule)

Array of Rule

key

number

| float

value

number

| float

max

number

| float

discount_qty

number

| float

min

number

| float

display_meta

object (DisplayMeta)

DisplayMeta

title

string

auto

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

apply

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

remove

object (DisplayMetaDict)

DisplayMetaDict

title

string

subtitle

string

subtitle

string

description

string

code

string

type_slug

string

identifiers

object (Identifier)

Identifier

brand_id

array of integer

company_id

array of integer

store_id

array of integer

collection_id

array of string

item_id

array of integer

user_id

array of string

category_id

array of integer

article_id

array of string

exclude_brand_id

array of integer

email_domain

array of string

validity

object (Validity)

Validity

priority

integer

| int32

rule_definition

object (RuleDefinition)

RuleDefinition

currency_code

string

Default Value : INR

auto_apply

boolean

type

string

Enum

is_exact

boolean

Default Value : false

applicable_on

string

Enum

calculate_on

string

Enum

value_type

string

Enum

scope

array of string

Enum

_id

string

Coupon id

is_archived

boolean

Examples

Parameters

id:

"5f92ac427715e600016115f1"

body:

body

Was this section helpful?

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon/{id}

Response

GET

Check if coupon is already created with coupon code

Validates the presence of a coupon code for the specified sales channel to verify whether the provided code already exists or not.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

code

string

Coupon code

Response

200

400

Valid response with existing coupon code count

Properties

success

boolean

count

integer

Examples

Parameters

code:

"t_flat_100"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/coupon_code_exists

Response

DEL

Remove Applied Coupon for platform pos user

Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

uid

string

The unique identifier of the cart

buy_now

boolean

This is boolean to get buy_now cart

cart_type

string

The type of cart

Enum

Response

200

Success. Returns coupons removed from the cart along with item details and price breakup. Refer `CartDetailResponseObject` for more details.

CartDetailResponseObject

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.

string

Unique identifier of the user cart.

error_message

string

Error message of the predicted shipment.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Staff employee user id if cart is created by staff employee for the customer.

success

boolean

Success flag of get cart detail API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

Last modified timestamp of cart.

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

buy_now

boolean

Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

custom_cart_meta

object

Custom meta details added cart checkout API payload .

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

uid:

"65c06fe589db42581e4be72e"

Was this section helpful?

DEL

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/platform-pos-coupon

Response

GET

Validate applied coupon

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.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _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

iin

string

Debit/Credit card prefix (first 6 digit)

network

string

Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY

type

string

card type, e.g. Credit, Debit

card_id

string

saved card token reference id

cart_type

string

type of the cart

Enum

Response

200

Success. Returns a success message and the coupon validity. Refer `PaymentCouponValidate` for more details.

PaymentCouponValidate

success

boolean

message

string

coupon_validity

object (CouponValidity)

CouponValidity

title

string

next_validation_required

boolean

Nullable

valid

boolean

display_message_en

string

Nullable

code

string

Nullable

discount

number

| float

Examples

Parameters

id:

"65c06fe589db42581e4be72e"

address_id:

"65bb5a41feeb84432e132c03"

payment_mode:

"NB"

payment_identifier:

"ICIC"

aggregator_name:

"Razorpay"

merchant_code:

"NB_ICIC"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/payment/validate/

Response

Customer address

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

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/address

# Add address to an account

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/address

# Get a list of addresses for a customer

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/address/{id}

# Get details for a single customer address

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/address/{id}

# Updates an existing customer address

DEL

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/address/{id}

# Removes an address from a customer's address list

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/select-address

# Select customer address for order processing

POST

Add address to an account

Use this API to add an address to an account.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

pincode

number

Nullable

phone

string

area_code_slug

string

country_code

string

geo_location

object (GeoLocation)

GeoLocation

longitude

number

| float

Default Value : 0

latitude

number

| float

Default Value : 0

country

string

state

string

is_default_address

boolean

tags

array of string

created_by_user_id

string

landmark

string

Nullable

area_code

string

checkout_mode

string

meta

object

is_active

boolean

name

string

google_map_point

object

cart_id

string

city

string

sector

string

state_code

string

State code for international address

area

string

user_id

string

address_type

string

address

string

country_phone_code

string

country_iso_code

string

_custom_json

object (AddressCustomJson)

AddressCustomJson

meta_data

string

meta_data_int

number

uid

number

is_anonymous

boolean

app_id

string

expire_at

string

| date-time

Nullable

address_id

string

Nullable

store_name

string

Nullable

Response

200

Success. Returns the address ID, a flag whether the address is set as default, and a success message. Refer `SaveAddressResponseObject` for more details.

SaveAddressResponseObject

string

success

boolean

is_default_address

boolean

address_id

string

oneOf Schema from below

Examples

Parameters

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/address

Response

GET

Get a list of addresses for a customer

Retrieves a list of all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

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

checkout_mode

string

Option to checkout for `self` or for `others`. By default, it is `self`.

Enum

tags

string

Tag given to an address, e.g. work, home, office, shop.

Enum

is_default

boolean

This is a boolean value. Select `true` to fetch the default address.

user_id

string

Option to fetch address for the provided user_id.

Response

200

400

Success. Returns an Address object containing a list of address saved in the account. Refer `PlatformGetAddressesResponseObject` for more details.

PlatformGetAddressesResponseObject

address

array of object (PlatformAddress)

Array of PlatformAddress

pincode

number

Nullable

phone

string

area_code_slug

string

country_code

string

geo_location

object (GeoLocation)

GeoLocation

longitude

number

| float

Default Value : 0

latitude

number

| float

Default Value : 0

country

string

state

string

is_default_address

boolean

tags

array of string

created_by_user_id

string

landmark

string

Nullable

area_code

string

checkout_mode

string

meta

object

is_active

boolean

name

string

google_map_point

object

cart_id

string

city

string

sector

string

state_code

string

State code for international address

area

string

user_id

string

address_type

string

address

string

country_phone_code

string

country_iso_code

string

_custom_json

object (AddressCustomJson)

AddressCustomJson

meta_data

string

meta_data_int

number

uid

number

is_anonymous

boolean

app_id

string

expire_at

string

| date-time

Nullable

address_id

string

Nullable

store_name

string

Nullable

pii_masking

boolean

validation_config

object (ValidationConfig)

ValidationConfig

address_max_limit

integer

| int32

The maximum number of addresses a user can have.

user_address_count

integer

| int32

The total number of addresses saved by a user.

Examples

Parameters

cart_id:

"5c5c0b0a3fe3c6d1ae4ea1fc"

mobile_no:

9915347757

user_id:

"5c5c0b0a3fe3c6d1ae4ea1fc"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/address

Response

GET

Get details for a single customer address

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.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _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

checkout_mode

string

Option to checkout for self or for others

Enum

tags

string

Tag given to an address, e.g. work, home, office, shop.

Enum

is_default

boolean

This is a boolean value. Select `true` to fetch the default address.

user_id

string

Option to fetch address for the provided user_id.

Response

200

400

Success. Returns an PlatformAddress object containing a list of address saved in the account. Refer `PlatformAddress` for more details.

PlatformAddress

pincode

number

Nullable

phone

string

area_code_slug

string

country_code

string

geo_location

object (GeoLocation)

GeoLocation

longitude

number

| float

Default Value : 0

latitude

number

| float

Default Value : 0

country

string

state

string

is_default_address

boolean

tags

array of string

created_by_user_id

string

landmark

string

Nullable

area_code

string

checkout_mode

string

meta

object

is_active

boolean

name

string

google_map_point

object

cart_id

string

city

string

sector

string

state_code

string

State code for international address

area

string

user_id

string

address_type

string

address

string

country_phone_code

string

country_iso_code

string

_custom_json

object (AddressCustomJson)

AddressCustomJson

meta_data

string

meta_data_int

number

uid

number

is_anonymous

boolean

app_id

string

expire_at

string

| date-time

Nullable

address_id

string

Nullable

store_name

string

Nullable

Examples

Parameters

id:

"65bb5a41feeb84432e132c03"

cart_id:

"5c5c0b0a3fe3c6d1ae4ea1fc"

mobile_no:

9915347757

user_id:

"5c5c0b0a3fe3c6d1ae4ea1fc"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/address/{id}

Response

PUT

Updates an existing customer address

Update the user address

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

ID allotted to the selected address

Request body

pincode

number

Nullable

phone

string

area_code_slug

string

country_code

string

geo_location

object (GeoLocation)

GeoLocation

longitude

number

| float

Default Value : 0

latitude

number

| float

Default Value : 0

country

string

state

string

is_default_address

boolean

tags

array of string

created_by_user_id

string

landmark

string

Nullable

area_code

string

checkout_mode

string

meta

object

is_active

boolean

name

string

google_map_point

object

cart_id

string

city

string

sector

string

state_code

string

State code for international address

area

string

user_id

string

address_type

string

address

string

country_phone_code

string

country_iso_code

string

_custom_json

object (AddressCustomJson)

AddressCustomJson

meta_data

string

meta_data_int

number

uid

number

is_anonymous

boolean

app_id

string

expire_at

string

| date-time

Nullable

address_id

string

Nullable

store_name

string

Nullable

Response

200

400

Success. Returns the address ID and a message indicating a successful address updation.

UpdateAddressResponseObject

string

is_default_address

boolean

success

boolean

is_updated

boolean

address_id

string

oneOf Schema from below

Examples

Parameters

id:

"65bb5a41feeb84432e132c03"

body:

body

Was this section helpful?

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/address/{id}

Response

DEL

Removes an address from a customer's address list

Remove an existing customer address from the system.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

ID allotted to the selected address

user_id

string

Option to delete address for the provided user_id.

Response

200

Returns a Status object indicating the success or failure of address deletion.

DeleteAddressResponseObject

string

is_deleted

boolean

address_id

string

Examples

Parameters

id:

"65bb5a41feeb84432e132c06"

user_id:

"5c5c0b0a3fe3c6d1ae4ea1fc"

Was this section helpful?

DEL

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/address/{id}

Response

POST

Select customer address for order processing

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.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

cart_id

string

The unique identifier of the cart

buy_now

boolean

This is boolean to get buy_now cart

boolean

This is a boolean value. Select `true` to retrieve all the items added in the cart.

boolean

This is a boolean value. Select `true` to retrieve the price breakup of cart items.

Request body

cart_id

string

billing_address_id

string

checkout_mode

string

user_id

string

Response

200

400

Success. Returns a Cart object as shown below. Refer `CartDetailResponseObject` for more details. .

CartDetailResponseObject

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.

string

Unique identifier of the user cart.

error_message

string

Error message of the predicted shipment.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Staff employee user id if cart is created by staff employee for the customer.

success

boolean

Success flag of get cart detail API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

Last modified timestamp of cart.

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

buy_now

boolean

Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

custom_cart_meta

object

Custom meta details added cart checkout API payload .

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

cart_id:

"65c06fe589db42581e4be72e"

"true"

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/select-address

Response

Payment mode

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

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/payment

# Select payment mode

PUT

/service/platform/cart/v2.0/company/{company_id}/application/{application_id}/payment

# Select payment mode (latest)

PUT

Select payment mode

Customers can select a preferred payment mode from available options during the cart checkout process to securely and efficiently complete their transaction.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _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.

Enum

Request body

address_id

string

payment_mode

string

aggregator_name

string

merchant_code

string

payment_identifier

string

Nullable

string

Response

200

Success. Returns a Cart object as shown below. Refer `CartDetailResponseObject` for more details.

CartDetailResponseObject

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.

string

Unique identifier of the user cart.

error_message

string

Error message of the predicted shipment.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Staff employee user id if cart is created by staff employee for the customer.

success

boolean

Success flag of get cart detail API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

Last modified timestamp of cart.

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

buy_now

boolean

Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

custom_cart_meta

object

Custom meta details added cart checkout API payload .

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

id:

"65c06fe589db42581e4be72e"

body:

body

Was this section helpful?

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/payment

Response

PUT

Select payment mode (latest)

Selection of payment mode that supports multiple MOP(mode of payment).

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _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.

Enum

Request body

address_id

string

payment_mode

string

aggregator_name

string

merchant_code

string

payment_identifier

string

Nullable

string

payment_methods

array of object (PaymentMethod)

Array of PaymentMethod

mode

string

Required

payment

string

payment_meta

object (PaymentMeta)

Required

PaymentMeta

payment_gateway

string

type

string

payment_identifier

string

Nullable

merchant_code

string

payment_identifier

string

Nullable

amount

number

| float

Nullable

name

string

payment_extra_identifiers

object

Response

200

Success. Returns a Cart object as shown below. Refer `CartDetailResponseObject` for more details.

CartDetailResponseObject

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.

string

Unique identifier of the user cart.

error_message

string

Error message of the predicted shipment.

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

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Staff employee user id if cart is created by staff employee for the customer.

success

boolean

Success flag of get cart detail API response.

breakup_values

object (CartBreakup)

CartBreakup

coupon

object (CouponBreakup)

CouponBreakup

title

string

Nullable

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

Last modified timestamp of cart.

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

buy_now

boolean

Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.

gstin

string

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

custom_cart_meta

object

Custom meta details added cart checkout API payload .

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

id:

"65c06fe589db42581e4be72e"

body:

body

Was this section helpful?

PUT

/service/platform/cart/v2.0/company/{company_id}/application/{application_id}/payment

Response

Price adjustment

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

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/price-adjustment

# Create new price adjustment

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/price-adjustment

# Get a list of all price adjustments associated with a cart

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/price-adjustment/{id}

# Update price adjustments.

DEL

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/price-adjustment/{id}

# Remove price adjustments.

POST

Create new price adjustment

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

value

number

| float

Required

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 (PostOrder1)

PostOrder1

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

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

collected_by

string

Required

type

string

Required

type of price adjusment

Enum

allowed_refund

boolean

Flag indicating whether refunds are allowed (default: False)

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

id of article

quantity

integer

| int32

total quantity of the article to be considered (currently used only in discount type)

meta

object

meta related to article

meta

object

cart_id

string

Required

The ID of the cart

remove_articles

boolean

This field if set true will remove all articles in price adjustment if article_ids are present

auto_remove

boolean

This field if set true will remove mop type price adjustment.

distribution_logic

object

Response

201

400

Price Adjustment Created successfully

AddPriceAdjustmentResponseObject

data

object (PriceAdjustment)

PriceAdjustment

value

number

| float

message

string

The message associated with the price adjustment

apply_expiry

string

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 (PostOrder1)

PostOrder1

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

article_level_distribution

boolean

Flag indicating whether the distribution should is done at the article level

string

collection

object (Collection)

Collection

refund_by

string

collected_by

string

type

string

type of price adjusment

Enum

allowed_refund

boolean

Flag indicating whether refunds are allowed (default: False)

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

id of article

quantity

integer

| int32

total quantity of the article to be considered (currently used only in discount type)

meta

object

meta related to article

meta

object

cart_id

string

The ID of the cart

remove_articles

boolean

This field if set true will remove all articles in price adjustment if article_ids are present

auto_remove

boolean

This field if set true will remove mop type price adjustment.

is_active

boolean

created_by

string

cart_value

number

| float32

modified_by

string

distribution_logic

object

expire_at

string

| date-time

success

boolean

price_adjustments

array of object (PriceAdjustment)

Array of PriceAdjustment

value

number

| float

message

string

The message associated with the price adjustment

apply_expiry

string

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 (PostOrder1)

PostOrder1

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

article_level_distribution

boolean

Flag indicating whether the distribution should is done at the article level

string

collection

object (Collection)

Collection

refund_by

string

collected_by

string

type

string

type of price adjusment

Enum

allowed_refund

boolean

Flag indicating whether refunds are allowed (default: False)

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

id of article

quantity

integer

| int32

total quantity of the article to be considered (currently used only in discount type)

meta

object

meta related to article

meta

object

cart_id

string

The ID of the cart

remove_articles

boolean

This field if set true will remove all articles in price adjustment if article_ids are present

auto_remove

boolean

This field if set true will remove mop type price adjustment.

is_active

boolean

created_by

string

cart_value

number

| float32

modified_by

string

distribution_logic

object

expire_at

string

| date-time

Examples

Parameters

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/price-adjustment

Response

GET

Get a list of all price adjustments associated with a cart

This API helps to get price adjustments data associated to a particular cart

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

cart_id

string

Required

Cart Id

Response

200

Price Adjustments List. See example below for details

PriceAdjustmentResponsObject

data

array of object (PriceAdjustment)

Array of PriceAdjustment

value

number

| float

message

string

The message associated with the price adjustment

apply_expiry

string

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 (PostOrder1)

PostOrder1

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

article_level_distribution

boolean

Flag indicating whether the distribution should is done at the article level

string

collection

object (Collection)

Collection

refund_by

string

collected_by

string

type

string

type of price adjusment

Enum

allowed_refund

boolean

Flag indicating whether refunds are allowed (default: False)

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

id of article

quantity

integer

| int32

total quantity of the article to be considered (currently used only in discount type)

meta

object

meta related to article

meta

object

cart_id

string

The ID of the cart

remove_articles

boolean

This field if set true will remove all articles in price adjustment if article_ids are present

auto_remove

boolean

This field if set true will remove mop type price adjustment.

is_active

boolean

created_by

string

cart_value

number

| float32

modified_by

string

distribution_logic

object

expire_at

string

| date-time

success

boolean

price_adjustments

array of object (PriceAdjustment)

Array of PriceAdjustment

value

number

| float

message

string

The message associated with the price adjustment

apply_expiry

string

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 (PostOrder1)

PostOrder1

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

article_level_distribution

boolean

Flag indicating whether the distribution should is done at the article level

string

collection

object (Collection)

Collection

refund_by

string

collected_by

string

type

string

type of price adjusment

Enum

allowed_refund

boolean

Flag indicating whether refunds are allowed (default: False)

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

id of article

quantity

integer

| int32

total quantity of the article to be considered (currently used only in discount type)

meta

object

meta related to article

meta

object

cart_id

string

The ID of the cart

remove_articles

boolean

This field if set true will remove all articles in price adjustment if article_ids are present

auto_remove

boolean

This field if set true will remove mop type price adjustment.

is_active

boolean

created_by

string

cart_value

number

| float32

modified_by

string

distribution_logic

object

expire_at

string

| date-time

Examples

Parameters

cart_id:

"65c06fe589db42581e4be72e"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/price-adjustment

Response

PUT

Update price adjustments.

Modify price adjustments for items in the cart.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _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

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 (PostOrder1)

PostOrder1

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

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

collected_by

string

Required

type

string

Required

type of price adjusment

Enum

allowed_refund

boolean

Flag indicating whether refunds are allowed (default: False)

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

id of article

quantity

integer

| int32

total quantity of the article to be considered (currently used only in discount type)

meta

object

meta related to article

remove_articles

boolean

This field if set true will remove all articles in price adjustment if article_ids are present

auto_remove

boolean

This field if set true will remove mop type price adjustment.

meta

object

cart_id

string

Required

The ID of the cart

allow_refund

boolean

distribution_logic

object

Response

200

400

Price Adjustment Updated successfully

UpdatePriceAdjustmentResponseObject

data

object (PriceAdjustment)

PriceAdjustment

value

number

| float

message

string

The message associated with the price adjustment

apply_expiry

string

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 (PostOrder1)

PostOrder1

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

article_level_distribution

boolean

Flag indicating whether the distribution should is done at the article level

string

collection

object (Collection)

Collection

refund_by

string

collected_by

string

type

string

type of price adjusment

Enum

allowed_refund

boolean

Flag indicating whether refunds are allowed (default: False)

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

id of article

quantity

integer

| int32

total quantity of the article to be considered (currently used only in discount type)

meta

object

meta related to article

meta

object

cart_id

string

The ID of the cart

remove_articles

boolean

This field if set true will remove all articles in price adjustment if article_ids are present

auto_remove

boolean

This field if set true will remove mop type price adjustment.

is_active

boolean

created_by

string

cart_value

number

| float32

modified_by

string

distribution_logic

object

expire_at

string

| date-time

success

boolean

Examples

Parameters

id:

"65c48415cb1ec3bd1e06849d"

body:

body

Was this section helpful?

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/price-adjustment/{id}

Response

DEL

Remove price adjustments.

Remove price adjustments applied to items in the cart.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

Price Adjustment id for fetching single price adjustment data for editing

Response

200

400

Price Adjustment data Removed successfully

SuccessMessage

success

boolean

message

string

Examples

Parameters

id:

"65c48415cb1ec3bd1e06849d"

Was this section helpful?

DEL

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/price-adjustment/{id}

Response

Promotion

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

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promo-tags

# Get a list of all Promotion tags associated with a application.

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promotion

# List promotions

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promotion

# Create a promotion

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promotion/{id}

# Get a promotion

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promotion/{id}

# Update a promotion

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promotion_code_exists

# Check if promotion is already created with promotion code

GET

Get a list of all Promotion tags associated with a application.

This API helps to get Promotion tags data associated to a particular application.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

integer

Required

ID of the application for which tags are to be fetched.

Response

200

Tag List. See example below for details

TagsViewResponseObject

success

boolean

items

array of string

Default Value :

Examples

Parameters

Parameters are not required.

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promo-tags

Response

GET

List promotions

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.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

page_no

integer

current page no as per pagination

Default Value : 0

page_size

integer

Promotion max records fetched in single request

Default Value : 10

string

Filter by name

is_active

boolean

Filter by active or inactive promotion

Default Value : true

promo_group

string

Filter promotion group

Enum

promotion_type

string

Filter promotion type

fp_panel

string

Filter non extension promotions

promotion_id

string

Filter by promotion _id

Response

200

Promotion List for sent page_size and page_no

PromotionsResponseObject

draft

number

Nullable

review

number

Nullable

rejected

number

Nullable

approved

number

Nullable

items

array of object (PromotionListItem)

Array of PromotionListItem

draft

number

Nullable

review

number

Nullable

rejected

number

Nullable

approved

number

Nullable

stackable

boolean

Allows more than one promotion to get combined benefits

calculate_on

string

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

Enum

display_meta

object (DisplayMeta1)

DisplayMeta1

description

string

offer_label

string

Default Value :

name

string

offer_text

string

ownership

object (Ownership)

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

_schedule

object (PromotionSchedule)

PromotionSchedule

end

string

start

string

published

boolean

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

duration

integer

| int32

Nullable

status

string

Enum

author

object (PromotionAuthor)

PromotionAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

date_meta

object (PromotionDateMeta)

PromotionDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

_id

string

Promotion id

is_processed

boolean

Flag to verify if promotion is ready to be applied on cart and ready to update promotion

code

string

tags

array of string

Default Value :

promotion_type

string

Promotion type

is_archived

boolean

Flag to verify if promotion is archived

page

object (Page)

Page

has_next

boolean

true if more records are present for next pages

item_total

integer

| int32

Total coupon count in system

current

integer

| int32

Current page no

next_id

string

Cursor id for next set of records.

page

integer

| int32

Page requested

last_id

string

Nullable

Last objects id

type

string

size

integer

| int32

Current request page size

has_previous

boolean

true if more records are present for previous pages. Sent for cursor pagination

Examples

Parameters

page_no:

page_size:

is_active:

true

promo_group:

"product"

promotion_type:

"amount"

promotion_id:

"61d1db23f5b315cf265126c0"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promotion

Response

POST

Create a promotion

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.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

body

object (PromotionAdd)

Required

PromotionAdd

_id

string

stackable

boolean

calculate_on

string

Only available for Contract pricing and Ladder pricing promotion type

Enum

apply_exclusive

string

Nullable

Enum

promo_group

string

Required

Enum

mode

string

Required

Enum

apply_all_discount

boolean

display_meta

object (DisplayMeta1)

Required

DisplayMeta1

description

string

offer_label

string

Default Value :

name

string

offer_text

string

ownership

object (Ownership)

Required

Ownership

payable_category

string

Required

Promotion amount payable category.

Enum

payable_by

string

Required

Promotion amount bearable party.

promotion_type

string

Required

Enum

discount_rules

array of object (DiscountRule)

Required

Array of DiscountRule

discount_type

string

Required

Enum

buy_condition

string

Required

item_criteria

object (ItemCriteria)

Required

ItemCriteria

cart_quantity

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

available_zones

array of string

item_exclude_company

array of integer

item_id

array of integer

item_l1_category

array of integer

cart_total

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

cart_unique_item_quantity

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

cart_unique_item_amount

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

item_exclude_id

array of integer

all_items

boolean

item_exclude_l1_category

array of integer

item_size

array of string

item_store

array of integer

item_exclude_sku

array of string

item_department

array of integer

item_exclude_store

array of integer

item_brand

array of integer

item_exclude_department

array of integer

item_exclude_category

array of integer

item_category

array of integer

buy_rules

array of string

item_exclude_brand

array of integer

item_l2_category

array of integer

item_company

array of integer

item_tags

array of string

item_exclude_l2_category

array of integer

item_sku

array of string

offer

object (DiscountOffer)

Required

DiscountOffer

max_discount_amount

number

| float

discount_price

number

| float

apportion_discount

boolean

partial_can_ret

boolean

max_usage_per_transaction

integer

| int32

min_offer_quantity

integer

| int32

code

string

discount_amount

number

| float

discount_percentage

number

| float

max_offer_quantity

integer

| int32

restrictions

object (Restrictions1)

Restrictions1

payments

object

user_registered

object (UserRegistered)

UserRegistered

end

string

| date-time

Nullable

start

string

| date-time

Nullable

platforms

array of string

post_order

object (PostOrder1)

PostOrder1

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

user_groups

array of integer

order_quantity

integer

| int32

anonymous_users

boolean

user_id

array of string

uses

object (UsesRestriction1)

Required

UsesRestriction1

maximum

object (UsesRemaining1)

UsesRemaining1

user

integer

| int32

total

integer

| int32

remaining

object (UsesRemaining1)

UsesRemaining1

user

integer

| int32

total

integer

| int32

ordering_stores

array of integer

user_type

string

currency

string

code

string

_schedule

object (PromotionSchedule)

PromotionSchedule

end

string

Required

start

string

Required

published

boolean

Required

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

duration

integer

| int32

Nullable

status

string

Enum

post_order_action

object (PromotionAction)

PromotionAction

action_date

string

| date-time

Required

action_type

string

Required

apply_priority

integer

| int32

author

object (PromotionAuthor)

PromotionAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

visiblility

object (Visibility)

Visibility

coupon_list

boolean

Required

pdp

boolean

Required

application_id

string

Required

buy_rules

object

Required

_custom_json

object

date_meta

object (PromotionDateMeta)

PromotionDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

indexed_criteria

array of object (PromoIndexedCriteria)

Array of PromoIndexedCriteria

key

string

Enum

value

string

oneOf Schema from below

tags

array of string

Default Value :

Request body

_id

string

stackable

boolean

calculate_on

string

Only available for Contract pricing and Ladder pricing promotion type

Enum

apply_exclusive

string

Nullable

Enum

promo_group

string

Required

Enum

mode

string

Required

Enum

apply_all_discount

boolean

display_meta

object (DisplayMeta1)

Required

DisplayMeta1

description

string

offer_label

string

Default Value :

name

string

offer_text

string

ownership

object (Ownership)

Required

Ownership

payable_category

string

Required

Promotion amount payable category.

Enum

payable_by

string

Required

Promotion amount bearable party.

promotion_type

string

Required

Enum

discount_rules

array of object (DiscountRule)

Required

Array of DiscountRule

discount_type

string

Required

Enum

buy_condition

string

Required

item_criteria

object (ItemCriteria)

Required

ItemCriteria

cart_quantity

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

available_zones

array of string

item_exclude_company

array of integer

item_id

array of integer

item_l1_category

array of integer

cart_total

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

cart_unique_item_quantity

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

cart_unique_item_amount

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

item_exclude_id

array of integer

all_items

boolean

item_exclude_l1_category

array of integer

item_size

array of string

item_store

array of integer

item_exclude_sku

array of string

item_department

array of integer

item_exclude_store

array of integer

item_brand

array of integer

item_exclude_department

array of integer

item_exclude_category

array of integer

item_category

array of integer

buy_rules

array of string

item_exclude_brand

array of integer

item_l2_category

array of integer

item_company

array of integer

item_tags

array of string

item_exclude_l2_category

array of integer

item_sku

array of string

offer

object (DiscountOffer)

Required

DiscountOffer

max_discount_amount

number

| float

discount_price

number

| float

apportion_discount

boolean

partial_can_ret

boolean

max_usage_per_transaction

integer

| int32

min_offer_quantity

integer

| int32

code

string

discount_amount

number

| float

discount_percentage

number

| float

max_offer_quantity

integer

| int32

restrictions

object (Restrictions1)

Restrictions1

payments

object

user_registered

object (UserRegistered)

UserRegistered

end

string

| date-time

Nullable

start

string

| date-time

Nullable

platforms

array of string

post_order

object (PostOrder1)

PostOrder1

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

user_groups

array of integer

order_quantity

integer

| int32

anonymous_users

boolean

user_id

array of string

uses

object (UsesRestriction1)

Required

UsesRestriction1

maximum

object (UsesRemaining1)

UsesRemaining1

user

integer

| int32

total

integer

| int32

remaining

object (UsesRemaining1)

UsesRemaining1

user

integer

| int32

total

integer

| int32

ordering_stores

array of integer

user_type

string

currency

string

code

string

_schedule

object (PromotionSchedule)

PromotionSchedule

end

string

Required

start

string

Required

published

boolean

Required

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

duration

integer

| int32

Nullable

status

string

Enum

post_order_action

object (PromotionAction)

PromotionAction

action_date

string

| date-time

Required

action_type

string

Required

apply_priority

integer

| int32

author

object (PromotionAuthor)

PromotionAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

visiblility

object (Visibility)

Visibility

coupon_list

boolean

Required

pdp

boolean

Required

application_id

string

Required

buy_rules

object

Required

_custom_json

object

date_meta

object (PromotionDateMeta)

PromotionDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

indexed_criteria

array of object (PromoIndexedCriteria)

Array of PromoIndexedCriteria

key

string

Enum

value

string

oneOf Schema from below

tags

array of string

Default Value :

Response

201

400

Promotion Created successfully

PromotionAddResult

draft

number

review

number

rejected

number

approved

number

offer_counts

number

Number of offers created

offer_prefix

string

Offer prefix

is_bank_offer

boolean

Is bank offer

custom_content

object

medias

array of object (Media)

Array of Media

url

string

type

string

alt_text

string

offer_type

string

visibility

object (Visibility)

Visibility

coupon_list

boolean

pdp

boolean

is_archived

boolean

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

offer_label

string

Default Value :

name

string

offer_text

string

ownership

object (Ownership)

Ownership

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

Enum

buy_condition

string

item_criteria

object (ItemCriteria)

ItemCriteria

cart_quantity

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

available_zones

array of string

item_exclude_company

array of integer

item_id

array of integer

item_l1_category

array of integer

cart_total

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

cart_unique_item_quantity

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

cart_unique_item_amount

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

item_exclude_id

array of integer

all_items

boolean

item_exclude_l1_category

array of integer

item_size

array of string

item_store

array of integer

item_exclude_sku

array of string

item_department

array of integer

item_exclude_store

array of integer

item_brand

array of integer

item_exclude_department

array of integer

item_exclude_category

array of integer

item_category

array of integer

buy_rules

array of string

item_exclude_brand

array of integer

item_l2_category

array of integer

item_company

array of integer

item_tags

array of string

item_exclude_l2_category

array of integer

item_sku

array of string

offer

object (DiscountOffer)

DiscountOffer

max_discount_amount

number

| float

discount_price

number

| float

apportion_discount

boolean

partial_can_ret

boolean

max_usage_per_transaction

integer

| int32

min_offer_quantity

integer

| int32

code

string

discount_amount

number

| float

discount_percentage

number

| float

max_offer_quantity

integer

| int32

restrictions

object (Restrictions1)

Restrictions1

payments

object

user_registered

object (UserRegistered)

UserRegistered

end

string

| date-time

Nullable

start

string

| date-time

Nullable

platforms

array of string

post_order

object (PostOrder1)

PostOrder1

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

user_groups

array of integer

order_quantity

integer

| int32

anonymous_users

boolean

user_id

array of string

uses

object (UsesRestriction1)

UsesRestriction1

maximum

object (UsesRemaining1)

UsesRemaining1

user

integer

| int32

total

integer

| int32

remaining

object (UsesRemaining1)

UsesRemaining1

user

integer

| int32

total

integer

| int32

ordering_stores

array of integer

user_type

string

currency

string

Promotion Currency code like INR

code

string

Promotion unique code

_schedule

object (PromotionSchedule)

PromotionSchedule

end

string

start

string

published

boolean

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

duration

integer

| int32

Nullable

status

string

Enum

post_order_action

object (PromotionAction)

PromotionAction

action_date

string

| date-time

action_type

string

apply_priority

integer

| int32

Promotion applicable priority

author

object (PromotionAuthor)

PromotionAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

visiblility

object (Visibility)

Visibility

coupon_list

boolean

pdp

boolean

application_id

string

Current application id of sales channel

buy_rules

object

_custom_json

object

Set extra properties in promotion

date_meta

object (PromotionDateMeta)

PromotionDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

indexed_criteria

array of object (PromoIndexedCriteria)

Array of PromoIndexedCriteria

key

string

Enum

value

string

oneOf Schema from below

tags

array of string

List of tags applicable for promotion

Default Value :

_id

string

Unique idenfier of promotion.

Examples

Parameters

body:

body

Was this section helpful?

POST

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promotion

Response

GET

Get a promotion

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.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

Promotion mongo _id for fetching single promotion data for editing

Response

200

404

Promotion object for sent `id`

PromotionUpdateResult

stackable

boolean

Set true to apply other promotions in cart

medias

array of object (Media)

Array of Media

url

string

type

string

alt_text

string

is_archived

boolean

Nullable

Denotes if promotion is archived

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

offer_label

string

Default Value :

name

string

offer_text

string

ownership

object (Ownership)

Ownership

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

Enum

buy_condition

string

item_criteria

object (ItemCriteria)

ItemCriteria

cart_quantity

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

available_zones

array of string

item_exclude_company

array of integer

item_id

array of integer

item_l1_category

array of integer

cart_total

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

cart_unique_item_quantity

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

cart_unique_item_amount

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

item_exclude_id

array of integer

all_items

boolean

item_exclude_l1_category

array of integer

item_size

array of string

item_store

array of integer

item_exclude_sku

array of string

item_department

array of integer

item_exclude_store

array of integer

item_brand

array of integer

item_exclude_department

array of integer

item_exclude_category

array of integer

item_category

array of integer

buy_rules

array of string

item_exclude_brand

array of integer

item_l2_category

array of integer

item_company

array of integer

item_tags

array of string

item_exclude_l2_category

array of integer

item_sku

array of string

offer

object (DiscountOffer)

DiscountOffer

max_discount_amount

number

| float

discount_price

number

| float

apportion_discount

boolean

partial_can_ret

boolean

max_usage_per_transaction

integer

| int32

min_offer_quantity

integer

| int32

code

string

discount_amount

number

| float

discount_percentage

number

| float

max_offer_quantity

integer

| int32

restrictions

object (Restrictions1)

Restrictions1

payments

object

user_registered

object (UserRegistered)

UserRegistered

end

string

| date-time

Nullable

start

string

| date-time

Nullable

platforms

array of string

post_order

object (PostOrder1)

PostOrder1

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

user_groups

array of integer

order_quantity

integer

| int32

anonymous_users

boolean

user_id

array of string

uses

object (UsesRestriction1)

UsesRestriction1

maximum

object (UsesRemaining1)

UsesRemaining1

user

integer

| int32

total

integer

| int32

remaining

object (UsesRemaining1)

UsesRemaining1

user

integer

| int32

total

integer

| int32

ordering_stores

array of integer

user_type

string

currency

string

Promotion Currency code like INR

code

string

Promotion unique code

_schedule

object (PromotionSchedule)

PromotionSchedule

end

string

start

string

published

boolean

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

duration

integer

| int32

Nullable

status

string

Enum

post_order_action

object (PromotionAction)

PromotionAction

action_date

string

| date-time

action_type

string

apply_priority

integer

| int32

Promotion applicable priority

author

object (PromotionAuthor)

PromotionAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

visibility

object (Visibility)

Visibility

coupon_list

boolean

pdp

boolean

visiblility

object (Visibility)

Visibility

coupon_list

boolean

pdp

boolean

offer_prefix

string

custom_content

object

offer_counts

number

offer_type

string

is_bank_offer

boolean

application_id

string

Current application id of sales channel

buy_rules

object

_custom_json

object

Set extra properties in promotion

date_meta

object (PromotionDateMeta)

PromotionDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

indexed_criteria

array of object (PromoIndexedCriteria)

Array of PromoIndexedCriteria

key

string

Enum

value

string

oneOf Schema from below

tags

array of string

List of tags applicable for promotion

Default Value :

_id

string

Auto generated id of specific promotion

Examples

Parameters

id:

"61d1db23f5b315cf265126c0"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promotion/{id}

Response

PUT

Update a promotion

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.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

Promotion mongo _id for fetching single promotion data for editing

body

object (PromotionUpdate)

Required

PromotionUpdate

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

offer_label

string

Default Value :

name

string

offer_text

string

ownership

object (Ownership)

Ownership

payable_category

string

Required

Promotion amount payable category.

Enum

payable_by

string

Required

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

Enum

buy_condition

string

Required

item_criteria

object (ItemCriteria)

Required

ItemCriteria

cart_quantity

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

available_zones

array of string

item_exclude_company

array of integer

item_id

array of integer

item_l1_category

array of integer

cart_total

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

cart_unique_item_quantity

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

cart_unique_item_amount

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

item_exclude_id

array of integer

all_items

boolean

item_exclude_l1_category

array of integer

item_size

array of string

item_store

array of integer

item_exclude_sku

array of string

item_department

array of integer

item_exclude_store

array of integer

item_brand

array of integer

item_exclude_department

array of integer

item_exclude_category

array of integer

item_category

array of integer

buy_rules

array of string

item_exclude_brand

array of integer

item_l2_category

array of integer

item_company

array of integer

item_tags

array of string

item_exclude_l2_category

array of integer

item_sku

array of string

offer

object (DiscountOffer)

Required

DiscountOffer

max_discount_amount

number

| float

discount_price

number

| float

apportion_discount

boolean

partial_can_ret

boolean

max_usage_per_transaction

integer

| int32

min_offer_quantity

integer

| int32

code

string

discount_amount

number

| float

discount_percentage

number

| float

max_offer_quantity

integer

| int32

restrictions

object (Restrictions1)

Restrictions1

payments

object

user_registered

object (UserRegistered)

UserRegistered

end

string

| date-time

Nullable

start

string

| date-time

Nullable

platforms

array of string

post_order

object (PostOrder1)

PostOrder1

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

user_groups

array of integer

order_quantity

integer

| int32

anonymous_users

boolean

user_id

array of string

uses

object (UsesRestriction1)

Required

UsesRestriction1

maximum

object (UsesRemaining1)

UsesRemaining1

user

integer

| int32

total

integer

| int32

remaining

object (UsesRemaining1)

UsesRemaining1

user

integer

| int32

total

integer

| int32

ordering_stores

array of integer

user_type

string

currency

string

Promotion Currency code like INR

code

string

Promotion unique code

_schedule

object (PromotionSchedule)

PromotionSchedule

end

string

Required

start

string

Required

published

boolean

Required

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

duration

integer

| int32

Nullable

status

string

Enum

post_order_action

object (PromotionAction)

PromotionAction

action_date

string

| date-time

Required

action_type

string

Required

apply_priority

integer

| int32

Promotion applicable priority

author

object (PromotionAuthor)

PromotionAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

visiblility

object (Visibility)

Visibility

coupon_list

boolean

Required

pdp

boolean

Required

application_id

string

Required

Current application id of sales channel

buy_rules

object

_custom_json

object

Set extra properties in promotion

date_meta

object (PromotionDateMeta)

PromotionDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

tags

array of string

List of tags applicable for promotion

Default Value :

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

offer_label

string

Default Value :

name

string

offer_text

string

ownership

object (Ownership)

Ownership

payable_category

string

Required

Promotion amount payable category.

Enum

payable_by

string

Required

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

Enum

buy_condition

string

Required

item_criteria

object (ItemCriteria)

Required

ItemCriteria

cart_quantity

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

available_zones

array of string

item_exclude_company

array of integer

item_id

array of integer

item_l1_category

array of integer

cart_total

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

cart_unique_item_quantity

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

cart_unique_item_amount

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

item_exclude_id

array of integer

all_items

boolean

item_exclude_l1_category

array of integer

item_size

array of string

item_store

array of integer

item_exclude_sku

array of string

item_department

array of integer

item_exclude_store

array of integer

item_brand

array of integer

item_exclude_department

array of integer

item_exclude_category

array of integer

item_category

array of integer

buy_rules

array of string

item_exclude_brand

array of integer

item_l2_category

array of integer

item_company

array of integer

item_tags

array of string

item_exclude_l2_category

array of integer

item_sku

array of string

offer

object (DiscountOffer)

Required

DiscountOffer

max_discount_amount

number

| float

discount_price

number

| float

apportion_discount

boolean

partial_can_ret

boolean

max_usage_per_transaction

integer

| int32

min_offer_quantity

integer

| int32

code

string

discount_amount

number

| float

discount_percentage

number

| float

max_offer_quantity

integer

| int32

restrictions

object (Restrictions1)

Restrictions1

payments

object

user_registered

object (UserRegistered)

UserRegistered

end

string

| date-time

Nullable

start

string

| date-time

Nullable

platforms

array of string

post_order

object (PostOrder1)

PostOrder1

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

user_groups

array of integer

order_quantity

integer

| int32

anonymous_users

boolean

user_id

array of string

uses

object (UsesRestriction1)

Required

UsesRestriction1

maximum

object (UsesRemaining1)

UsesRemaining1

user

integer

| int32

total

integer

| int32

remaining

object (UsesRemaining1)

UsesRemaining1

user

integer

| int32

total

integer

| int32

ordering_stores

array of integer

user_type

string

currency

string

Promotion Currency code like INR

code

string

Promotion unique code

_schedule

object (PromotionSchedule)

PromotionSchedule

end

string

Required

start

string

Required

published

boolean

Required

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

duration

integer

| int32

Nullable

status

string

Enum

post_order_action

object (PromotionAction)

PromotionAction

action_date

string

| date-time

Required

action_type

string

Required

apply_priority

integer

| int32

Promotion applicable priority

author

object (PromotionAuthor)

PromotionAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

visiblility

object (Visibility)

Visibility

coupon_list

boolean

Required

pdp

boolean

Required

application_id

string

Required

Current application id of sales channel

buy_rules

object

_custom_json

object

Set extra properties in promotion

date_meta

object (PromotionDateMeta)

PromotionDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

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

medias

array of object (Media)

Array of Media

url

string

type

string

alt_text

string

is_archived

boolean

Nullable

Denotes if promotion is archived

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

offer_label

string

Default Value :

name

string

offer_text

string

ownership

object (Ownership)

Ownership

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

Enum

buy_condition

string

item_criteria

object (ItemCriteria)

ItemCriteria

cart_quantity

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

available_zones

array of string

item_exclude_company

array of integer

item_id

array of integer

item_l1_category

array of integer

cart_total

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

cart_unique_item_quantity

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

cart_unique_item_amount

object (CompareObject)

CompareObject

equals

number

| float

greater_than

number

| float

less_than_equals

number

| float

less_than

number

| float

greater_than_equals

number

| float

item_exclude_id

array of integer

all_items

boolean

item_exclude_l1_category

array of integer

item_size

array of string

item_store

array of integer

item_exclude_sku

array of string

item_department

array of integer

item_exclude_store

array of integer

item_brand

array of integer

item_exclude_department

array of integer

item_exclude_category

array of integer

item_category

array of integer

buy_rules

array of string

item_exclude_brand

array of integer

item_l2_category

array of integer

item_company

array of integer

item_tags

array of string

item_exclude_l2_category

array of integer

item_sku

array of string

offer

object (DiscountOffer)

DiscountOffer

max_discount_amount

number

| float

discount_price

number

| float

apportion_discount

boolean

partial_can_ret

boolean

max_usage_per_transaction

integer

| int32

min_offer_quantity

integer

| int32

code

string

discount_amount

number

| float

discount_percentage

number

| float

max_offer_quantity

integer

| int32

restrictions

object (Restrictions1)

Restrictions1

payments

object

user_registered

object (UserRegistered)

UserRegistered

end

string

| date-time

Nullable

start

string

| date-time

Nullable

platforms

array of string

post_order

object (PostOrder1)

PostOrder1

cancellation_allowed

boolean

Default Value : true

return_allowed

boolean

Default Value : true

user_groups

array of integer

order_quantity

integer

| int32

anonymous_users

boolean

user_id

array of string

uses

object (UsesRestriction1)

UsesRestriction1

maximum

object (UsesRemaining1)

UsesRemaining1

user

integer

| int32

total

integer

| int32

remaining

object (UsesRemaining1)

UsesRemaining1

user

integer

| int32

total

integer

| int32

ordering_stores

array of integer

user_type

string

currency

string

Promotion Currency code like INR

code

string

Promotion unique code

_schedule

object (PromotionSchedule)

PromotionSchedule

end

string

start

string

published

boolean

next_schedule

array of object (NextSchedule)

Array of NextSchedule

start

string

end

string

cron

string

Nullable

duration

integer

| int32

Nullable

status

string

Enum

post_order_action

object (PromotionAction)

PromotionAction

action_date

string

| date-time

action_type

string

apply_priority

integer

| int32

Promotion applicable priority

author

object (PromotionAuthor)

PromotionAuthor

created_by

string

Nullable

Default Value : null

modified_by

string

Nullable

Default Value : null

rejected_by

string

Nullable

Default Value : null

approved_by

string

Nullable

Default Value : null

reviewed_by

string

Nullable

Default Value : null

visibility

object (Visibility)

Visibility

coupon_list

boolean

pdp

boolean

visiblility

object (Visibility)

Visibility

coupon_list

boolean

pdp

boolean

offer_prefix

string

custom_content

object

offer_counts

number

offer_type

string

is_bank_offer

boolean

application_id

string

Current application id of sales channel

buy_rules

object

_custom_json

object

Set extra properties in promotion

date_meta

object (PromotionDateMeta)

PromotionDateMeta

modified_on

string

| date-time

Nullable

Default Value : null

created_on

string

| date-time

Nullable

Default Value : null

approved_on

string

| date-time

Nullable

Default Value : null

rejected_on

string

| date-time

Nullable

Default Value : null

reviewed_on

string

| date-time

Nullable

Default Value : null

indexed_criteria

array of object (PromoIndexedCriteria)

Array of PromoIndexedCriteria

key

string

Enum

value

string

oneOf Schema from below

tags

array of string

List of tags applicable for promotion

Default Value :

_id

string

Auto generated id of specific promotion

Examples

Parameters

id:

"61d1db23f5b315cf265126c0"

body:

body

Was this section helpful?

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promotion/{id}

Response

GET

Check if promotion is already created with promotion code

Validates the presence of a promotion code for the specified sales channel to verify whether the provided code already exists or not.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

code

string

Promotion code

Response

200

400

Valid response with existing promotion code count

Properties

success

boolean

count

integer

Examples

Parameters

code:

"ag_600_off"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/promotion_code_exists

Response

Selling Location

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

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/store-address

# Get Store Address

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.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

store_uid

integer

Required

The unique identifier of the store

Response

200

400

Success. Returns available store information with its address as shown below.

StoreDetailsResponseObject

items

array of object (PickupStoreDetail)

Array of PickupStoreDetail

country

string

state

string

city

string

phone

string

Nullable

area_code

string

uid

integer

| int32

area_code_slug

string

address_type

string

area

string

integer

| int32

store_manager_name

string

Nullable

name

string

store_code

string

landmark

string

Nullable

pincode

integer

| int32

address

string

sector

string

Nullable

state_code

string

Nullable

geo_location

object (GeoLocation)

GeoLocation

longitude

number

| float

Default Value : 0

latitude

number

| float

Default Value : 0

data

array of object (PickupStoreDetail)

Array of PickupStoreDetail

country

string

state

string

city

string

phone

string

Nullable

area_code

string

uid

integer

| int32

area_code_slug

string

address_type

string

area

string

integer

| int32

store_manager_name

string

Nullable

name

string

store_code

string

landmark

string

Nullable

pincode

integer

| int32

address

string

sector

string

Nullable

state_code

string

Nullable

geo_location

object (GeoLocation)

GeoLocation

longitude

number

| float

Default Value : 0

latitude

number

| float

Default Value : 0

Examples

Parameters

store_uid:

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/store-address

Response

Shipment

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

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/shipment

# Get shipments details

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/shipment

# Update shipments

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/available-delivery-mode

# Get delivery modes

GET

Get shipments details

Use this API to get shipment details, expected delivery date, items and price breakup of the shipment.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

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.

boolean

This is a boolean value. Select `true` to retrieve all the items added in the cart.

boolean

This is a boolean value. Select `true` for getting a payment option in response.

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 `PlatformCartShipmentsResponseObject` for more details.

PlatformCartShipmentsResponseObject

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.

string

Unique identifier of the user cart.

error_message

string

Error message of the shipment API response.

pan_config

object

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Nullable

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

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

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

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

shipments

array of object (PlatformShipmentResponseObject)

Array of PlatformShipmentResponseObject

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

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

dp_options

object

Nullable

Delivery partner options that are available to deliver the shipment.

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.

box_type

string

Nullable

Box type of the shipment in which the shipment will be delivered.

promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

dp_id

string

Nullable

Delivery partner id of the shipment.

fulfillment_type

string

Fulfilment type of shipment.

articles

array of object (ShipmentArticle)

Array of ShipmentArticle

meta

string

quantity

string

article_id

string

meta

object (ShipmentMeta)

ShipmentMeta

packaging_name

string

Nullable

dimension

object (ShipmentMetaDimension)

ShipmentMetaDimension

height

number

The height of the product

length

number

The length of the product

width

number

The width of the product

assign_dp_from_sb

string

Nullable

dp_sort_key

string

Nullable

shipment_weight

number

Nullable

shipment_volumetric_weight

number

Nullable

shipment_chargeable_weight

number

Nullable

shipping_zone

string

Nullable

debug

object

Nullable

logistics_meta

object (ShipmentLogisticsMeta)

ShipmentLogisticsMeta

account_options

array of object (ShipmentLogisticsMetaAccount)

Array of ShipmentLogisticsMetaAccount

name

string

Nullable

display_name

string

Nullable

fm_priority

number

Nullable

lm_priority

number

Nullable

rvp_priority

number

Nullable

type

string

Nullable

sub_type

string

Nullable

parent_id

string

Nullable

is_active

boolean

Nullable

payment_mode

string

Nullable

assign_dp_from_sb

string

Nullable

internal_account_id

string

Nullable

external_account_id

string

Nullable

f_priority

number

Nullable

r_priority

number

Nullable

dp_shipping_charges

number

Nullable

qc_enabled

boolean

Nullable

area_code

object (ShipmentLogisticsMetaAccountAreaCode)

ShipmentLogisticsMetaAccountAreaCode

from_pincode

string

Nullable

to_pincode

string

Nullable

source

string

Nullable

destination

string

Nullable

operations

array of string

dp_tat

object (ShipmentLogisticsMetaAccountDpTat)

ShipmentLogisticsMetaAccountDpTat

min

number

Nullable

max

number

Nullable

account_info

object

dp_sort_key

string

Nullable

assign_dp_from_sb

string

Nullable

error

object (ShipmentError)

ShipmentError

type

string

Nullable

value

array of string

message

string

Nullable

debug

object

error

boolean

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart_meta

object

Custom meta details added cart checkout API payload.

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

ordering_store_id:

2890

id:

"65c06fe589db42581e4be72e"

address_id:

"65bb5a41feeb84432e132c03"

area_code:

400093

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/shipment

Response

PUT

Update shipments

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.

Requires application/cart/write access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

boolean

This is a boolean value. Select `true` to retrieve all the items added in the cart.

boolean

This is a boolean value. Select `true` for getting a payment option in response.

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.

Enum

Request body

shipments

array of object (UpdateCartShipmentItem)

Required

Array of UpdateCartShipmentItem

quantity

integer

| int32

Quantity of product in shipment

shipment_type

string

Required

Shipment delivery type

article_uid

string

Required

Article mongo id

Response

200

Success. Returns delivery promise along with shipment details and price breakup. Refer `PlatformCartShipmentsResponseObject` for more details.

PlatformCartShipmentsResponseObject

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.

string

Unique identifier of the user cart.

error_message

string

Error message of the shipment API response.

pan_config

object

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

comment

string

Comment message to be added in user cart.

items

array of object (CartProductInfo)

Items data list in user cart that includes item id, item size, store id, available sizes and rest of the item related data.

Array of CartProductInfo

quantity

integer

| int32

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

payment_identifier

string

default_options

string

enabled

boolean

delivery_charge_info

string

Delivery charge information message of the shipment.

common_config

object (CartCommonConfig)

CartCommonConfig

delivery_charges_config

object (DeliveryChargesConfig)

DeliveryChargesConfig

enabled

boolean

charges

array of object (ChargesThreshold)

Array of ChargesThreshold

charges

number

| float

threshold

number

| float

coupon

object (CartDetailCoupon)

CartDetailCoupon

cashback_amount

number

| float

cashback_message_primary

string

cashback_message_secondary

string

coupon_code

string

coupon_description

string

coupon_id

string

Nullable

coupon_subtitle

string

coupon_title

string

coupon_type

string

coupon_value

number

| float

discount

number

| float

is_applied

boolean

is_valid

boolean

maximum_discount_value

number

| float

message

string

minimum_cart_value

number

| float

medias

array of object (CartCouponMedias)

Array of CartCouponMedias

alt

string

url

string

type

string

key

string

mrp_coupon

boolean

Determine where the coupon is mrp or esp based.

restrict_checkout

boolean

Restrict checkout flag to restrict the checkout process.

message

string

Message of the get cart detail API response.

notification

object

Notification object which denotes notification data for user cart.

staff_user_id

string

Nullable

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

max_discount_value

number

| float

value

number

| float

is_applied

boolean

uid

string

Nullable

coupon_type

string

Nullable

sub_title

string

Nullable

coupon_value

number

| float

code

string

type

string

minimum_cart_value

number

| float

message

string

description

string

Nullable

display

array of object (DisplayBreakup)

Array of DisplayBreakup

key

string

value

number

| float

currency_code

string

currency_symbol

string

display

string

message

array of string

original

number

| float32

attr

string

meta

object

loyalty_points

object (LoyaltyPoints)

LoyaltyPoints

is_applied

boolean

Nullable

total

number

| float

Nullable

applicable

number

| float

Nullable

description

string

Nullable

message

string

Nullable

raw

object (RawBreakup)

RawBreakup

promotion

number

| float

coupon

number

| float

gst_charges

number

| float

mrp_total

number

| float

fynd_cash

number

| float

vog

number

| float

gift_card

number

| float

cod_charge

number

| float

total

number

| float

discount

number

| float

delivery_charge

number

| float

you_saved

number

| float

subtotal

number

| float

sub_total

number

| float

convenience_fee

number

| float

total_charge

number

| float

mop_total

number

| float

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

checkout_mode

string

Checkout mode of user cart.

last_modified

string

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

Nullable

GSTIN added in user cart.

applied_promo_details

array of object (AppliedPromotion)

List of applied promotions data to cart which includes promotion id, promotion name, offer text, description, buy rules, discount rules and promotion type.

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

pan_no

string

Nullable

Permanent Account Number of the user.

custom_cart

object (CustomCart)

CustomCart

string

id of custom cart config

cart_name

string

Name of custom cart

cart_type

string

Type of custom cart

is_universal

boolean

By default all carts are universal, will be false for custom cart

price_adjustment_applied

array of object (CartAppliedPriceAdjustment)

Array of CartAppliedPriceAdjustment

remove_articles

boolean

Boolean value indicating if articles should be removed from cart

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

auto_remove

boolean

Boolean value indicating if auto remove is enabled

applied_articles_ids

array of string

List of article IDs where the adjustment is applied

message

string

Message associated with the Price adjustment

_type

string

Type of the Price Adjustment

meta

object

Meta data added in article of price adjustment

restrictions

object

It contains all the restrictions applied on price adjustments

_id

string

ID of the price Adjustment

shipments

array of object (PlatformShipmentResponseObject)

Array of PlatformShipmentResponseObject

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

product

object (CartProduct)

CartProduct

slug

string

Unique product url name generated via product name and other meta data

images

array of object (ProductImage)

Array of ProductImage

secure_url

string

url

string

aspect_ratio

string

teaser_tag

object

Nullable

Teaser tag or short promotional phrase for the product.

brand

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

action

object (ProductAction)

ProductAction

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

uid

integer

| int32

Unique identifier of the product in cart.

tags

array of string

Nullable

Products tags that are added to each product to identify the set of products.

_custom_json

object

Field to add custom json of the product in cart.

type

string

Nullable

Type of product in cart.

name

string

Product name of the product in cart which is defined on platform.

item_code

string

Nullable

Product code of the product while defining product on platform.

categories

array of object (CategoryInfo)

Product category information which incldes category name and category id.

Array of CategoryInfo

uid

integer

| int32

Product Category Id.

name

string

Category name of the product.

attributes

object

Nullable

Product attributes defined on platform.

l1_categories

array of number

Nullable

List of L1 categories.

l2_categories

array of number

Nullable

List of L2 categories.

l3_categories

array of number

Nullable

List of L3 categories.

departments

array of number

Nullable

List of departments.

product_ean_id

string

European Article Number of the product (limited upto 50 EAN identifier in a single request).

parent_item_identifiers

object

Parent item information of the product which identifies the parent of the product in cart.

is_set

boolean

Nullable

Whether or not the product is a set of items.

article

object (ProductArticle)

ProductArticle

seller_identifier

string

Nullable

List of identifiers used by sellers for the product size.

quantity

integer

| int32

Quantity of the article added in cart.

seller

object (BaseInfo)

BaseInfo

uid

integer

| int32

Unique identifier of entities like brand or seller.

name

string

Nullable

Name of entities like brand or seller.

cart_item_meta

object

Meta details of the article added from cart.

parent_item_identifiers

object

Fields to determine parent product of the product.

is_gift_visible

boolean

Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.

uid

string

This unique identifier is assigned to the specific article. This represents item x size x location.

gift_card

object (ArticleGiftCard)

ArticleGiftCard

gift_price

number

| float32

Gift price amount applied on article.

display_text

string

Nullable

A gift message for the recipient to be included with the delivery of the order.

is_gift_applied

boolean

A flag indicating if the order is a gift.

product_group_tags

array of string

Nullable

List fot the unique identifier for the product grouping.

identifier

object

Nullable

Unique identifier of the article.

mto_quantity

integer

| int32

Quantity of the product which will specially manufactured as not available in stock.

extra_meta

object

Field to update extra meta of the article in cart.

type

string

Type of the data sent in response. Possible value is article.

Enum

_custom_json

object

Field to update custom json of the article in cart.

price

object (ArticlePriceInfo)

ArticlePriceInfo

converted

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

base

object (BasePrice)

BasePrice

effective

number

| float

currency_code

string

currency_symbol

string

marked

number

| float

selling

number

| float

meta

object

Article meta data.

size

string

Size of the article added in cart.

store

object (StoreInfo)

StoreInfo

uid

integer

| int32

Unique identifiers of the store from where product is fulfileld.

name

string

Nullable

Store name of the store from where the product is fulfiled.

store_code

string

Nullable

A unique code or identifier for the store, often used for internal reference.

tags

array of string

a list of article tags

variants

object

Product variant responses, each detailing a specific variant.

promotions_applied

array of object (AppliedPromotion)

Array of AppliedPromotion

string

Promotion id of current promotion

discount

number

discount of current promotion

article_quantity

integer

| int32

Quantity of article on which promotion is applicable

original_article_quantity

integer

| int32

ownership

object (Ownership)

Ownership of promotion

Ownership

payable_category

string

Promotion amount payable category.

Enum

payable_by

string

Promotion amount bearable party.

currency

object (CartCurrency)

CartCurrency

code

string

Currency code defined by ISO 4217:2015

symbol

string

discount_rules

array of object (DiscountRulesApp)

Discount rules for promotions

Array of DiscountRulesApp

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

raw_offer

object (PromoDiscountRuleRawOffer)

PromoDiscountRuleRawOffer

buy_condition

string

discount_type

string

offer

object (PromoDiscountRuleOffer)

PromoDiscountRuleOffer

max_offer_quantity

number

| int32

Nullable

discount_percentage

number

| float32

Nullable

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

item_criteria

object (PromoDiscountRuleItemCriteria)

PromoDiscountRuleItemCriteria

item_id

array of number

buy_rules

array of string

matched_buy_rules

array of string

Matched buy rules for promotion

applied_free_articles

array of object (AppliedFreeArticles)

Applied free article for free gift item promotions

Array of AppliedFreeArticles

parent_item_identifier

string

Parent item identifier for free article

quantity

integer

| int32

Free article quantity

article_id

string

free article id

free_gift_item_details

object (FreeGiftItems)

Free gift items details

FreeGiftItems

item_slug

string

item slug

item_name

string

Item name

item_price_details

object (ItemPriceDetails)

ItemPriceDetails

marked

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

effective

object (PriceMinMax)

PriceMinMax

min

number

| float

max

number

| float

currency

string

item_brand_name

string

item brand name

item_id

integer

| int32

Item id

item_images_url

array of string

item images URL

promotion_name

string

Promotion name of current promotion

buy_rules

array of object (BuyRules)

Buy rules for promotions

Array of BuyRules

cart_conditions

object (PromoBuyRuleCartConditions)

PromoBuyRuleCartConditions

cart_quantity

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

cart_total

object (PromoBuyRuleCompareFieldsTypes)

PromoBuyRuleCompareFieldsTypes

greater_than_equals

number

greater_than

number

equals

number

less_than

number

less_than_equals

number

item_id

array of number

item_store

array of number

item_company

array of number

item_brand

array of number

item_exclude_brand

array of number

item_category

array of number

item_exclude_category

array of number

item_l1_category

array of number

item_exclude_l1_category

array of number

item_l2_category

array of number

item_exclude_l2_category

array of number

item_department

array of number

item_exclude_id

array of number

available_zones

array of number

product_tags

array of string

item_criteria

object

Item criteria of promotion

all_items

boolean

Nullable

mrp_promo

boolean

slug

string

offer_text

string

Offer text of current promotion

amount

number

| float

Per unit discount amount applied with current promotion

promotion_type

string

Promotion type of current promotion

mrp_promotion

boolean

If applied promotion is applied on product MRP or ESP

promotion_group

string

Promotion group for the promotion

promo_id

string

Promotion id

meta

object

Meta object for extra data

code

string

Nullable

Promotion code

offer_label

string

Nullable

return_allowed

boolean

Nullable

cancellation_allowed

boolean

Nullable

promo_code

string

Nullable

free_quantity

integer

| int32

Nullable

offer_description

string

Nullable

delivery_promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

key

string

The attribute key associated with the size.

coupon

object (CouponDetails)

CouponDetails

discount_total_quantity

number

| float

discount_single_quantity

number

| float

code

string

bulk_offer

object

Bulk offer information for the product which denotes if any bulk offer is applied to the product in cart.

price_adjustment_applied

array of object (ArticleAppliedPriceAdjustment)

Array of ArticleAppliedPriceAdjustment

adjusted_value

object

Value of price adjustment created along with destination currency

article_level_distribution

boolean

Boolean value true if price adjustment is distributed over articles

article_id

string

Article Id of product

applied_quantity

integer

| int32

Article quantity on which this price adjusment applied

meta

object

Meta data added in article of price adjustment

price

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

coupon_message

string

Message for the coupon denotes which coupon is applied and empty if not applied.

identifiers

object (CartProductIdentifer)

CartProductIdentifer

identifier

string

Article idenfier generated by cart

message

string

Product level message which denotes error information to display over the product in cart.

discount

string

Discount amount of the product in cart.

availability

object (ProductAvailability)

ProductAvailability

is_valid

boolean

other_store_quantity

integer

| int64

deliverable

boolean

available_sizes

array of object (ProductAvailabilitySize)

Array of ProductAvailabilitySize

display

string

value

string

is_available

boolean

out_of_stock

boolean

sizes

array of string

moq

object (CartItemMOQ)

CartItemMOQ

increment_unit

number

| int32

Nullable

maximum

number

| int32

Nullable

minimum

number

| int32

Nullable

price_per_unit

object (ProductPriceInfo)

ProductPriceInfo

converted

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

base

object (ProductPrice)

ProductPrice

marked

number

| float

add_on

number

| float

currency_code

string

currency_symbol

string

effective

number

| float

selling

number

| float

selling_price

number

| float

promo_meta

object (PromoMeta)

PromoMeta

message

string

custom_order

object (CartItemCustomOrder)

CartItemCustomOrder

is_custom_order

boolean

manufacturing_time

number

| int32

manufacturing_time_unit

string

charges

array of number

Charges information which denotes types of charges and amount of charge applied to that product in cart.

allow_remove

boolean

If true, the product is allowed to be removed from the cart.

auto_add_to_cart

boolean

In case of bundle product this product is automatically added with parent product if true.

discount_meta

object (DiscountMeta)

DiscountMeta

timer

boolean

Determines whether the discount countdown is visible or not.

start_timer_in_minutes

number

The time in minutes before the discount ends when the countdown timer should start.

start

string

The start time of the live discount.

end

string

The end time of the live discount.

dp_options

object

Nullable

Delivery partner options that are available to deliver the shipment.

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.

box_type

string

Nullable

Box type of the shipment in which the shipment will be delivered.

promise

object (ShipmentPromise)

ShipmentPromise

formatted

object (PromiseFormatted)

PromiseFormatted

max

string

Nullable

min

string

Nullable

timestamp

object (PromiseTimestamp)

PromiseTimestamp

max

number

| float

Nullable

min

number

| float

Nullable

iso

object (PromiseISOFormat)

PromiseISOFormat

max

string

Nullable

Max promise in ISO format.

min

string

Nullable

Min Promise in ISO format.

dp_id

string

Nullable

Delivery partner id of the shipment.

fulfillment_type

string

Fulfilment type of shipment.

articles

array of object (ShipmentArticle)

Array of ShipmentArticle

meta

string

quantity

string

article_id

string

meta

object (ShipmentMeta)

ShipmentMeta

packaging_name

string

Nullable

dimension

object (ShipmentMetaDimension)

ShipmentMetaDimension

height

number

The height of the product

length

number

The length of the product

width

number

The width of the product

assign_dp_from_sb

string

Nullable

dp_sort_key

string

Nullable

shipment_weight

number

Nullable

shipment_volumetric_weight

number

Nullable

shipment_chargeable_weight

number

Nullable

shipping_zone

string

Nullable

debug

object

Nullable

logistics_meta

object (ShipmentLogisticsMeta)

ShipmentLogisticsMeta

account_options

array of object (ShipmentLogisticsMetaAccount)

Array of ShipmentLogisticsMetaAccount

name

string

Nullable

display_name

string

Nullable

fm_priority

number

Nullable

lm_priority

number

Nullable

rvp_priority

number

Nullable

type

string

Nullable

sub_type

string

Nullable

parent_id

string

Nullable

is_active

boolean

Nullable

payment_mode

string

Nullable

assign_dp_from_sb

string

Nullable

internal_account_id

string

Nullable

external_account_id

string

Nullable

f_priority

number

Nullable

r_priority

number

Nullable

dp_shipping_charges

number

Nullable

qc_enabled

boolean

Nullable

area_code

object (ShipmentLogisticsMetaAccountAreaCode)

ShipmentLogisticsMetaAccountAreaCode

from_pincode

string

Nullable

to_pincode

string

Nullable

source

string

Nullable

destination

string

Nullable

operations

array of string

dp_tat

object (ShipmentLogisticsMetaAccountDpTat)

ShipmentLogisticsMetaAccountDpTat

min

number

Nullable

max

number

Nullable

account_info

object

dp_sort_key

string

Nullable

assign_dp_from_sb

string

Nullable

error

object (ShipmentError)

ShipmentError

type

string

Nullable

value

array of string

message

string

Nullable

debug

object

error

boolean

is_pan_received

boolean

If the customer provides a PAN number, set it to true.

custom_cart_meta

object

Custom meta details added cart checkout API payload.

error_code

string

Nullable

Error code corresponding to error in cart.

Examples

Parameters

id:

"65c06fe589db42581e4be72e"

address_id:

"65bb5a41feeb84432e132c03"

area_code:

400093

body:

body

Was this section helpful?

PUT

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/shipment

Response

GET

Get delivery modes

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.

Requires application/cart/read access scope.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

area_code

string

Required

The PIN Code of the destination address, e.g. 400059

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.

CartDeliveryModesResponseObject

pickup_stores

array of integer

Store pick up available store uids

available_modes

array of string

Available delivery modes

Examples

Parameters

area_code:

400093

id:

"65c06fe589db42581e4be72e"

Was this section helpful?

GET

/service/platform/cart/v1.0/company/{company_id}/application/{application_id}/available-delivery-mode

Response

« Register Subscriber.

Get values of the selected value for the filter options. »

Cart

Cart

Get promotion and coupon type

Get promotion and coupon type

getPromosCouponConfig

Get cart meta configuration by id

Get cart meta configuration by id

getCartMetaConfig

Update cart metadata configuration.

Update cart metadata configuration.

updateCartMetaConfig

Delete cart meta configuration

Delete cart meta configuration

deleteCartMetaConfig

Fetch cart meta configuration

Fetch cart meta configuration

getCartMetaConfigs

Create new cart meta configuration

Create new cart meta configuration

createCartMetaConfig

Get abandoned carts

Get abandoned carts

getAbandonedCart

Share cart link

Share cart link

getCartShareLink

Get details of a shared cart

Get details of a shared cart

getCartSharedItems

Update shared cart items

Update shared cart items

updateCartWithSharedItems

Get cart list for store os user

Get cart list for store os user

getCartList

Update cart user details.

Update cart user details.

updateCartUser

Count items in the customer's cart

Count items in the customer's cart

getItemCount

Add items to cart

Add items to cart

platformAddItems

Update cart items

Update cart items

platformUpdateCart

Delete a cart

Delete a cart

deleteCart

List coupons

List coupons

getAppCoupons

Apply a coupon to the cart.

Apply a coupon to the cart.

applyCoupon

Update cart metadata

Update cart metadata

updateCartMeta

Checkout

Get and validate cart items

Get and validate cart items

fetchAndvalidateCartItems

Check cart serviceability

Check cart serviceability

checkCartServiceability

Checkout cart

Checkout cart

checkoutCart

Get abandoned cart details

Get abandoned cart details

getAbandonedCartDetails

Add items to abandoned cart

Add items to abandoned cart

addItems

Update cart items

Update cart items

updateCart

Create Fynd order with overriding cart details

Create Fynd order with overriding cart details