Cart
Handles shopping carts, including adding, removing, and updating items, as well as calculating totals.
Cart
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
# Get a cart
HEAD
# Get last modified timestamp of a cart
POST
# Add items to a cart
PUT
# Update cart items
PUT
# Delete a cart
GET
# Get a cart items count
PUT
# Update cart metadata
POST
# Create share cart link
GET
# List shared cart items
POST
# Update with shared items
GET
Get a cart
Get details of a cart 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
The unique identifier of the cart.
i
boolean
Select `true` to retrieve all the items added in the cart.
b
boolean
Select `true` to retrieve the price breakup of cart items.
c
boolean
Select `true` to retrieve the cod charges in breakup of cart items.
assignCardId
integer
Token of user's debit or credit card.
areaCode
string
Customer servicable area_code.
buyNow
boolean
Select `true` to set/initialize buy now cart.
Response
200
Success. Returns a Cart object. Check the example shown below or refer `CartDetailResponse` for more details.
CartDetailResponse
cart_id
integer
| int32
Unique identifier of the user cart.
uid
string
Unique identifier of the 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
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
delivery_promise
object (ShipmentPromise)
ShipmentPromise
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
delivery_charge_info
string
Delivery charge in information message on shipment .
common_config
object (CartCommonConfig)
CartCommonConfig
coupon
object (CartDetailCoupon)
CartDetailCoupon
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.
gstin
string
GSTIN added in user cart.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
CartBreakup
currency
object (CartCurrency)
CartCurrency
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
Examples
Parameters
id:
"value"
i:
false
b:
false
c:
false
assignCardId:
0
areaCode:
"value"
buyNow:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Get a cart
getCart
HEAD
Get last modified timestamp of a cart
Retrieve the last modified timestamp of the cart using unique cart ID. It indicates the most recent update made to the cart's content or properties.
Parameters
id
string
The unique identifier of the cart.
Response
200
Success. Receives last modifed timestamp in the header.
Header Items
Last-Modified
string
| date
Last-Modified Action on Cart
Examples
Parameters
id:
"value"
Was this section helpful?
HEAD
Loading...
Response
Example response not available.
Get last modified timestamp of a cart
getCartLastModified
POST
Add items to a 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
Select `true` to retrieve all the items added in the cart.
b
boolean
Select `true` to retrieve the price breakup of cart items.
areaCode
string
Customer servicable area_code.
buyNow
boolean
Select `true` to set/initialize buy now cart.
id
string
The unique identifier of the cart.
body
object (AddCartRequest)
Required
Specify the item details as shown below. Refer `AddCartRequest` for more details.
AddCartRequest
items
array of object (AddProductCart)
List of items detail which need to be added to cart like item id, item size, and item quantity.
Array of AddProductCart
new_cart
boolean
Field to create to new cart whille user adds item to cart.
Response
200
Success. Returns a cart object as shown below. Refer `AddCartDetailResponse` for more details.
AddCartDetailResponse
message
string
Message of add to cart API response.
partial
boolean
When adding multiple items check if all added. True if only few are added.
cart
object (CartDetailResponse)
CartDetailResponse
success
boolean
True if all items are added successfully. False if partially added or not added.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Add items to a cart
addItems
PUT
Update cart items
Update cart. Customers can modify added product attributes such as quantity and size, as well as remove items from the cart.
Parameters
id
string
The unique identifier of the cart.
i
boolean
Select `true` to retrieve all the items added in the cart.
b
boolean
Select `true` to retrieve the price breakup of cart items.
areaCode
string
Customer servicable area_code.
buyNow
boolean
Select `true` to set/initialize buy now cart.
cartType
string
The type of cart.
body
object (UpdateCartRequest)
Required
Specify the item details and operation as shown below. Refer `UpdateCartRequest` for more details.
UpdateCartRequest
items
array of object (UpdateProductCart)
List items data that needs to be updated in cart.
Array of UpdateProductCart
operation
string
Required
Field to determine if item to be removed from cart or it needs to be updated.
Enum
Response
200
Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResponse` for more details.
UpdateCartDetailResponse
message
string
Message of update cart API response.
cart
object (CartDetailResponse)
CartDetailResponse
success
boolean
True if all items are added successfully. False if partially added or not added.
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
Loading...
Response
Loading...
Update cart items
updateCart
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
The unique identifier of the cart.
Response
200
Success. Returns whether the cart has been deleted or not.
DeleteCartDetailResponse
message
string
Message for delete cart response.
success
boolean
True if cart is archived successfully. False if not archived.
Examples
Parameters
id:
"value"
Was this section helpful?
PUT
Loading...
Response
Loading...
Delete a cart
deleteCart
GET
Get a cart items count
Get total count of items currently present in the customer's cart.
Parameters
id
string
The unique identifier of the cart.
buyNow
boolean
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
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
Update metadata associated with a cart, which includes customer preferences, delivery instructions, or any special requirements related to the cart items.
Parameters
id
string
The unique identifier of the cart.
buyNow
boolean
Whether to get buy_now cart.
body
object (CartMetaRequest)
Required
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.
CartMetaRequest
delivery_slots
object
Delivery slots details includes article level time slot when the shipment can be delivered.
gift_details
object (ArticleGiftDetail)
ArticleGiftDetail
pick_up_customer_details
object
Customer contact details for customer pickup at store.
checkout_mode
string
Checkout mode of user cart.
comment
string
Comment message to be added in user cart.
gstin
string
GSTIN number to be added in user cart.
Response
200
400
Returns a message indicating the success of cart meta updation as shown below.
CartMetaResponse
message
string
Detailed message.
is_valid
boolean
Whether added meta was vaild.
Examples
Parameters
id:
"value"
buyNow:
false
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update cart metadata
updateCartMeta
Create share cart link
getCartShareLink
List shared cart items
getCartSharedItems
Update with shared items
updateCartWithSharedItems
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
# Checkout cart
POST
# Start cart checkout (latest)
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
buyNow
boolean
This indicates the type of cart to checkout.
cartType
string
The type of cart.
body
object (CartCheckoutDetailRequest)
Required
Check the example shown below or refer `CartCheckoutDetailRequest` for more details.
CartCheckoutDetailRequest
custom_meta
array of object (CartCheckoutCustomMeta)
Custom meta data to be added in order.
Array of CartCheckoutCustomMeta
customer_details
object (CustomerDetails)
Customer details to be added in order.
CustomerDetails
merchant_code
string
Merchant code of the payment mode selected to do the payment.
id
string
Cart id of the user cart.
payment_auto_confirm
boolean
Payment auto confirm flag if payment need not to be collected from user.
payment_mode
string
Required
Payment mode from which the payment to be done for the order.
aggregator
string
Aggregator name of the payment gateway.
address_id
string
Address id of the user on which the order to be delivered.
callback_url
string
Callback url to be redirected after payment received/failed.
delivery_address
object
Delivery address data which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name.
staff
object (StaffCheckout)
StaffCheckout
order_type
string
Order type of the order being placed like pickAtStore or HomeDelivery.
ordering_store
integer
| int32
Ordering store id of the store from which the order is getting placed.
extra_meta
object
Extra meta to be added while checkout in order.
payment_identifier
string
Payment identifier of the payment mode selected to do the payment.
billing_address
object
Billing address json which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name.
payment_params
object
Payment params which includes payment identifier and merchant code.
billing_address_id
string
Billing address id of the customer on which the invoice to be generated after the order is placed.
meta
object
Meta data to be added in order.
payment_extra_identifiers
object
Payment extra identifier for the payment mode to do the payment.
iin
string
Issuer Identification Number' number of card if payment mode is card.
network
string
Network of card if payment mode is card to do the payment.
type
string
Type of cart if payment mode is card to do the payment.
card_id
string
Saved card id if payment mode is card to do the payment.
Response
200
Success. Returns the status of cart checkout. Refer `CartCheckoutResponseSchema` for more details.
CartCheckoutResponse
payment_confirm_url
string
Payment confirm url used to redirect after payment is confirmed.
app_intercept_url
string
App intercept url which is used to redirect on app after payment in confirmed/failed.
success
boolean
Success flag of cart checkout API response.
callback_url
string
Callback url to be redirected after payment received/failed.
message
string
Message of the cart checkout v2 API response.
data
object
Data of the user cart checkout includes cart data, address, user id, order type etc.
order_id
string
Order id generated after placing order.
cart
object (CheckCart)
CheckCart
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Checkout cart
checkoutCart
POST
Start cart checkout (latest)
Enhanced version of checkout process that supports multiple mode of payment(MOP).
Parameters
buyNow
boolean
This indicates the type of cart to checkout.
cartType
string
The type of cart.
body
object (CartCheckoutDetailV2Request)
Required
Check the example shown below or refer `CartCheckoutDetailV2Request` for more details.
CartCheckoutDetailV2Request
custom_meta
object
Custom meta data to be added in order.
customer_details
object (CustomerDetails)
Nullable
Customer details to be added in order.
CustomerDetails
merchant_code
string
Merchant code of the payment mode selected to do the payment.
cart_id
string
Cart id of the user cart.
id
string
Nullable
Cart id of the user cart.
payment_auto_confirm
boolean
Payment auto confirm flag if payment need not to be collected from user.
payment_methods
array of object (PaymentMethod)
Required
Payment methods list used to make the payment.
Array of PaymentMethod
payment_mode
string
Required
Payment mode of the payment selected to do the payment.
aggregator
string
Aggregator of payment mode to do the payment.
address_id
string
Address id of the user where the order to be delivered.
callback_url
string
Nullable
Callback url after payment received/failed.
Default Value : null
delivery_address
object
Delivery address data which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name.
staff
object (StaffCheckout)
StaffCheckout
order_type
string
Order type of the order being placed like pickAtStore or HomeDelivery.
ordering_store
integer
| int32
Nullable
Ordering store id of the store from which the order is getting placed.
extra_meta
object
Extra meta to be added while checkout in order.
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment.
billing_address
object
Billing address json which includes customer address, customer phone, customer email, customer pincode, customer landmark and customer name.
payment_params
object
Nullable
Payment params which includes payment identifier and merchant code.
billing_address_id
string
Billing address id selected by user on which shipment bill to be generated.
meta
object
Meta data sent while checkout v2.
iin
string
Issuer Identification Number' number of card if payment mode is card to do the payment.
network
string
Network of card if payment mode is card to do the payment.
type
string
Type of cart if payment mode is card to do the payment.
card_id
string
Saved card id if payment mode is card to do the payment.
Response
200
400
Success. Returns the status of cart checkout. Refer `CartCheckoutResponseSchema` for more details.
CartCheckoutResponse
payment_confirm_url
string
Payment confirm url used to redirect after payment is confirmed.
app_intercept_url
string
App intercept url which is used to redirect on app after payment in confirmed/failed.
success
boolean
Success flag of cart checkout API response.
callback_url
string
Callback url to be redirected after payment received/failed.
message
string
Message of the cart checkout v2 API response.
data
object
Data of the user cart checkout includes cart data, address, user id, order type etc.
order_id
string
Order id generated after placing order.
cart
object (CheckCart)
CheckCart
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
Start cart checkout (latest)
checkoutCartV2
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 available coupons
POST
# Apply coupon
DEL
# Remove coupon
GET
# List bulk discounts
GET
# Validate applied coupon
GET
List available coupons
List 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
The unique identifier of the cart.
buyNow
boolean
Whether to get buy_now cart.
slug
string
Product slug to fetch the available coupons.
storeId
string
Unique identifier of a store.
Response
200
Success. Returns a coupon object which has a list of all the eligible coupons. Refer `GetCouponResponse` for more details.
GetCouponResponse
page
object (PageCoupon)
PageCoupon
available_coupon_list
array of object (Coupon)
List of available coupon which can be applied on cart.
Array of Coupon
Examples
Parameters
id:
"value"
buyNow:
false
slug:
"value"
storeId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List available coupons
getCoupons
POST
Apply coupon
Apply a coupon code to the cart to trigger discounts on eligible items.
Parameters
i
boolean
Select `true` to retrieve all the items added in the cart.
b
boolean
Select `true` to retrieve the price breakup of cart items.
p
boolean
Select `true` for getting a payment option in response.
id
string
The unique identifier of the cart.
buyNow
boolean
This is boolean to get buy_now cart.
cartType
string
The type of cart.
body
object (ApplyCouponRequest)
Required
Pass coupon code in the request body as shown below.
ApplyCouponRequest
coupon_code
string
Required
Coupon code to be applied.
Response
201
Success. Returns coupons applied to the cart along with item details and price breakup. Refer `CartDetailResponse` for more details.
CartDetailResponse
cart_id
integer
| int32
Unique identifier of the user cart.
uid
string
Unique identifier of the 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
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
delivery_promise
object (ShipmentPromise)
ShipmentPromise
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
delivery_charge_info
string
Delivery charge in information message on shipment .
common_config
object (CartCommonConfig)
CartCommonConfig
coupon
object (CartDetailCoupon)
CartDetailCoupon
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.
gstin
string
GSTIN added in user cart.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
CartBreakup
currency
object (CartCurrency)
CartCurrency
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
Examples
Parameters
i:
false
b:
false
p:
false
id:
"value"
buyNow:
false
cartType:
"value"
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
id
string
The unique identifier of the cart.
buyNow
boolean
Wheter 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
Unique identifier of the user cart.
uid
string
Unique identifier of the 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
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
delivery_promise
object (ShipmentPromise)
ShipmentPromise
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
delivery_charge_info
string
Delivery charge in information message on shipment .
common_config
object (CartCommonConfig)
CartCommonConfig
coupon
object (CartDetailCoupon)
CartDetailCoupon
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.
gstin
string
GSTIN added in user cart.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
CartBreakup
currency
object (CartCurrency)
CartCurrency
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
Examples
Parameters
id:
"value"
buyNow:
false
Was this section helpful?
DEL
Loading...
Response
Loading...
Remove coupon
removeCoupon
GET
List bulk discounts
List offer discounts with information about quantity and seller. One offer is marked with a "best" flag, indicating it as the best offer among the list.
Parameters
itemId
integer
The Item ID of the product.
articleId
string
Article Mongo ID.
uid
integer
UID of the product.
slug
string
A short, human-readable, URL-friendly identifier of a product.
Response
200
500
Success. Returns a data object containing the seller details and available offers (if exists) on bulk products. Refer `BulkPriceResponse` for more details.
BulkPriceResponse
data
array of object (BulkPriceOffer)
Actual data to be in response consist of offers from multiple seller.
Array of BulkPriceOffer
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List bulk discounts
getBulkDiscountOffers
GET
Validate applied coupon
Validate 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
The unique identifier of the cart.
buyNow
boolean
Whether to get buy_now cart.
addressId
string
ID allotted to an address.
paymentMode
string
Payment mode selected by the customer.
paymentIdentifier
string
Identifier of payment like ICIC, PAYTM.
aggregatorName
string
Payment gateway identifier.
merchantCode
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.
cardId
string
Saved card token reference id.
cartType
string
Type of the cart.
Response
200
Success. Returns a success message and the coupon validity. Refer `PaymentCouponValidate` for more details.
PaymentCouponValidate
message
string
Payment mode valid message for coupon.
coupon_validity
object (CouponValidity)
CouponValidity
success
boolean
Success flag of coupon payment mode validity API response.
Examples
Parameters
id:
"value"
buyNow:
false
addressId:
"value"
paymentMode:
"value"
paymentIdentifier:
"value"
aggregatorName:
"value"
merchantCode:
"value"
iin:
"value"
network:
"value"
type:
"value"
cardId:
"value"
cartType:
"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 a address
DEL
# Delete a address
POST
# Select a delivery address
GET
List customer addresses
List all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery.
Parameters
cartId
string
The unique identifier of the user cart.
buyNow
boolean
Whether to get buy_now cart.
mobileNo
string
Mobile number of the customer.
checkoutMode
string
Option to checkout for self or for others.
tags
string
Tag given to an address, e.g. work, home, office, shop.
isDefault
boolean
Select `true` to fetch the default address.
Response
200
Success. Returns an Address object containing a list of address saved in the account. Refer `GetAddressesResponse` for more details.
GetAddressesResponse
pii_masking
boolean
Personally Identifiable Information masking flag to denote if the user data in address is masked or not.
address
array of object (Address)
Address description for address data.
Array of Address
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List customer addresses
getAddresses
POST
Create a new address
Add a new address to their cart to save details such as name, email, contact information, and address.
Parameters
body
object (Address)
Required
Add address details in the request body as shown below or refer `Address` for more details.
Address
country_iso_code
string
Country iso code for address.
area
string
Area description for address.
phone
string
Phone number for address.
country_phone_code
string
Country phone code for address.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
address
string
Address description for address data.
area_code_slug
string
Area code slug for address. example pincode is slug for India.
geo_location
object (GeoLocation)
GeoLocation
id
string
Id of the address.
_custom_json
object
Custom json of the address.
city
string
City of the address.
sector
string
Sector of the address.
state_code
string
State code for address.
created_by_user_id
string
Created by user id of address.
landmark
string
Landmark of address.
user_id
string
User id of address for which address is created.
name
string
Name of person in address data to whom it belongs to.
google_map_point
object
Google map point of the address.
is_active
boolean
States whether address is active or not.
tags
array of string
Tags of address from which it can be identified.
country_code
string
Country code of address.
address_type
string
Address type of address.
country
string
Country of address.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
area_code
string
Area code of the address.
email
string
Email address for address data.
state
string
State of the address.
meta
object
Metadata of the address.
Response
200
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
Id of the address.
success
boolean
Success flag of save address Response.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create a new address
addAddress
GET
Get a address
Get 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
Required
ID allotted to the selected address.
cartId
string
The unique identifier of the cart.
buyNow
boolean
This is boolean to get buy_now cart.
mobileNo
string
Mobile number of the customer.
checkoutMode
string
Option to checkout for self or for others.
tags
string
Tag given to an address, e.g. work, home, office, shop.
isDefault
boolean
This is a boolean value. Select `true` to fetch the default address.
Response
200
Success. Returns an Address object containing a list of address saved in the account. Refer `Address` for more details.
Address
country_iso_code
string
Country iso code for address.
area
string
Area description for address.
phone
string
Phone number for address.
country_phone_code
string
Country phone code for address.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
address
string
Address description for address data.
area_code_slug
string
Area code slug for address. example pincode is slug for India.
geo_location
object (GeoLocation)
GeoLocation
id
string
Id of the address.
_custom_json
object
Custom json of the address.
city
string
City of the address.
sector
string
Sector of the address.
state_code
string
State code for address.
created_by_user_id
string
Created by user id of address.
landmark
string
Landmark of address.
user_id
string
User id of address for which address is created.
name
string
Name of person in address data to whom it belongs to.
google_map_point
object
Google map point of the address.
is_active
boolean
States whether address is active or not.
tags
array of string
Tags of address from which it can be identified.
country_code
string
Country code of address.
address_type
string
Address type of address.
country
string
Country of address.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
area_code
string
Area code of the address.
email
string
Email address for address data.
state
string
State of the address.
meta
object
Metadata of the address.
Examples
Parameters
id:
"value"
cartId:
"value"
buyNow:
false
mobileNo:
"value"
checkoutMode:
"value"
tags:
"value"
isDefault:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Get a address
getAddressById
PUT
Update a address
Customer can modify the details of a previously saved addresses.
Parameters
id
string
Required
ID allotted to the selected address.
body
object (Address)
Required
Add address details in the request body as shown below or refer `Address` for more details.
Address
country_iso_code
string
Country iso code for address.
area
string
Area description for address.
phone
string
Phone number for address.
country_phone_code
string
Country phone code for address.
checkout_mode
string
Checkout mode of address on which address to be used for which checkout mode of cart.
address
string
Address description for address data.
area_code_slug
string
Area code slug for address. example pincode is slug for India.
geo_location
object (GeoLocation)
GeoLocation
id
string
Id of the address.
_custom_json
object
Custom json of the address.
city
string
City of the address.
sector
string
Sector of the address.
state_code
string
State code for address.
created_by_user_id
string
Created by user id of address.
landmark
string
Landmark of address.
user_id
string
User id of address for which address is created.
name
string
Name of person in address data to whom it belongs to.
google_map_point
object
Google map point of the address.
is_active
boolean
States whether address is active or not.
tags
array of string
Tags of address from which it can be identified.
country_code
string
Country code of address.
address_type
string
Address type of address.
country
string
Country of address.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
area_code
string
Area code of the address.
email
string
Email address for address data.
state
string
State of the address.
meta
object
Metadata of the address.
Response
201
Success. Returns the address ID and a message indicating a successful address updation.
UpdateAddressResponse
is_updated
boolean
Updated flag for update address operation if the address updated or not.
id
string
ID of an address.
success
boolean
Success flag of update address response.
is_default_address
boolean
Default address flag if no address selected then this should be the default address selected.
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update a address
updateAddress
DEL
Delete a address
Delete an existing customer address from the system.
Parameters
id
string
Required
ID allotted to the selected address.
Response
201
Returns a Status object indicating the success or failure of address deletion.
DeleteAddressResponse
id
string
Id of the address.
is_deleted
boolean
Deleted flag in delete address response states whether the address was deleted or not.
Examples
Parameters
id:
"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
The unique identifier of the cart.
buyNow
boolean
Whether to get buy_now cart.
i
boolean
Select `true` to retrieve all the items added in the cart.
b
boolean
Select `true` to retrieve the price breakup of cart items.
body
object (SelectCartAddressRequest)
Required
Pass address details in the request body as shown below or refer `SelectCartAddressRequest` for more details.
SelectCartAddressRequest
id
string
Address is selected by user on which shipment to be delivered.
billing_address_id
string
Billing address id selected by user on which shipment bill to be generated.
cart_id
string
Cart id of the user cart for which the select address operation performed.
Response
201
400
Success. Returns a Cart object as shown below. Refer `CartDetailResponse` for more details. .
CartDetailResponse
cart_id
integer
| int32
Unique identifier of the user cart.
uid
string
Unique identifier of the 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
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
delivery_promise
object (ShipmentPromise)
ShipmentPromise
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
delivery_charge_info
string
Delivery charge in information message on shipment .
common_config
object (CartCommonConfig)
CartCommonConfig
coupon
object (CartDetailCoupon)
CartDetailCoupon
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.
gstin
string
GSTIN added in user cart.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
CartBreakup
currency
object (CartCurrency)
CartCurrency
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
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
Select a preferred payment mode from available options during the cart checkout process to securely and efficiently complete their transaction.
Parameters
id
string
The unique identifier of the cart.
buyNow
boolean
Whether to get buy_now cart.
body
object (UpdateCartPaymentRequest)
Required
Check the example shown below or refer `UpdateCartPaymentRequest` for more details.
UpdateCartPaymentRequest
id
string
Cart id of the user cart for which the update cart payment operation performed.
payment_identifier
string
Nullable
Payment identifier of the payment mode selected to do the payment.
address_id
string
Address id of the user address selected to deliver the shipment.
merchant_code
string
Merchant code of the payment mode selected to do the payment.
aggregator_name
string
Aggregator name of the payment gateway.
payment_mode
string
Payment mode of the payment selected to do the payment.
Response
200
Success. Returns a Cart object as shown below. Refer `CartDetailResponse` for more details.
CartDetailResponse
cart_id
integer
| int32
Unique identifier of the user cart.
uid
string
Unique identifier of the 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
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
delivery_promise
object (ShipmentPromise)
ShipmentPromise
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
delivery_charge_info
string
Delivery charge in information message on shipment .
common_config
object (CartCommonConfig)
CartCommonConfig
coupon
object (CartDetailCoupon)
CartDetailCoupon
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.
gstin
string
GSTIN added in user cart.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
CartBreakup
currency
object (CartCurrency)
CartCurrency
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
Examples
Parameters
id:
"value"
buyNow:
false
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Select payment mode
selectPaymentMode
Promotion offers
Promotion offers are special incentives or discounts provided to customers to encourage purchases or enhance their shopping experience. These offers can take various forms, such as percentage discounts, fixed-price discounts, free shipping, buy-one-get-one (BOGO) deals. Ladder pricing, also known as tiered pricing, refers to a pricing strategy where the price of a product varies depending on the quantity purchased or other specified criteria. With ladder pricing, customers are incentivized to buy more by offering discounts or reduced prices for larger quantities or higher purchase volumes. For example, a retailer might offer a discounted price per unit for purchasing 10 items instead of just one.
Operations
GET
# List available promotion offers
GET
# List ladder offers
GET
List available promotion offers
List all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period.
Parameters
slug
string
A short, human-readable, URL-friendly identifier of a product.
pageSize
integer
Number of offers to be fetched to show.
promotionGroup
string
Type of promotion groups.
storeId
integer
Unique identifier of a store.
cartType
string
The type of cart.
Response
200
400
Success. Returns a array containing the available offers (if exists) on product via promotions. Refer `PromotionOffersResponse` for more details.
PromotionOffersResponse
available_promotions
array of object (PromotionOffer)
Available promotion details which are available on product which includes promotion data like promotion id, promotion name, buy rules, discount rules validity dates etc.
Array of PromotionOffer
Examples
Parameters
slug:
"value"
pageSize:
0
promotionGroup:
"value"
storeId:
0
cartType:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List available promotion offers
getPromotionOffers
GET
List ladder offers
Get ladder offers associated for the items in the cart. Ladder offers provide discounts or special pricing based on item quantity, allowing users to benefit from bulk purchases or promotional deals.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a product.
storeId
string
Store uid of assigned store on PDP page. If not passed default first created ladder will be returned.
promotionId
string
Get ladder information of given promotion id explicitely.
pageSize
integer
Number of offers to be fetched to show.
Response
200
400
Success. Returns a object containing the applicable ladder price offers (if exists) on product. Refer `PromotionOffersResponse` for more details.
LadderPriceOffers
available_offers
array of object (LadderPriceOffer)
Available ladder promotions offers list.
Array of LadderPriceOffer
currency
object (CurrencyInfo)
CurrencyInfo
Examples
Parameters
slug:
"value"
storeId:
"value"
promotionId:
"value"
pageSize:
0
Was this section helpful?
GET
Loading...
Response
Loading...
List ladder offers
getLadderOffers
Reward Points
Reward points are incentives given to customers as part of a loyalty program or promotional campaign. Users accumulate reward points through various activities, such as making purchases, referring friends, or engaging with the platform. Reward points can be redeemed for discounts.
Operations
POST
# Use reward points
POST
Use reward points
Users can redeem their accumulated reward points and apply them to the items in their cart, thereby availing discounts on their current purchases.
Parameters
id
string
The unique identifier of the cart.
i
boolean
Select `true` to retrieve all the items added in the cart.
b
boolean
Select `true` to retrieve the price breakup of cart items.
buyNow
boolean
This is boolean to get buy_now cart.
body
object (RewardPointRequest)
Required
Check the example shown below or refer `RewardPointRequestSchema` for more details.
RewardPointRequest
points
boolean
Required
Points to be applied for cart.
Response
200
Success. Returns a Cart object. Check the example shown below or refer `CartDetailResponse` for more details.
CartDetailResponse
cart_id
integer
| int32
Unique identifier of the user cart.
uid
string
Unique identifier of the 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
checkout_mode
string
Checkout mode of user cart.
pan_no
string
Permanent Account Number of the user.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
id
string
Unique identifier of the user cart.
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
delivery_promise
object (ShipmentPromise)
ShipmentPromise
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
delivery_charge_info
string
Delivery charge in information message on shipment .
common_config
object (CartCommonConfig)
CartCommonConfig
coupon
object (CartDetailCoupon)
CartDetailCoupon
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.
gstin
string
GSTIN added in user cart.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
breakup_values
object (CartBreakup)
CartBreakup
currency
object (CartCurrency)
CartCurrency
coupon_text
string
Coupon text of coupon applied on cart.
buy_now
boolean
Buy now flag for the cart which denotes user is doing fast checkout for the cart using buy now.
pan_config
object
Pan card config states at what condition user should enter the pan card.
Examples
Parameters
id:
"value"
i:
false
b:
false
buyNow:
false
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Use reward points
applyRewardPoints
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 Digital) and other shipment meta information. Additionally, it provides details about the items included in the shipment.
Operations
GET
# List shipments
GET
List shipments
Get shipment details for the items in a cart, specific to the selected address. Shipment details include delivery promises, seller information, item details, and other relevant information.
Parameters
p
boolean
Select `true` for getting a payment option in response.
id
string
The unique identifier of the cart.
buyNow
boolean
This is boolean to get buy_now cart.
addressId
string
ID allotted to the selected address.
areaCode
string
The PIN Code of the destination address, e.g. 400059.
orderType
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. Digital - If the customer wants to buy digital voucher ( for jiogames ).
Response
200
500
Success. Returns delivery promise along with shipment details and price breakup. Refer `CartShipmentsResponse` for more details.
CartShipmentsResponse
delivery_charge_info
string
Delivery charge in information message on shipment.
checkout_mode
string
Checkout mode of cart.
message
string
Response message of get shipments API.
gstin
string
GSTIN number added in cart.
restrict_checkout
boolean
Restrict checkout flag to restrict the checkout process.
last_modified
string
| date-time
Last modified timestamp of cart.
cart_id
integer
| int32
Cart id of the user cart.
is_valid
boolean
Cart validity flag determines the if the response is valid or not.
breakup_values
object (CartBreakup)
CartBreakup
currency
object (CartCurrency)
CartCurrency
id
string
Cart id of the user cart.
shipments
array of object (ShipmentResponse)
List of Shipments which includes shipment data like shipment items, shipment promise, Shipment type, shipment order type, shipment dp options etc.
Array of ShipmentResponse
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
coupon_text
string
Coupon text of coupon applied on cart.
delivery_promise
object (ShipmentPromise)
ShipmentPromise
error
boolean
Error details if any error occurs which includes type of error, error code and error message.
comment
string
Comment message added in cart.
buy_now
boolean
Buy now flag of user cart.
uid
string
Cart id of the user cart.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...