Skip to main content

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.

API Tokens

The API Token focuses on the management and updating of API tokens for your sales channel. It ensures secure access to your sales channel services and data by offering functionalities to create, manage, and update API tokens.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/token
# Get sales channel API tokens
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/token
# Update sales channel API tokens
GET

Get sales channel API tokens

Retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth.
Parameters
No Parameters
Response
200
Success
TokenResponse
tokens
object (Tokens)
Optional
Tokens
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the token
application
string
Optional
Alphanumeric ID allotted to the current application created within the current business account
created_at
string
Optional
ISO 8601 timestamp of token creation
modified_at
string
Optional
ISO 8601 timestamp of token updation
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/token
Loading...
Response
Loading...
POST

Update sales channel API tokens

Add and edit the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google and Facebook auth.
Parameters
body
object (TokenResponse)
TokenResponse
tokens
object (Tokens)
Optional
Tokens
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the token
application
string
Optional
Alphanumeric ID allotted to the current application created within the current business account
created_at
string
Optional
ISO 8601 timestamp of token creation
modified_at
string
Optional
ISO 8601 timestamp of token updation
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero.
Response
200
400
Success
TokenResponse
tokens
object (Tokens)
Optional
Tokens
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the token
application
string
Optional
Alphanumeric ID allotted to the current application created within the current business account
created_at
string
Optional
ISO 8601 timestamp of token creation
modified_at
string
Optional
ISO 8601 timestamp of token updation
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero.
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/token
Loading...
Response
Loading...

Brands and Companies

The Brands and Companies serves as a central hub for managing company brands, which are essential for configuring inventory within the Sales channel. This resource enables operations such as retrieving brands associated with a company and accessing information about the company or stores linked to specific brands. Brands and Comapnies streamlines brand management processes, allowing businesses to effectively showcase their brand identities and maintain consistency across their products or services. Brands and companies has details about specific brands, including brand name, logo, description, and other relevant information, and make edits to ensure accuracy and currency.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/inventory/brands-by-companies
# List brands by company
POST
/service/platform/configuration/v1.0/company/{company_id}/inventory/companies-by-brands
# List companies by brand
POST
/service/platform/configuration/v1.0/company/{company_id}/inventory/stores-by-brands
# Get store by brands
GET

List brands by company

Retrieve all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image. can be searched on brand_name.
Parameters
q
string
Optional
Search text for brand name
Response
200
422
Success
BrandsByCompanyResponse
brands
array of object (CompanyBrandInfo)
Optional
Array of CompanyBrandInfo
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/inventory/brands-by-companies
Loading...
Response
Loading...
POST

List companies by brand

Retrieve a paginated list of companies associated with specific brands. Can be searched using the brand ID and company name
Parameters
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
body
object (CompanyByBrandsRequest)
CompanyByBrandsRequest
brands
integer
| int32
Brand UID
search_text
string
Optional
A search field for finding a company by its name
Response
200
Success
CompanyByBrandsResponse
items
array of object (BrandCompanyInfo)
Optional
Array of BrandCompanyInfo
page
object (Page)
Optional
Page
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/configuration/v1.0/company/{company_id}/inventory/companies-by-brands
Loading...
Response
Loading...
POST

Get store by brands

Retrieve stores associated with specific brands. Retrieve a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail. filtering can be done on brand id and brand names
Parameters
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
body
object (StoreByBrandsRequest)
StoreByBrandsRequest
company_id
integer
| int32
Optional
Current company ID for current company stores only. Don't send in case cross-selling (franchise) is enabled.
brands
integer
| int32
Brand UID
search_text
string
Optional
Search store by its name or store code
Response
200
Success
StoreByBrandsResponse
items
array of object (BrandStoreInfo)
Optional
Array of BrandStoreInfo
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/configuration/v1.0/company/{company_id}/inventory/stores-by-brands
Loading...
Response
Loading...

Build Configuration

The build configuration resource centers on retrieving and adjusting the most recent build settings of the sales channel. It permits to modify aspects like the app name, landing page image, and splash image in mobile builds, providing flexibility and customization options for the sales channel appearance and functionality.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/build/{platform_type}/configuration
# Get Build Configuration
PUT
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/build/{platform_type}/configuration
# Update build configuration
GET

Get Build Configuration

Retrieve latest build configuration, such as app name, landing page image, splash image used in a mobile build.
Parameters
platformType
string
The device platform for which the mobile app is built, e.g. android, ios.
Enum
Response
200
422
Success
MobileAppConfiguration
is_active
boolean
Optional
Indicates the availability of the mobile build
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) for mobile application configuration
app_name
string
Optional
Name of the mobile app
landing_image
object (LandingImage)
Optional
LandingImage
splash_image
object (SplashImage)
Optional
SplashImage
application
string
Optional
Application ID of the current sales channel
platform_type
string
Optional
Device platform for which the mobile app was built, e.g. android, ios.
Enum
created_at
string
Optional
ISO 8601 timestamp of application configuration creation
modified_at
string
Optional
ISO 8601 timestamp of last known modifications to the app build
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero.
package_name
string
Optional
Shows bundle identifier if device platform is iOS, and directory of the app if device platform is Android
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/build/{platform_type}/configuration
Loading...
Response
Loading...
PUT

Update build configuration

Modify the existing build configuration, such as app name, landing page image, splash image used in a mobile build.
Parameters
platformType
string
The device platform for which the mobile app is built, e.g. android, ios.
Enum
body
object (MobileAppConfigRequest)
MobileAppConfigRequest
app_name
string
Optional
Name of the mobile app
landing_image
object (LandingImage)
Optional
LandingImage
splash_image
object (SplashImage)
Optional
SplashImage
is_active
boolean
Optional
shows update in mobile app config is active or not
Response
200
422
Success
MobileAppConfiguration
is_active
boolean
Optional
Indicates the availability of the mobile build
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) for mobile application configuration
app_name
string
Optional
Name of the mobile app
landing_image
object (LandingImage)
Optional
LandingImage
splash_image
object (SplashImage)
Optional
SplashImage
application
string
Optional
Application ID of the current sales channel
platform_type
string
Optional
Device platform for which the mobile app was built, e.g. android, ios.
Enum
created_at
string
Optional
ISO 8601 timestamp of application configuration creation
modified_at
string
Optional
ISO 8601 timestamp of last known modifications to the app build
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero.
package_name
string
Optional
Shows bundle identifier if device platform is iOS, and directory of the app if device platform is Android
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/build/{platform_type}/configuration
Loading...
Response
Loading...

Company and Selling Location

The Company and Selling Location assists in accessing information related to companies and selling location(also known as stores) linked to your sales channel. It provides access to crucial details like company profiles and store data, which are integral for the smooth functioning of your sales channel.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/companies
# List sales channel companies
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/stores
# list sales channel stores
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store/select
# Get ordering store signed cookie
DEL
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store/select
# Delete Ordering Store signed cookie
GET

List sales channel companies

Retrieve info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel sales channel
Parameters
uid
integer
Optional
UID of companies to be fetched
pageNo
integer
Optional
The current page number to navigate through the given set of results. Default value is 1.
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
Response
200
Success
CompaniesResponse
items
array of object (AppInventoryCompanies)
Optional
Array of AppInventoryCompanies
page
object (Page)
Optional
Page
Examples
Parameters
uid:
1080
pageNo:
1
pageSize:
10
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/companies
Loading...
Response
Loading...
GET

list sales channel stores

Retrieve information of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel sales channel
Parameters
pageNo
integer
Optional
The current page number to navigate through the given set of results. Default value is 1.
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
Response
200
Success
StoresResponse
items
array of object (AppInventoryStores)
Optional
Array of AppInventoryStores
page
object (Page)
Optional
Page
Examples
Parameters
pageNo:
1
pageSize:
1
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/stores
Loading...
Response
Loading...
POST

Get ordering store signed cookie

Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart.
Parameters
body
object (OrderingStoreSelectRequest)
Pass the UID of the ordering store in the request body as shown below.
OrderingStoreSelectRequest
ordering_store
object (OrderingStoreSelect)
OrderingStoreSelect
Response
200
400
Success
SuccessMessageResponse
success
boolean
Optional
Shows whether domain was deleted successfully
message
string
Optional
Success message shown to the user (in a string format)
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store/select
Loading...
Response
Loading...
DEL

Delete Ordering Store signed cookie

Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app.
Parameters
No Parameters
Response
200
Success
SuccessMessageResponse
success
boolean
Optional
Shows whether domain was deleted successfully
message
string
Optional
Success message shown to the user (in a string format)
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store/select
Loading...
Response
Loading...

Contact

The Contact streamlines accessing and editing your sales channel contact details. It ensures precise communication with users and stakeholders by offering tools to manage and update contact information effectively within the sales channel.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/information
# Get sales channel contact
PUT
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/information
# Update sales channel contact
GET

Get sales channel contact

Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the sales channel.
Parameters
No Parameters
Response
200
Success
ApplicationInformation
address
object (InformationAddress)
Optional
InformationAddress
support
object (InformationSupport)
Optional
InformationSupport
social_links
object (SocialLinks)
Optional
SocialLinks
links
array of object (Links)
Optional
Array of Links
copyright_text
string
Optional
Copyright statement usually seen at the site's footer
_id
string
Optional
Unique identifier (24-digit Mongo Object ID) of the application information
business_highlights
array of object (BusinessHighlights)
Optional
Array of BusinessHighlights
application
string
Optional
Alphanumeric ID allotted to a sales channel application created within a business account
created_at
string
Optional
ISO 8601 timestamp of creation of the application information
modified_at
string
Optional
ISO 8601 timestamp of updation of the application information
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/information
Loading...
Response
Loading...
PUT

Update sales channel contact

Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the sales channel.
Parameters
body
object (ApplicationInformation)
Request body to save modified application information.
ApplicationInformation
address
object (InformationAddress)
Optional
InformationAddress
support
object (InformationSupport)
Optional
InformationSupport
social_links
object (SocialLinks)
Optional
SocialLinks
links
array of object (Links)
Optional
Array of Links
copyright_text
string
Optional
Copyright statement usually seen at the site's footer
_id
string
Optional
Unique identifier (24-digit Mongo Object ID) of the application information
business_highlights
array of object (BusinessHighlights)
Optional
Array of BusinessHighlights
application
string
Optional
Alphanumeric ID allotted to a sales channel application created within a business account
created_at
string
Optional
ISO 8601 timestamp of creation of the application information
modified_at
string
Optional
ISO 8601 timestamp of updation of the application information
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero.
Response
200
Success
ApplicationInformation
address
object (InformationAddress)
Optional
InformationAddress
support
object (InformationSupport)
Optional
InformationSupport
social_links
object (SocialLinks)
Optional
SocialLinks
links
array of object (Links)
Optional
Array of Links
copyright_text
string
Optional
Copyright statement usually seen at the site's footer
_id
string
Optional
Unique identifier (24-digit Mongo Object ID) of the application information
business_highlights
array of object (BusinessHighlights)
Optional
Array of BusinessHighlights
application
string
Optional
Alphanumeric ID allotted to a sales channel application created within a business account
created_at
string
Optional
ISO 8601 timestamp of creation of the application information
modified_at
string
Optional
ISO 8601 timestamp of updation of the application information
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero.
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/information
Loading...
Response
Loading...

Currency

Currecny Standardized money system facilitating exchange, represented by codes/symbols, essential for financial transactions and economic activities globally. Currency resource can be used to access available currencies.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/currencies
# List currencies
GET

List currencies

Retrieve a list of available currencies.
Parameters
No Parameters
Response
200
Currencies Success response
CurrenciesResponse
items
array of object (Currency)
Optional
Array of Currency
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/currencies
Loading...
Response
Loading...

Currency Configuration

The currency configuration is designed for handling every aspect of currency settings within the Sales channel. It offers tools to access and adjust currency-related configurations, update currency settings, and retrieve the list of supported currencies for the sales channel.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/currency
# Get sales channel currency configuration
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/currency
# Update sales channel currency configuration
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/currency/supported
# List supported currencies
GET

Get sales channel currency configuration

Retrieve a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the sales channel.
Parameters
No Parameters
Response
200
404
Success
AppSupportedCurrency
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the currency configuration supported by the application
supported_currency
array of string
Optional
application
string
Optional
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
default_currency
object (DefaultCurrency)
Optional
DefaultCurrency
created_at
string
Optional
ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel
modified_at
string
Optional
ISO 8601 timestamp when currency was updated in the list of currencies supported by the sales channel
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/currency
Loading...
Response
Loading...
POST

Update sales channel currency configuration

Modify currency configuration settings for the sales channel. Add and edit the currencies supported in the sales channel. Initially, INR will be enabled by default.
Parameters
body
object (AppSupportedCurrency)
AppSupportedCurrency
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the currency configuration supported by the application
supported_currency
array of string
Optional
application
string
Optional
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
default_currency
object (DefaultCurrency)
Optional
DefaultCurrency
created_at
string
Optional
ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel
modified_at
string
Optional
ISO 8601 timestamp when currency was updated in the list of currencies supported by the sales channel
Response
200
Success
AppSupportedCurrency
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the currency configuration supported by the application
supported_currency
array of string
Optional
application
string
Optional
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
default_currency
object (DefaultCurrency)
Optional
DefaultCurrency
created_at
string
Optional
ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel
modified_at
string
Optional
ISO 8601 timestamp when currency was updated in the list of currencies supported by the sales channel
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/currency
Loading...
Response
Loading...
GET

List supported currencies

Retrieve a list of supported currencies for the sales channel. A list of currencies allowed in the current sales channel. Moreover, get the name, code, symbol, and the decimal digits of the currencies.
Parameters
No Parameters
Response
200
404
Success. Check the example shown below or refer `AppCurrencyResponse` for more details.
AppCurrencyResponse
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the currency configuration supported by the application
application
string
Optional
Alphanumeric ID allotted to an application (sales channel website) created within a business account
default_currency
object (DefaultCurrency)
Optional
DefaultCurrency
supported_currency
array of object (Currency)
Optional
Array of Currency
created_at
string
Optional
ISO 8601 timestamp when currency was added in the list of currencies supported by the sales channel
modified_at
string
Optional
ISO 8601 timestamp when currency was updated in the list of currencies supported by the sales channel
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/currency/supported
Loading...
Response
Loading...

Domain

A unique string that represents the address of a fynd store on the Internet. Check the availability of a domain name for registration and pre-defined custom domain is supported. Domain resource is responsible for managing all domain-related operations within the sales channel. It includes functionalities such as adding and removing domains, changing domain types, and checking the active status of domains.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain
# List domains
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain
# Create domain
DEL
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain/{id}
# Remove domain
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain/set-domain
# Update domain
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain/domain-status
# Get domain status
POST
/service/platform/configuration/v1.0/company/{company_id}/domain/suggestions
# List suggestion domain
GET

List domains

Retrieve a list of existing domains by its sales channel id.
Parameters
No Parameters
Response
200
Success
DomainsResponse
domains
array of object (Domain)
Optional
Array of Domain
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain
Loading...
Response
Loading...
POST

Create domain

Creates a domain for an sales channel. Note - Only 15 domains can be added to the sales channel
Parameters
body
object (DomainAddRequest)
DomainAddRequest
domain
object (DomainAdd)
Optional
DomainAdd
Response
200
400
Success
Domain
name
string
Optional
Full domain name, e.g. newton.com
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the sales channel domain
verified
boolean
Optional
Domain is verified or not. TXT and A records should propagate correctly.
is_primary
boolean
Optional
Domain is primary or not. Primary domain is the default/main domain.
is_shortlink
boolean
Optional
Shortlink is present or not for the domain
is_predefined
boolean
Optional
Domain is hosting domain or not.
message
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain
Loading...
Response
Loading...
DEL

Remove domain

Delete a specific domain from the sales channel. Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain.
Parameters
id
string
The unique identifier (24-digit Mongo Object ID) of the domain
Response
200
400
404
Success
SuccessMessageResponse
success
boolean
Optional
Shows whether domain was deleted successfully
message
string
Optional
Success message shown to the user (in a string format)
Examples
Parameters
id:
"5caf4f967583794673424d77"
Was this section helpful?
DEL
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain/{id}
Loading...
Response
Loading...
POST

Update domain

Modify the type of a specific domain. Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links.
Parameters
body
object (UpdateDomainTypeRequest)
UpdateDomainTypeRequest
domain
object (UpdateDomain)
Optional
UpdateDomain
action
string
Optional
Shows domain is made primary domain for the sales channel or shorlink is created for the sales channel domain
Enum
Response
200
404
Success
DomainsResponse
domains
array of object (Domain)
Optional
Array of Domain
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain/set-domain
Loading...
Response
Loading...
POST

Get domain status

Retrieve the status of a specific domain. Shows if the A records and TXT records of the domain correctly points to appropriate IP on Fynd Servers.
Parameters
body
object (DomainStatusRequest)
DomainStatusRequest
domain_url
string
Optional
URL of the domain, e.g. uniket.hostx0.de
Response
200
Success
DomainStatusResponse
connected
boolean
Optional
Check if domain is live and mapped to appropriate IP of Fynd Servers
status
array of object (DomainStatus)
Optional
Array of DomainStatus
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/domain/domain-status
Loading...
Response
Loading...
POST

List suggestion domain

Check the availability of a specific domain. Use this API to check the domain availability before linking it to sales channel. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider.
Parameters
body
object (DomainSuggestionsRequest)
DomainSuggestionsRequest
domain_url
string
Optional
Domain url
custom
boolean
Optional
Get suggestions for custom domains or Fynd domains
Response
200
Success
DomainSuggestionsResponse
domains
array of object (DomainSuggestion)
Optional
Domain URL
Array of DomainSuggestion
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/configuration/v1.0/company/{company_id}/domain/suggestions
Loading...
Response
Loading...

Integration Configuration

Integration Configuration helps in managing integrations across various levels within the sales channel. it helps to obtain configuration details for specific integrations at different levels and to update and retrieve integration options and their statuses. This functionality allows for seamless integration with external systems or services, ensuring smooth operation and effective communication between different components of the sales channel.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/integration/{id}
# Get integration by Id
GET
/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/available
# List available opt-ins
GET
/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/selected/{level}/{uid}
# List selected opt-in
GET
/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/configuration/{id}/{level}
# Get level configuration
PUT
/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/configuration/{id}/{level}
# Update level integration
GET
/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/configuration/{id}/{level}/{uid}
# Get integration Id
PUT
/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/configuration/{id}/{level}/{uid}
# Update level UID integration
GET
/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/check/configuration/{id}/{level}/{uid}
# Get active integrations
GET

Get integration by Id

Retrieve detailed information about a specific integration. Retrieve the details of an integration (such as Ginesys, SAP, etc.) using its ID.
Parameters
id
string
Integration id
Response
200
404
Success
Integration
validators
object (Validators)
Optional
Validators
description
string
Optional
Basic description about the integration
description_html
string
Optional
Basic HTML description about the integration
constants
object
Optional
companies
array of string
Optional
support
array of string
Optional
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the integration
name
string
Optional
Name of the integration, e.g. SAP RBL Integration
slug
string
Optional
Name of the integration, e.g. SAP RBL Integration
meta
array of object (IntegrationMeta)
Optional
Array of IntegrationMeta
icon
string
Optional
Hosted URL of the icon image
hidden
boolean
Optional
owner
string
Optional
The unique identifier (24-digit Mongo Object ID) of the user who created the integration
created_at
string
Optional
ISO 8601 timestamp of integration creation
modified_at
string
Optional
ISO 8601 timestamp of integration updation
token
string
Optional
Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated.
secret
string
Optional
Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated.
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero.
Examples
Parameters
id:
"6524d9e195f3c8e3d36b6977"
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/integration/{id}
Loading...
Response
Loading...
GET

List available opt-ins

Retrieve a list of available opt-ins. Retrieve a list of all available integrations in a company.
Parameters
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
Response
200
Success
GetIntegrationsOptInsResponse
items
array of object (IntegrationOptIn)
Optional
Array of IntegrationOptIn
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/available
Loading...
Response
Loading...
GET

List selected opt-in

Retrieve a list of selected opt-ins. Retrieve the store-level/company-level integrations configured in a company
Parameters
level
string
store or company
uid
integer
Unique identifier of the selected integration level.
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
Response
200
Success
GetIntegrationsOptInsResponse
items
array of object (IntegrationOptIn)
Optional
Array of IntegrationOptIn
page
object (Page)
Optional
Page
Examples
Parameters
level:
"store"
uid:
2
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/selected/{level}/{uid}
Loading...
Response
Loading...
GET

Get level configuration

Retrieve configuration settings for integration levels. Retrieve the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc.
Parameters
id
string
Integration ID (24-digit Mongo Object ID)
level
string
store or company
opted
boolean
Optional
True means get the opted stores. False means get the stores that aren't opted.
checkPermission
boolean
Optional
Filter on if permissions (for inventory/order) are present
Response
200
Success
IntegrationConfigResponse
items
array of object (IntegrationLevel)
Optional
Array of IntegrationLevel
Examples
Parameters
id:
"6524d9e195f3c8e3d36b6977"
level:
"company"
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/configuration/{id}/{level}
Loading...
Response
Loading...
PUT

Update level integration

Modify level integration. Update the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company).
Parameters
id
string
Integration ID (24-digit Mongo Object ID)
level
string
Integration level, `store` or `company`
body
object (UpdateIntegrationLevelRequest)
UpdateIntegrationLevelRequest
items
array of object (IntegrationLevel)
Optional
Array of IntegrationLevel
Response
200
Success
IntegrationLevel
opted
boolean
Optional
Shows this integration is opted or not opted for the current company
permissions
array of object
Optional
last_patch
array of object (LastPatch)
Optional
Array of LastPatch
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the integration config
integration
string
Optional
Integration id. Shows which integration you are enabling.
level
string
Optional
Shows for what level the integration is set up. It can be company level or store level.
uid
integer
| int32
Optional
It can be store uid or company uid. Depends on the level of integration.
company_id
integer
| int32
Optional
Unique id of company.
meta
array of object (IntegrationMeta)
Optional
Array of IntegrationMeta
token
string
Optional
Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated.
created_at
string
Optional
ISO 8601 timestamp of integration config creation
modified_at
string
Optional
ISO 8601 timestamp of integration config updation
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero.
data
object
Optional
Schema data of the integration stored in key-value pairs
success
boolean
Optional
message
string
Optional
additionalProperties
Optional
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
id:
"000000000000000000000001"
level:
"company"
body:
body
Was this section helpful?
PUT
/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/configuration/{id}/{level}
Loading...
Response
Loading...
GET

Get integration Id

Retrieve integration details for a specific level. Retrieve the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company).
Parameters
id
string
Integration ID (24-digit Mongo Object ID)
level
string
Integration level, `store` or `company`
uid
integer
Unique identifier of integration level (store/company)
Response
200
Success
IntegrationLevel
opted
boolean
Optional
Shows this integration is opted or not opted for the current company
permissions
array of object
Optional
last_patch
array of object (LastPatch)
Optional
Array of LastPatch
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the integration config
integration
string
Optional
Integration id. Shows which integration you are enabling.
level
string
Optional
Shows for what level the integration is set up. It can be company level or store level.
uid
integer
| int32
Optional
It can be store uid or company uid. Depends on the level of integration.
company_id
integer
| int32
Optional
Unique id of company.
meta
array of object (IntegrationMeta)
Optional
Array of IntegrationMeta
token
string
Optional
Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated.
created_at
string
Optional
ISO 8601 timestamp of integration config creation
modified_at
string
Optional
ISO 8601 timestamp of integration config updation
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero.
data
object
Optional
Schema data of the integration stored in key-value pairs
success
boolean
Optional
message
string
Optional
additionalProperties
Optional
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
id:
"6524d9e195f3c8e3d36b6977"
level:
"company"
uid:
2
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/configuration/{id}/{level}/{uid}
Loading...
Response
Loading...
PUT

Update level UID integration

Modify UID-based integration. Update the level of integration by store UID
Parameters
id
string
Integration ID (24-digit Mongo Object ID)
level
string
Integration level, `store` or `company`
uid
integer
Unique identifier of integration level (store/company)
body
object (IntegrationLevel)
IntegrationLevel
opted
boolean
Optional
Shows this integration is opted or not opted for the current company
permissions
array of object
Optional
last_patch
array of object (LastPatch)
Optional
Array of LastPatch
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the integration config
integration
string
Optional
Integration id. Shows which integration you are enabling.
level
string
Optional
Shows for what level the integration is set up. It can be company level or store level.
uid
integer
| int32
Optional
It can be store uid or company uid. Depends on the level of integration.
company_id
integer
| int32
Optional
Unique id of company.
meta
array of object (IntegrationMeta)
Optional
Array of IntegrationMeta
token
string
Optional
Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated.
created_at
string
Optional
ISO 8601 timestamp of integration config creation
modified_at
string
Optional
ISO 8601 timestamp of integration config updation
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero.
data
object
Optional
Schema data of the integration stored in key-value pairs
success
boolean
Optional
message
string
Optional
additionalProperties
Optional
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
Success
IntegrationLevel
opted
boolean
Optional
Shows this integration is opted or not opted for the current company
permissions
array of object
Optional
last_patch
array of object (LastPatch)
Optional
Array of LastPatch
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the integration config
integration
string
Optional
Integration id. Shows which integration you are enabling.
level
string
Optional
Shows for what level the integration is set up. It can be company level or store level.
uid
integer
| int32
Optional
It can be store uid or company uid. Depends on the level of integration.
company_id
integer
| int32
Optional
Unique id of company.
meta
array of object (IntegrationMeta)
Optional
Array of IntegrationMeta
token
string
Optional
Randomly generated fixed-length string for opted integration. It is auto-generated. It would never change once it is generated.
created_at
string
Optional
ISO 8601 timestamp of integration config creation
modified_at
string
Optional
ISO 8601 timestamp of integration config updation
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero.
data
object
Optional
Schema data of the integration stored in key-value pairs
success
boolean
Optional
message
string
Optional
additionalProperties
Optional
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
id:
"000000000000000000000001"
level:
"company"
uid:
2
body:
body
Was this section helpful?
PUT
/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/configuration/{id}/{level}/{uid}
Loading...
Response
Loading...
GET

Get active integrations

Check if a store is already opted-in for any integration
Parameters
id
string
Integration ID (24-digit Mongo Object ID)
level
string
Integration level, `store` or `company`
uid
integer
Unique identifier of integration level (store/company)
Response
200
Success
OptedStoreIntegration
other_opted
boolean
Optional
Allow user to opt same store in other integration
other_integration
object (IntegrationOptIn)
Optional
IntegrationOptIn
other_entity
object (OtherEntity)
Optional
OtherEntity
Examples
Parameters
id:
"6524d9e195f3c8e3d36b6977"
level:
"company"
uid:
11081
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/integration-opt-in/check/configuration/{id}/{level}/{uid}
Loading...
Response
Loading...

Ordering Stores

Ordering Stores manages all aspects of ordering store configurations within the sales channel. It allows users to retrieve ordering store details and update ordering store configurations, including staff-specific ordering stores.

Operations
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store/stores/filter
# List ordering stores
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store
# Update ordering store configuration
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store
# Get ordering store configuration
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store/staff-stores
# Get staff ordering stores
POST

List ordering stores

Retrieve ordering stores based on specified filters. Use filters and retrieve the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders).
Parameters
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
body
object (FilterOrderingStoreRequest)
FilterOrderingStoreRequest
all_stores
boolean
Optional
Allow all stores from the ordering stores
deployed_stores
array of integer
Optional
q
string
Optional
Store code or name of the ordering store
Response
200
Success
OrderingStores
page
object (Page)
Optional
Page
items
array of object (OrderingStore)
Optional
Array of OrderingStore
deployed_stores
array of integer
Optional
all_stores
boolean
Optional
Allow all stores of the ordering stores
enabled
boolean
Optional
Allow ordering stores for current sales channel
type
string
Optional
For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
Enum
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the ordering store
app
string
Optional
Alphanumeric ID allotted to an application (sales channel website) created within a business account
__v
integer
| int32
Optional
Version key for tracking ordering stores. Default value is zero.
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store/stores/filter
Loading...
Response
Loading...
POST

Update ordering store configuration

Modify configuration settings for ordering stores. Edit the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders)
Parameters
body
object (OrderingStoreConfig)
OrderingStoreConfig
deployment_meta
object (DeploymentMeta)
Optional
DeploymentMeta
Response
200
400
404
Success
DeploymentMeta
deployed_stores
array of integer
Optional
all_stores
boolean
Optional
Allow all stores from the ordering store
enabled
boolean
Optional
Allow ordering stores for current sales channel
type
string
Optional
Permitted values are 'hard' and 'soft'. For hard type delivery, store selection is compulsory. For soft type, delivery store selection is optional.
Enum
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the ordering stores
app
string
Optional
Alphanumeric ID allotted to an application (sales channel website) created within a business account
__v
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store
Loading...
Response
Loading...
GET

Get ordering store configuration

Retrieve configuration settings for ordering stores. Retrieve the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders).
Parameters
No Parameters
Response
200
404
Success
OrderingStoreConfig
deployment_meta
object (DeploymentMeta)
Optional
DeploymentMeta
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store
Loading...
Response
Loading...
GET

Get staff ordering stores

Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the sales channel will be utilized for placing orders).
Parameters
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
q
string
Optional
Store code or name of the ordering store.
Response
200
Success. Check the example shown below or refer `OrderingStoresResponse` for more details.
OrderingStoresResponse
page
object (Page)
Optional
Page
items
array of object (OrderingStore)
Optional
Array of OrderingStore
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/ordering-store/staff-stores
Loading...
Response
Loading...

Other Seller Sales Channel

Handle all operations concerning the cross-seller sales channel, which facilitates multiple sellers in selling their products, accessing the list of sales channel supporting cross-selling, viewing specific sales channel details, and managing the company's product sales opt-in and opt-out.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/other-seller-applications
# Get other sales channel
GET
/service/platform/configuration/v1.0/company/{company_id}/other-seller-applications/{id}
# Get others sales. channel
PUT
/service/platform/configuration/v1.0/company/{company_id}/other-seller-applications/{id}/opt_out
# opt out of marketplaces
GET

Get other sales channel

Retrieve sales channels of other sellers. Retrieve all other seller sales channels that were not created within the current company. but have opted for the current company's inventory.
Parameters
pageNo
integer
Optional
The page number to navigate through the given set of results. Default value is 1.
pageSize
integer
Optional
The number of items to retrieve in each page. Default value is 10.
Response
200
Success
OtherSellerApplications
items
array of object (OtherSellerApplication)
Optional
Array of OtherSellerApplication
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/other-seller-applications
Loading...
Response
Loading...
GET

Get others sales. channel

Retrieve details of a seller sales channel that was not created within the current company but has opted for the current company's inventory and searched via the sales channel ID of another sales channel
Parameters
id
string
Application Id
Response
200
404
Success
OptedApplicationResponse
name
string
Optional
Name of the other seller's sales channel
description
string
Optional
Basic details about the other seller's sales channel
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the other seller's sales channel
domain
string
Optional
Domain URL of the other seller's sales channel
company
object (OptedCompany)
Optional
OptedCompany
opted_inventory
object (OptedInventory)
Optional
OptedInventory
opt_out_inventory
object (OptOutInventory)
Optional
OptOutInventory
Examples
Parameters
id:
"000000000000000000000001"
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/other-seller-applications/{id}
Loading...
Response
Loading...
PUT

opt out of marketplaces

This API allows businesses to opt out of sharing their inventory with external seller sales channels. By using this API, companies or stores can prevent specific seller sales channels from fetching their inventory data. This feature is useful for businesses that want to control who can access their product listings and other inventory information. It helps maintain privacy and control over data distribution, ensuring that sensitive information is only shared with authorized partners.
Parameters
id
string
Alphanumeric ID allotted to an application (sales channel website) created within a business account.
body
object (OptOutInventory)
OptOutInventory
store
array of integer
List of selling locations (stores) opted out from the inventory of other seller's application
company
array of integer
List of companies opted out from the inventory of other seller's application
Response
200
400
404
Success
SuccessMessageResponse
success
boolean
Optional
Shows whether domain was deleted successfully
message
string
Optional
Success message shown to the user (in a string format)
Examples
Parameters
id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
/service/platform/configuration/v1.0/company/{company_id}/other-seller-applications/{id}/opt_out
Loading...
Response
Loading...

Product Listing Configuration

The product listing configuration oversees the management of product configuration tasks within the sales channel. It empowers users to define multiple aspects, such as determining the availability of products from specific brands, stores, or companies for sale. Product Listing Configurstion can also choose to list only in-stock products and set criteria for including products with images in the sales channel promotions offerings.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/configuration
# Get inventory configuration
PUT
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/configuration
# Update inventory configuration
PATCH
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/configuration
# Partially update inventory configuration
GET

Get inventory configuration

Retrieve configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
Parameters
No Parameters
Response
200
404
Success
ApplicationInventory
inventory
object (AppInventoryConfig)
Optional
AppInventoryConfig
authentication
object (AuthenticationConfig)
Optional
AuthenticationConfig
article_assignment
object (ArticleAssignmentConfig)
Optional
ArticleAssignmentConfig
reward_points
object (RewardPointsConfig)
Optional
RewardPointsConfig
cart
object (AppCartConfig)
Optional
AppCartConfig
payment
object (AppPaymentConfig)
Optional
AppPaymentConfig
order
object (AppOrderConfig)
Optional
AppOrderConfig
logistics
object (AppLogisticsConfig)
Optional
AppLogisticsConfig
pii_masking
object (PiiMasking)
Optional
PiiMasking
tags
array of string
Optional
__v
integer
Optional
business
string
Optional
Indicates the business type for sales channel e.g. retail or wholesale
comms_enabled
boolean
Optional
Shows communication(comms) is enabled or not for sales channel inventory
communication
object (CommunicationConfig)
Optional
CommunicationConfig
platforms
array of string
Optional
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the sales channel inventory
loyalty_points
object (LoyaltyPointsConfig)
Optional
LoyaltyPointsConfig
app
string
Optional
Current sales channel ID
created_at
string
Optional
ISO 8601 timestamp of sales channel inventory creation
modified_at
string
Optional
ISO 8601 timestamp of sales channel inventory updation
modified_by
string
Optional
User ID of the person who made the latest changes in the sales channel inventory
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/configuration
Loading...
Response
Loading...
PUT

Update inventory configuration

Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
Parameters
body
object (ApplicationInventory)
ApplicationInventory
inventory
object (AppInventoryConfig)
Optional
AppInventoryConfig
authentication
object (AuthenticationConfig)
Optional
AuthenticationConfig
article_assignment
object (ArticleAssignmentConfig)
Optional
ArticleAssignmentConfig
reward_points
object (RewardPointsConfig)
Optional
RewardPointsConfig
cart
object (AppCartConfig)
Optional
AppCartConfig
payment
object (AppPaymentConfig)
Optional
AppPaymentConfig
order
object (AppOrderConfig)
Optional
AppOrderConfig
logistics
object (AppLogisticsConfig)
Optional
AppLogisticsConfig
pii_masking
object (PiiMasking)
Optional
PiiMasking
tags
array of string
Optional
__v
integer
Optional
business
string
Optional
Indicates the business type for sales channel e.g. retail or wholesale
comms_enabled
boolean
Optional
Shows communication(comms) is enabled or not for sales channel inventory
communication
object (CommunicationConfig)
Optional
CommunicationConfig
platforms
array of string
Optional
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the sales channel inventory
loyalty_points
object (LoyaltyPointsConfig)
Optional
LoyaltyPointsConfig
app
string
Optional
Current sales channel ID
created_at
string
Optional
ISO 8601 timestamp of sales channel inventory creation
modified_at
string
Optional
ISO 8601 timestamp of sales channel inventory updation
modified_by
string
Optional
User ID of the person who made the latest changes in the sales channel inventory
Response
200
429
Success
ApplicationInventory
inventory
object (AppInventoryConfig)
Optional
AppInventoryConfig
authentication
object (AuthenticationConfig)
Optional
AuthenticationConfig
article_assignment
object (ArticleAssignmentConfig)
Optional
ArticleAssignmentConfig
reward_points
object (RewardPointsConfig)
Optional
RewardPointsConfig
cart
object (AppCartConfig)
Optional
AppCartConfig
payment
object (AppPaymentConfig)
Optional
AppPaymentConfig
order
object (AppOrderConfig)
Optional
AppOrderConfig
logistics
object (AppLogisticsConfig)
Optional
AppLogisticsConfig
pii_masking
object (PiiMasking)
Optional
PiiMasking
tags
array of string
Optional
__v
integer
Optional
business
string
Optional
Indicates the business type for sales channel e.g. retail or wholesale
comms_enabled
boolean
Optional
Shows communication(comms) is enabled or not for sales channel inventory
communication
object (CommunicationConfig)
Optional
CommunicationConfig
platforms
array of string
Optional
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the sales channel inventory
loyalty_points
object (LoyaltyPointsConfig)
Optional
LoyaltyPointsConfig
app
string
Optional
Current sales channel ID
created_at
string
Optional
ISO 8601 timestamp of sales channel inventory creation
modified_at
string
Optional
ISO 8601 timestamp of sales channel inventory updation
modified_by
string
Optional
User ID of the person who made the latest changes in the sales channel inventory
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/configuration
Loading...
Response
Loading...
PATCH

Partially update inventory configuration

Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
Parameters
body
object (AppInventoryPartialUpdate)
AppInventoryPartialUpdate
reward_points
object (RewardPointsConfig)
Optional
RewardPointsConfig
cart
object (AppCartConfig)
Optional
AppCartConfig
payment
object (AppPaymentConfig)
Optional
AppPaymentConfig
loyalty_points
object (LoyaltyPointsConfig)
Optional
LoyaltyPointsConfig
comms_enabled
boolean
Optional
Shows communication (comms) is enabled or not for sales channel partial inventory update
communication
object (CommunicationConfig)
Optional
CommunicationConfig
Response
200
Success
ApplicationInventory
inventory
object (AppInventoryConfig)
Optional
AppInventoryConfig
authentication
object (AuthenticationConfig)
Optional
AuthenticationConfig
article_assignment
object (ArticleAssignmentConfig)
Optional
ArticleAssignmentConfig
reward_points
object (RewardPointsConfig)
Optional
RewardPointsConfig
cart
object (AppCartConfig)
Optional
AppCartConfig
payment
object (AppPaymentConfig)
Optional
AppPaymentConfig
order
object (AppOrderConfig)
Optional
AppOrderConfig
logistics
object (AppLogisticsConfig)
Optional
AppLogisticsConfig
pii_masking
object (PiiMasking)
Optional
PiiMasking
tags
array of string
Optional
__v
integer
Optional
business
string
Optional
Indicates the business type for sales channel e.g. retail or wholesale
comms_enabled
boolean
Optional
Shows communication(comms) is enabled or not for sales channel inventory
communication
object (CommunicationConfig)
Optional
CommunicationConfig
platforms
array of string
Optional
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the sales channel inventory
loyalty_points
object (LoyaltyPointsConfig)
Optional
LoyaltyPointsConfig
app
string
Optional
Current sales channel ID
created_at
string
Optional
ISO 8601 timestamp of sales channel inventory creation
modified_at
string
Optional
ISO 8601 timestamp of sales channel inventory updation
modified_by
string
Optional
User ID of the person who made the latest changes in the sales channel inventory
Examples
Parameters
body:
body
Was this section helpful?
PATCH
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/configuration
Loading...
Response
Loading...

Sales Channel

Sales Channel handles all operations for sales channel management, encompassing tasks like creating sales channel, retrieving detailed information about specific sales channel, and obtaining a list of all sales channel available. It serves as the centralized hub for managing various aspects of sales channel within the system.

Operations
POST
/service/platform/configuration/v1.0/company/{company_id}/application
# Create sales channel
GET
/service/platform/configuration/v1.0/company/{company_id}/application
# List sales channel stores
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}
# Get sales channel by id
POST

Create sales channel

Generate and add a new sales channel. sales channels are sales channel websites which can be configured, personalized and customized. Use this API to create a new sales channel in the current company.
Parameters
body
object (CreateApplicationRequest)
CreateApplicationRequest
app
object (App)
Optional
App
configuration
object (ApplicationInventory)
Optional
ApplicationInventory
domain
object (AppDomain)
Optional
AppDomain
Response
200
400
Success
CreateAppResponse
app
object (Application)
Optional
Application
configuration
object (ApplicationInventory)
Optional
ApplicationInventory
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/configuration/v1.0/company/{company_id}/application
Loading...
Response
Loading...
GET

List sales channel stores

Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company.
Parameters
pageNo
integer
Optional
pageSize
integer
Optional
q
string
Optional
Search param by name or domain
Response
200
Success
ApplicationsResponse
items
array of object (Application)
Optional
Array of Application
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/application
Loading...
Response
Loading...
GET

Get sales channel by id

Retrieve detailed information about a specific sales channel. Use sales channel ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc.
Parameters
No Parameters
Response
200
404
Success
ApplicationById
website
object (ApplicationWebsite)
Optional
ApplicationWebsite
cors
object (ApplicationCors)
Optional
ApplicationCors
auth
object (ApplicationAuth)
Optional
ApplicationAuth
description
string
Optional
It contains detailed information about the sales channel.
channel_type
string
Optional
It indicates different types of channels, such as store, website, and mobile apps, with 'store' being the default value.
cache_ttl
integer
| int32
Optional
An integer value that specifies the number of seconds until the key expires
is_internal
boolean
Optional
Indicates whether a sales channel is internal or not
is_active
boolean
Optional
Indicates sales channel is active or not active
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the sales channel
name
string
Optional
Name of the sales channel, e.g. Zenz Fashion
owner
string
Optional
The unique identifier (24-digit Mongo Object ID) of owner who owns the application
company_id
integer
| int32
Optional
Numeric ID allotted to a business account where the sales channel exists
token
string
Optional
Random generated fix length string for sales channel. It is required and auto-generated.
redirections
array of object (ApplicationRedirections)
Optional
Array of ApplicationRedirections
meta
array of object (ApplicationMeta)
Optional
Array of ApplicationMeta
created_at
string
Optional
ISO 8601 timestamp of sales channel creation
modified_at
string
Optional
ISO 8601 timestamp of sales channel updation
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero.
banner
object (SecureUrl)
Optional
SecureUrl
logo
object (SecureUrl)
Optional
SecureUrl
favicon
object (SecureUrl)
Optional
SecureUrl
domains
array of object (Domain)
Optional
Array of Domain
app_type
string
Optional
It shows application is live or in development mode.
Enum
mobile_logo
object (SecureUrl)
Optional
SecureUrl
domain
object (Domain)
Optional
Domain
slug
string
Optional
mode
string
Optional
status
string
Optional
tokens
array of object (TokenSchemaID)
Optional
Array of TokenSchemaID
secret
string
Optional
additionalProperties
Optional
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
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}
Loading...
Response
Loading...

Sales Channel Basic Details

The sales channel basic details is focused on fetching and editing vital information regarding your sales channel. It offers capabilities to access and adjust critical details and configurations essential for your sales channel proper operation.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/detail
# Get sales channel
PUT
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/detail
# Update sales channel basic details
GET

Get sales channel

Shows basic sales channel details like name, description, logo, domain, company ID, and other related information.
Parameters
No Parameters
Response
200
Success
ApplicationDetail
name
string
Name of the sales channel. It is required.
description
string
Optional
It gives a detailed information about the sales channel. It is required.
logo
object (SecureUrl)
Optional
SecureUrl
mobile_logo
object (SecureUrl)
Optional
SecureUrl
favicon
object (SecureUrl)
Optional
SecureUrl
banner
object (SecureUrl)
Optional
SecureUrl
domain
object (Domain)
Optional
Domain
domains
array of object (Domain)
Optional
Array of Domain
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) for the sales channel details
slug
string
Optional
company_id
integer
Optional
additionalProperties
Optional
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
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/detail
Loading...
Response
Loading...
PUT

Update sales channel basic details

Modify sales channel details like name, description, logo, domain, company ID, and other related information.
Parameters
body
object (ApplicationDetail)
ApplicationDetail
name
string
Name of the sales channel. It is required.
description
string
Optional
It gives a detailed information about the sales channel. It is required.
logo
object (SecureUrl)
Optional
SecureUrl
mobile_logo
object (SecureUrl)
Optional
SecureUrl
favicon
object (SecureUrl)
Optional
SecureUrl
banner
object (SecureUrl)
Optional
SecureUrl
domain
object (Domain)
Optional
Domain
domains
array of object (Domain)
Optional
Array of Domain
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) for the sales channel details
slug
string
Optional
company_id
integer
Optional
additionalProperties
Optional
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
Success
ApplicationDetail
name
string
Name of the sales channel. It is required.
description
string
Optional
It gives a detailed information about the sales channel. It is required.
logo
object (SecureUrl)
Optional
SecureUrl
mobile_logo
object (SecureUrl)
Optional
SecureUrl
favicon
object (SecureUrl)
Optional
SecureUrl
banner
object (SecureUrl)
Optional
SecureUrl
domain
object (Domain)
Optional
Domain
domains
array of object (Domain)
Optional
Array of Domain
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) for the sales channel details
slug
string
Optional
company_id
integer
Optional
additionalProperties
Optional
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/detail
Loading...
Response
Loading...

Sales Channel Features

The sales channel features resource enables to access and control sales channel functionalities. It supports retrieving feature details, updating configurations, and making adjustments for smooth management of the sales channel functionality.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/feature
# Get sales channel
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/feature
# Update sales channel
PATCH
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/feature
# update sales channel features
GET

Get sales channel

Shows feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more.
Parameters
No Parameters
Response
200
404
Success
AppFeatureResponse
feature
object (AppFeature)
Optional
AppFeature
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/feature
Loading...
Response
Loading...
POST

Update sales channel

Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more.
Parameters
body
object (AppFeatureRequest)
Request body to save/update sales channel feature.
AppFeatureRequest
feature
object (AppFeature)
Optional
AppFeature
Response
200
400
Success
AppFeature
product_detail
object (ProductDetailFeature)
Optional
ProductDetailFeature
landing_page
object (LandingPageFeature)
Optional
LandingPageFeature
registration_page
object (RegistrationPageFeature)
Optional
RegistrationPageFeature
home_page
object (HomePageFeature)
Optional
HomePageFeature
common
object (CommonFeature)
Optional
CommonFeature
cart
object (CartFeature)
Optional
CartFeature
qr
object (QrFeature)
Optional
QrFeature
pcr
object (PcrFeature)
Optional
PcrFeature
order
object (OrderFeature)
Optional
OrderFeature
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) for the sales channel features
app
string
Optional
Application ID of the sales channel
created_at
string
Optional
ISO 8601 timestamp showing the date when the features were configured
modified_at
string
Optional
ISO 8601 timestamp of last known modifications to the sales channel feature configuration
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/feature
Loading...
Response
Loading...
PATCH

update sales channel features

Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more.
Parameters
body
object (AppFeatureRequest)
Request body to save/update application feature.
AppFeatureRequest
feature
object (AppFeature)
Optional
AppFeature
Response
200
400
404
Success
AppFeature
product_detail
object (ProductDetailFeature)
Optional
ProductDetailFeature
landing_page
object (LandingPageFeature)
Optional
LandingPageFeature
registration_page
object (RegistrationPageFeature)
Optional
RegistrationPageFeature
home_page
object (HomePageFeature)
Optional
HomePageFeature
common
object (CommonFeature)
Optional
CommonFeature
cart
object (CartFeature)
Optional
CartFeature
qr
object (QrFeature)
Optional
QrFeature
pcr
object (PcrFeature)
Optional
PcrFeature
order
object (OrderFeature)
Optional
OrderFeature
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) for the sales channel features
app
string
Optional
Application ID of the sales channel
created_at
string
Optional
ISO 8601 timestamp showing the date when the features were configured
modified_at
string
Optional
ISO 8601 timestamp of last known modifications to the sales channel feature configuration
__v
integer
| int32
Optional
Version key for tracking revisions. Default value is zero
Examples
Parameters
body:
body
Was this section helpful?
PATCH
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/feature
Loading...
Response
Loading...

Sales Channel Versions

The sales channel versions focuses on accessing data about prior versions of the sales channel. It aids in version control and deployment by offering historical information and details about past sales channel versions.

Operations
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/build/{platform_type}/versions
# Get previous versions
GET

Get previous versions

Retrieve version details of the app, this includes the build status, build date, version name, latest version, and a lot more.
Parameters
platformType
string
The device platform for which the mobile app is built, e.g. android, ios.
Enum
Response
200
422
Success
BuildVersionHistory
versions
array of object (BuildVersion)
Optional
Array of BuildVersion
latest_available_version_name
string
Optional
Latest version number of the mobile build, in dot-decimal notation
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/configuration/v1.0/company/{company_id}/application/{application_id}/build/{platform_type}/versions
Loading...
Response
Loading...