Storefront REST API
Introduction
Change Log
GETGet a cart
HEADGet last modified timestamp of a cart
POSTAdd items to a cart
PUTUpdate cart items
PATCHUpdate store credits into cart and their items
PUTDelete a cart
GETGet a cart items count
PUTUpdate cart metadata
POSTCreate share cart link
GETList shared cart items
POSTUpdate with shared items
POSTCheckout cart
GETList available coupons
POSTApply coupon
DELRemove coupon
GETList bulk discounts
GETValidate applied coupon
GETGet a list of addresses for a customer
POSTCreates a new address for a customer
GETGet details for a single customer address
PUTUpdates an existing customer address
DELRemoves an address from a customer's address list
POSTSelect customer address for order processing
GETList eligible offer products
PUTSelect payment mode
GETList available promotion offers
GETList ladder offers
GETFetch available promotions payment offers
POSTUse loyalty points
GETList shipments
GETList brands
GETGet a brand
GETList product categories
GETGet category by slug
GETList collections
GETLists items of collection
GETGet a collection
GETList departments
GETList followed products, brands
DELDelete item, brand, product
POSTCreate item, brand, product
GETGet follower count
GETList Ids of followed item, brand, product
GETGet a product
GETGet children for a bundled product
GETGet bundled items for a specific product size
GETList sizes
GETList products for comparison
GETList similar products
GETList frequent products
GETList product variants
GETGet product stocks
GETList future stock
GETList products
GETList homepage-featured products
GETGet product price
GETList sellers
GETList country to currency mapping
GETList product, brand, category
GETList available stores
GETList stores with inventory
GETGet selling location
GETRetrieve consent status
POSTUpdate or adds consent settings
POSTUpdate or adds app push token
GETList currencies
GETGet a currency
GETGet currency configuration
GETList languages
GETGet sales channel
GETGet sales channel owner
GETGet Sales channel
GETGet API tokens
GETGet sales channel features
GETGet sales channel contact
GETList order-enabled selling locations
GETGet a selling location
POSTCreate cookies
DELDelete store cookie
GETList staff members
GETGet staff member
GETList announcements
GETGet a blog
GETList blogs
GETGet list of custom fields of given resource and resource slug
GETGet bulk list of custom fields of given resource
GETGet custom object details
GETGet customer support information
GETList Dataloaders
GETList FAQs
GETList FAQ Categories
GETGet FAQ
GETGet a FAQ category
GETList FAQs by category
GETGet HTML tags
GETGet a landing page
GETGet legal information
GETList navigation items
GETGet a page
GETLists pages
GETGet SEO settings
GETList SEO Markup schemas
POSTInitiates file upload
POSTFinalizes upload process.
POSTSigns file URLs.
POSTThis API will provide customer's credit balance against phone number or email and seller*affiliate id
POSTLock or Unlock requested credit note.
GETGet custom form
POSTSubmits form data
GETGet deliverable countries
GETGet countries
GETGet country details
GETGet Localities
GETGet Locality API
POSTValidate address
GETGet fulfillment options
GETGet Fulfillment Option Stores
GETGet delivery promise
GETRetrieve Reasons for Cancellation and Return journey
GETList customer orders
GETGet an order
GETRetrieves POS order details
GETGet refund modes for a shipment
POSTGet refund modes and Refund Price Break for a shipment
GETGet a Shipment
GETRetrieves invoice for shipment
GETTrack shipment status
GETGet shipment's customer
POSTSend OTP to customer
POSTVerifies OTP
GETList shipment cancellation reasons
PUTUpdates shipment status
PUTInitiates a delivery reattempt request for a given shipment
GETRetrieve beneficiary details
GETGet Refund Beneficiaries
POSTAdd a beneficiary for refunds
DELDelete a refund beneficiary
GETGet Refund Beneficiaries using OTP session
POSTAdd a beneficiary for refunds using OTP session
POSTLink payment card to customer
GETRetrieve active card aggregator
GETGet customer cards
POSTDelete customer card
GETGet card details
GETRetrieve details of paid orders
POSTCreate Order
POSTVerify payment customer
POSTVerify order confirmation and charge
POSTVerify payment customer and show credit summary
GETGet payment aggregators
POSTStart payment process
POSTUpdate payment status
GETGet payment modes
GETPOS payment modes
POSTInitiate linking of wallet
POSTOTP verification
POSTDelink the wallet
POSTRender HTML
POSTValidate VPA
GETCredit summary
GETRedirects users to the payment aggregator's interface
GETVerify credit availability and status
POSTOnboard customer for payment
POSTResend or cancel a pending payment transaction
GETGet payment link
POSTCreate payment link
POSTResend payment link
POSTCancel payment link
GETPayment modes for payment link
GETPoll status of payment link
POSTCreate order for payment via link
POSTInitialize payment link
POSTUpdate payment link status
GETRetrieve beneficiary details
POSTVerify OTP for bank and add beneficiary
POSTAdd beneficiary for refund
POSTAdd refund account using OTP verification
POSTVerify OTP for wallet
POSTSet default beneficiary for refund
GETGet refund transfer modes
PUTToggle refund mode
POSTApp QR code
POSTProduct QR code
POSTCollection QR code
POSTURL to QR code
POSTShorten URL
GETGet short link
GETOriginal URL
GETGet applied theme
GETGet theme for preview
GETList pages
GETGet theme page
GETGet Logged in User
GETGet List OF Active Sessions
GETGet Platform Configuration
GETChcek User Existence
POSTVerify OTP and Delete User
GETLogout Current User
GETGet User Attributes
PATCHUpdate User Attributes
GETGet User Attribute Definitions
POSTReset Password via Email
POSTReset Password via Mobile
POSTValidate Password Reset Code
POSTReset Password via Code and login
POSTReset Password via Code
GETCheck Password Existence
POSTUpdate password
POSTVerify Email with Code
POSTVerify Mobile with Code
POSTEdit User Profile Details
PUTAdd Mobile Number to Profile
DELDelete Mobile Number From Profile
POSTSet Mobile as Primary
POSTSend Verification Link to Mobile
PUTAdd Email to Profile
DELDelete Email From Profile
POSTSet Email as Primary
POSTSend Verification Link to Email
POSTSend OTP to Primary Mobile or Email
POSTVerify OTP sent to Primary Mobile or Email
POSTSend OTP to update Mobile or Email
POSTVerify OTP sent to Mobile or Email to update primary details.
POSTLogin with Mobile OTP
POSTEmail and Password Login
POSTLogin with Token
POSTRegister User with Form
POSTSend OTP on Mobile
POSTSend mobile OTP for forgot-password
POSTVerify mobile OTP
POSTVerify Mobile OTP for Forgot Password
POSTSend OTP on Email
POSTSend Email OTP for Forgot Password
POSTVerify Email OTP
POSTVerify Email OTP for Forgot Password
POSTLogin with Facebook
POSTLogin with Google
POSTAndroid Login with Google
POSTiOS Login with Google
POSTiOS Login with Apple
POSTCapture and save click events from various sales channels