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

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

# Check cart serviceability

GET

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

# Get abandoned carts

GET

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

# Get abandoned cart details

POST

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

# Add items to cart

PUT

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

# Update cart items

POST

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

# Share cart link

GET

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

# List shared cart items

POST

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

# Update shared cart items

GET

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

# List carts

PUT

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

# Update user of a cart

GET

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

# Get a cart

POST

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

# Add items to cart

PUT

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

# Update cart items

PUT

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

# Delete a cart

GET

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

# Get a cart items count

PUT

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

# 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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

cart_items

array of object (CartItem)

Required

Array of CartItem

shipping_address

object (ShippingAddress)

Required

ShippingAddress

Response

200

Cart details with pincode validity information at item level

OpenApiCartServiceabilityResponse

is_valid

boolean

items

array of object (CartProductInfo)

Array of CartProductInfo

delivery_promise

object (ShipmentPromise)

ShipmentPromise

message

string

breakup_values

object (CartBreakup)

CartBreakup

Examples

Parameters

Parameters are not required.

Was this section helpful?

POST

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

Response

GET

Get abandoned carts

Retrieve the list of abandoned carts that have been active for the specified period of time and have not yet been archived for the specific sales channel.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

page_no

integer

current page no as per pagination

Default Value : 0

page_size

integer

Coupon max records fetched in single request

Default Value : 10

from_date

string

Cart which are created on or after from_date

to_date

string

Cart which are created on or before to_date

anonymous_cart

boolean

Filter by `anonymous_cart`

last_id

string

pagination is done based on the last_object_id

sort_on

string

on which column to sort on i.e created_on or last_modified

Response

200

Abandoned Cart List for sent page_size and page_no

AbandonedCartResponse

items

array of object (AbandonedCart)

Array of AbandonedCart

result

object

page

object (Page)

Page

success

boolean

the request success is defined

message

string

message of the response

Examples

Parameters

Parameters are not required.

Was this section helpful?

GET

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

Response

GET

Get abandoned cart details

Retrieves abandoned cart details linked to a specific customer using a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart

boolean

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

boolean

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

boolean

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

Response

200

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

CartDetailResponse

cart_id

integer

| int32

uid

string

coupon_text

string

pan_config

object

delivery_promise

object (ShipmentPromise)

ShipmentPromise

comment

string

items

array of object (CartProductInfo)

Array of CartProductInfo

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

delivery_charge_info

string

common_config

object (CartCommonConfig)

CartCommonConfig

coupon

object (CartDetailCoupon)

CartDetailCoupon

restrict_checkout

boolean

message

string

notification

object

staff_user_id

string

success

boolean

breakup_values

object (CartBreakup)

CartBreakup

is_valid

boolean

currency

object (CartCurrency)

CartCurrency

checkout_mode

string

last_modified

string

| date

buy_now

boolean

gstin

string

applied_promo_details

array of object (AppliedPromotion)

Array of AppliedPromotion

pan_no

string

custom_cart_meta

object

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

false

Was this section helpful?

GET

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

Response

POST

Add items to cart

Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

cart_id

string

Required

Current Cart _id

boolean

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

Request body

new_cart

boolean

items

array of object (AddProductCart)

Array of AddProductCart

Response

200

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

AddCartDetailResponse

success

boolean

True if all items are added successfully. False if partially added or not added.

cart

object (CartDetailResponse)

CartDetailResponse

partial

boolean

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

message

string

Examples

Parameters

Parameters are not required.

Was this section helpful?

POST

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

Response

PUT

Update cart items

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

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

cart_id

string

Required

Current Cart _id

boolean

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

Request body

items

array of object (UpdateProductCart)

Array of UpdateProductCart

operation

string

Required

Enum

Response

200

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

UpdateCartDetailResponse

success

boolean

True if all items are added successfully. False if partially added or not added.

cart

object (CartDetailResponse)

CartDetailResponse

message

string

Examples

Parameters

Parameters are not required.

Was this section helpful?

PUT

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

Response

POST

Share cart link

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

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

string

Cart uid for generating sharing

meta

object

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

Response

200

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

GetShareCartLinkResponse

token

string

Short url unique id

share_url

string

Short shareable final url

Examples

Parameters

Parameters are not required.

Was this section helpful?

POST

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

Response

GET

List shared cart items

Retrieve the cart items from the shared cart link based on unique token.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

token

string

Required

Token of the shared short link

Response

200

404

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

SharedCartResponse

cart

object (SharedCart)

SharedCart

error

string

Examples

Parameters

companyId:

"value"

applicationId:

"value"

token:

"value"

Was this section helpful?

GET

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

Response

POST

Update shared cart items

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

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

token

string

Required

Token of the shared short link

action

string

Required

Operation to perform on the existing cart merge or replace.

Enum

cart_id

string

The unique identifier of the cart

Response

200

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

SharedCartResponse

cart

object (SharedCart)

SharedCart

error

string

Examples

Parameters

Parameters are not required.

Was this section helpful?

POST

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

Response

GET

List carts

Retrieve the list of active carts associated with a specific customer.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

from_date

string

Cart which are created on or after from_date. Supports ISO date format.

to_date

string

Cart which are created on or before to_date. Supports ISO date format.

filter_on

string

on which column to sort on i.e created_on or last_modified

Response

200

Platform user cart list

MultiCartResponse

success

boolean

data

array of object (CartList)

Array of CartList

Examples

Parameters

Parameters are not required.

Was this section helpful?

GET

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

Response

PUT

Update user of a cart

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

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

cart id

Request body

user_id

string

Required

Response

200

UserCartMappingResponse

coupon_text

string

user

object (UserInfo)

UserInfo

string

pan_config

object

delivery_promise

object (ShipmentPromise)

ShipmentPromise

comment

string

items

array of object (CartProductInfo)

Array of CartProductInfo

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

delivery_charge_info

string

restrict_checkout

boolean

message

string

breakup_values

object (CartBreakup)

CartBreakup

is_valid

boolean

currency

object (CartCurrency)

CartCurrency

checkout_mode

string

last_modified

string

| date

buy_now

boolean

gstin

string

custom_cart_meta

object

applied_promo_details

array of object (AppliedPromotion)

Array of AppliedPromotion

pan_no

string

Examples

Parameters

Parameters are not required.

Was this section helpful?

PUT

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

Response

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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart

user_id

string

Option to fetch cart for the provided user_id.

order_type

string

The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.

boolean

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

boolean

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

assign_card_id

integer

Token of user's debit or credit card

buy_now

boolean

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

Response

200

400

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

CartDetailResponse

cart_id

integer

| int32

uid

string

coupon_text

string

pan_config

object

delivery_promise

object (ShipmentPromise)

ShipmentPromise

comment

string

items

array of object (CartProductInfo)

Array of CartProductInfo

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

delivery_charge_info

string

common_config

object (CartCommonConfig)

CartCommonConfig

coupon

object (CartDetailCoupon)

CartDetailCoupon

restrict_checkout

boolean

message

string

notification

object

staff_user_id

string

success

boolean

breakup_values

object (CartBreakup)

CartBreakup

is_valid

boolean

currency

object (CartCurrency)

CartCurrency

checkout_mode

string

last_modified

string

| date

buy_now

boolean

gstin

string

applied_promo_details

array of object (AppliedPromotion)

Array of AppliedPromotion

pan_no

string

custom_cart_meta

object

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

userId:

"value"

orderType:

"value"

false

assignCardId:

buyNow:

false

Was this section helpful?

GET

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

Response

POST

Add items to cart

Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

boolean

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

boolean

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

buy_now

boolean

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

order_type

string

The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.

string

The unique identifier of the cart

Request body

user_id

string

new_cart

boolean

items

array of object (AddProductCart)

Array of AddProductCart

Response

200

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

AddCartDetailResponse

success

boolean

True if all items are added successfully. False if partially added or not added.

cart

object (CartDetailResponse)

CartDetailResponse

partial

boolean

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

message

string

Examples

Parameters

Parameters are not required.

Was this section helpful?

POST

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

Response

PUT

Update cart items

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

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart

boolean

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

order_type

string

The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.

boolean

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

buy_now

boolean

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

Request body

user_id

string

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

success

boolean

True if all items are added successfully. False if partially added or not added.

cart

object (CartDetailResponse)

CartDetailResponse

message

string

Examples

Parameters

Parameters are not required.

Was this section helpful?

PUT

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

Response

PUT

Delete a cart

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

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart.

Request body

cart_id_list

array of string

Response

200

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

DeleteCartDetailResponse

success

boolean

True if cart is archived successfully. False if not archived.

message

string

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

body:

body

Was this section helpful?

PUT

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

Response

GET

Get a cart items count

Retrieve the total count of items currently present in the customer's cart.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart.

buy_now

boolean

Boolean value to get buy_now cart.

Response

200

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

CartItemCountResponse

user_cart_items_count

integer

| int32

Item count present in cart

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

buyNow:

false

Was this section helpful?

GET

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

Response

PUT

Update cart metadata

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

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart

buy_now

boolean

this is boolean to get buy_now cart

Request body

gstin

string

pick_up_customer_details

object

Customer contact details for customer pickup at store

checkout_mode

string

gift_details

object

Nullable

pan_no

string

comment

string

staff_user_id

string

Nullable

staff user id

Response

200

400

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

CartMetaResponse

is_valid

boolean

message

string

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

buyNow:

false

body:

body

Was this section helpful?

PUT

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

Response

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

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

# Update cart meta

GET

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

# Get cart meta

POST

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

# 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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

cart_meta_id

string

Required

CartMeta mongo _id for fetching single cart meta data for editing

Request body

min_cart_value

integer

| int32

max_cart_value

integer

| int32

bulk_coupons

boolean

max_cart_items

integer

| int32

gift_display_text

string

delivery_charges

object (DeliveryCharges)

DeliveryCharges

revenue_engine_coupon

boolean

gift_pricing

number

| float

enabled

boolean

Response

200

400

Cart Meta Config updated successfully

CartMetaConfigUpdate

min_cart_value

integer

| int32

max_cart_value

integer

| int32

bulk_coupons

boolean

max_cart_items

integer

| int32

gift_display_text

string

delivery_charges

object (DeliveryCharges)

DeliveryCharges

revenue_engine_coupon

boolean

gift_pricing

number

| float

enabled

boolean

Examples

Parameters

companyId:

"value"

applicationId:

"value"

cartMetaId:

"value"

body:

body

Was this section helpful?

PUT

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

Response

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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Response

200

400

Cart Meta Config Fetched successfully

CartMetaConfigAdd

min_cart_value

integer

| int32

max_cart_value

integer

| int32

bulk_coupons

boolean

max_cart_items

integer

| int32

gift_display_text

string

delivery_charges

object (DeliveryCharges)

DeliveryCharges

revenue_engine_coupon

boolean

gift_pricing

number

| float

enabled

boolean

Examples

Parameters

companyId:

"value"

applicationId:

"value"

Was this section helpful?

GET

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

Response

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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

min_cart_value

integer

| int32

max_cart_value

integer

| int32

bulk_coupons

boolean

max_cart_items

integer

| int32

gift_display_text

string

delivery_charges

object (DeliveryCharges)

DeliveryCharges

revenue_engine_coupon

boolean

gift_pricing

number

| float

enabled

boolean

Response

201

400

Cart Meta Config Created successfully

CartMetaConfigAdd

min_cart_value

integer

| int32

max_cart_value

integer

| int32

bulk_coupons

boolean

max_cart_items

integer

| int32

gift_display_text

string

delivery_charges

object (DeliveryCharges)

DeliveryCharges

revenue_engine_coupon

boolean

gift_pricing

number

| float

enabled

boolean

Examples

Parameters

companyId:

"value"

applicationId:

"value"

body:

body

Was this section helpful?

POST

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

Response

Checkout

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

Operations

POST

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

# Get and validate cart items

POST

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

# Checkout cart

POST

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

# Update cart checkout

POST

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

# Checkout cart

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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

cart_items

array of object (CartItem)

Required

Array of CartItem

Response

200

400

Cart details with breakup

OpenapiCartDetailsResponse

is_valid

boolean

message

string

breakup_values

object (CartBreakup)

CartBreakup

items

array of object (CartProductInfo)

Array of CartProductInfo

Examples

Parameters

companyId:

"value"

applicationId:

"value"

body:

body

Was this section helpful?

POST

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

Response

POST

Checkout cart

The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

payment_mode

string

cart_value

number

| float

Required

cart_items

array of object (OpenApiOrderItem)

Required

Array of OpenApiOrderItem

shipping_address

object (ShippingAddress)

ShippingAddress

loyalty_discount

number

| float

comment

string

Nullable

payment_methods

array of object (MultiTenderPaymentMethod)

Required

Array of MultiTenderPaymentMethod

employee_discount

object

coupon

string

cashback_applied

number

| float

Required

gstin

string

Nullable

billing_address

object (ShippingAddress)

Required

ShippingAddress

coupon_code

string

Required

coupon_value

number

| float

Required

delivery_charges

number

| float

Required

affiliate_order_id

string

currency_code

string

order_id

string

files

array of object (OpenApiFiles)

Array of OpenApiFiles

cod_charges

number

| float

Required

Response

200

400

Checkout cart and create Fynd order id

OpenApiCheckoutResponse

success

boolean

message

string

order_ref_id

string

Order id sent in request

order_id

string

Fynd order id

Examples

Parameters

companyId:

"value"

applicationId:

"value"

body:

body

Was this section helpful?

POST

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

Response

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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

cart_id

string

Required

payment_mode

string

Required

billing_address

object

merchant_code

string

Required

payment_identifier

string

Nullable

Required

currency_code

string

Required

aggregator

string

Required

order_type

string

Required

callback_url

string

cart_items

array of object (OverrideCartItem)

Required

Array of OverrideCartItem

ordering_store

integer

| int32

Nullable

Default Value : null

shipping_address

object

Response

200

Checkout cart and create Fynd order id

OverrideCheckoutResponse

data

object

cart

object

success

string

order_id

string

message

string

Examples

Parameters

companyId:

"value"

applicationId:

"value"

body:

body

Was this section helpful?

POST

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

Response

POST

Checkout cart

The checkout cart initiates the order creation process based on the items in the user’s cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart

Request body

address_id

string

payment_identifier

string

Nullable

payment_params

object

Nullable

custom_meta

object

payment_auto_confirm

boolean

string

Required

pos

boolean

billing_address_id

string

merchant_code

string

aggregator

string

pick_at_store_uid

integer

| int32

Nullable

Default Value : null

device_id

string

Nullable

delivery_address

object

payment_mode

string

checkout_mode

string

customer_details

object (CustomerDetails)

Nullable

Customer details

CustomerDetails

meta

object

payment_methods

array of object (PaymentMethod)

Required

Array of PaymentMethod

staff

object (StaffCheckout)

StaffCheckout

employee_code

string

Nullable

billing_address

object

callback_url

string

Nullable

Default Value : null

user_id

string

Nullable

Required

extra_meta

object

order_type

string

Required

files

array of object (Files)

List of file url

Array of Files

ordering_store

integer

| int32

Nullable

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

app_intercept_url

string

data

object

cart

object (CheckCart)

CheckCart

success

boolean

callback_url

string

payment_confirm_url

string

order_id

string

message

string

Examples

Parameters

Parameters are not required.

Was this section helpful?

POST

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

Response

Coupon

Coupons are promotional tools offered by businesses to customers, providing discounts, incentives, or special offers on purchases. Their aim is to attract customers, increase sales, encourage repeat purchases, and promote customer loyalty. Various types of coupons include: X Percentage Value: Offers a discount based on a percentage of the total purchase value. Example: Get 15% off your entire order. X Amount Value: Provides a fixed discount amount regardless of the total purchase value. Example: Save Rs.20 on your purchase. Bundle Percentage Discount: Discounts applied when purchasing a specific combination or quantity of items. Example: Buy 2 shirts and get 20% off each. Bundle Amount Percentage Discount: Similar to bundle percentage discount, but the discount is applied to a specific amount spent. Example: Spend Rs.100 on shoes and receive 25% off your entire order. Buy X Items Get Y Items Free: Offers a certain number of items for free when a specified quantity is purchased. Example: Buy 2 pairs of socks and get 1 pair free. Buy X Items at Absolute Amount: Allows customers to purchase a set number of items at a fixed price. Example: Buy 3 t-shirts for Rs. 250.

Operations

GET

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

# List coupons

POST

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

# Create a coupon

GET

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

# Get a coupon

PUT

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

# Update a coupon

GET

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

# Check coupon code exists

GET

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

# List coupons

POST

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

# Apply coupon

DEL

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

# Remove coupon

GET

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

# 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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

page_no

integer

current page no as per pagination

Default Value : 0

page_size

integer

Coupon max records fetched in single request

Default Value : 10

is_archived

boolean

Filter by active or inactive coupon

Default Value : false

title

string

Filter by `title`

is_public

boolean

Filter by `is_public`

is_display

boolean

Filter by `is_display`

type_slug

string

Filter by coupon type

code

string

Filter by `code`

Response

200

Coupon List for sent page_size and page_no

CouponsResponse

items

array of object (CouponAdd)

Array of CouponAdd

page

object (Page)

Page

Examples

Parameters

Parameters are not required.

Was this section helpful?

GET

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

Response

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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

date_meta

object (CouponDateMeta)

CouponDateMeta

ownership

object (Ownership)

Required

Ownership

author

object (CouponAuthor)

CouponAuthor

state

object (State)

State

restrictions

object (Restrictions)

Restrictions

validation

object (Validation)

Validation

action

object (CouponAction)

CouponAction

tags

array of string

Default Value :

_schedule

object (CouponSchedule)

CouponSchedule

rule

array of object (Rule)

Required

Array of Rule

display_meta

object (DisplayMeta)

Required

DisplayMeta

code

string

Required

type_slug

string

Required

identifiers

object (Identifier)

Required

Identifier

validity

object (Validity)

Required

Validity

rule_definition

object (RuleDefinition)

Required

RuleDefinition

_id

string

Coupon id

Response

201

400

Coupon Created successfully

SuccessMessage

success

boolean

message

string

Examples

Parameters

companyId:

"value"

applicationId:

"value"

body:

body

Was this section helpful?

POST

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

Response

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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

Coupon mongo _id for fetching single coupon data for editing

Response

200

404

Coupon object for sent `id`

CouponUpdate

date_meta

object (CouponDateMeta)

CouponDateMeta

ownership

object (Ownership)

Ownership

author

object (CouponAuthor)

CouponAuthor

state

object (State)

State

restrictions

object (Restrictions)

Restrictions

validation

object (Validation)

Validation

action

object (CouponAction)

CouponAction

tags

array of string

Default Value :

_schedule

object (CouponSchedule)

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

companyId:

"value"

applicationId:

"value"

id:

"value"

Was this section helpful?

GET

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

Response

PUT

Update a coupon

Update the details of an existing coupon by specifying its unique identifier. This includes modifying coupon attributes such as discount percentage, validity period, and associated conditions. Leveraging this functionality allows businesses to quickly adapt their promotional strategies to changing market dynamics.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

Coupon mongo _id for fetching single coupon data for editing

Request body

date_meta

object (CouponDateMeta)

CouponDateMeta

ownership

object (Ownership)

Required

Ownership

author

object (CouponAuthor)

CouponAuthor

state

object (State)

State

restrictions

object (Restrictions)

Restrictions

validation

object (Validation)

Validation

action

object (CouponAction)

CouponAction

tags

array of string

Default Value :

_schedule

object (CouponSchedule)

CouponSchedule

rule

array of object (Rule)

Required

Array of Rule

display_meta

object (DisplayMeta)

Required

DisplayMeta

code

string

Required

type_slug

string

Required

identifiers

object (Identifier)

Required

Identifier

validity

object (Validity)

Required

Validity

rule_definition

object (RuleDefinition)

Required

RuleDefinition

Response

200

404

Coupon updated successfully

SuccessMessage

success

boolean

message

string

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

body:

body

Was this section helpful?

PUT

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

Response

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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

code

string

Coupon code

Response

200

400

Valid response with existing coupon code count

Properties

success

boolean

count

integer

Examples

Parameters

Parameters are not required.

Was this section helpful?

GET

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

Response

GET

List coupons

Retrieve a list of all available coupons that customer can apply to their carts. It provides details about each coupon, including its code, discount amount, and applicable conditions.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart.

buy_now

boolean

This is boolean to get buy_now cart

slug

string

Product slug to fetch the available coupons

store_id

string

Store id

Response

200

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)

Array of Coupon

page

object (PageCoupon)

PageCoupon

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

buyNow:

false

slug:

"value"

storeId:

"value"

Was this section helpful?

GET

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

Response

POST

Apply coupon

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

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

boolean

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

boolean

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

boolean

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

string

The unique identifier of the cart

buy_now

boolean

This is boolean to get buy_now cart

Request body

coupon_code

string

Required

Coupon code to be applied

Response

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

coupon_text

string

pan_config

object

delivery_promise

object (ShipmentPromise)

ShipmentPromise

comment

string

items

array of object (CartProductInfo)

Array of CartProductInfo

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

delivery_charge_info

string

common_config

object (CartCommonConfig)

CartCommonConfig

coupon

object (CartDetailCoupon)

CartDetailCoupon

restrict_checkout

boolean

message

string

notification

object

staff_user_id

string

success

boolean

breakup_values

object (CartBreakup)

CartBreakup

is_valid

boolean

currency

object (CartCurrency)

CartCurrency

checkout_mode

string

last_modified

string

| date

buy_now

boolean

gstin

string

applied_promo_details

array of object (AppliedPromotion)

Array of AppliedPromotion

pan_no

string

custom_cart_meta

object

Examples

Parameters

companyId:

"value"

applicationId:

"value"

false

id:

"value"

buyNow:

false

body:

body

Was this section helpful?

POST

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

Response

DEL

Remove coupon

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

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

uid

string

The unique identifier of the cart

buy_now

boolean

This is boolean to get buy_now cart

Response

200

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

CartDetailResponse

cart_id

integer

| int32

uid

string

coupon_text

string

pan_config

object

delivery_promise

object (ShipmentPromise)

ShipmentPromise

comment

string

items

array of object (CartProductInfo)

Array of CartProductInfo

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

delivery_charge_info

string

common_config

object (CartCommonConfig)

CartCommonConfig

coupon

object (CartDetailCoupon)

CartDetailCoupon

restrict_checkout

boolean

message

string

notification

object

staff_user_id

string

success

boolean

breakup_values

object (CartBreakup)

CartBreakup

is_valid

boolean

currency

object (CartCurrency)

CartCurrency

checkout_mode

string

last_modified

string

| date

buy_now

boolean

gstin

string

applied_promo_details

array of object (AppliedPromotion)

Array of AppliedPromotion

pan_no

string

custom_cart_meta

object

Examples

Parameters

companyId:

"value"

applicationId:

"value"

uid:

"value"

buyNow:

false

Was this section helpful?

DEL

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

Response

GET

Validate applied coupon

Validates the applicability of a coupon code for the selected payment mode for the existing cart. This ensures the coupon's validity before proceeding with the payment process, enhancing user experience and preventing potential errors during transactions.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart

buy_now

boolean

This is boolean to get buy_now cart

address_id

string

ID allotted to an address

payment_mode

string

Payment mode selected by the customer

payment_identifier

string

Identifier of payment like ICIC, PAYTM

aggregator_name

string

Payment gateway identifier

merchant_code

string

Identifier used by payment gateway for a given payment mode, e.g. NB_ICIC, PAYTM

Response

200

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

PaymentCouponValidate

success

boolean

message

string

coupon_validity

object (CouponValidity)

CouponValidity

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

buyNow:

false

addressId:

"value"

paymentMode:

"value"

paymentIdentifier:

"value"

aggregatorName:

"value"

merchantCode:

"value"

Was this section helpful?

GET

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

Response

Customer address

A customer's address refers to the address where the ordered product is to be delivered. It usually includes details such as the recipient's name, contact, street address, city, state or province, PIN code or ZIP code, and country. Each customer can have multiple addresses associated with them. Storing addresses includes validating the address based on the country and its unique identifiers like PIN code, ZIP code, or area code.

Operations

GET

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

# Get a list of addresses for a customer

POST

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

# Creates a new address for a customer

GET

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

# Get details for a single customer address

PUT

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

# Updates an existing customer address

DEL

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

# Removes an address from a customer's address list

POST

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

# Select customer address for order processing

GET

Get a list of addresses for a customer

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

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

cart_id

string

The unique identifier of the cart

buy_now

boolean

This is boolean to get buy_now cart

mobile_no

string

10-digit mobile number

checkout_mode

string

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

tags

string

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

is_default

boolean

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

user_id

string

Option to fetch address for the provided user_id.

Response

200

400

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

PlatformGetAddressesResponse

address

array of object (PlatformAddress)

Array of PlatformAddress

Examples

Parameters

Parameters are not required.

Was this section helpful?

GET

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

Response

POST

Creates a new address for a customer

Customers can add a new address to their cart to save details such as name, email, contact information, and address.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

phone

string

area_code_slug

string

country_code

string

geo_location

object (GeoLocation)

GeoLocation

country

string

state

string

is_default_address

boolean

tags

array of string

created_by_user_id

string

landmark

string

area_code

string

checkout_mode

string

meta

object

is_active

boolean

name

string

google_map_point

object

cart_id

string

city

string

sector

string

state_code

string

State code for international address

area

string

user_id

string

address_type

string

address

string

country_phone_code

string

country_iso_code

string

_custom_json

object

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

string

success

boolean

is_default_address

boolean

Examples

Parameters

companyId:

"value"

applicationId:

"value"

body:

body

Was this section helpful?

POST

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

Response

GET

Get details for a single customer address

Retrieve a specific customer address stored in the system by providing its unique identifier. This API provides detailed information about the address, including the recipient's name, address, city, postal code, and other relevant details.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

ID allotted to the selected address

cart_id

string

The unique identifier of the cart

buy_now

boolean

This is boolean to get buy_now cart

mobile_no

string

10-digit mobile number

checkout_mode

string

Option to checkout for self or for others

tags

string

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

is_default

boolean

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

user_id

string

Option to fetch address for the provided user_id.

Response

200

400

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

PlatformAddress

phone

string

area_code_slug

string

country_code

string

geo_location

object (GeoLocation)

GeoLocation

country

string

state

string

is_default_address

boolean

tags

array of string

created_by_user_id

string

landmark

string

area_code

string

checkout_mode

string

meta

object

is_active

boolean

name

string

google_map_point

object

cart_id

string

city

string

sector

string

state_code

string

State code for international address

area

string

user_id

string

address_type

string

address

string

country_phone_code

string

country_iso_code

string

_custom_json

object

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

cartId:

"value"

buyNow:

false

mobileNo:

"value"

checkoutMode:

"value"

tags:

"value"

isDefault:

false

userId:

"value"

Was this section helpful?

GET

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

Response

PUT

Updates an existing customer address

Update the user address

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

ID allotted to the selected address

Request body

phone

string

area_code_slug

string

country_code

string

geo_location

object (GeoLocation)

GeoLocation

country

string

state

string

is_default_address

boolean

tags

array of string

created_by_user_id

string

landmark

string

area_code

string

checkout_mode

string

meta

object

is_active

boolean

name

string

google_map_point

object

cart_id

string

city

string

sector

string

state_code

string

State code for international address

area

string

user_id

string

address_type

string

address

string

country_phone_code

string

country_iso_code

string

_custom_json

object

Response

201

400

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

UpdateAddressResponse

string

is_default_address

boolean

success

boolean

is_updated

boolean

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

body:

body

Was this section helpful?

PUT

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

Response

DEL

Removes an address from a customer's address list

Remove an existing customer address from the system.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

ID allotted to the selected address

user_id

string

Option to delete address for the provided user_id.

Response

201

400

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

DeleteAddressResponse

string

is_deleted

boolean

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

userId:

"value"

Was this section helpful?

DEL

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

Response

POST

Select customer address for order processing

Select an address from the saved customer addresses and validates the availability of items in the cart. Additionally, it verifies and updates the delivery promise based on the selected address.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

cart_id

string

The unique identifier of the cart

buy_now

boolean

This is boolean to get buy_now cart

boolean

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

boolean

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

Request body

cart_id

string

billing_address_id

string

checkout_mode

string

user_id

string

Response

201

400

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

CartDetailResponse

cart_id

integer

| int32

uid

string

coupon_text

string

pan_config

object

delivery_promise

object (ShipmentPromise)

ShipmentPromise

comment

string

items

array of object (CartProductInfo)

Array of CartProductInfo

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

delivery_charge_info

string

common_config

object (CartCommonConfig)

CartCommonConfig

coupon

object (CartDetailCoupon)

CartDetailCoupon

restrict_checkout

boolean

message

string

notification

object

staff_user_id

string

success

boolean

breakup_values

object (CartBreakup)

CartBreakup

is_valid

boolean

currency

object (CartCurrency)

CartCurrency

checkout_mode

string

last_modified

string

| date

buy_now

boolean

gstin

string

applied_promo_details

array of object (AppliedPromotion)

Array of AppliedPromotion

pan_no

string

custom_cart_meta

object

Examples

Parameters

companyId:

"value"

applicationId:

"value"

cartId:

"value"

buyNow:

false

body:

body

Was this section helpful?

POST

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

Response

Payment mode

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

Operations

PUT

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

# Select payment mode

PUT

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

# Select payment mode (latest)

PUT

Select payment mode

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

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart

buy_now

boolean

This is boolean to get buy_now cart

order_type

string

The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.

Request body

address_id

string

payment_mode

string

aggregator_name

string

merchant_code

string

payment_identifier

string

Nullable

string

Response

200

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

CartDetailResponse

cart_id

integer

| int32

uid

string

coupon_text

string

pan_config

object

delivery_promise

object (ShipmentPromise)

ShipmentPromise

comment

string

items

array of object (CartProductInfo)

Array of CartProductInfo

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

delivery_charge_info

string

common_config

object (CartCommonConfig)

CartCommonConfig

coupon

object (CartDetailCoupon)

CartDetailCoupon

restrict_checkout

boolean

message

string

notification

object

staff_user_id

string

success

boolean

breakup_values

object (CartBreakup)

CartBreakup

is_valid

boolean

currency

object (CartCurrency)

CartCurrency

checkout_mode

string

last_modified

string

| date

buy_now

boolean

gstin

string

applied_promo_details

array of object (AppliedPromotion)

Array of AppliedPromotion

pan_no

string

custom_cart_meta

object

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

buyNow:

false

orderType:

"value"

body:

body

Was this section helpful?

PUT

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

Response

PUT

Select payment mode (latest)

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

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

The unique identifier of the cart

buy_now

boolean

This is boolean to get buy_now cart

order_type

string

The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.

Request body

address_id

string

payment_mode

string

aggregator_name

string

merchant_code

string

payment_identifier

string

Nullable

string

payment_methods

array of object (PaymentMethod)

Array of PaymentMethod

Response

200

400

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

CartDetailResponse

cart_id

integer

| int32

uid

string

coupon_text

string

pan_config

object

delivery_promise

object (ShipmentPromise)

ShipmentPromise

comment

string

items

array of object (CartProductInfo)

Array of CartProductInfo

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

delivery_charge_info

string

common_config

object (CartCommonConfig)

CartCommonConfig

coupon

object (CartDetailCoupon)

CartDetailCoupon

restrict_checkout

boolean

message

string

notification

object

staff_user_id

string

success

boolean

breakup_values

object (CartBreakup)

CartBreakup

is_valid

boolean

currency

object (CartCurrency)

CartCurrency

checkout_mode

string

last_modified

string

| date

buy_now

boolean

gstin

string

applied_promo_details

array of object (AppliedPromotion)

Array of AppliedPromotion

pan_no

string

custom_cart_meta

object

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

buyNow:

false

orderType:

"value"

body:

body

Was this section helpful?

PUT

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

Response

Price adjustment

Price adjustment refers to modification of product prices based on various factors such as user behavior, market conditions, or business rules. It allows for real-time adjustments to product pricing, enabling businesses to offer personalized pricing or targeted discounts to individual customers or specific segments of users. For example, suppose a user has paid through a third-party platform, and the business wants to offer them a discount or apply a different pricing strategy. In that case, the Price Adjustment enable developers to incorporate these adjustments into the transaction process, enhancing flexibility and convenience for both users and businesses.

Operations

PUT

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

# Update price adjustments

DEL

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

# Remove price adjustments

POST

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

# Create price adjustments

GET

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

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

PUT

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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

price adjustment id for fetching single price adjustment data for editing

Request body

modified_by

string

The entity that modified the field

value

number

| float

Required

message

string

Required

The message associated with the price adjustment

apply_expiry

string

| date-time

The date and time when the expiry should be applied

restrictions

object (PriceAdjustmentRestrictions)

restrictions applied to this particular item or product, including whether or not cancellation and return are allowed.

PriceAdjustmentRestrictions

article_level_distribution

boolean

Required

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

collection

object (Collection)

Required

Collection

type

string

Required

type of price adjusment

Enum

allowed_refund

boolean

Flag indicating whether refunds are allowed (default: False)

is_authenticated

boolean

Required

Flag indicating whether the user is authenticated

article_ids

array of object (Article)

Required

The list of article object in the price adjustment

Array of Article

meta

object

cart_id

string

Required

The ID of the cart

Response

200

400

Price Adjustment Updated successfully

PriceAdjustmentResponse

data

object (PriceAdjustment)

PriceAdjustment

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

body:

body

Was this section helpful?

PUT

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

Response

DEL

Remove price adjustments

Remove the applied price adjustments for specific items within the cart based on unique price adjustment ID.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

Price Adjustment id for fetching single price adjustment data for editing

Response

200

400

Price Adjustment data Removed successfully

SuccessMessage

success

boolean

message

string

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

Was this section helpful?

DEL

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

Response

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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

value

number

| float

Required

message

string

Required

The message associated with the price adjustment

apply_expiry

string

| date-time

The date and time when the expiry should be applied

restrictions

object (PriceAdjustmentRestrictions)

This field accepts the restrictions applied to this particular item or service, including whether or not cancellation and return are allowed, etc

PriceAdjustmentRestrictions

created_by

string

The entity that created the field

article_level_distribution

boolean

Required

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

collection

object (Collection)

Required

Collection

type

string

Required

type of price adjusment

Enum

allowed_refund

boolean

Flag indicating whether refunds are allowed (default: False)

is_authenticated

boolean

Required

Flag indicating whether the user is authenticated

article_ids

array of object (Article)

Required

The list of article object in the price adjustment

Array of Article

meta

object

cart_id

string

Required

The ID of the cart

Response

201

400

Price Adjustment Created successfully

PriceAdjustmentResponse

data

object (PriceAdjustment)

PriceAdjustment

Examples

Parameters

companyId:

"value"

applicationId:

"value"

body:

body

Was this section helpful?

POST

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

Response

GET

Get a list of all price adjustments associated with a cart

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

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

cart_id

string

Required

Cart Id

Response

200

Price Adjustments List. See example below for details

GetPriceAdjustmentResponse

data

array of object (PriceAdjustment)

Array of PriceAdjustment

Examples

Parameters

cartId:

"65c06fe589db42581e4be72e"

Was this section helpful?

GET

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

Response

Promotion

Promotion refers to a marketing campaign designed to incentivize customers to make purchases by offering discounts, bonuses, or other special offers. The aim of promotions is to attract customers, increase sales, clear excess inventory, introduce new products, encourage repeat purchases, and foster customer loyalty. Various types of promotions include:  X Percentage Value: Offers a percentage discount based on the total purchase value. Example: Get 20% off orders over Rs. 1000. X Amount Value: Provides a fixed discount amount regardless of the total purchase value. Example: Save Rs. 50 on orders over Rs. 500. Buy X Items Get Y Items Free: Offers free items when a specified quantity is purchased. Example: Buy 2 shirts, get 1 shirt free. Buy X Items at Absolute Amount: Allows purchasing a set number of items at a fixed price. Example: Buy 3 t-shirts for Rs. 500. Free Shipping: Waives shipping fees on orders over Rs. 500. Example: Enjoy free shipping on all orders over Rs. 500. Free Gift Items: Offers complimentary items with qualifying purchases. Example: Get a free tote bag with orders over Rs. 1000. Bundle Percentage Discount: Discounts applied when buying specific combinations or quantities. Example: Buy 2 shirts, get 20% off each. Bundle Amount Discount: Similar to bundle percentage discount, but discount is applied to a specific spending amount. Example: Spend Rs. 1000 on shoes, receive Rs. 200 off entire order. Buy X Amount and Get Y Percentage Off: Offers a percentage discount on the total purchase when a specified amount is spent. Example: Spend Rs. 1500, get 10% off entire order.

Operations

GET

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

# List promotions

POST

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

# Create a promotion

GET

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

# Get a promotion

PUT

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

# Update a promotion

GET

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

# Get promotion and coupon type

GET

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

# 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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

page_no

integer

current page no as per pagination

Default Value : 0

page_size

integer

Promotion max records fetched in single request

Default Value : 10

string

Filter by name

is_active

boolean

Filter by active or inactive promotion

Default Value : true

promo_group

string

Filter promotion group

Enum

promotion_type

string

Filter promotion type

fp_panel

string

Filter non extension promotions

promotion_id

string

Filter by promotion _id

Response

200

Promotion List for sent page_size and page_no

PromotionsResponse

items

array of object (PromotionListItem)

Array of PromotionListItem

page

object (Page)

Page

Examples

Parameters

Parameters are not required.

Was this section helpful?

GET

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

Response

POST

Create a promotion

Creates a new promotion based on the selected promotion type. Sellers can choose from multiple supported promotion types, including percentage value, fixed amount value, bundled discount, buy X get Y items, and more, along with customizable promotion criteria to meet specific business requirements.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

Request body

stackable

boolean

calculate_on

string

Only available for Contract pricing and Ladder pricing promotion type

Enum

apply_exclusive

string

Nullable

Enum

promo_group

string

Required

Enum

mode

string

Required

Enum

apply_all_discount

boolean

display_meta

object (DisplayMeta1)

Required

DisplayMeta1

ownership

object (Ownership1)

Required

Ownership1

promotion_type

string

Required

Enum

discount_rules

array of object (DiscountRule)

Required

Array of DiscountRule

restrictions

object (Restrictions1)

Restrictions1

currency

string

code

string

_schedule

object (PromotionSchedule)

PromotionSchedule

post_order_action

object (PromotionAction)

PromotionAction

apply_priority

integer

| int32

author

object (PromotionAuthor)

PromotionAuthor

visiblility

object (Visibility)

Visibility

application_id

string

Required

buy_rules

object

Required

_custom_json

object

date_meta

object (PromotionDateMeta)

PromotionDateMeta

tags

array of string

Default Value :

Response

201

400

Promotion Created successfully

PromotionAdd

stackable

boolean

calculate_on

string

Only available for Contract pricing and Ladder pricing promotion type

Enum

apply_exclusive

string

Nullable

Enum

promo_group

string

Enum

mode

string

Enum

apply_all_discount

boolean

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)

Restrictions1

currency

string

code

string

_schedule

object (PromotionSchedule)

PromotionSchedule

post_order_action

object (PromotionAction)

PromotionAction

apply_priority

integer

| int32

author

object (PromotionAuthor)

PromotionAuthor

visiblility

object (Visibility)

Visibility

application_id

string

buy_rules

object

_custom_json

object

date_meta

object (PromotionDateMeta)

PromotionDateMeta

tags

array of string

Default Value :

Examples

Parameters

companyId:

"value"

applicationId:

"value"

body:

body

Was this section helpful?

POST

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

Response

GET

Get a promotion

Retrieve details of a specific promotion by providing its unique identifier to obtain information such as promotion type, rules, validity period and other related information.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

Promotion mongo _id for fetching single promotion data for editing

Response

200

404

Promotion object for sent `id`

PromotionUpdate

stackable

boolean

calculate_on

string

Only available for Contract pricing and Ladder pricing promotion type

Enum

apply_exclusive

string

Nullable

Enum

promo_group

string

Enum

mode

string

Enum

apply_all_discount

boolean

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)

Restrictions1

currency

string

code

string

_schedule

object (PromotionSchedule)

PromotionSchedule

post_order_action

object (PromotionAction)

PromotionAction

apply_priority

integer

| int32

author

object (PromotionAuthor)

PromotionAuthor

visiblility

object (Visibility)

Visibility

application_id

string

buy_rules

object

_custom_json

object

date_meta

object (PromotionDateMeta)

PromotionDateMeta

tags

array of string

Default Value :

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

Was this section helpful?

GET

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

Response

PUT

Update a promotion

Update the details of an existing promotion by specifying its unique identifier. This includes modifying promotion attributes such as discount percentage, validity period, and associated conditions. Leveraging this functionality allows businesses to quickly adapt their promotional strategies to changing market dynamics.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

string

Required

Promotion mongo _id for fetching single promotion data for editing

Request body

stackable

boolean

calculate_on

string

Only available for Contract pricing and Ladder pricing promotion type

Enum

apply_exclusive

string

Nullable

Enum

promo_group

string

Required

Enum

mode

string

Required

Enum

apply_all_discount

boolean

display_meta

object (DisplayMeta1)

Required

DisplayMeta1

ownership

object (Ownership1)

Required

Ownership1

promotion_type

string

Required

Enum

discount_rules

array of object (DiscountRule)

Required

Array of DiscountRule

restrictions

object (Restrictions1)

Restrictions1

currency

string

code

string

_schedule

object (PromotionSchedule)

PromotionSchedule

post_order_action

object (PromotionAction)

PromotionAction

apply_priority

integer

| int32

author

object (PromotionAuthor)

PromotionAuthor

visiblility

object (Visibility)

Visibility

application_id

string

Required

buy_rules

object

Required

_custom_json

object

date_meta

object (PromotionDateMeta)

PromotionDateMeta

tags

array of string

Default Value :

Response

200

404

Promotion updated successfully

PromotionUpdate

stackable

boolean

calculate_on

string

Only available for Contract pricing and Ladder pricing promotion type

Enum

apply_exclusive

string

Nullable

Enum

promo_group

string

Enum

mode

string

Enum

apply_all_discount

boolean

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)

Restrictions1

currency

string

code

string

_schedule

object (PromotionSchedule)

PromotionSchedule

post_order_action

object (PromotionAction)

PromotionAction

apply_priority

integer

| int32

author

object (PromotionAuthor)

PromotionAuthor

visiblility

object (Visibility)

Visibility

application_id

string

buy_rules

object

_custom_json

object

date_meta

object (PromotionDateMeta)

PromotionDateMeta

tags

array of string

Default Value :

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

body:

body

Was this section helpful?

PUT

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

Response

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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

entity_type

string

entity_type as promotion or coupon

Enum

is_hidden

boolean

promo-coupon config shown or not

Response

200

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

ActivePromosResponse

entity_slug

string

title

string

Name of the promotion

modified_on

string

Coupon modification date

example

string

Discount offers examples

entity_type

string

Type of entity to be selected from : ['coupon', 'promotion']

created_on

string

Coupon creation date

is_hidden

boolean

If the promo is active or not

type

string

Coupon type

subtitle

string

Small description of the current offer

description

string

The description of the offer in the form of an HTML

Examples

Parameters

companyId:

"value"

applicationId:

"value"

entityType:

"value"

isHidden:

false

Was this section helpful?

GET

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

Response

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

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

code

string

Promotion code

Response

200

400

Valid response with existing promotion code count

Properties

success

boolean

count

integer

Examples

Parameters

Parameters are not required.

Was this section helpful?

GET

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

Response

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/platform/cart/v1.0/company/{company_id}/application/{application_id}/available-promotions

# List available promotion offers

GET

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

# Fetch available promotions payment 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

company_id

string

Required

Current company id

application_id

string

Required

Current Application id

slug

string

A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/

page_size

integer

Number of offers to be fetched to show

promotion_group

string

Type of promotion groups

store_id

integer

Store id

cart_type

string

The type of cart

Response

200

400

Success. Returns a array containing the available offers (if exists) on product via promotions. Refer `PromotionOffersResponse` for more details.

PromotionOffersResponse

available_promotions

array of object (PromotionOffer)

Array of PromotionOffer

Examples

Parameters

companyId:

"value"

applicationId:

"value"

slug:

"value"

pageSize:

promotionGroup:

"value"

storeId:

cartType:

"value"

Was this section helpful?

GET

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

Response

GET

Fetch available promotions payment offers

Use this API to get top 5 payment offers available for current product

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application id

string

Cart id

uid

integer

Cart uid

Response

200

400

Success. Returns a array containing the available offers (if exists) on product via promotions. Refer `PromotionPaymentOffersResponse` for more details.

PromotionPaymentOffersResponse

success

boolean

promotions

array of object (PromotionPaymentOffer)

Array of PromotionPaymentOffer

Examples

Parameters

companyId:

"value"

applicationId:

"value"

id:

"value"

uid:

Was this section helpful?

GET

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

Response

Selling Location

A selling location represents a geographical location where your stores, pop-up stores, headquarters, and warehouses exist. Find in-stock locations for products Additionally, the API retrieves detailed location information by ID, offering comprehensive store details for enhanced user convenience

Operations

GET

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

# Get Store Address

GET

Get Store Address

Retrieve store details by entering the unique identifier of the pickup stores. Store details include the seller's name, contact information such as email address or phone number and business address.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

store_uid

integer

Required

The unique identifier of the store

Response

200

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

StoreDetailsResponse

items

array of object (PickupStoreDetail)

Array of PickupStoreDetail

Examples

Parameters

companyId:

"value"

applicationId:

"value"

storeUid:

Was this section helpful?

GET

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

Response

Shipment

Shipment refers to the process of delivering purchased items from the seller's location to the customer’s designated address. Shipment details includes seller information, estimated delivery dates, item quantity, order type (Home Delivery or Pick At Store or Digital) and other shipment meta information. Additionally, it provides details about the items included in the shipment.

Operations

GET

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

# Get shipments details

PUT

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

# Update shipments

GET

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

# Get delivery modes

GET

Get shipments details

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

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

pick_at_store_uid

integer

ID of the store from where the order will be picked up by the customer, assuming the order_type is `PickAtStore`. This may or may not be the same as the ID of the ordering store.

ordering_store_id

integer

ID of the store where the customer is ordering from.

boolean

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

boolean

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

string

The unique identifier of the cart

address_id

string

ID allotted to the selected address

area_code

string

The PIN Code of the destination address, e.g. 400059

order_type

string

The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.

Enum

Response

200

500

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

PlatformCartShipmentsResponse

coupon_text

string

pan_config

object

delivery_promise

object (ShipmentPromise)

ShipmentPromise

comment

string

items

array of object (CartProductInfo)

Array of CartProductInfo

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

delivery_charge_info

string

restrict_checkout

boolean

message

string

breakup_values

object (CartBreakup)

CartBreakup

staff_user_id

string

Nullable

is_valid

boolean

shipments

array of object (PlatformShipmentResponse)

Array of PlatformShipmentResponse

currency

object (CartCurrency)

CartCurrency

checkout_mode

string

last_modified

string

| date

buy_now

boolean

gstin

string

applied_promo_details

array of object (AppliedPromotion)

Array of AppliedPromotion

error

boolean

pan_no

string

custom_cart_meta

object

Examples

Parameters

Parameters are not required.

Was this section helpful?

GET

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

Response

PUT

Update shipments

Update the quantity or delivery type of the shipments. Customers can switch the order type from Home Delivery to Pick At Store and vice versa.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

boolean

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

boolean

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

string

The unique identifier of the cart

address_id

string

ID allotted to an address

area_code

string

The PIN Code of the destination address, e.g. 400059

order_type

string

The order type of shipment HomeDelivery - If the customer wants the order home-delivered PickAtStore - If the customer wants the handover of an order at the store itself.

Request body

shipments

array of object (UpdateCartShipmentItem)

Required

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

pan_config

object

delivery_promise

object (ShipmentPromise)

ShipmentPromise

comment

string

items

array of object (CartProductInfo)

Array of CartProductInfo

payment_selection_lock

object (PaymentSelectionLock)

PaymentSelectionLock

delivery_charge_info

string

restrict_checkout

boolean

message

string

breakup_values

object (CartBreakup)

CartBreakup

staff_user_id

string

Nullable

is_valid

boolean

shipments

array of object (PlatformShipmentResponse)

Array of PlatformShipmentResponse

currency

object (CartCurrency)

CartCurrency

checkout_mode

string

last_modified

string

| date

buy_now

boolean

gstin

string

applied_promo_details

array of object (AppliedPromotion)

Array of AppliedPromotion

error

boolean

pan_no

string

custom_cart_meta

object

Examples

Parameters

Parameters are not required.

Was this section helpful?

PUT

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

Response

GET

Get delivery modes

Retrieve a list of delivery modes (home delivery/store pickup) along with a list of available pickup stores for a given cart at a specified PIN Code.

Parameters

company_id

string

Required

Current company id

application_id

string

Required

Current Application _id

area_code

string

Required

The PIN Code of the destination address, e.g. 400059

string

The unique identifier of the cart

Response

200

Success. Returns the available delivery mode available for a given PIN Code, along with the UID of all the eligible pickup stores.

CartDeliveryModesResponse

pickup_stores

array of integer

Store pick up available store uids

available_modes

array of string

Available delivery modes

Examples

Parameters

companyId:

"value"

applicationId:

"value"

areaCode:

"value"

id:

"value"

Was this section helpful?

GET

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

Response

« List event configurations

List sales channel brands »

Cart

Cart

Check cart serviceability

Check cart serviceability

checkCartServiceability

Get abandoned carts

Get abandoned carts

getAbandonedCart

Get abandoned cart details

Get abandoned cart details

getAbandonedCartDetails

Add items to cart

Add items to cart

addItems

Update cart items

Update cart items

updateCart

Share cart link

Share cart link

getCartShareLink

List shared cart items

List shared cart items

getCartSharedItems

Update shared cart items

Update shared cart items

updateCartWithSharedItems

List carts

List carts

getCartList

Update user of a cart

Update user of a cart

updateCartUser

Get a cart

Get a cart

getCart

Add items to cart

Add items to cart

platformAddItems

Update cart items

Update cart items

platformUpdateCart

Delete a cart

Delete a cart

deleteCart

Get a cart items count

Get a cart items count

getItemCount

Update cart metadata

Update cart metadata

updateCartMeta

Cart meta

Update cart meta

Update cart meta

updateCartMetaConfig

Get cart meta

Get cart meta

fetchCartMetaConfig

Create a new cart meta

Create a new cart meta

createCartMetaConfig

Checkout

Get and validate cart items

Get and validate cart items

fetchAndvalidateCartItems

Checkout cart

Checkout cart

checkoutCart

Update cart checkout

Update cart checkout

overrideCart

Checkout cart

Checkout cart

platformCheckoutCartV2

Coupon

List coupons

List coupons

getCoupons

Create a coupon

Create a coupon

createCoupon