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
POST
# Check cart serviceability
GET
# Get abandoned carts
GET
# Get abandoned cart details
POST
# Add items to cart
PUT
# Update cart items
POST
# Share cart link
GET
# List shared cart items
POST
# Update shared cart items
GET
# List carts
PUT
# Update user of a cart
GET
# Get a cart
POST
# Add items to cart
PUT
# Update cart items
PUT
# Delete a cart
GET
# Get a cart items count
PUT
# Update cart metadata
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.
Parameters
body
object (OpenApiCartServiceabilityRequest)
OpenApiCartServiceabilityRequest
cart_items
array of object (CartItem)
Array of CartItem
shipping_address
object (ShippingAddress)
ShippingAddress
Response
200
Cart details with pincode validity information at item level
OpenApiCartServiceabilityResponse
is_valid
boolean
Optional
items
array of object (CartProductInfo)
Optional
Array of CartProductInfo
delivery_promise
object (ShipmentPromise)
Optional
ShipmentPromise
message
string
Optional
breakup_values
object (CartBreakup)
Optional
CartBreakup
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Check cart serviceability
checkCartServiceability
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.
Parameters
pageNo
integer
Optional
current page no as per pagination
Default Value : 0
pageSize
integer
Optional
Coupon max records fetched in single request
Default Value : 10
fromDate
string
Optional
Cart which are created on or after from_date
toDate
string
Optional
Cart which are created on or before to_date
anonymousCart
boolean
Optional
Filter by `anonymous_cart`
lastId
string
Optional
pagination is done based on the last_object_id
sortOn
string
Optional
on which column to sort on i.e created_on or last_modified
Response
200
Abandoned Cart List for sent page_size and page_no
AbandonedCartResponse
items
array of object (AbandonedCart)
Optional
Array of AbandonedCart
result
object
Optional
page
object (Page)
Optional
Page
success
boolean
Optional
the request success is defined
message
string
Optional
message of the response
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get abandoned carts
getAbandonedCart
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.
Parameters
id
string
Optional
The unique identifier of the cart
i
boolean
Optional
This is a boolean value. Select `true` to retrieve all the items added in the cart.
b
boolean
Optional
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
c
boolean
Optional
This is a boolean value. Select `true` to retrieve the cod charges in breakup of cart items.
Response
200
Success. Returns a Cart object. Check the example shown below or refer `CartDetailResponse` for more details.
CartDetailResponse
cart_id
integer
| int32
Optional
uid
string
Optional
coupon_text
string
Optional
id
string
Optional
pan_config
object
Optional
delivery_promise
object (ShipmentPromise)
Optional
ShipmentPromise
comment
string
Optional
items
array of object (CartProductInfo)
Optional
Array of CartProductInfo
payment_selection_lock
object (PaymentSelectionLock)
Optional
PaymentSelectionLock
delivery_charge_info
string
Optional
common_config
object (CartCommonConfig)
Optional
CartCommonConfig
coupon
object (CartDetailCoupon)
Optional
CartDetailCoupon
restrict_checkout
boolean
Optional
message
string
Optional
notification
object
Optional
staff_user_id
string
Optional
success
boolean
Optional
breakup_values
object (CartBreakup)
Optional
CartBreakup
is_valid
boolean
Optional
currency
object (CartCurrency)
Optional
CartCurrency
checkout_mode
string
Optional
last_modified
string
| date
Optional
buy_now
boolean
Optional
gstin
string
Optional
applied_promo_details
array of object (AppliedPromotion)
Optional
Array of AppliedPromotion
pan_no
string
Optional
Examples
Parameters
id:
"value"
i:
false
b:
false
c:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Get abandoned cart details
getAbandonedCartDetails
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.
Parameters
cartId
string
Current Cart _id
b
boolean
Optional
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
body
object (AddCartRequest)
Specify the item details as shown below. Refer `AddCartRequest` for more details.
AddCartRequest
new_cart
boolean
Optional
items
array of object (AddProductCart)
Optional
Array of AddProductCart
Response
200
Success. Returns a cart object as shown below. Refer `AddCartDetailResponse` for more details.
AddCartDetailResponse
success
boolean
Optional
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResponse)
Optional
CartDetailResponse
partial
boolean
Optional
When adding multiple items check if all added. True if only few are added.
message
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Add items to cart
addItems
PUT
Update cart items
Customers can modify added product attributes such as quantity and size, as well as remove items from the cart.
Parameters
cartId
string
Current Cart _id
b
boolean
Optional
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
body
object (UpdateCartRequest)
Specify the item details and operation as shown below. Refer `UpdateCartRequest` for more details.
UpdateCartRequest
items
array of object (UpdateProductCart)
Optional
Array of UpdateProductCart
operation
string
Enum
Response
200
Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResponse` for more details.
UpdateCartDetailResponse
success
boolean
Optional
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResponse)
Optional
CartDetailResponse
message
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Loading...
Response
Loading...
Update cart items
updateCart
Share cart link
getCartShareLink
List shared cart items
getCartSharedItems
Update shared cart items
updateCartWithSharedItems
GET
List carts
Retrieve the list of active carts associated with a specific customer.
Parameters
fromDate
string
Optional
Cart which are created on or after from_date. Supports ISO date format.
toDate
string
Optional
Cart which are created on or before to_date. Supports ISO date format.
filterOn
string
Optional
on which column to sort on i.e created_on or last_modified
Response
200
Platform user cart list
MultiCartResponse
success
boolean
Optional
data
array of object (CartList)
Optional
Array of CartList
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List carts
getCartList
PUT
Update user of a cart
Modify the cart user to a new valid customer for the provided customer ID.
Parameters
id
string
Optional
cart id
body
object (UpdateUserCartMapping)
Customer id to map with cart.
UpdateUserCartMapping
user_id
string
Response
200
UserCartMappingResponse
coupon_text
string
Optional
user
object (UserInfo)
Optional
UserInfo
id
string
Optional
pan_config
object
Optional
delivery_promise
object (ShipmentPromise)
Optional
ShipmentPromise
comment
string
Optional
items
array of object (CartProductInfo)
Optional
Array of CartProductInfo
payment_selection_lock
object (PaymentSelectionLock)
Optional
PaymentSelectionLock
delivery_charge_info
string
Optional
restrict_checkout
boolean
Optional
message
string
Optional
breakup_values
object (CartBreakup)
Optional
CartBreakup
is_valid
boolean
Optional
currency
object (CartCurrency)
Optional
CartCurrency
checkout_mode
string
Optional
last_modified
string
| date
Optional
buy_now
boolean
Optional
gstin
string
Optional
applied_promo_details
array of object (AppliedPromotion)
Optional
Array of AppliedPromotion
pan_no
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Loading...
Response
Loading...
Update user of a cart
updateCartUser
GET
Get a cart
Retrieve details of a cart linked to a specific customer using either the customer's ID or a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart.
Parameters
id
string
Optional
The unique identifier of the cart
userId
string
Optional
Option to fetch cart for the provided user_id.
i
boolean
Optional
This is a boolean value. Select `true` to retrieve all the items added in the cart.
b
boolean
Optional
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
assignCardId
integer
Optional
Token of user's debit or credit card
buyNow
boolean
Optional
This is a boolen value. Select `true` to set/initialize buy now cart
Response
200
400
Success. Returns a Cart object. Check the example shown below or refer `CartDetailResponse` for more details.
CartDetailResponse
cart_id
integer
| int32
Optional
uid
string
Optional
coupon_text
string
Optional
id
string
Optional
pan_config
object
Optional
delivery_promise
object (ShipmentPromise)
Optional
ShipmentPromise
comment
string
Optional
items
array of object (CartProductInfo)
Optional
Array of CartProductInfo
payment_selection_lock
object (PaymentSelectionLock)
Optional
PaymentSelectionLock
delivery_charge_info
string
Optional
common_config
object (CartCommonConfig)
Optional
CartCommonConfig
coupon
object (CartDetailCoupon)
Optional
CartDetailCoupon
restrict_checkout
boolean
Optional
message
string
Optional
notification
object
Optional
staff_user_id
string
Optional
success
boolean
Optional
breakup_values
object (CartBreakup)
Optional
CartBreakup
is_valid
boolean
Optional
currency
object (CartCurrency)
Optional
CartCurrency
checkout_mode
string
Optional
last_modified
string
| date
Optional
buy_now
boolean
Optional
gstin
string
Optional
applied_promo_details
array of object (AppliedPromotion)
Optional
Array of AppliedPromotion
pan_no
string
Optional
Examples
Parameters
id:
"value"
userId:
"value"
i:
false
b:
false
assignCardId:
0
buyNow:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Get a cart
getCart
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.
Parameters
i
boolean
Optional
This is a boolean value. Select `true` to retrieve all the items added in the cart.
b
boolean
Optional
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
buyNow
boolean
Optional
This is a boolen value. Select `true` to set/initialize buy now cart
id
string
Optional
The unique identifier of the cart
body
object (PlatformAddCartRequest)
Specify the item details as shown below. Refer `PlatformAddCartRequest` for more details.
PlatformAddCartRequest
user_id
string
Optional
new_cart
boolean
Optional
items
array of object (AddProductCart)
Optional
Array of AddProductCart
Response
200
Success. Returns a cart object as shown below. Refer `AddCartDetailResponse` for more details.
AddCartDetailResponse
success
boolean
Optional
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResponse)
Optional
CartDetailResponse
partial
boolean
Optional
When adding multiple items check if all added. True if only few are added.
message
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Add items to cart
platformAddItems
PUT
Update cart items
Customers can modify added product attributes such as quantity and size, as well as remove items from the cart.
Parameters
id
string
Optional
The unique identifier of the cart
i
boolean
Optional
This is a boolean value. Select `true` to retrieve all the items added in the cart.
b
boolean
Optional
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
buyNow
boolean
Optional
This is a boolen value. Select `true` to set/initialize buy now cart
body
object (PlatformUpdateCartRequest)
Specify the item details and operation as shown below. Refer `PlatformUpdateCartRequest` for more details.
PlatformUpdateCartRequest
user_id
string
Optional
items
array of object (UpdateProductCart)
Optional
Array of UpdateProductCart
operation
string
Enum
Response
200
Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResponse` for more details.
UpdateCartDetailResponse
success
boolean
Optional
True if all items are added successfully. False if partially added or not added.
cart
object (CartDetailResponse)
Optional
CartDetailResponse
message
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Loading...
Response
Loading...
Update cart items
platformUpdateCart
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.
Parameters
id
string
Optional
The unique identifier of the cart.
body
object (DeleteCartRequest)
Specify cart id list to archive/delete carts. Refer `DeleteCartRequest` for more details.
DeleteCartRequest
cart_id_list
array of string
Optional
Response
200
Success. Returns whether the cart has been deleted or not.
DeleteCartDetailResponse
success
boolean
Optional
True if cart is archived successfully. False if not archived.
message
string
Optional
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Delete a cart
deleteCart
GET
Get a cart items count
Retrieve the total count of items currently present in the customer's cart.
Parameters
id
string
Optional
The unique identifier of the cart.
buyNow
boolean
Optional
Boolean value to get buy_now cart.
Response
200
Success. Returns the total count of items in a user's cart.
CartItemCountResponse
user_cart_items_count
integer
| int32
Optional
Item count present in cart
Examples
Parameters
id:
"value"
buyNow:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Get a cart items count
getItemCount
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.
Parameters
id
string
Optional
The unique identifier of the cart
buyNow
boolean
Optional
this is boolean to get buy_now cart
body
object (PlatformCartMetaRequest)
gstin:Pass gstin number to claim GST credit, e.g. 27AAPFU0939F1ZV checkout_mode:Pass checkout mode for current order as described below. self:Customer him self placing order staff:Placing order on behalf of customer comment:Set comments to be passed to order team during adding items, e.g. leave the package with my neighbour.
PlatformCartMetaRequest
gstin
string
Optional
pick_up_customer_details
object
Optional
Customer contact details for customer pickup at store
checkout_mode
string
Optional
gift_details
object
Nullable
Optional
pan_no
string
Optional
comment
string
Optional
staff_user_id
string
Nullable
Optional
staff user id
Response
200
400
Returns a message indicating the success of cart meta updation as shown below.
CartMetaResponse
is_valid
boolean
Optional
message
string
Optional
Examples
Parameters
id:
"value"
buyNow:
false
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update cart metadata
updateCartMeta
Cart meta
Cart meta includes configuration settings for customizing and optimizing the cart experience, such as adjusting item limits, configuring discounts, and managing delivery charges, to meet the needs of sales channels effectively.
Operations
PUT
# Update cart meta
GET
# Get cart meta
POST
# Create a new cart meta
PUT
Update cart meta
Modify the configuration settings for cart metadata associated with a specific sales channel. Cart meta includes configuration settings such as allowed maximum cart value, allowed minimum cart value, maximum allowed cart items, delivery charges, etc.
Parameters
cartMetaId
string
CartMeta mongo _id for fetching single cart meta data for editing
body
object (CartMetaConfigUpdate)
CartMetaConfigUpdate
min_cart_value
integer
| int32
Optional
max_cart_value
integer
| int32
Optional
bulk_coupons
boolean
Optional
max_cart_items
integer
| int32
Optional
gift_display_text
string
Optional
delivery_charges
object (DeliveryCharges)
Optional
DeliveryCharges
revenue_engine_coupon
boolean
Optional
gift_pricing
number
| float
Optional
enabled
boolean
Optional
Response
200
400
Cart Meta Config updated successfully
CartMetaConfigUpdate
min_cart_value
integer
| int32
Optional
max_cart_value
integer
| int32
Optional
bulk_coupons
boolean
Optional
max_cart_items
integer
| int32
Optional
gift_display_text
string
Optional
delivery_charges
object (DeliveryCharges)
Optional
DeliveryCharges
revenue_engine_coupon
boolean
Optional
gift_pricing
number
| float
Optional
enabled
boolean
Optional
Examples
Parameters
cartMetaId:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update cart meta
updateCartMetaConfig
GET
Get cart meta
Retrieve meta configuration settings tailored for customizing the cart experience within a specific sales channel. Cart meta includes configuration settings such as allowed maximum cart value, allowed minimum cart value, maximum allowed cart items, delivery charges, etc.
Parameters
No Parameters
Response
200
400
Cart Meta Config Fetched successfully
CartMetaConfigAdd
min_cart_value
integer
| int32
Optional
max_cart_value
integer
| int32
Optional
bulk_coupons
boolean
Optional
max_cart_items
integer
| int32
Optional
gift_display_text
string
Optional
delivery_charges
object (DeliveryCharges)
Optional
DeliveryCharges
revenue_engine_coupon
boolean
Optional
gift_pricing
number
| float
Optional
enabled
boolean
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get cart meta
fetchCartMetaConfig
POST
Create a new cart meta
Create custom meta configurations for carts associated with a specific sales channel. By specifying the company ID and application ID, seller can define unique cart settings, including preferences, rules, and constraints, tailored to their business needs.
Parameters
body
object (CartMetaConfigAdd)
CartMetaConfigAdd
min_cart_value
integer
| int32
Optional
max_cart_value
integer
| int32
Optional
bulk_coupons
boolean
Optional
max_cart_items
integer
| int32
Optional
gift_display_text
string
Optional
delivery_charges
object (DeliveryCharges)
Optional
DeliveryCharges
revenue_engine_coupon
boolean
Optional
gift_pricing
number
| float
Optional
enabled
boolean
Optional
Response
201
400
Cart Meta Config Created successfully
CartMetaConfigAdd
min_cart_value
integer
| int32
Optional
max_cart_value
integer
| int32
Optional
bulk_coupons
boolean
Optional
max_cart_items
integer
| int32
Optional
gift_display_text
string
Optional
delivery_charges
object (DeliveryCharges)
Optional
DeliveryCharges
revenue_engine_coupon
boolean
Optional
gift_pricing
number
| float
Optional
enabled
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create a new cart meta
createCartMetaConfig
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
# Get and validate cart items
POST
# Checkout cart
POST
# Update cart checkout
POST
# Checkout cart
POST
# 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.
Parameters
body
object (OpenapiCartDetailsRequest)
OpenapiCartDetailsRequest
cart_items
array of object (CartItem)
Array of CartItem
Response
200
400
Cart details with breakup
OpenapiCartDetailsResponse
is_valid
boolean
Optional
message
string
Optional
breakup_values
object (CartBreakup)
Optional
CartBreakup
items
array of object (CartProductInfo)
Optional
Array of CartProductInfo
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Get and validate cart items
fetchAndvalidateCartItems
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.
Parameters
body
object (OpenApiPlatformCheckoutReq)
OpenApiPlatformCheckoutReq
payment_mode
string
Optional
cart_value
number
| float
cart_items
array of object (OpenApiOrderItem)
Array of OpenApiOrderItem
shipping_address
object (ShippingAddress)
Optional
ShippingAddress
loyalty_discount
number
| float
Optional
comment
string
Nullable
Optional
payment_methods
array of object (MultiTenderPaymentMethod)
Array of MultiTenderPaymentMethod
employee_discount
object
Optional
coupon
string
Optional
cashback_applied
number
| float
gstin
string
Nullable
Optional
billing_address
object (ShippingAddress)
ShippingAddress
coupon_code
string
coupon_value
number
| float
delivery_charges
number
| float
affiliate_order_id
string
Optional
currency_code
string
Optional
order_id
string
Optional
files
array of object (OpenApiFiles)
Optional
Array of OpenApiFiles
cod_charges
number
| float
Response
200
400
Checkout cart and create Fynd order id
OpenApiCheckoutResponse
success
boolean
Optional
message
string
Optional
order_ref_id
string
Optional
Order id sent in request
order_id
string
Fynd order id
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Checkout cart
checkoutCart
POST
Update cart checkout
Overrides the cart's checkout process with a new provided cart items. It provides flexibility in customizing checkout flows to meet specific business requirements, enhancing the user experience and optimizing order processing workflows.
Parameters
body
object (OverrideCheckoutReq)
OverrideCheckoutReq
cart_id
string
payment_mode
string
billing_address
object
Optional
merchant_code
string
payment_identifier
string
Nullable
currency_code
string
aggregator
string
order_type
string
cart_items
array of object (OverrideCartItem)
Array of OverrideCartItem
ordering_store
integer
| int32
Nullable
Optional
Default Value : null
shipping_address
object
Optional
Response
200
Checkout cart and create Fynd order id
OverrideCheckoutResponse
data
object
cart
object
success
string
order_id
string
message
string
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update cart checkout
overrideCart
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.
Parameters
id
string
Optional
The unique identifier of the cart
body
object (PlatformCartCheckoutDetailRequest)
Check the example shown below or refer `PlatformCartCheckoutDetailRequest` for more details.
PlatformCartCheckoutDetailRequest
custom_meta
array of object (CartCheckoutCustomMeta)
Optional
Array of CartCheckoutCustomMeta
address_id
string
Optional
payment_identifier
string
Nullable
Optional
payment_params
object
Nullable
Optional
payment_auto_confirm
boolean
Optional
id
string
pos
boolean
Optional
billing_address_id
string
Optional
merchant_code
string
Optional
aggregator
string
Optional
pick_at_store_uid
integer
| int32
Nullable
Optional
Default Value : null
device_id
string
Nullable
Optional
delivery_address
object
Optional
payment_mode
string
checkout_mode
string
Optional
customer_details
object (CustomerDetails)
Nullable
Optional
Customer details
CustomerDetails
meta
object
Optional
staff
object (StaffCheckout)
Optional
StaffCheckout
employee_code
string
Nullable
Optional
billing_address
object
Optional
callback_url
string
Nullable
Optional
Default Value : null
user_id
string
Nullable
extra_meta
object
Optional
order_type
string
files
array of object (Files)
Optional
List of file url
Array of Files
ordering_store
integer
| int32
Nullable
Optional
payment_extra_identifiers
object
Optional
iin
string
Optional
network
string
Optional
type
string
Optional
card_id
string
Optional
Response
200
Success. Returns the status of cart checkout. Refer `CartCheckoutResponse` for more details.
CartCheckoutResponse
app_intercept_url
string
Optional
data
object
Optional
cart
object (CheckCart)
Optional
CheckCart
success
boolean
Optional
callback_url
string
Optional
payment_confirm_url
string
Optional
order_id
string
Optional
message
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Checkout cart
platformCheckoutCart
POST
Cart checkout (latest)
Checkout process that supports multiple MOP(mode of payment).
Parameters
id
string
Optional
The unique identifier of the cart
body
object (PlatformCartCheckoutDetailV2Request)
Check the example shown below or refer `PlatformCartCheckoutDetailV2Request` for more details.
PlatformCartCheckoutDetailV2Request
address_id
string
Optional
payment_identifier
string
Nullable
Optional
payment_params
object
Nullable
Optional
custom_meta
object
Optional
payment_auto_confirm
boolean
Optional
id
string
pos
boolean
Optional
billing_address_id
string
Optional
merchant_code
string
Optional
aggregator
string
Optional
pick_at_store_uid
integer
| int32
Nullable
Optional
Default Value : null
device_id
string
Nullable
Optional
delivery_address
object
Optional
payment_mode
string
Optional
checkout_mode
string
Optional
customer_details
object (CustomerDetails)
Nullable
Optional
Customer details
CustomerDetails
meta
object
Optional
payment_methods
array of object (PaymentMethod)
Array of PaymentMethod
staff
object (StaffCheckout)
Optional
StaffCheckout
employee_code
string
Nullable
Optional
billing_address
object
Optional
callback_url
string
Nullable
Optional
Default Value : null
user_id
string
Nullable
extra_meta
object
Optional
order_type
string
files
array of object (Files)
Optional
List of file url
Array of Files
ordering_store
integer
| int32
Nullable
Optional
iin
string
Optional
network
string
Optional
type
string
Optional
card_id
string
Optional
Response
200
400
Success. Returns the status of cart checkout. Refer `CartCheckoutResponseSchema` for more details.
CartCheckoutResponse
app_intercept_url
string
Optional
data
object
Optional
cart
object (CheckCart)
Optional
CheckCart
success
boolean
Optional
callback_url
string
Optional
payment_confirm_url
string
Optional
order_id
string
Optional
message
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Cart checkout (latest)
platformCheckoutCartV2
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
GET
# List coupons
POST
# Create a coupon
GET
# Get a coupon
PUT
# Update a coupon
PATCH
# Update a coupon partially
GET
# Get coupon option values
GET
# Check coupon code exists
GET
# List coupons
POST
# Apply coupon
DEL
# Remove coupon
GET
# Validate applied coupon
GET
List 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.
Parameters
pageNo
integer
Optional
current page no as per pagination
Default Value : 0
pageSize
integer
Optional
Coupon max records fetched in single request
Default Value : 10
isArchived
boolean
Optional
Filter by active or inactive coupon
Default Value : false
title
string
Optional
Filter by `title`
isPublic
boolean
Optional
Filter by `is_public`
isDisplay
boolean
Optional
Filter by `is_display`
typeSlug
string
Optional
Filter by coupon type
code
string
Optional
Filter by `code`
Response
200
Coupon List for sent page_size and page_no
CouponsResponse
items
array of object (CouponAdd)
Optional
Array of CouponAdd
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List coupons
getCoupons
POST
Create a coupon
Creates a new coupon based on the selected coupon type. Sellers can choose from multiple supported coupon types, including percentage value, fixed amount value, bundled discount, buy X get Y items, and more, along with customizable coupon criteria to meet specific business requirements.
Parameters
body
object (CouponAdd)
CouponAdd
date_meta
object (CouponDateMeta)
Optional
CouponDateMeta
ownership
object (Ownership)
Ownership
author
object (CouponAuthor)
Optional
CouponAuthor
state
object (State)
Optional
State
restrictions
object (Restrictions)
Optional
Restrictions
validation
object (Validation)
Optional
Validation
action
object (CouponAction)
Optional
CouponAction
tags
array of string
Optional
Default Value :
_schedule
object (CouponSchedule)
Optional
CouponSchedule
rule
array of object (Rule)
Array of Rule
display_meta
object (DisplayMeta)
DisplayMeta
code
string
type_slug
string
identifiers
object (Identifier)
Identifier
validity
object (Validity)
Validity
rule_definition
object (RuleDefinition)
RuleDefinition
_id
string
Optional
Coupon id
Response
201
400
Coupon Created successfully
SuccessMessage
success
boolean
Optional
message
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create a coupon
createCoupon
GET
Get a coupon
Retrieve details of a specific coupon by providing its unique identifier to obtain information such as coupon type, rules, validity period and other related information.
Parameters
id
string
Coupon mongo _id for fetching single coupon data for editing
Response
200
404
Coupon object for sent `id`
CouponUpdate
date_meta
object (CouponDateMeta)
Optional
CouponDateMeta
ownership
object (Ownership)
Ownership
author
object (CouponAuthor)
Optional
CouponAuthor
state
object (State)
Optional
State
restrictions
object (Restrictions)
Optional
Restrictions
validation
object (Validation)
Optional
Validation
action
object (CouponAction)
Optional
CouponAction
tags
array of string
Optional
Default Value :
_schedule
object (CouponSchedule)
Optional
CouponSchedule
rule
array of object (Rule)
Array of Rule
display_meta
object (DisplayMeta)
DisplayMeta
code
string
type_slug
string
identifiers
object (Identifier)
Identifier
validity
object (Validity)
Validity
rule_definition
object (RuleDefinition)
RuleDefinition
Examples
Parameters
id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get a coupon
getCouponById
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.
Parameters
id
string
Coupon mongo _id for fetching single coupon data for editing
body
object (CouponUpdate)
CouponUpdate
date_meta
object (CouponDateMeta)
Optional
CouponDateMeta
ownership
object (Ownership)
Ownership
author
object (CouponAuthor)
Optional
CouponAuthor
state
object (State)
Optional
State
restrictions
object (Restrictions)
Optional
Restrictions
validation
object (Validation)
Optional
Validation
action
object (CouponAction)
Optional
CouponAction
tags
array of string
Optional
Default Value :
_schedule
object (CouponSchedule)
Optional
CouponSchedule
rule
array of object (Rule)
Array of Rule
display_meta
object (DisplayMeta)
DisplayMeta
code
string
type_slug
string
identifiers
object (Identifier)
Identifier
validity
object (Validity)
Validity
rule_definition
object (RuleDefinition)
RuleDefinition
Response
200
404
Coupon updated successfully
SuccessMessage
success
boolean
Optional
message
string
Optional
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update a coupon
updateCoupon
PATCH
Update a coupon partially
Seller can make partial adjustments of an existing coupon by specifying its unique identifier. It enables businesses to modify specific attributes of the coupon while preserving other details intact.
Parameters
id
string
Coupon mongo _id for fetching single coupon data for editing
body
object (CouponPartialUpdate)
CouponPartialUpdate
archive
boolean
Optional
Send true to unpublish coupon
schedule
object (CouponSchedule)
Optional
CouponSchedule
Response
200
404
Coupon updated successfully
SuccessMessage
success
boolean
Optional
message
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
PATCH
Loading...
Response
Loading...
Update a coupon partially
updateCouponPartially
GET
Get coupon option values
Retrieves the available values for coupon options used to create and update coupons.
Parameters
No Parameters
Response
200
Coupon options enums
Properties
types
array of string
Optional
scopes
array of string
Optional
applicable_on
array of string
Optional
value_types
array of string
Optional
calculate_on
array of string
Optional
payable_category
array of string
Optional
txn_mode
array of string
Optional
payable_by
array of string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get coupon option values
getCouponOptionValues
GET
Check coupon code exists
Validates the presence of a coupon code for the specified sales channel to verify whether the provided code already exists or not.
Parameters
code
string
Optional
Coupon code
Response
200
400
Valid response with existing coupon code count
Properties
success
boolean
Optional
count
integer
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Check coupon code exists
getCouponCodeExists
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.
Parameters
id
string
Optional
The unique identifier of the cart.
buyNow
boolean
Optional
This is boolean to get buy_now cart
slug
string
Optional
Product slug to fetch the available coupons
storeId
string
Optional
Store id
Response
200
Success. Returns a coupon object which has a list of all the eligible coupons. Refer `GetCouponResponse` for more details.
GetCouponResponse
available_coupon_list
array of object (Coupon)
Optional
Array of Coupon
page
object (PageCoupon)
Optional
PageCoupon
Examples
Parameters
id:
"value"
buyNow:
false
slug:
"value"
storeId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List coupons
getAppCoupons
POST
Apply coupon
Apply a coupon code to the customer's cart to trigger discounts on eligible items
Parameters
i
boolean
Optional
This is a boolean value. Select `true` to retrieve all the items added in the cart.
b
boolean
Optional
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
p
boolean
Optional
This is a boolean value. Select `true` for getting a payment option in response.
id
string
Optional
The unique identifier of the cart
buyNow
boolean
Optional
This is boolean to get buy_now cart
body
object (ApplyCouponRequest)
Pass coupon code in the request body as shown below.
ApplyCouponRequest
coupon_code
string
Coupon code to be applied
Response
201
Success. Returns coupons applied to the cart along with item details and price breakup. Refer `CartDetailResponse` for more details.
CartDetailResponse
cart_id
integer
| int32
Optional
uid
string
Optional
coupon_text
string
Optional
id
string
Optional
pan_config
object
Optional
delivery_promise
object (ShipmentPromise)
Optional
ShipmentPromise
comment
string
Optional
items
array of object (CartProductInfo)
Optional
Array of CartProductInfo
payment_selection_lock
object (PaymentSelectionLock)
Optional
PaymentSelectionLock
delivery_charge_info
string
Optional
common_config
object (CartCommonConfig)
Optional
CartCommonConfig
coupon
object (CartDetailCoupon)
Optional
CartDetailCoupon
restrict_checkout
boolean
Optional
message
string
Optional
notification
object
Optional
staff_user_id
string
Optional
success
boolean
Optional
breakup_values
object (CartBreakup)
Optional
CartBreakup
is_valid
boolean
Optional
currency
object (CartCurrency)
Optional
CartCurrency
checkout_mode
string
Optional
last_modified
string
| date
Optional
buy_now
boolean
Optional
gstin
string
Optional
applied_promo_details
array of object (AppliedPromotion)
Optional
Array of AppliedPromotion
pan_no
string
Optional
Examples
Parameters
i:
false
b:
false
p:
false
id:
"value"
buyNow:
false
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Apply coupon
applyCoupon
DEL
Remove coupon
Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total.
Parameters
uid
string
Optional
The unique identifier of the cart
buyNow
boolean
Optional
This is boolean to get buy_now cart
Response
200
Success. Returns coupons removed from the cart along with item details and price breakup. Refer `CartDetailResponse` for more details.
CartDetailResponse
cart_id
integer
| int32
Optional
uid
string
Optional
coupon_text
string
Optional
id
string
Optional
pan_config
object
Optional
delivery_promise
object (ShipmentPromise)
Optional
ShipmentPromise
comment
string
Optional
items
array of object (CartProductInfo)
Optional
Array of CartProductInfo
payment_selection_lock
object (PaymentSelectionLock)
Optional
PaymentSelectionLock
delivery_charge_info
string
Optional
common_config
object (CartCommonConfig)
Optional
CartCommonConfig
coupon
object (CartDetailCoupon)
Optional
CartDetailCoupon
restrict_checkout
boolean
Optional
message
string
Optional
notification
object
Optional
staff_user_id
string
Optional
success
boolean
Optional
breakup_values
object (CartBreakup)
Optional
CartBreakup
is_valid
boolean
Optional
currency
object (CartCurrency)
Optional
CartCurrency
checkout_mode
string
Optional
last_modified
string
| date
Optional
buy_now
boolean
Optional
gstin
string
Optional
applied_promo_details
array of object (AppliedPromotion)
Optional
Array of AppliedPromotion
pan_no
string
Optional
Examples
Parameters
uid:
"value"
buyNow:
false
Was this section helpful?
DEL
Loading...
Response
Loading...
Remove coupon
removeCoupon
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.
Parameters
id
string
Optional
The unique identifier of the cart
buyNow
boolean
Optional
This is boolean to get buy_now cart
addressId
string
Optional
ID allotted to an address
paymentMode
string
Optional
Payment mode selected by the customer
paymentIdentifier
string
Optional
Identifier of payment like ICIC, PAYTM
aggregatorName
string
Optional
Payment gateway identifier
merchantCode
string
Optional
Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM
Response
200
Success. Returns a success message and the coupon validity. Refer `PaymentCouponValidate` for more details.
PaymentCouponValidate
success
boolean
message
string
Optional
coupon_validity
object (CouponValidity)
Optional
CouponValidity
Examples
Parameters
id:
"value"
buyNow:
false
addressId:
"value"
paymentMode:
"value"
paymentIdentifier:
"value"
aggregatorName:
"value"
merchantCode:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Validate applied coupon
validateCouponForPayment
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
GET
# List customer addresses
POST
# Create a new address
GET
# Get a address
PUT
# Update address
DEL
# Delete a address
POST
# select a delivery address
GET
List customer addresses
Retrieves a list of all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery.
Parameters
cartId
string
Optional
The unique identifier of the cart
buyNow
boolean
Optional
This is boolean to get buy_now cart
mobileNo
string
Optional
10-digit mobile number
checkoutMode
string
Optional
Option to checkout for `self` or for `others`. By default, it is `self`.
tags
string
Optional
Tag given to an address, e.g. work, home, office, shop.
isDefault
boolean
Optional
This is a boolean value. Select `true` to fetch the default address.
userId
string
Optional
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 `GetAddressesResponse` for more details.
PlatformGetAddressesResponse
address
array of object (PlatformAddress)
Optional
Array of PlatformAddress
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List customer addresses
getAddresses
POST
Create a new address
Customers can add a new address to their cart to save details such as name, email, contact information, and address.
Parameters
body
object (PlatformAddress)
Add address details in the request body as shown below or refer `PlatformAddress` for more details.
PlatformAddress
phone
string
Optional
id
string
Optional
area_code_slug
string
Optional
country_code
string
Optional
geo_location
object (GeoLocation)
Optional
GeoLocation
country
string
Optional
state
string
Optional
is_default_address
boolean
Optional
tags
array of string
Optional
created_by_user_id
string
Optional
landmark
string
Optional
email
string
Optional
area_code
string
Optional
checkout_mode
string
Optional
meta
object
Optional
is_active
boolean
Optional
name
string
Optional
google_map_point
object
Optional
cart_id
string
Optional
city
string
Optional
sector
string
Optional
state_code
string
Optional
State code for international address
area
string
Optional
user_id
string
Optional
address_type
string
Optional
address
string
Optional
country_phone_code
string
Optional
country_iso_code
string
Optional
_custom_json
object
Optional
Response
200
400
Success. Returns the address ID, a flag whether the address is set as default, and a success message. Refer `SaveAddressResponse` for more details.
SaveAddressResponse
id
string
Optional
success
boolean
Optional
is_default_address
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create a new address
addAddress
GET
Get a 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.
Parameters
id
string
ID allotted to the selected address
cartId
string
Optional
The unique identifier of the cart
buyNow
boolean
Optional
This is boolean to get buy_now cart
mobileNo
string
Optional
10-digit mobile number
checkoutMode
string
Optional
Option to checkout for self or for others
tags
string
Optional
Tag given to an address, e.g. work, home, office, shop.
isDefault
boolean
Optional
This is a boolean value. Select `true` to fetch the default address.
userId
string
Optional
Option to fetch address for the provided user_id.
Response
200
400
Success. Returns an PlatformAddress object containing a list of address saved in the account. Refer `PlatformAddress` for more details.
PlatformAddress
phone
string
Optional
id
string
Optional
area_code_slug
string
Optional
country_code
string
Optional
geo_location
object (GeoLocation)
Optional
GeoLocation
country
string
Optional
state
string
Optional
is_default_address
boolean
Optional
tags
array of string
Optional
created_by_user_id
string
Optional
landmark
string
Optional
email
string
Optional
area_code
string
Optional
checkout_mode
string
Optional
meta
object
Optional
is_active
boolean
Optional
name
string
Optional
google_map_point
object
Optional
cart_id
string
Optional
city
string
Optional
sector
string
Optional
state_code
string
Optional
State code for international address
area
string
Optional
user_id
string
Optional
address_type
string
Optional
address
string
Optional
country_phone_code
string
Optional
country_iso_code
string
Optional
_custom_json
object
Optional
Examples
Parameters
id:
"value"
cartId:
"value"
buyNow:
false
mobileNo:
"value"
checkoutMode:
"value"
tags:
"value"
isDefault:
false
userId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get a address
getAddressById
PUT
Update address
Update the user address
Parameters
id
string
ID allotted to the selected address
body
object (PlatformAddress)
Add address details in the request body as shown below or refer `PlatformAddress` for more details.
PlatformAddress
phone
string
Optional
id
string
Optional
area_code_slug
string
Optional
country_code
string
Optional
geo_location
object (GeoLocation)
Optional
GeoLocation
country
string
Optional
state
string
Optional
is_default_address
boolean
Optional
tags
array of string
Optional
created_by_user_id
string
Optional
landmark
string
Optional
email
string
Optional
area_code
string
Optional
checkout_mode
string
Optional
meta
object
Optional
is_active
boolean
Optional
name
string
Optional
google_map_point
object
Optional
cart_id
string
Optional
city
string
Optional
sector
string
Optional
state_code
string
Optional
State code for international address
area
string
Optional
user_id
string
Optional
address_type
string
Optional
address
string
Optional
country_phone_code
string
Optional
country_iso_code
string
Optional
_custom_json
object
Optional
Response
201
400
Success. Returns the address ID and a message indicating a successful address updation.
UpdateAddressResponse
id
string
Optional
is_default_address
boolean
Optional
success
boolean
Optional
is_updated
boolean
Optional
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update address
updateAddress
DEL
Delete a address
Remove an existing customer address from the system.
Parameters
id
string
ID allotted to the selected address
userId
string
Optional
Option to delete address for the provided user_id.
Response
201
400
Returns a Status object indicating the success or failure of address deletion.
DeleteAddressResponse
id
string
Optional
is_deleted
boolean
Optional
Examples
Parameters
id:
"value"
userId:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete a address
removeAddress
POST
select a delivery address
Select an address from the saved customer addresses and validates the availability of items in the cart. Additionally, it verifies and updates the delivery promise based on the selected address.
Parameters
cartId
string
Optional
The unique identifier of the cart
buyNow
boolean
Optional
This is boolean to get buy_now cart
i
boolean
Optional
This is a boolean value. Select `true` to retrieve all the items added in the cart.
b
boolean
Optional
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
body
object (PlatformSelectCartAddressRequest)
Pass address details in the request body as shown below or refer `PlatformSelectCartAddressRequest` for more details.
PlatformSelectCartAddressRequest
cart_id
string
Optional
billing_address_id
string
Optional
checkout_mode
string
Optional
id
string
Optional
user_id
string
Optional
Response
201
400
Success. Returns a Cart object as shown below. Refer `CartDetailResponse` for more details. .
CartDetailResponse
cart_id
integer
| int32
Optional
uid
string
Optional
coupon_text
string
Optional
id
string
Optional
pan_config
object
Optional
delivery_promise
object (ShipmentPromise)
Optional
ShipmentPromise
comment
string
Optional
items
array of object (CartProductInfo)
Optional
Array of CartProductInfo
payment_selection_lock
object (PaymentSelectionLock)
Optional
PaymentSelectionLock
delivery_charge_info
string
Optional
common_config
object (CartCommonConfig)
Optional
CartCommonConfig
coupon
object (CartDetailCoupon)
Optional
CartDetailCoupon
restrict_checkout
boolean
Optional
message
string
Optional
notification
object
Optional
staff_user_id
string
Optional
success
boolean
Optional
breakup_values
object (CartBreakup)
Optional
CartBreakup
is_valid
boolean
Optional
currency
object (CartCurrency)
Optional
CartCurrency
checkout_mode
string
Optional
last_modified
string
| date
Optional
buy_now
boolean
Optional
gstin
string
Optional
applied_promo_details
array of object (AppliedPromotion)
Optional
Array of AppliedPromotion
pan_no
string
Optional
Examples
Parameters
cartId:
"value"
buyNow:
false
i:
false
b:
false
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
select a delivery address
selectAddress
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
# Select payment mode
PUT
# 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.
Parameters
id
string
Optional
The unique identifier of the cart
buyNow
boolean
Optional
This is boolean to get buy_now cart
orderType
string
Optional
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.
body
object (UpdateCartPaymentRequest)
Check the example shown below or refer `UpdateCartPaymentRequest` for more details.
UpdateCartPaymentRequest
address_id
string
Optional
payment_mode
string
Optional
aggregator_name
string
Optional
merchant_code
string
Optional
payment_identifier
string
Nullable
Optional
id
string
Optional
Response
200
Success. Returns a Cart object as shown below. Refer `CartDetailResponse` for more details.
CartDetailResponse
cart_id
integer
| int32
Optional
uid
string
Optional
coupon_text
string
Optional
id
string
Optional
pan_config
object
Optional
delivery_promise
object (ShipmentPromise)
Optional
ShipmentPromise
comment
string
Optional
items
array of object (CartProductInfo)
Optional
Array of CartProductInfo
payment_selection_lock
object (PaymentSelectionLock)
Optional
PaymentSelectionLock
delivery_charge_info
string
Optional
common_config
object (CartCommonConfig)
Optional
CartCommonConfig
coupon
object (CartDetailCoupon)
Optional
CartDetailCoupon
restrict_checkout
boolean
Optional
message
string
Optional
notification
object
Optional
staff_user_id
string
Optional
success
boolean
Optional
breakup_values
object (CartBreakup)
Optional
CartBreakup
is_valid
boolean
Optional
currency
object (CartCurrency)
Optional
CartCurrency
checkout_mode
string
Optional
last_modified
string
| date
Optional
buy_now
boolean
Optional
gstin
string
Optional
applied_promo_details
array of object (AppliedPromotion)
Optional
Array of AppliedPromotion
pan_no
string
Optional
Examples
Parameters
id:
"value"
buyNow:
false
orderType:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Select payment mode
selectPaymentMode
PUT
Select payment mode (latest)
Selection of payment mode that supports multiple MOP(mode of payment).
Parameters
id
string
Optional
The unique identifier of the cart
buyNow
boolean
Optional
This is boolean to get buy_now cart
orderType
string
Optional
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.
body
object (UpdateCartPaymentRequestV2)
Check the example shown below or refer `UpdateCartPaymentRequestV2` for more details.
UpdateCartPaymentRequestV2
address_id
string
Optional
payment_mode
string
Optional
aggregator_name
string
Optional
merchant_code
string
Optional
payment_identifier
string
Nullable
Optional
id
string
Optional
payment_methods
array of object (PaymentMethod)
Optional
Array of PaymentMethod
Response
200
400
Success. Returns a Cart object as shown below. Refer `CartDetailResponse` for more details.
CartDetailResponse
cart_id
integer
| int32
Optional
uid
string
Optional
coupon_text
string
Optional
id
string
Optional
pan_config
object
Optional
delivery_promise
object (ShipmentPromise)
Optional
ShipmentPromise
comment
string
Optional
items
array of object (CartProductInfo)
Optional
Array of CartProductInfo
payment_selection_lock
object (PaymentSelectionLock)
Optional
PaymentSelectionLock
delivery_charge_info
string
Optional
common_config
object (CartCommonConfig)
Optional
CartCommonConfig
coupon
object (CartDetailCoupon)
Optional
CartDetailCoupon
restrict_checkout
boolean
Optional
message
string
Optional
notification
object
Optional
staff_user_id
string
Optional
success
boolean
Optional
breakup_values
object (CartBreakup)
Optional
CartBreakup
is_valid
boolean
Optional
currency
object (CartCurrency)
Optional
CartCurrency
checkout_mode
string
Optional
last_modified
string
| date
Optional
buy_now
boolean
Optional
gstin
string
Optional
applied_promo_details
array of object (AppliedPromotion)
Optional
Array of AppliedPromotion
pan_no
string
Optional
Examples
Parameters
id:
"value"
buyNow:
false
orderType:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Select payment mode (latest)
selectPaymentModeV2
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
PUT
# Update price adjustments
DEL
# Remove price adjustments
POST
# Create price adjustments
PUT
Update price adjustments
Modify price adjustments for specific items in the cart. By providing the seller ID, sales channel ID, and price adjustment ID, seller can apply discounts or other adjustments to the prices of cart items, facilitating dynamic pricing strategies.
Parameters
id
string
price adjustment id for fetching single price adjustment data for editing
body
object (PriceAdjustmentUpdate)
PriceAdjustmentUpdate
modified_by
string
Optional
The entity that modified the field
value
number
| float
message
string
The message associated with the price adjustment
apply_expiry
string
| date-time
Optional
The date and time when the expiry should be applied
restrictions
object (PriceAdjustmentRestrictions)
Optional
restrictions applied to this particular item or product, including whether or not cancellation and return are allowed.
PriceAdjustmentRestrictions
article_level_distribution
boolean
Flag indicating whether the distribution should is done at the article level
collection
object (Collection)
Collection
type
string
type of price adjusment
Enum
allowed_refund
boolean
Optional
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
meta
object
Optional
cart_id
string
The ID of the cart
Response
200
400
Price Adjustment Updated successfully
PriceAdjustmentResponse
data
object (PriceAdjustment)
Optional
PriceAdjustment
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update price adjustments
updatePriceAdjustment
DEL
Remove price adjustments
Remove the applied price adjustments for specific items within the cart based on unique price adjustment ID.
Parameters
id
string
Price Adjustment id for fetching single price adjustment data for editing
Response
200
400
Price Adjustment data Removed successfully
SuccessMessage
success
boolean
Optional
message
string
Optional
Examples
Parameters
id:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Remove price adjustments
removePriceAdjustment
POST
Create price adjustments
Create custom price adjustments for items in the cart, facilitating the application of discounts or promotions. Price adjustments can be tailored based on specific sales channel contexts, enhancing flexibility in pricing strategies.
Parameters
body
object (PriceAdjustmentAdd)
PriceAdjustmentAdd
value
number
| float
message
string
The message associated with the price adjustment
apply_expiry
string
| date-time
Optional
The date and time when the expiry should be applied
restrictions
object (PriceAdjustmentRestrictions)
Optional
This field accepts the restrictions applied to this particular item or service, including whether or not cancellation and return are allowed, etc
PriceAdjustmentRestrictions
created_by
string
Optional
The entity that created the field
article_level_distribution
boolean
Flag indicating whether the distribution should is done at the article level
collection
object (Collection)
Collection
type
string
type of price adjusment
Enum
allowed_refund
boolean
Optional
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
meta
object
Optional
cart_id
string
The ID of the cart
Response
201
400
Price Adjustment Created successfully
PriceAdjustmentResponse
data
object (PriceAdjustment)
Optional
PriceAdjustment
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create price adjustments
addPriceAdjustment
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
# List promotions
POST
# Create a promotion
GET
# Get a promotion
PUT
# Update a promotion
PATCH
# Update a promotion partially
GET
# Get promotion and coupon type
GET
# Check promotion code exists
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.
Parameters
pageNo
integer
Optional
current page no as per pagination
Default Value : 0
pageSize
integer
Optional
Promotion max records fetched in single request
Default Value : 10
q
string
Optional
Filter by name
isActive
boolean
Optional
Filter by active or inactive promotion
Default Value : true
promoGroup
string
Optional
Filter promotion group
Enum
promotionType
string
Optional
Filter promotion type
fpPanel
string
Optional
Filter non extension promotions
promotionId
string
Optional
Filter by promotion _id
Response
200
Promotion List for sent page_size and page_no
PromotionsResponse
items
array of object (PromotionListItem)
Optional
Array of PromotionListItem
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List promotions
getPromotions
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.
Parameters
body
object (PromotionAdd)
PromotionAdd
stackable
boolean
Optional
calculate_on
string
Optional
Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
Optional
Enum
promo_group
string
Enum
mode
string
Enum
apply_all_discount
boolean
Optional
display_meta
object (DisplayMeta1)
DisplayMeta1
ownership
object (Ownership1)
Ownership1
promotion_type
string
Enum
discount_rules
array of object (DiscountRule)
Array of DiscountRule
restrictions
object (Restrictions1)
Optional
Restrictions1
currency
string
Optional
code
string
Optional
_schedule
object (PromotionSchedule)
Optional
PromotionSchedule
post_order_action
object (PromotionAction)
Optional
PromotionAction
apply_priority
integer
| int32
Optional
author
object (PromotionAuthor)
Optional
PromotionAuthor
visiblility
object (Visibility)
Optional
Visibility
application_id
string
buy_rules
object
_custom_json
object
Optional
date_meta
object (PromotionDateMeta)
Optional
PromotionDateMeta
tags
array of string
Optional
Default Value :
Response
201
400
Promotion Created successfully
PromotionAdd
stackable
boolean
Optional
calculate_on
string
Optional
Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
Optional
Enum
promo_group
string
Enum
mode
string
Enum
apply_all_discount
boolean
Optional
display_meta
object (DisplayMeta1)
DisplayMeta1
ownership
object (Ownership1)
Ownership1
promotion_type
string
Enum
discount_rules
array of object (DiscountRule)
Array of DiscountRule
restrictions
object (Restrictions1)
Optional
Restrictions1
currency
string
Optional
code
string
Optional
_schedule
object (PromotionSchedule)
Optional
PromotionSchedule
post_order_action
object (PromotionAction)
Optional
PromotionAction
apply_priority
integer
| int32
Optional
author
object (PromotionAuthor)
Optional
PromotionAuthor
visiblility
object (Visibility)
Optional
Visibility
application_id
string
buy_rules
object
_custom_json
object
Optional
date_meta
object (PromotionDateMeta)
Optional
PromotionDateMeta
tags
array of string
Optional
Default Value :
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create a promotion
createPromotion
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.
Parameters
id
string
Promotion mongo _id for fetching single promotion data for editing
Response
200
404
Promotion object for sent `id`
PromotionUpdate
stackable
boolean
Optional
calculate_on
string
Optional
Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
Optional
Enum
promo_group
string
Enum
mode
string
Enum
apply_all_discount
boolean
Optional
display_meta
object (DisplayMeta1)
DisplayMeta1
ownership
object (Ownership1)
Ownership1
promotion_type
string
Enum
discount_rules
array of object (DiscountRule)
Array of DiscountRule
restrictions
object (Restrictions1)
Optional
Restrictions1
currency
string
Optional
code
string
Optional
_schedule
object (PromotionSchedule)
Optional
PromotionSchedule
post_order_action
object (PromotionAction)
Optional
PromotionAction
apply_priority
integer
| int32
Optional
author
object (PromotionAuthor)
Optional
PromotionAuthor
visiblility
object (Visibility)
Optional
Visibility
application_id
string
buy_rules
object
_custom_json
object
Optional
date_meta
object (PromotionDateMeta)
Optional
PromotionDateMeta
tags
array of string
Optional
Default Value :
Examples
Parameters
id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get a promotion
getPromotionById
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.
Parameters
id
string
Promotion mongo _id for fetching single promotion data for editing
body
object (PromotionUpdate)
PromotionUpdate
stackable
boolean
Optional
calculate_on
string
Optional
Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
Optional
Enum
promo_group
string
Enum
mode
string
Enum
apply_all_discount
boolean
Optional
display_meta
object (DisplayMeta1)
DisplayMeta1
ownership
object (Ownership1)
Ownership1
promotion_type
string
Enum
discount_rules
array of object (DiscountRule)
Array of DiscountRule
restrictions
object (Restrictions1)
Optional
Restrictions1
currency
string
Optional
code
string
Optional
_schedule
object (PromotionSchedule)
Optional
PromotionSchedule
post_order_action
object (PromotionAction)
Optional
PromotionAction
apply_priority
integer
| int32
Optional
author
object (PromotionAuthor)
Optional
PromotionAuthor
visiblility
object (Visibility)
Optional
Visibility
application_id
string
buy_rules
object
_custom_json
object
Optional
date_meta
object (PromotionDateMeta)
Optional
PromotionDateMeta
tags
array of string
Optional
Default Value :
Response
200
404
Promotion updated successfully
PromotionUpdate
stackable
boolean
Optional
calculate_on
string
Optional
Only available for Contract pricing and Ladder pricing promotion type
Enum
apply_exclusive
string
Nullable
Optional
Enum
promo_group
string
Enum
mode
string
Enum
apply_all_discount
boolean
Optional
display_meta
object (DisplayMeta1)
DisplayMeta1
ownership
object (Ownership1)
Ownership1
promotion_type
string
Enum
discount_rules
array of object (DiscountRule)
Array of DiscountRule
restrictions
object (Restrictions1)
Optional
Restrictions1
currency
string
Optional
code
string
Optional
_schedule
object (PromotionSchedule)
Optional
PromotionSchedule
post_order_action
object (PromotionAction)
Optional
PromotionAction
apply_priority
integer
| int32
Optional
author
object (PromotionAuthor)
Optional
PromotionAuthor
visiblility
object (Visibility)
Optional
Visibility
application_id
string
buy_rules
object
_custom_json
object
Optional
date_meta
object (PromotionDateMeta)
Optional
PromotionDateMeta
tags
array of string
Optional
Default Value :
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update a promotion
updatePromotion
PATCH
Update a promotion partially
Seller can make partial adjustments of an existing promotion by specifying its unique identifier. It enables businesses to modify specific attributes of the promotion while preserving other details intact.
Parameters
id
string
Promotion mongo _id for fetching single promotion data for editing
body
object (PromotionPartialUpdate)
PromotionPartialUpdate
archive
boolean
Optional
Send true to unpublish promotion
schedule
object (PromotionSchedule)
Optional
PromotionSchedule
Response
200
404
Promotion updated successfully
SuccessMessage
success
boolean
Optional
message
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
PATCH
Loading...
Response
Loading...
Update a promotion partially
updatePromotionPartially
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.
Parameters
entityType
string
Optional
entity_type as promotion or coupon
Enum
isHidden
boolean
Optional
promo-coupon config shown or not
Response
200
Success. Returns a list of all the curently active coupons/promos
ActivePromosResponse
entity_slug
string
Optional
title
string
Optional
Name of the promotion
modified_on
string
Optional
Coupon modification date
example
string
Optional
Discount offers examples
entity_type
string
Optional
Type of entity to be selected from : ['coupon', 'promotion']
created_on
string
Optional
Coupon creation date
is_hidden
boolean
Optional
If the promo is active or not
type
string
Optional
Coupon type
subtitle
string
Optional
Small description of the current offer
description
string
Optional
The description of the offer in the form of an HTML
Examples
Parameters
entityType:
"value"
isHidden:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Get promotion and coupon type
getPromosCouponConfig
GET
Check promotion code exists
Validates the presence of a promotion code for the specified sales channel to verify whether the provided code already exists or not.
Parameters
code
string
Optional
Promotion code
Response
200
400
Valid response with existing promotion code count
Properties
success
boolean
Optional
count
integer
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Check promotion code exists
getPromotionCodeExists
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
# 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.
Parameters
storeUid
integer
The unique identifier of the store
Response
200
Success. Returns available store information with its address as shown below.
StoreDetailsResponse
items
array of object (PickupStoreDetail)
Optional
Array of PickupStoreDetail
Examples
Parameters
storeUid:
0
Was this section helpful?
GET
Loading...
Response
Loading...
Get Store Address
getStoreAddressByUid
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
# Get shipments details
PUT
# Update shipments
GET
# Get delivery modes
GET
Get shipments details
Use this API to get shipment details, expected delivery date, items and price breakup of the shipment.
Parameters
pickAtStoreUid
integer
Optional
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.
orderingStoreId
integer
Optional
ID of the store where the customer is ordering from.
i
boolean
Optional
This is a boolean value. Select `true` to retrieve all the items added in the cart.
p
boolean
Optional
This is a boolean value. Select `true` for getting a payment option in response.
id
string
Optional
The unique identifier of the cart
addressId
string
Optional
ID allotted to the selected address
areaCode
string
Optional
The PIN Code of the destination address, e.g. 400059
orderType
string
Optional
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
500
Success. Returns delivery promise along with shipment details and price breakup. Refer `PlatformCartShipmentsResponse` for more details.
PlatformCartShipmentsResponse
coupon_text
string
Optional
id
string
Optional
pan_config
object
Optional
delivery_promise
object (ShipmentPromise)
Optional
ShipmentPromise
comment
string
Optional
items
array of object (CartProductInfo)
Optional
Array of CartProductInfo
payment_selection_lock
object (PaymentSelectionLock)
Optional
PaymentSelectionLock
delivery_charge_info
string
Optional
restrict_checkout
boolean
Optional
message
string
Optional
breakup_values
object (CartBreakup)
Optional
CartBreakup
staff_user_id
string
Nullable
Optional
is_valid
boolean
Optional
shipments
array of object (PlatformShipmentResponse)
Optional
Array of PlatformShipmentResponse
currency
object (CartCurrency)
Optional
CartCurrency
checkout_mode
string
Optional
last_modified
string
| date
Optional
buy_now
boolean
Optional
gstin
string
Optional
applied_promo_details
array of object (AppliedPromotion)
Optional
Array of AppliedPromotion
error
boolean
Optional
pan_no
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get shipments details
getShipments
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.
Parameters
i
boolean
Optional
This is a boolean value. Select `true` to retrieve all the items added in the cart.
p
boolean
Optional
This is a boolean value. Select `true` for getting a payment option in response.
id
string
Optional
The unique identifier of the cart
addressId
string
Optional
ID allotted to an address
areaCode
string
Optional
The PIN Code of the destination address, e.g. 400059
orderType
string
Optional
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.
body
object (UpdateCartShipmentRequest)
Pass quantity, article uid, shipment type of all items, in the request body as shown below.
UpdateCartShipmentRequest
shipments
array of object (UpdateCartShipmentItem)
Array of UpdateCartShipmentItem
Response
200
500
Success. Returns delivery promise along with shipment details and price breakup. Refer `PlatformCartShipmentsResponse` for more details.
PlatformCartShipmentsResponse
coupon_text
string
Optional
id
string
Optional
pan_config
object
Optional
delivery_promise
object (ShipmentPromise)
Optional
ShipmentPromise
comment
string
Optional
items
array of object (CartProductInfo)
Optional
Array of CartProductInfo
payment_selection_lock
object (PaymentSelectionLock)
Optional
PaymentSelectionLock
delivery_charge_info
string
Optional
restrict_checkout
boolean
Optional
message
string
Optional
breakup_values
object (CartBreakup)
Optional
CartBreakup
staff_user_id
string
Nullable
Optional
is_valid
boolean
Optional
shipments
array of object (PlatformShipmentResponse)
Optional
Array of PlatformShipmentResponse
currency
object (CartCurrency)
Optional
CartCurrency
checkout_mode
string
Optional
last_modified
string
| date
Optional
buy_now
boolean
Optional
gstin
string
Optional
applied_promo_details
array of object (AppliedPromotion)
Optional
Array of AppliedPromotion
error
boolean
Optional
pan_no
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Loading...
Response
Loading...
Update shipments
updateShipments
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.
Parameters
areaCode
string
The PIN Code of the destination address, e.g. 400059
id
string
Optional
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.
CartDeliveryModesResponse
pickup_stores
array of integer
Optional
Store pick up available store uids
available_modes
array of string
Optional
Available delivery modes
Examples
Parameters
areaCode:
"value"
id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...