Cart
Handles shopping carts, including adding, removing, and updating items, as well as calculating totals.
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.
Check cart serviceability
checkCartServiceability
Get abandoned carts
getAbandonedCart
Get abandoned cart details
getAbandonedCartDetails
Add items to cart
addItems
Update cart items
updateCart
Share cart link
getCartShareLink
List shared cart items
getCartSharedItems
Update shared cart items
updateCartWithSharedItems
List of carts
getCartList
Update user of a cart
updateCartUser
Get a cart
getCart
Add items to cart
platformAddItems
Update cart items
platformUpdateCart
Delete a cart
deleteCart
Get a cart items count
getItemCount
Update cart metadata
updateCartMeta
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.
Update cart meta
updateCartMetaConfig
Get cart meta
fetchCartMetaConfig
Create a new cart meta
createCartMetaConfig
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.
Get and validate cart items
fetchAndvalidateCartItems
Checkout cart
checkoutCart
Update cart checkout
overrideCart
Checkout cart
platformCheckoutCartV2
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.
List of coupons
getCoupons
Create a coupon
createCoupon
Get a coupon
getCouponById
Update a coupon
updateCoupon
Delete a coupon which is in draft state
deleteCoupon
Check coupon code exists
getCouponCodeExists
List of coupons
getAppCoupons
Apply coupon
applyCoupon
Remove coupon
removeCoupon
Validate applied coupon
validateCouponForPayment
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.
Get a list of addresses for a customer
getAddresses
Creates a new address for a customer
addAddress
Get details for a single customer address
getAddressById
Updates an existing customer address
updateAddress
Removes an address from a customer's address list
removeAddress
Select customer address for order processing
selectAddress
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.
Select payment mode
selectPaymentMode
Select payment mode (latest)
selectPaymentModeV2
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.
Update price adjustments
updatePriceAdjustment
Remove price adjustments
removePriceAdjustment
Create price adjustments
addPriceAdjustment
Get a list of all price adjustments associated with a cart
getPriceAdjustments
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.
List of promotions
getPromotions
Create a promotion
createPromotion
Get a specific promotion
getPromotionById
Update a promotion
updatePromotion
Delete a promotion which is in draft state
deletePromotion
Get promotion and coupon type
getPromosCouponConfig
Check promotion code exists
getPromotionCodeExists
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.
List of all available promotion offers
getPromotionOffers
Fetch available promotions payment offers
getPromotionPaymentOffers
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
Get Store Address
getStoreAddressByUid
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.