Skip to main content

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
/service/application/cart/v1.0/detail
# Get a cart
HEAD
/service/application/cart/v1.0/detail
# Get last modified timestamp of a cart
POST
/service/application/cart/v1.0/detail
# Add items to a cart
PUT
/service/application/cart/v1.0/detail
# Update cart items
PUT
/service/application/cart/v1.0/cart_archive
# Delete a cart
GET
/service/application/cart/v1.0/basic
# Get a cart items count
PUT
/service/application/cart/v1.0/meta
# Update cart metadata
POST
/service/application/cart/v1.0/share-cart
# Create share cart link
GET
/service/application/cart/v1.0/share-cart/{token}
# List shared cart items
POST
/service/application/cart/v1.0/share-cart/{token}/{action}
# Update with shared items
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
The unique identifier of the cart
i
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
b
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
c
boolean
This is a boolean value. Select `true` to retrieve the cod charges in breakup of cart items.
assignCardId
integer
Token of user's debit or credit card
areaCode
string
Customer servicable area_code
buyNow
boolean
This is a boolen value. 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
uid
string
applied_promo_details
array of object (AppliedPromotion)
Array of AppliedPromotion
checkout_mode
string
pan_no
string
is_valid
boolean
id
string
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
delivery_promise
object (ShipmentPromise)
ShipmentPromise
comment
string
items
array of object (CartProductInfo)
Array of CartProductInfo
delivery_charge_info
string
common_config
object (CartCommonConfig)
CartCommonConfig
coupon
object (CartDetailCoupon)
CartDetailCoupon
message
string
notification
object
staff_user_id
string
success
boolean
gstin
string
restrict_checkout
boolean
last_modified
string
| date-time
breakup_values
object (CartBreakup)
CartBreakup
currency
object (CartCurrency)
CartCurrency
coupon_text
string
buy_now
boolean
pan_config
object
Examples
Parameters
id:
"value"
i:
false
b:
false
c:
false
assignCardId:
0
areaCode:
"value"
buyNow:
false
Was this section helpful?
GET
/service/application/cart/v1.0/detail
Loading...
Response
Loading...
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
/service/application/cart/v1.0/detail
Loading...
Response
Example response not available.
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
This is a boolean value. Select `true` to retrieve all the items added in the cart.
b
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
areaCode
string
Customer servicable area_code
buyNow
boolean
This is a boolen value. 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)
Array of AddProductCart
new_cart
boolean
Response
200
Success. Returns a cart object as shown below. Refer `AddCartDetailResponse` for more details.
AddCartDetailResponse
message
string
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
/service/application/cart/v1.0/detail
Loading...
Response
Loading...
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
The unique identifier of the cart
i
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
b
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
areaCode
string
Customer servicable area_code
buyNow
boolean
This is a boolen value. 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)
Array of UpdateProductCart
operation
string
Required
Enum
Response
200
Success. Updates and returns a cart object as shown below. Refer `UpdateCartDetailResponse` for more details.
UpdateCartDetailResponse
message
string
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
/service/application/cart/v1.0/detail
Loading...
Response
Loading...
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
success
boolean
True if cart is archived successfully. False if not archived.
Examples
Parameters
id:
"value"
Was this section helpful?
PUT
/service/application/cart/v1.0/cart_archive
Loading...
Response
Loading...
GET

Get a cart items count

Retrieve the 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
/service/application/cart/v1.0/basic
Loading...
Response
Loading...
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
The unique identifier of the cart
buyNow
boolean
this is boolean 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
gift_details
object (ArticleGiftDetail)
ArticleGiftDetail
pick_up_customer_details
object
Customer contact details for customer pickup at store
checkout_mode
string
comment
string
gstin
string
Response
200
400
Returns a message indicating the success of cart meta updation as shown below.
CartMetaResponse
message
string
is_valid
boolean
Examples
Parameters
id:
"value"
buyNow:
false
body:
body
Was this section helpful?
PUT
/service/application/cart/v1.0/meta
Loading...
Response
Loading...
GET

List shared cart items

Retrieve the cart items from the shared cart link based on unique token.
Parameters
token
string
Required
Token of the shared short link
Response
200
404
Success. Returns a Cart object as per the valid token. Refer `SharedCartResponse` for more details.
SharedCartResponse
error
string
cart
object (SharedCart)
SharedCart
Examples
Parameters
token:
"value"
Was this section helpful?
GET
/service/application/cart/v1.0/share-cart/{token}
Loading...
Response
Loading...
POST

Update with shared items

Customer can either merge or replace shared cart items with existing cart.
Parameters
token
string
Required
Token of the shared short link
action
string
Required
Operation to perform on the existing cart merge or replace.
Enum
Response
200
Success. Returns a merged or replaced cart as per the valid token. Refer `SharedCartResponse` for more details.
SharedCartResponse
error
string
cart
object (SharedCart)
SharedCart
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/application/cart/v1.0/share-cart/{token}/{action}
Loading...
Response
Loading...

Checkout

Checkout refers to the final stage of the purchasing process where the customer completes their transaction by paying for the selected items and providing necessary shipping and payment information. During checkout, users review their cart contents, enter billing and shipping addresses, choose payment methods, and confirm their order. It's the pivotal moment when the transaction is finalized, and the goods are prepared for delivery to the customer's designated address.

Operations
POST
/service/application/cart/v1.0/checkout
# Checkout cart
POST
/service/application/cart/v2.0/checkout
# 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)
Array of CartCheckoutCustomMeta
customer_details
object (CustomerDetails)
Customer details
CustomerDetails
merchant_code
string
id
string
payment_auto_confirm
boolean
payment_mode
string
Required
aggregator
string
address_id
string
callback_url
string
delivery_address
object
staff
object (StaffCheckout)
StaffCheckout
order_type
string
ordering_store
integer
| int32
extra_meta
object
payment_identifier
string
billing_address
object
payment_params
object
billing_address_id
string
meta
object
payment_extra_identifiers
object
iin
string
network
string
type
string
card_id
string
Response
200
Success. Returns the status of cart checkout. Refer `CartCheckoutResponseSchema` for more details.
CartCheckoutResponse
payment_confirm_url
string
app_intercept_url
string
success
boolean
callback_url
string
message
string
data
object
order_id
string
cart
object (CheckCart)
CheckCart
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/application/cart/v1.0/checkout
Loading...
Response
Loading...
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
customer_details
object (CustomerDetails)
Nullable
Customer details
CustomerDetails
merchant_code
string
cart_id
string
id
string
Nullable
payment_auto_confirm
boolean
payment_methods
array of object (PaymentMethod)
Required
Array of PaymentMethod
payment_mode
string
Required
aggregator
string
address_id
string
callback_url
string
Nullable
Default Value : null
delivery_address
object
staff
object (StaffCheckout)
StaffCheckout
order_type
string
ordering_store
integer
| int32
Nullable
extra_meta
object
payment_identifier
string
Nullable
billing_address
object
payment_params
object
Nullable
billing_address_id
string
meta
object
iin
string
network
string
type
string
card_id
string
Response
200
400
Success. Returns the status of cart checkout. Refer `CartCheckoutResponseSchema` for more details.
CartCheckoutResponse
payment_confirm_url
string
app_intercept_url
string
success
boolean
callback_url
string
message
string
data
object
order_id
string
cart
object (CheckCart)
CheckCart
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/application/cart/v2.0/checkout
Loading...
Response
Loading...

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
/service/application/cart/v1.0/coupon
# List available coupons
POST
/service/application/cart/v1.0/coupon
# Apply coupon
DEL
/service/application/cart/v1.0/coupon
# Remove coupon
GET
/service/application/cart/v1.0/bulk-price
# List bulk discounts
GET
/service/application/cart/v1.0/payment/validate/
# Validate applied coupon
GET

List available 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
The unique identifier of the cart.
buyNow
boolean
This is boolean to get buy_now cart
slug
string
Product slug to fetch the available coupons
storeId
string
Store id
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)
Array of Coupon
Examples
Parameters
id:
"value"
buyNow:
false
slug:
"value"
storeId:
"value"
Was this section helpful?
GET
/service/application/cart/v1.0/coupon
Loading...
Response
Loading...
POST

Apply coupon

Apply a coupon code to the customer's cart to trigger discounts on eligible items
Parameters
i
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
b
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
p
boolean
This is a boolean value. Select `true` for getting a payment option in response.
id
string
The unique identifier of the cart
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
uid
string
applied_promo_details
array of object (AppliedPromotion)
Array of AppliedPromotion
checkout_mode
string
pan_no
string
is_valid
boolean
id
string
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
delivery_promise
object (ShipmentPromise)
ShipmentPromise
comment
string
items
array of object (CartProductInfo)
Array of CartProductInfo
delivery_charge_info
string
common_config
object (CartCommonConfig)
CartCommonConfig
coupon
object (CartDetailCoupon)
CartDetailCoupon
message
string
notification
object
staff_user_id
string
success
boolean
gstin
string
restrict_checkout
boolean
last_modified
string
| date-time
breakup_values
object (CartBreakup)
CartBreakup
currency
object (CartCurrency)
CartCurrency
coupon_text
string
buy_now
boolean
pan_config
object
Examples
Parameters
i:
false
b:
false
p:
false
id:
"value"
buyNow:
false
cartType:
"value"
body:
body
Was this section helpful?
POST
/service/application/cart/v1.0/coupon
Loading...
Response
Loading...
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
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
uid
string
applied_promo_details
array of object (AppliedPromotion)
Array of AppliedPromotion
checkout_mode
string
pan_no
string
is_valid
boolean
id
string
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
delivery_promise
object (ShipmentPromise)
ShipmentPromise
comment
string
items
array of object (CartProductInfo)
Array of CartProductInfo
delivery_charge_info
string
common_config
object (CartCommonConfig)
CartCommonConfig
coupon
object (CartDetailCoupon)
CartDetailCoupon
message
string
notification
object
staff_user_id
string
success
boolean
gstin
string
restrict_checkout
boolean
last_modified
string
| date-time
breakup_values
object (CartBreakup)
CartBreakup
currency
object (CartCurrency)
CartCurrency
coupon_text
string
buy_now
boolean
pan_config
object
Examples
Parameters
id:
"value"
buyNow:
false
Was this section helpful?
DEL
/service/application/cart/v1.0/coupon
Loading...
Response
Loading...
GET

List bulk discounts

Retrieve a list of 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. You can get slug value from the endpoint /service/application/catalog/v1.0/products/
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)
Consist of offers from multiple seller
Array of BulkPriceOffer
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/cart/v1.0/bulk-price
Loading...
Response
Loading...
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
This is boolean 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
coupon_validity
object (CouponValidity)
CouponValidity
success
boolean
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
/service/application/cart/v1.0/payment/validate/
Loading...
Response
Loading...

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
/service/application/cart/v1.0/address
# List customer addresses
POST
/service/application/cart/v1.0/address
# Create a new address
GET
/service/application/cart/v1.0/address/{id}
# Get a address
PUT
/service/application/cart/v1.0/address/{id}
# Update a address
DEL
/service/application/cart/v1.0/address/{id}
# Delete a address
POST
/service/application/cart/v1.0/select-address
# Select a delivery address
GET

List customer addresses

Retrieve a list of 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 cart
buyNow
boolean
This is boolean to get buy_now cart
mobileNo
string
10-digit mobile number
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 `GetAddressesResponse` for more details.
GetAddressesResponse
pii_masking
boolean
address
array of object (Address)
Array of Address
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/cart/v1.0/address
Loading...
Response
Loading...
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 (Address)
Required
Add address details in the request body as shown below or refer `Address` for more details.
Address
country_iso_code
string
area
string
phone
string
country_phone_code
string
checkout_mode
string
address
string
area_code_slug
string
geo_location
object (GeoLocation)
GeoLocation
id
string
_custom_json
object
city
string
sector
string
state_code
string
State code for international address
created_by_user_id
string
landmark
string
user_id
string
name
string
google_map_point
object
is_active
boolean
tags
array of string
country_code
string
address_type
string
country
string
is_default_address
boolean
area_code
string
email
string
state
string
meta
object
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
success
boolean
is_default_address
boolean
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/cart/v1.0/address
Loading...
Response
Loading...
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
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
10-digit mobile number
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
area
string
phone
string
country_phone_code
string
checkout_mode
string
address
string
area_code_slug
string
geo_location
object (GeoLocation)
GeoLocation
id
string
_custom_json
object
city
string
sector
string
state_code
string
State code for international address
created_by_user_id
string
landmark
string
user_id
string
name
string
google_map_point
object
is_active
boolean
tags
array of string
country_code
string
address_type
string
country
string
is_default_address
boolean
area_code
string
email
string
state
string
meta
object
Examples
Parameters
id:
"value"
cartId:
"value"
buyNow:
false
mobileNo:
"value"
checkoutMode:
"value"
tags:
"value"
isDefault:
false
Was this section helpful?
GET
/service/application/cart/v1.0/address/{id}
Loading...
Response
Loading...
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
area
string
phone
string
country_phone_code
string
checkout_mode
string
address
string
area_code_slug
string
geo_location
object (GeoLocation)
GeoLocation
id
string
_custom_json
object
city
string
sector
string
state_code
string
State code for international address
created_by_user_id
string
landmark
string
user_id
string
name
string
google_map_point
object
is_active
boolean
tags
array of string
country_code
string
address_type
string
country
string
is_default_address
boolean
area_code
string
email
string
state
string
meta
object
Response
201
Success. Returns the address ID and a message indicating a successful address updation.
UpdateAddressResponse
is_updated
boolean
id
string
success
boolean
is_default_address
boolean
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PUT
/service/application/cart/v1.0/address/{id}
Loading...
Response
Loading...
DEL

Delete a address

Removes 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
is_deleted
boolean
Examples
Parameters
id:
"value"
Was this section helpful?
DEL
/service/application/cart/v1.0/address/{id}
Loading...
Response
Loading...
POST

Select a delivery address

Selects 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
This is boolean to get buy_now cart
i
boolean
This is a boolean value. Select `true` to retrieve all the items added in the cart.
b
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
body
object (SelectCartAddressRequest)
Required
Pass address details in the request body as shown below or refer `SelectCartAddressRequest` for more details.
SelectCartAddressRequest
id
string
billing_address_id
string
cart_id
string
Response
201
400
Success. Returns a Cart object as shown below. Refer `CartDetailResponse` for more details. .
CartDetailResponse
cart_id
integer
| int32
uid
string
applied_promo_details
array of object (AppliedPromotion)
Array of AppliedPromotion
checkout_mode
string
pan_no
string
is_valid
boolean
id
string
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
delivery_promise
object (ShipmentPromise)
ShipmentPromise
comment
string
items
array of object (CartProductInfo)
Array of CartProductInfo
delivery_charge_info
string
common_config
object (CartCommonConfig)
CartCommonConfig
coupon
object (CartDetailCoupon)
CartDetailCoupon
message
string
notification
object
staff_user_id
string
success
boolean
gstin
string
restrict_checkout
boolean
last_modified
string
| date-time
breakup_values
object (CartBreakup)
CartBreakup
currency
object (CartCurrency)
CartCurrency
coupon_text
string
buy_now
boolean
pan_config
object
Examples
Parameters
cartId:
"value"
buyNow:
false
i:
false
b:
false
body:
body
Was this section helpful?
POST
/service/application/cart/v1.0/select-address
Loading...
Response
Loading...

Payment mode

Payment mode refers to the method used by customers to pay for their purchases during the checkout process. Payment modes typically include options such as credit card, debit card, digital wallets, bank transfer, cash on delivery (COD), and various online payment platforms like PayPal or Stripe. Customers select their preferred payment mode based on factors such as convenience, security, and availability. The chosen payment mode dictates how the transaction is processed and completed, ensuring a smooth and secure payment experience for the customer.

Operations
PUT
/service/application/cart/v1.0/payment
# Select payment mode
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
The unique identifier of the cart
buyNow
boolean
This is boolean to get buy_now cart
body
object (UpdateCartPaymentRequest)
Required
Check the example shown below or refer `UpdateCartPaymentRequest` for more details.
UpdateCartPaymentRequest
id
string
payment_identifier
string
Nullable
address_id
string
merchant_code
string
aggregator_name
string
payment_mode
string
Response
200
Success. Returns a Cart object as shown below. Refer `CartDetailResponse` for more details.
CartDetailResponse
cart_id
integer
| int32
uid
string
applied_promo_details
array of object (AppliedPromotion)
Array of AppliedPromotion
checkout_mode
string
pan_no
string
is_valid
boolean
id
string
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
delivery_promise
object (ShipmentPromise)
ShipmentPromise
comment
string
items
array of object (CartProductInfo)
Array of CartProductInfo
delivery_charge_info
string
common_config
object (CartCommonConfig)
CartCommonConfig
coupon
object (CartDetailCoupon)
CartDetailCoupon
message
string
notification
object
staff_user_id
string
success
boolean
gstin
string
restrict_checkout
boolean
last_modified
string
| date-time
breakup_values
object (CartBreakup)
CartBreakup
currency
object (CartCurrency)
CartCurrency
coupon_text
string
buy_now
boolean
pan_config
object
Examples
Parameters
id:
"value"
buyNow:
false
body:
body
Was this section helpful?
PUT
/service/application/cart/v1.0/payment
Loading...
Response
Loading...

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
/service/application/cart/v1.0/available-promotions
# List available promotion offers
GET
/service/application/cart/v1.0/available-ladder-prices
# List ladder offers
GET

List available promotion offers

Retrieve a list of all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period.
Parameters
slug
string
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/
pageSize
integer
Number of offers to be fetched to show
promotionGroup
string
Type of promotion groups
storeId
integer
Store id
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)
Array of PromotionOffer
Examples
Parameters
slug:
"value"
pageSize:
0
promotionGroup:
"value"
storeId:
0
cartType:
"value"
Was this section helpful?
GET
/service/application/cart/v1.0/available-promotions
Loading...
Response
Loading...
GET

List ladder offers

Retrieve 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. You can get slug value from the endpoint /service/application/catalog/v1.0/products/
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)
Array of LadderPriceOffer
currency
object (CurrencyInfo)
CurrencyInfo
Examples
Parameters
slug:
"value"
storeId:
"value"
promotionId:
"value"
pageSize:
0
Was this section helpful?
GET
/service/application/cart/v1.0/available-ladder-prices
Loading...
Response
Loading...

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
/service/application/cart/v1.0/redeem/points/
# 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
This is a boolean value. Select `true` to retrieve all the items added in the cart.
b
boolean
This is a boolean value. Select `true` to retrieve the price breakup of cart items.
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
Response
200
Success. Returns a Cart object. Check the example shown below or refer `CartDetailResponse` for more details.
CartDetailResponse
cart_id
integer
| int32
uid
string
applied_promo_details
array of object (AppliedPromotion)
Array of AppliedPromotion
checkout_mode
string
pan_no
string
is_valid
boolean
id
string
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
delivery_promise
object (ShipmentPromise)
ShipmentPromise
comment
string
items
array of object (CartProductInfo)
Array of CartProductInfo
delivery_charge_info
string
common_config
object (CartCommonConfig)
CartCommonConfig
coupon
object (CartDetailCoupon)
CartDetailCoupon
message
string
notification
object
staff_user_id
string
success
boolean
gstin
string
restrict_checkout
boolean
last_modified
string
| date-time
breakup_values
object (CartBreakup)
CartBreakup
currency
object (CartCurrency)
CartCurrency
coupon_text
string
buy_now
boolean
pan_config
object
Examples
Parameters
id:
"value"
i:
false
b:
false
buyNow:
false
body:
body
Was this section helpful?
POST
/service/application/cart/v1.0/redeem/points/
Loading...
Response
Loading...

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
/service/application/cart/v1.0/shipment
# List shipments
GET

List shipments

Retrieve 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
This is a boolean value. 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
checkout_mode
string
message
string
gstin
string
restrict_checkout
boolean
last_modified
string
| date-time
cart_id
integer
| int32
is_valid
boolean
breakup_values
object (CartBreakup)
CartBreakup
currency
object (CartCurrency)
CartCurrency
id
string
shipments
array of object (ShipmentResponse)
Array of ShipmentResponse
payment_selection_lock
object (PaymentSelectionLock)
PaymentSelectionLock
coupon_text
string
delivery_promise
object (ShipmentPromise)
ShipmentPromise
error
boolean
comment
string
buy_now
boolean
uid
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/cart/v1.0/shipment
Loading...
Response
Loading...