Skip to main content

Common

Manage sales channels and locations

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
/service/common/configuration/v1.0/application/search-application
# Get sales channel
GET

Get sales channel

Retrieves an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned
Parameters
authorization
string
query
string
Provide application name
Response
200
400
404
Success
ApplicationResponse
application
object (Application)
Application
Examples
Parameters
authorization:
"value"
query:
"value"
Was this section helpful?
GET
/service/common/configuration/v1.0/application/search-application
Loading...
Response
Loading...

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
/service/common/configuration/v1.0/location
# Get a location
GET

Get a location

Retrieves countries , state , cities data associated with the sales channel
Parameters
locationType
string
Provide location type to query on. Possible values : country, state, city
Enum
id
string
Field is optional when location_type is country. If querying for state, provide id of country. If querying for city, provide id of state.
Response
200
Success
Locations
items
array of object (LocationCountry)
Array of LocationCountry
Examples
Parameters
locationType:
"value"
id:
"value"
Was this section helpful?
GET
/service/common/configuration/v1.0/location
Loading...
Response
Loading...