Configuration
The Configuration service handles settings for currency, sales channels, application stores, languages, staff users, brands, build configurations, and more, offering comprehensive customization options for the platform.
Sellers can allow customers to pay in their local currency on the storefront sales channel. When a customer selects a currency, all prices on the storefront and checkout are automatically converted to that currency. Sellers can enable the currencies that they want to offer to customers from sales channel settings. You can use this resource to get the list of all currencies available in the sales channel along with the configuration associated with the sales channel.
Operations
GET
# List currencies
GET
# Get a currency
GET
# Get currency configuration
Parameters
No Parameters
Response
200
Success. Check the example shown below or refer `CurrenciesResponse` for more details.
CurrenciesResponseSchema
items
array of object (Currency)
A list of currency objects. Each object represents a different currency.
Array of Currency
_id
string
The unique identifier (24-digit Mongo Object ID) of the current sales channel supported currency.
is_active
boolean
Shows currency is enabled or not in current sales channel.
name
string
Name of the currency, e.g Indian Rupee.
code
string
3-character currency code, e.g. INR, USD, EUR.
created_at
string
| date-time
ISO 8601 timestamp of sales channel support currency creation.
modified_at
string
| date-time
ISO 8601 timestamp of sales channel support currency updation.
decimal_digits
integer
| int32
Acceptable decimal limits for a given currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid value of a currency.
symbol
string
Unique symbol for identifying the currency, e.g. ₹.
country_name
string
Country name.
country_code
string
Country code.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Parameters
id
string
Required
ID assigned to the currency.
Response
200
Success. Check the example shown below or refer `Currency` for more details.
Currency
_id
string
The unique identifier (24-digit Mongo Object ID) of the current sales channel supported currency.
is_active
boolean
Shows currency is enabled or not in current sales channel.
name
string
Name of the currency, e.g Indian Rupee.
code
string
3-character currency code, e.g. INR, USD, EUR.
created_at
string
| date-time
ISO 8601 timestamp of sales channel support currency creation.
modified_at
string
| date-time
ISO 8601 timestamp of sales channel support currency updation.
decimal_digits
integer
| int32
Acceptable decimal limits for a given currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid value of a currency.
symbol
string
Unique symbol for identifying the currency, e.g. ₹.
country_name
string
Country name.
country_code
string
Country code.
Examples
Parameters
id:
"5bc8a62e21d33c25ebbfd6d3"
Was this section helpful?
GET
Response
Parameters
No Parameters
Response
200
Success. Check the example shown below or refer `AppCurrencyResponse` for more details.
AppCurrencyResponseSchema
application
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
default_currency
object (DefaultCurrency)
DefaultCurrency
ref
string
The unique identifier (24-digit Mongo Object ID) of the default currency.
code
string
3-character code of the default currency, e.g. INR, EUR, USD.
supported_currency
array of object (Currency)
A list of currencies supported by the application.
Array of Currency
_id
string
The unique identifier (24-digit Mongo Object ID) of the current sales channel supported currency.
is_active
boolean
Shows currency is enabled or not in current sales channel.
name
string
Name of the currency, e.g Indian Rupee.
code
string
3-character currency code, e.g. INR, USD, EUR.
created_at
string
| date-time
ISO 8601 timestamp of sales channel support currency creation.
modified_at
string
| date-time
ISO 8601 timestamp of sales channel support currency updation.
decimal_digits
integer
| int32
Acceptable decimal limits for a given currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid value of a currency.
symbol
string
Unique symbol for identifying the currency, e.g. ₹.
country_name
string
Country name.
country_code
string
Country code.
_id
string
The unique identifier of the application.
created_at
string
| date-time
ISO 8601 timestamp of when the application was created.
modified_at
string
| date-time
ISO 8601 timestamp of when the application was last modified.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
The platform supports multiple languages to display products, checkout and other information on the storefront website. Multi-language support helps reach a larger audience and improve conversion rates. Use this resource to get all languages which are available in the application.
Operations
GET
# List languages
Parameters
No Parameters
Response
200
Success. Check the example shown below or refer `LanguageResponse` for more details.
LanguageResponseSchema
items
array of object (SupportedLanguage)
List of supported languages.
Array of SupportedLanguage
name
string
Name of the supported language, e.g. हिन्दी.
code
string
Unique code of supported language, e.g. hi-IN.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
A sales channel, also known as application, enables the seller to list and sell their products. Different types of sales channels are available namely - 1. Storefront websites - create your own custom storefront website with a free or your own domain. 2. Marketplaces integrations - upload product catalog on platform and sync it to external marketplaces like Myntra, Amazaon, Fynd, etc. You can use this resource to retrieve details of the current sales channel. To identify an application, we use the id as the application identifier and the associated token in the header, and then return the corresponding application details.
Operations
GET
# Get sales channel
GET
# Get sales channel owner
GET
# Get Sales channel
GET
# Get API tokens
GET
# Get sales channel features
GET
# Get sales channel contact
Parameters
No Parameters
Response
200
404
Success. Check the example shown below or refer `Application` for more details.
Application
website
object (ApplicationWebsite)
ApplicationWebsite
enabled
boolean
Shows whether sales channel website URL is enabled or not.
basepath
string
Base path for the current sales channel website.
cors
object (ApplicationCors)
ApplicationCors
domains
array of string
List of domains added to the sales channel.
auth
object (ApplicationAuth)
ApplicationAuth
enabled
boolean
Shows sales channel auth is enabled or not enabled.
description
string
It contains detailed information about the sales channel.
channel_type
string
It indicates different channel types like store, website-and-mobile-apps. Default value is store.
cache_ttl
integer
| int32
An integer value that specifies the number of seconds until the key expires.
is_internal
boolean
Indicates whether a sales channel is internal or not.
is_active
boolean
Indicates sales channel is active or not active.
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel.
name
string
Name of the sales channel, e.g. Zenz Fashion.
owner
string
The unique identifier (24-digit Mongo Object ID) of owner who owns the application.
company_id
integer
| int32
Numeric ID allotted to a business account where the sales channel exists.
token
string
Random generated fix length string for sales channel. It is required and auto-generated.
redirections
array of object (ApplicationRedirections)
List of redirections for the sales channel.
Array of ApplicationRedirections
redirect_from
string
Old domain url of the sales channel.
redirect_to
string
New domain URL of the sales channel. Users will be automatically redirected from old domain to new domain.
type
string
It shows domain redirection type. Permanent redirection is for long time period redirection, and temporary redirection for a short time period.
Enum
meta
array of object (ApplicationMeta)
List of meta information for the sales channel.
Array of ApplicationMeta
name
string
Indicates to name of application meta.
value
string
Value related to application meta name.
created_at
string
| date-time
ISO 8601 timestamp of sales channel creation.
modified_at
string
| date-time
ISO 8601 timestamp of sales channel updation.
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
banner
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image.
logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image.
favicon
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image.
domains
array of object (Domain)
List of domains associated with the sales channel.
Array of Domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain.
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain.
name
string
Domain name.
is_predefined
boolean
Domain is hosting domain or not.
app_type
string
It shows application is live or in development mode.
Enum
mobile_logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image.
domain
object (Domain)
Domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain.
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain.
name
string
Domain name.
is_predefined
boolean
Domain is hosting domain or not.
slug
string
Slug identifier.
mode
string
Application mode.
status
string
Current status of the application.
tokens
array of object (TokenSchema)
List of tokens associated with the sales channel.
Array of TokenSchema
token
string
Token string.
created_by
object
User details.
created_at
string
| date-time
ISO 8601 timestamp of when token created.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Parameters
No Parameters
Response
200
Success. Check the example shown below or refer `ApplicationAboutResponse` for more details.
ApplicationAboutResponseSchema
application_info
object (ApplicationInfo)
ApplicationInfo
company_info
object (CompanyInfo)
CompanyInfo
_id
string
The unique identifier (24-digit Mongo Object ID) of company information.
uid
integer
| int32
Unique identifier for the company.
created_on
string
| date-time
ISO 8601 timestamp of company information creation.
is_active
boolean
Indicates company is active or not active.
name
string
Name of the company, Reliance Retail Limited.
addresses
array of object (CompanyAboutAddress)
List of addresses associated with the company.
Array of CompanyAboutAddress
pincode
integer
| int32
6-digit PIN code of the city, e.g. 400001.
address1
string
Primary address line of the company.
address2
string
Secondary address line of the company.
city
string
City name, e.g. Mumbai.
state
string
State name, e.g. Maharashtra.
country
string
Country name, e.g. India.
address_type
string
Indicates different office types like office, registered, and home.
Enum
notification_emails
array of string
List of emails to notify.
owner_info
object (OwnerInfo)
OwnerInfo
_id
string
The unique identifier (24-digit Mongo Object ID) of owner info.
emails
array of object (UserEmail)
List of email addresses of the owner.
Array of UserEmail
active
boolean
Current email is active or not active.
primary
boolean
Indicates current email id primary email or not primary email of user.
verified
boolean
Indicates current email is verified email or not verified email.
email
string
Email address of the user.
phone_numbers
array of object (UserPhoneNumber)
List of phone numbers of the owner.
Array of UserPhoneNumber
active
boolean
Current phone number is active or not active.
primary
boolean
Indicates current phone number is primary or not for a user.
verified
boolean
Indicates current phone number is verified or not verified.
country_code
integer
| int32
Country code, e.g. +91.
phone
string
Phone number of the user.
first_name
string
First name of the owner.
last_name
string
Last name of the owner.
profile_pic
string
Hosted URL of profile pic.
_id
string
The unique identifier (24-digit Mongo Object ID) of application information.
domain
object (Domain)
Domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain.
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain.
name
string
Domain name.
is_predefined
boolean
Domain is hosting domain or not.
website
object (ApplicationWebsite)
ApplicationWebsite
enabled
boolean
Shows whether sales channel website URL is enabled or not.
basepath
string
Base path for the current sales channel website.
cors
object (ApplicationCors)
ApplicationCors
domains
array of string
List of domains added to the sales channel.
description
string
It contains details information about the sales channel.
name
string
Name of the sales channel, e.g. Zenz Fashion.
meta
array of object (ApplicationMeta)
Metadata related to the application.
Array of ApplicationMeta
name
string
Indicates to name of application meta.
value
string
Value related to application meta name.
token
string
Random generated fix length string for sales channel. It is required and auto-generated.
secret
string
Random generated fix length string for sales channel. It is required and auto-generated.
created_at
string
| date-time
ISO 8601 timestamp of sales channel information creation.
banner
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image.
logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image.
is_active
boolean
Indicates whether sales channel is active or not active.
mode
string
Mode of the application.
tokens
array of object (TokenSchema)
List of tokens associated with the application.
Array of TokenSchema
token
string
Token string.
created_by
object
User details.
created_at
string
| date-time
ISO 8601 timestamp of when token created.
domains
array of object (Domain)
List of domains associated with the application.
Array of Domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain.
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain.
name
string
Domain name.
is_predefined
boolean
Domain is hosting domain or not.
favicon
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image.
mobile_logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image.
slug
string
Slug identifier for the application.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Parameters
No Parameters
Response
200
Success. Check the example shown below or refer `ApplicationDetail` for more details.
ApplicationDetail
name
string
Name of the sales channel. It is required.
description
string
It gives a detailed information about the sales channel. It is required.
logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image.
mobile_logo
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image.
favicon
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image.
banner
object (SecureUrl)
SecureUrl
secure_url
string
Hosted URL of the image.
domain
object (Domain)
Domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain.
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain.
name
string
Domain name.
is_predefined
boolean
Domain is hosting domain or not.
domains
array of object (Domain)
List of domains associated with the sales channel.
Array of Domain
verified
boolean
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Shortlink is present or not for the domain.
_id
string
The unique identifier (24-digit Mongo Object ID) of the sales channel domain.
name
string
Domain name.
is_predefined
boolean
Domain is hosting domain or not.
_id
string
The unique identifier (24-digit Mongo Object ID) for the sales channel details.
slug
string
URL-friendly version of the sales channel name.
company_id
integer
Numeric ID allotted to the business account where the sales channel is mapped.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook.
Parameters
No Parameters
Response
200
Success. Check the example shown below or refer `AppTokenResponse` for more details.
AppTokenResponseSchema
tokens
object (Tokens)
Tokens
firebase
object (Firebase)
Firebase
credentials
object (Credentials)
Credentials
ios
object (Ios)
Ios
application_id
string
| base64
Alphanumeric ID allotted to a sales channel application created within a business account.
api_key
string
| base64
Firebase secret credential API key for IOS.
android
object (Android)
Android
application_id
string
| base64
Alphanumeric ID allotted to a sales channel application created within a business account.
api_key
string
| base64
Firebase secret credential API key for Android.
project_id
string
| base64
Project ID for Firebase integration. Project ID is a unique identifier for a project and is used only within the console.
gcm_sender_id
string
| base64
Google Cloud Manager's Sender ID for Firebase. It is a unique numerical value which is created when you configure your project in the Google Developers Console/Google Cloud Console.
application_id
string
| base64
Alphanumeric ID allotted to the current application created within the current business account.
api_key
string
| base64
An API key is a unique string that's used to route requests to your Firebase project when interacting with Firebase.
enabled
boolean
Shows whether Firebase integration is enabled or disabled for the sales channel.
moengage
object (Moengage)
Moengage
credentials
object (MoengageCredentials)
MoengageCredentials
app_id
string
| base64
APP ID provided by MoEngage to identify a specific app. The app_id for your MoEngage account is available on the MoEngage Dashboard.
enabled
boolean
Shows whether MoEngage integration is enabled or disabled for the sales channel.
segment
object (Segment)
Segment
credentials
object (SegmentCredentials)
SegmentCredentials
write_key
string
| base64
The unique identifier for a source that tells Segment from which source data is coming from, to which workspace the data belongs, and which destinations should receive the data.
enabled
boolean
Shows whether Segment integration is enabled or disabled for the sales channel.
gtm
object (Gtm)
Gtm
credentials
object (GtmCredentials)
GtmCredentials
api_key
string
| base64
Secret credential API key for GTM.
enabled
boolean
Shows whether GTM integration is enabled or disabled for the sales channel.
freshchat
object (Freshchat)
Freshchat
credentials
object (FreshchatCredentials)
FreshchatCredentials
app_id
string
| base64
The unique app_id of your Freshchat account for integrating Freshchat with your sales channel.
app_key
string
| base64
The unique app_key of your Freshchat account for integrating Freshchat with your sales channel.
web_token
string
| base64
Web token used for accessing the Freshchat APIs.
enabled
boolean
Shows whether Freshchat integration is enabled or disabled for the sales channel.
safetynet
object (Safetynet)
Safetynet
credentials
object (SafetynetCredentials)
SafetynetCredentials
api_key
string
| base64
Secret credential API key for Safetynet. This API key is used for calling the methods of Safetynet APIs.
enabled
boolean
Shows whether Safetynet integration is enabled or disabled for the sales channel.
fynd_rewards
object (FyndRewards)
FyndRewards
credentials
object (FyndRewardsCredentials)
FyndRewardsCredentials
public_key
string
| base64
Public key for integrating with Fynd rewards.
google_map
object (GoogleMap)
GoogleMap
enabled
boolean
Shows whether Google map integration is enabled or not.
credentials
object (GoogleMapCredentials)
GoogleMapCredentials
api_key
string
| base64
Secret API key for Google Maps. A unique identifier that authenticates requests made to Google Maps API.
_id
string
The unique identifier (24-digit Mongo Object ID) of the token.
application
string
Alphanumeric ID allotted to the current application created within the current business account.
created_at
string
| date-time
ISO 8601 timestamp of token creation.
modified_at
string
| date-time
ISO 8601 timestamp of token updation.
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Parameters
No Parameters
Response
200
404
Success. Check the example shown below or refer `AppFeatureResponse` for more details.
AppFeatureResponseSchema
feature
object (AppFeature)
AppFeature
product_detail
object (ProductDetailFeature)
ProductDetailFeature
similar
array of string
Configuration to show similar products, other products from same seller, other products in same category, other products in same price range, etc.
Enum
seller_selection
boolean
Shows whether the customers can choose the seller on PDP.
Default Value : true
update_product_meta
boolean
Allow user to update product meta. Default value is true.
Default Value : true
request_product
boolean
Indicates whether customers can request for a product. Default value is false.
Default Value : false
landing_page
object (LandingPageFeature)
LandingPageFeature
launch_page
object (LaunchPage)
LaunchPage
page_type
string
Type of the launch page.
params
object
| nullable
Launch page params. It can be nullable.
query
object
| nullable
Query related to launch page. It can be nullable.
continue_as_guest
boolean
Shows whether a guest can checkout from cart without logging in.
login_btn_text
string
Shows the text displayed over the login button.
show_domain_textbox
boolean
Shows whether a textbox for entering domain is available.
show_register_btn
boolean
Shows whether register button is available in the login/landing page.
registration_page
object (RegistrationPageFeature)
RegistrationPageFeature
ask_store_address
boolean
Shows whether a form to collect the address of the store, should be displayed upon visiting the website.
home_page
object (HomePageFeature)
HomePageFeature
order_processing
boolean
Shows whether order processing is enabled or not enabled.
common
object (CommonFeature)
CommonFeature
communication_optin_dialog
object (CommunicationOptinDialogFeature)
CommunicationOptinDialogFeature
visibility
boolean
Shows whether WhatsApp communication is enabled.
deployment_store_selection
object (DeploymentStoreSelectionFeature)
DeploymentStoreSelectionFeature
enabled
boolean
Shows whether selection of store (for deploying the application) is permitted.
type
string
Permitted values are 'hard' and 'soft'. For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
listing_price
object (ListingPriceFeature)
ListingPriceFeature
value
string
Shows which price to display on PLP if one product has multiple prices (for each size), valid values are 'min', 'max', 'range'. Default value is range.
sort
string
Sorting of listing price with min or max value. Default value is min.
currency
object (CurrencyFeature)
CurrencyFeature
value
array of string
3-letter currency code.
type
string
If 'explicit', currency formatting shows currency code with price. For explicit or all currency selection.
default_currency
string
3-letter code of the default currency used in the application. Default value is 'INR'.
revenue_engine
object (RevenueEngineFeature)
RevenueEngineFeature
enabled
boolean
Enable revenue engine. Default value is false.
feedback
object (FeedbackFeature)
FeedbackFeature
enabled
boolean
Whether customer feedback is enabled on PDP. Default value is false.
compare_products
object (CompareProductsFeature)
CompareProductsFeature
enabled
boolean
Whether product comparison feature is enabled on PDP.
reward_points
object (RewardPointsConfig)
RewardPointsConfig
credit
object (Credit)
Credit
enabled
boolean
Shows whether reward points should be credited.
debit
object (Debit)
Debit
enabled
boolean
Shows whether reward points are available for debit.
auto_apply
boolean
Allow automatic debit of reward points.
strategy_channel
string
Strategy channel for debiting reward points.
listing_page
object (ListingPageFeature)
ListingPageFeature
sort_on
string
Determines the sorting criteria for product listings on the page.
Default Value : popular
Enum
international_shipping
object (InternationalShipping)
InternationalShipping
enabled
boolean
International shipping is enabled or not.
cart
object (CartFeature)
CartFeature
gst_input
boolean
Whether customer is allowed to enter GST on the cart page for claiming input credits.
staff_selection
boolean
Whether staff selection is enabled on cart page.
placing_for_customer
boolean
Whether the staff is placing order on behalf of customer. Default value is true.
google_map
boolean
Allow adding of Google Maps. Default value is true.
revenue_engine_coupon
boolean
Allow coupon apply and credits, together. Default value is false.
qr
object (QrFeature)
QrFeature
application
boolean
Whether sharing of mobile app via QR code is allowed. Default value is false.
products
boolean
Whether sharing product via QR code is allowed. Default value is false.
collections
boolean
Whether sharing collection via QR code is allowed. Default value is false.
pcr
object (PcrFeature)
PcrFeature
staff_selection
boolean
Allow staff selection. Default value is false.
order
object (OrderFeature)
OrderFeature
buy_again
boolean
Allow buy again option for order. Default value is false.
_id
string
The unique identifier (24-digit Mongo Object ID) for the sales channel features.
app
string
Application ID of the sales channel.
created_at
string
| date-time
ISO 8601 timestamp showing the date when the features were configured.
modified_at
string
| date-time
ISO 8601 timestamp of last known modifications to the sales channel feature configuration.
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Parameters
No Parameters
Response
200
Success. Check the example shown below or refer `ApplicationAboutResponse` for more details.
ApplicationInformation
address
object (InformationAddress)
InformationAddress
loc
object (InformationLoc)
InformationLoc
type
string
Country code for contact number, e.g. +91 (for India).
coordinates
array of integer
10-digit mobile number.
address_line
array of string
Contact address of the sales channel.
phone
array of object (InformationPhone)
Phone numbers with country codes.
Array of InformationPhone
code
string
Country code for contact number, e.g. +91 (for India).
number
string
10-digit mobile number.
city
string
Name of the city, e.g. Mumbai.
country
string
Name of the country, e.g. India.
pincode
integer
| int32
6-digit PIN Code of the city, e.g. 400001.
support
object (InformationSupport)
InformationSupport
phone
array of object (InformationSupportPhone)
An array of phone contact details, including country code and number.
Array of InformationSupportPhone
code
string
Country code for contact number, e.g. +91 (for India).
number
string
10-digit mobile number.
key
string
Additional identifier or key for the contact number.
email
array of object (InformationSupportEmail)
An array of email contact details.
Array of InformationSupportEmail
value
string
Value of email.
key
string
Additional identifier or key for the email address.
timing
string
Working hours of support team, e.g. 9 AM to 9 PM.
social_links
object (SocialLinks)
SocialLinks
facebook
object (FacebookLink)
FacebookLink
title
string
Name of the social media platform, e.g. Facebook.
icon
string
Hosted URL of social icon image shown on the website.
link
string
Web URL of brand's Facebook page.
instagram
object (InstagramLink)
InstagramLink
title
string
Name of the social media platform, e.g. Instagram.
icon
string
Hosted URL of social icon image shown on the website.
link
string
Web URL of brand's Instagram page.
twitter
object (TwitterLink)
TwitterLink
title
string
Name of the social media platform, e.g. Twitter.
icon
string
Hosted URL of social icon image shown on the website.
link
string
Web URL of brand's Twitter account.
pinterest
object (PinterestLink)
PinterestLink
title
string
Name of the social media platform, e.g. Pinterest.
icon
string
Hosted URL of social icon image shown on the website.
link
string
Web URL of brand's Pinterest page.
google_plus
object (GooglePlusLink)
GooglePlusLink
title
string
Name of the social media platform, e.g. Google+.
icon
string
Hosted URL of social icon image shown on the website.
link
string
Web URL of brand's Google+ account.
youtube
object (YoutubeLink)
YoutubeLink
title
string
Name of the social media platform, e.g. YouTube.
icon
string
Hosted URL of social icon image shown on the website.
link
string
Web URL of brand's YouTube channel.
linked_in
object (LinkedInLink)
LinkedInLink
title
string
Name of the social media platform, e.g. LinkedIn.
icon
string
Hosted URL of social icon image shown on the website.
link
string
Web URL of brand's LinkedIn channel.
vimeo
object (VimeoLink)
VimeoLink
title
string
Name of the video hosting platform, e.g. Vimeo.
icon
string
Hosted URL of social icon image shown on the website.
link
string
Web URL of brand's Vimeo channel.
blog_link
object (BlogLink)
BlogLink
title
string
Name of the brand's blog page.
icon
string
Hosted URL of icon image shown on the website.
link
string
Web URL of brand's blog page.
links
array of object (Links)
Array of additional relevant web links related to the application.
Array of Links
title
string
Name of the related page or link.
link
string
Web URL for redirecting to a related page.
copyright_text
string
Copyright statement usually seen at the site's footer.
_id
string
Unique identifier (24-digit Mongo Object ID) of the application information.
business_highlights
array of object (BusinessHighlights)
Array of notable business highlights with icons and descriptions.
Array of BusinessHighlights
_id
string
Unique identifier (24-digit Mongo Object ID) of the related business.
title
string
Title of the business highlight, e.g. Superfast Delivery.
icon
string
Hosted URL of icon image representing the business highlight.
sub_title
string
Detailed information about the highlight.
application
string
Alphanumeric ID allotted to a sales channel application created within a business account.
created_at
string
| date-time
ISO 8601 timestamp of creation of the application information.
modified_at
string
| date-time
ISO 8601 timestamp of updation of the application information.
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
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
# List order-enabled selling locations
GET
# Get a selling location
POST
# Create cookies
DEL
# Delete store cookie
Get details of all the deployment store locations where the sales channel will be used for order placement.
Parameters
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
page_size
integer
The number of items to retrieve in each page. Default value is 10.
q
string
Store code or name of the ordering store.
Response
200
404
Success. Check the example shown below or refer `OrderingStores` for more details.
OrderingStores
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
items
array of object (OrderingStore)
List of ordering stores.
Array of OrderingStore
address
object (OptedStoreAddress)
OptedStoreAddress
state
string
State of the opted store, e.g. Maharashtra.
address1
string
Address of the opted store.
lat_long
object (StoreLatLong)
StoreLatLong
type
string
Coordinates type of the opted store.
coordinates
array of number
Latitude and Longitude coordinates of the store.
address2
string
Address of the opted store.
pincode
integer
| int32
6-digit PIN code of the opted store location.
country
string
Country of the opted store, e.g. India.
city
string
City of the opted store, e.g. Mumbai.
_id
string
The unique identifier (24-digit Mongo Object ID) of the ordering store.
uid
integer
| int32
Ordering store UID.
name
string
Store name of the ordering store.
display_name
string
Display name of the ordering store.
store_type
string
Store type of the ordering store, e.g. high_street, mall, warehouse.
store_code
string
Store code of the ordering store, e.g. MUM-102.
pincode
integer
| int32
6-digit PIN Code of the ordering store, e.g. 400001.
code
string
Code of the ordering store (usually same as Store Code).
deployed_stores
array of integer
List of all deployed stores.
all_stores
boolean
Allow all stores of the ordering stores.
enabled
boolean
Allow ordering stores for current sales channel.
type
string
For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
Enum
_id
string
The unique identifier (24-digit Mongo Object ID) of the ordering store.
app
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
__v
integer
| int32
Version key for tracking ordering stores. Default value is zero.
Examples
Parameters
q:
"MRVLB01"
Was this section helpful?
GET
Response
Parameters
store_id
integer
Required
Unique identifier for a store.
Response
200
404
Success. Check the example shown below or refer `OrderingStore` for more details.
OrderingStore
address
object (OptedStoreAddress)
OptedStoreAddress
state
string
State of the opted store, e.g. Maharashtra.
address1
string
Address of the opted store.
lat_long
object (StoreLatLong)
StoreLatLong
type
string
Coordinates type of the opted store.
coordinates
array of number
Latitude and Longitude coordinates of the store.
address2
string
Address of the opted store.
pincode
integer
| int32
6-digit PIN code of the opted store location.
country
string
Country of the opted store, e.g. India.
city
string
City of the opted store, e.g. Mumbai.
_id
string
The unique identifier (24-digit Mongo Object ID) of the ordering store.
uid
integer
| int32
Ordering store UID.
name
string
Store name of the ordering store.
display_name
string
Display name of the ordering store.
store_type
string
Store type of the ordering store, e.g. high_street, mall, warehouse.
store_code
string
Store code of the ordering store, e.g. MUM-102.
pincode
integer
| int32
6-digit PIN Code of the ordering store, e.g. 400001.
code
string
Code of the ordering store (usually same as Store Code).
Examples
Parameters
store_id:
1
Was this section helpful?
GET
Response
Parameters
No Parameters
Request body
ordering_store
object (OrderingStoreSelect)
Required
OrderingStoreSelect
uid
integer
| int32
Required
Ordering store unique uid. It is required.
Response
200
400
Success
SuccessMessageResponseSchema
message
string
Success message shown to the user (in a string format).
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Parameters
No Parameters
Response
200
Success
SuccessMessageResponseSchema
message
string
Success message shown to the user (in a string format).
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Response
Staff User has access to inventory management across all stores within a company. Staff users can view and manage inventory levels for products across different locations.Staff Users can place orders on behalf of customers. that will be delivered to customer address. In scenarios where a customer selects a specific size or shape of a product that is not available in the store they are visiting but is part of the inventory in another store, staff users can place order on behalf of customer that will be fulfilled by other store.
Operations
GET
# List staff members
GET
# Get staff member
Parameters
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
page_size
integer
The number of items to retrieve in each page.
order_incent
boolean
Select `true` to retrieve the staff members eligible for getting incentives on orders.
ordering_store
integer
ID of the ordering store. Helps in retrieving staff members working at a particular ordering store.
user
string
ID of the staff. Helps in retrieving the details of a particular staff member.
user_name
string
Username of the member.
Response
200
400
Success. Check the example shown below or refer `AppStaffListResponse` for more details.
AppStaffListResponseSchema
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
items
array of object (AppStaff)
List of staff users.
Array of AppStaff
_id
string
The unique identifier for the sales channel staff member.
order_incent
boolean
This is a boolean value. `true` to retrieve the staff members eligible for getting incentives on orders.
stores
array of integer
List of IDs of the ordering stores where the staff member works.
application
string
The unique identifier (24-digit Mongo Object ID) of the current sales channel.
title
string
Title for the staff member like owner, staff.
user
string
Mongo ID of the staff. Helps in retrieving the details of a particular staff member.
employee_code
string
Employee code of sales channel staff member. It has unique value.
first_name
string
First name the staff member.
last_name
string
Last name the staff member.
profile_pic_url
string
Profile image hosted url of the staff member.
Examples
Parameters
ordering_store:
1
user:
"000000000000000016841367"
user_name:
"Fynd"
Was this section helpful?
GET
Response
Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel.
Parameters
order_incent
boolean
Select `true` to retrieve the staff members eligible for getting incentives on orders.
ordering_store
integer
ID of the ordering store. Helps in retrieving staff members working at a particular ordering store.
user
string
ID of the staff. Helps in retrieving the details of a particular staff member.
Response
200
400
Success. Check the example shown below or refer `AppStaffResponse` for more details.
AppStaffResponseSchema
staff_users
array of object (AppStaff)
List of staff users.
Array of AppStaff
_id
string
The unique identifier for the sales channel staff member.
order_incent
boolean
This is a boolean value. `true` to retrieve the staff members eligible for getting incentives on orders.
stores
array of integer
List of IDs of the ordering stores where the staff member works.
application
string
The unique identifier (24-digit Mongo Object ID) of the current sales channel.
title
string
Title for the staff member like owner, staff.
user
string
Mongo ID of the staff. Helps in retrieving the details of a particular staff member.
employee_code
string
Employee code of sales channel staff member. It has unique value.
first_name
string
First name the staff member.
last_name
string
Last name the staff member.
profile_pic_url
string
Profile image hosted url of the staff member.
Examples
Parameters
ordering_store:
1
user:
"000000000000000016841367"
Was this section helpful?
GET
Response