Storefront REST API
Introduction
Change Log
GETGet user attributes
PATCHUpdate user attributes
GETGet user groups
GETGet group categories
GETRetrieve cart details.
HEADGet last modified timestamp of a cart
POSTAdd items to a cart
PUTUpdate items in the cart
PUTClears the cart
GETCount cart items.
GETCount items in the cart according to cart_type
PUTUpdate cart metadata.
POSTCreate share cart link
GETList shared cart items
POSTUpdate with shared items
GETGet cart configuration
GETGet cart configuration by id
POSTAdd items to a cart
PUTUpdate items in cart
POSTAdd items to a cart
PUTUpdate items in cart
POSTEnhanced cart checkout process
GETList available coupons.
POSTApply coupon.
DELRemove coupon.
GETList available coupons across sales channel.
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
PUTSelect payment mode
GETValidate applied coupon
GETList available promotion offers
GETList ladder offers
GETFetch available promotions payment offers
GETList shipments.
POSTCheckout cart
GETFetches all available brands.
GETRetrieves detailed brand info by slug.
GETLists all product categories.
GETRetrieves category details by slug.
GETFetches all available collections.
GETLists items in a collection by slug.
GETRetrieves collection details by slug.
GETFetches homepage-featured products.
GETLists all departments.
GETRetrieves user's followed listings.
POSTAdd products to wishlist (bulk support).
DELDelete item, brand, product
GETRetrieves follower count for an item.
GETFetches IDs of followed items.
GETFetches detailed product information by slug.
GETRetrieves available sizes for a product by slug.
GETCompares multiple products by slugs.
GETFetches similar products for comparison.
GETRetrieves products frequently compared with a given product.
GETRetrieves product variants by slug.
GETChecks product stock by IDs.
GETFetches future stock data for products.
GETLists all products.
GETFetches product bundles by slug.
POSTget size price for multiple products
GETGet the sellers of a product size at a PIN Code
GETRetrieves search result listings.
GETGet store meta information.
GETGet store meta information.
GETGet store meta information.
GETRetrieves communication consent status.
POSTUpdates or inserts consent settings.
GETRetrieves communication consent status.
POSTUpdates or inserts consent settings.
GETGet otp-configuration, if not present in db then return default settings
GETFetches application details.
GETGet sales channel, owner and seller information
GETRetrieves basic app info.
GETFetches API tokens.
GETGet all deployment stores
GETGet ordering store details
GETFetches app features.
GETRetrieves contact details.
GETLists supported currencies.
GETFetches currency by ID.
GETRetrieves app-specific currencies.
GETLists available languages.
GETLists app staff members.
POSTRetrieves store selection cookie.
DELDeletes store cookie.
GETList announcements
GETGet a blog
GETList blogs
GETGet list of custom fields of given resource and resource slug
GETGet custom object details
GETGet customer support information
GETList Dataloaders
GETGet Dynamic FAQ config
GETList Dynamic FAQ mappings
GETGet Dynamic FAQ mapping by ID
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
GETLists pages
GETGet page by slug
GETGet SEO settings
GETList SEO Markup schemas
GETGet default sitemap configuration
GETList sitemap configurations
GETGet a specific sitemap configuration
GETGet a specific well-known URL
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 a support ticket
POSTCreates a ticket
POSTLogs ticket history.
GETGet addresses
POSTCreate address
GETGet address by ID
PUTUpdate address
DELDelete address
GETGet Pincode API
GETGet deliverable countries
GETGet all countries and associated data.
GETGet country details
GETGet Localities by Name Prefix
GETGet Localities
GETGet locality detail
POSTValidate address
GETShows zones defined at the application level
GETGet zone IDs for delivery and price
GETGet all geoareas in the current application.
GETGet delivery stores
GETGet QC promise
POSTCreate and return shipments.
GETRetrieve Reasons for Cancellation and Return journey
GETList customer orders
GETGet an order
GETRetrieves POS order details.
GETTracks shipment status.
GETRetreives shipment's refund summary.
GETRetrieve refund options with amount breakup for specific shipment and bags.
POSTCheck promo violations for shipments and their associated bags
GETFetches shipment by ID.
GETRetrieves invoice for shipment.
GETRetrieves shipment customer.
POSTSends OTP to customer.
POSTVerifies OTP.
GETLists shipment reasons.
PUTUpdates shipment status.
GETRupifi banner info.
GETEpaylater banner info
GETRetrieve beneficiary details
GETRetrieve beneficiary details
POSTGet Payment status and information for a list of order_ids
GETRetrieve beneficiary details
POSTValidate UPI ID and IFSC code
POSTConfirm payment after successful payment from payment gateway
POSTLink payment card to customer
GETRetrieve active card aggregator
POSTcard aggregator
GETList user's cards.
POSTupdate a card
POSTDelete customer card
GETGet card details
POSTCancel payment link
GETRetrieve details of paid orders
POSTCreate Order
POSTVerify payment customer.
POSTVerify order confirmation and charge
GETVerify credit availability and status
POSTOnboard customer for payment
GETOutstanding orders.
GETGet payment aggregators
POSTStart payment process.
POSTUpdate payment status
GETGet payment modes
GETPOS payment modes
POSTInitiate linking of wallet
POSTOTP verification
POSTDelink the wallet
GETGet payment outages data
POSTRender HTML.
POSTValidate VPA.
GETCredit summary.
GETRedirects users to the payment aggregator's interface
GETGet payment modes (V2)
POSTResend or cancel a pending payment transaction
GETFetch payment link.
POSTCreate payment link.
GETGet payment link
POSTResend payment link
GETPayment link modes.
GETPoll payment link.
POSTOrder via link.
POSTInitialise link payment.
POSTPerforms continuous polling to check status of payment on the server
POSTAdd beneficiary for refund
PATCHDelete saved beneficiary details of customers
POSTVerify OTP for bank.
POSTSave bank details for cancelled/returned order
GETLists the beneficiary of a refund
POSTVerify OTP for wallet.
POSTSet default beneficiary for refund
POSTSave refund source against shipment and order
GETget the selected refund options for shipment id
GETGet refund transfer modes
PUTToggle refund mode
GETGet specific offer
POSTOrder from catalogue
POSTOrder discount
GETPoints history
GETCurrent points
GETReferral details
POSTRedeem code
GETLists all products.
GETBrowse products belonging to a collection.
GETVisual image-based product search.
GETRetrieves search result listings.
POSTApp QR code.
POSTProduct QR code.
POSTCollection QR code.
POSTURL to QR code.
POSTShorten URL.
GETFetch short link.
GETOriginal URL.
GETGet size chart by query
GETGet tags by option codes
GETGet tags V2 with service and tenant support
GETGet applied theme
GETGet theme for preview
GETCurrent theme.
GETPreview theme.
GETFetch all pages.
GETGet theme page
GETGet Logged in User
GETGet List OF Active Sessions
GETGet Platform Configuration
GETCheck User Existence
POSTVerify OTP and Delete User
GETLogout Current User
GETGet User Groups for a user
GETGet user attributes
PATCHUpdate user attributes
POSTReset Password via Email
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
POSTCancel Pending Mobile Number Update
POSTLogin with Mobile OTP
POSTEmail and Password Login
POSTLogin with Token
POSTRefresh JWT access 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
POSTTruecaller Callback (Web Only)
POSTVerify Truecaller Authentication (Web Only)
POSTLogin with Truecaller (Mobile)
POSTCapture and save click events from various sales channels

Audience

Application audience APIs for user groups and attributes.

UserAttribute

User attribute operations.

Operations
GET
/service/application/audience/v1.0/user/attributes
# Get user attributes
PATCH
/service/application/audience/v1.0/user/attributes
# Update user attributes
GET

Get user attributes

FDK Method Name: getUserAttributes
Retrieve user attributes for the current user.
Parameters
slug
string
Filter by attribute slug.
Response
200
User attributes
UserAttributesDetail
attributes
object
Examples
Parameters
Parameters are not required.
GET
/service/application/audience/v1.0/user/attributes
Loading...
Response
Loading...
PATCH

Update user attributes

FDK Method Name: updateUserAttributes
Update one or more user attributes for the current user.
Parameters
No Parameters
Request body
attributes
object
Response
200
400
Updated attributes
UserAttributesDetail
attributes
object
Examples
Parameters
body:
body
PATCH
/service/application/audience/v1.0/user/attributes
Loading...
Response
Loading...

UserGroup

User group operations.

Operations
GET
/service/application/audience/v1.0/groups
# Get user groups
GET
/service/application/audience/v1.0/groups/categories
# Get group categories
GET

Get user groups

FDK Method Name: getUserGroupsForUser
Retrieve the groups and categories available to the current user.
Parameters
No Parameters
Response
200
User groups
UserGroupsDetail
user_groups
object (UserGroups)
UserGroups
l1
array of integer
l2
array of integer
l3
array of integer
Examples
Parameters
Parameters are not required.
GET
/service/application/audience/v1.0/groups
Loading...
Response
Loading...
GET

Get group categories

FDK Method Name: getUserGroupCategories
Retrieve the available group categories for the current application.
Parameters
No Parameters
Response
200
Categories
UserGroupCategoriesDetail
categories
array of object (UserGroupCategory)
Array of UserGroupCategory
name
string
key
string
Enum
description
string
Examples
Parameters
Parameters are not required.
GET
/service/application/audience/v1.0/groups/categories
Loading...
Response
Loading...
Previous
« Change Log
Next
Retrieve cart details. »