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.
Currency
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
GET
List currencies
List available currencies.
Parameters
No Parameters
Response
200
Success. Check the example shown below or refer `CurrenciesResponse` for more details.
CurrenciesResponse
items
array of object (Currency)
A list of currency objects. Each object represents a different currency.
Array of Currency
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List currencies
getCurrencies
GET
Get a currency
Get details of the currency.
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
ISO 8601 timestamp of sales channel support currency creation.
modified_at
string
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
Loading...
Response
Loading...
Get a currency
getCurrencyById
GET
Get currency configuration
Get currency configuration of the sales channel.
Parameters
No Parameters
Response
200
Success. Check the example shown below or refer `AppCurrencyResponse` for more details.
AppCurrencyResponse
application
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
default_currency
object (DefaultCurrency)
DefaultCurrency
supported_currency
array of object (Currency)
A list of currencies supported by the application.
Array of Currency
_id
string
The unique identifier of the application.
created_at
string
ISO 8601 timestamp of when the application was created.
modified_at
string
ISO 8601 timestamp of when the application was last modified.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get currency configuration
getAppCurrencies
Language
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
GET
List languages
List available languages.
Parameters
No Parameters
Response
200
Success. Check the example shown below or refer `LanguageResponse` for more details.
LanguageResponse
items
array of object (SupportedLanguage)
List of supported languages.
Array of SupportedLanguage
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List languages
getLanguages
Sales Channel
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
GET
Get sales channel
Get details of the current sales channel.
Parameters
No Parameters
Response
200
404
Success. Check the example shown below or refer `Application` for more details.
Application
website
object (ApplicationWebsite)
ApplicationWebsite
cors
object (ApplicationCors)
ApplicationCors
auth
object (ApplicationAuth)
ApplicationAuth
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
meta
array of object (ApplicationMeta)
List of meta information for the sales channel.
Array of ApplicationMeta
created_at
string
ISO 8601 timestamp of sales channel creation.
modified_at
string
ISO 8601 timestamp of sales channel updation.
__v
integer
| int32
Version key for tracking revisions. Default value is zero.
banner
object (SecureUrl)
SecureUrl
logo
object (SecureUrl)
SecureUrl
favicon
object (SecureUrl)
SecureUrl
domains
array of object (Domain)
List of domains associated with the sales channel.
Array of Domain
app_type
string
It shows application is live or in development mode.
Enum
mobile_logo
object (SecureUrl)
SecureUrl
domain
object (Domain)
Domain
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
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get sales channel
getApplication
GET
Get sales channel owner
Get details of the sales channel owner.
Parameters
No Parameters
Response
200
Success. Check the example shown below or refer `ApplicationAboutResponse` for more details.
ApplicationAboutResponse
application_info
object (ApplicationInfo)
ApplicationInfo
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get sales channel owner
getOwnerInfo
GET
Get Sales channel
Get basic details of the sales channel.
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
mobile_logo
object (SecureUrl)
SecureUrl
favicon
object (SecureUrl)
SecureUrl
banner
object (SecureUrl)
SecureUrl
domain
object (Domain)
Domain
domains
array of object (Domain)
List of domains associated with the sales channel.
Array of Domain
_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.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get Sales channel
getBasicDetails
GET
Get API tokens
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.
AppTokenResponse
tokens
object (Tokens)
Tokens
_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
ISO 8601 timestamp of token creation.
modified_at
string
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
Loading...
Response
Loading...
Get API tokens
getIntegrationTokens
GET
Get sales channel features
Get configuration of the features of the sales channel.
Parameters
No Parameters
Response
200
404
Success. Check the example shown below or refer `AppFeatureResponse` for more details.
AppFeatureResponse
feature
object (AppFeature)
AppFeature
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get sales channel features
getFeatures
GET
Get sales channel contact
Get contact details of the sales channel.
Parameters
No Parameters
Response
200
Success. Check the example shown below or refer `ApplicationAboutResponse` for more details.
ApplicationInformation
address
object (InformationAddress)
InformationAddress
support
object (InformationSupport)
InformationSupport
social_links
object (SocialLinks)
SocialLinks
links
array of object (Links)
Array of additional relevant web links related to the application.
Array of Links
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
application
string
Alphanumeric ID allotted to a sales channel application created within a business account.
created_at
string
ISO 8601 timestamp of creation of the application information.
modified_at
string
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
Loading...
Response
Loading...
Get sales channel contact
getContactInfo
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
# List order-enabled selling locations
GET
# Get a selling location
POST
# Create cookies
DEL
# Delete store cookie
GET
List order-enabled selling locations
Get details of all the deployment store locations where the sales channel will be used for order placement.
Parameters
pageNo
integer
The page number to navigate through the given set of results. Default value is 1.
pageSize
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
items
array of object (OrderingStore)
List of ordering stores.
Array of OrderingStore
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
Loading...
Response
Loading...
List order-enabled selling locations
getOrderingStores
GET
Get a selling location
Get details of a selling location (store) by its ID.
Parameters
storeId
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
_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
storeId:
1
Was this section helpful?
GET
Loading...
Response
Loading...
Get a selling location
getStoreDetailById
POST
Create cookies
Reset cookie of ordering store.
Parameters
body
object (OrderingStoreSelectRequest)
Required
Pass the UID of the ordering store in the request body as shown below.
OrderingStoreSelectRequest
ordering_store
object (OrderingStoreSelect)
Required
OrderingStoreSelect
Response
200
400
Success
SuccessMessageResponse
message
string
Success message shown to the user (in a string format).
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create cookies
getOrderingStoreCookie
DEL
Delete store cookie
Delete store cookie.
Parameters
No Parameters
Response
200
Success
SuccessMessageResponse
message
string
Success message shown to the user (in a string format).
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete store cookie
removeOrderingStoreCookie
Staff User
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
GET
List staff members
List all staff members of the sales channel.
Parameters
pageNo
integer
The page number to navigate through the given set of results. Default value is 1.
pageSize
integer
The number of items to retrieve in each page.
orderIncent
boolean
Select `true` to retrieve the staff members eligible for getting incentives on orders.
orderingStore
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.
userName
string
Username of the member.
Response
200
400
500
Success. Check the example shown below or refer `AppStaffListResponse` for more details.
AppStaffListResponse
page
object (Page)
Page
items
array of object (AppStaff)
List of staff users.
Array of AppStaff
Examples
Parameters
orderingStore:
1
user:
"000000000000000016841367"
userName:
"Fynd"
Was this section helpful?
GET
Loading...
Response
Loading...
List staff members
getAppStaffList
GET
Get staff member
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
orderIncent
boolean
Select `true` to retrieve the staff members eligible for getting incentives on orders.
orderingStore
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
500
Success. Check the example shown below or refer `AppStaffResponse` for more details.
AppStaffResponse
staff_users
array of object (AppStaff)
List of staff users.
Array of AppStaff
Examples
Parameters
orderingStore:
1
user:
"000000000000000016841367"
Was this section helpful?
GET
Loading...
Response
Loading...