Common
Manage sales channels and locations
Location
Location used for managing location-related operations within the sales channel. It includes functionalities such as creating, updating, and retrieving location details. Additionally, users can create location tags to categorize and effectively manage locations within the system.
Operations
GET
# Get company locations
GET
Get company locations
Retrieve a list of locations associated with the company.
Parameters
locationType
string
Optional
Enum
id
string
Optional
Field is optional when location_type is country. If querying for state, provide id of the country. If querying for city, provide id of the state.
Response
200
Success
Locations
items
array of object (LocationCountry)
Optional
Object Containing Country Locations Details
Array of LocationCountry
Examples
Parameters
locationType:
"value"
id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get company locations
getLocations
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
GET
# List sales channel categories
GET
List sales channel categories
This API retrieves details for a specific sales channel based on the provided search criteria. The search can be performed using the name of the sales channel
Parameters
authorization
string
Optional
query
string
Optional
Provide application name
Response
200
400
404
Success
ApplicationResponse
application
object (Application)
Optional
Application
_id
string
Optional
The unique identifier (24-digit Mongo Object ID) of the current sales channel supported currency
is_active
boolean
Optional
Shows currency is enabled or not in current sales channel
name
string
Optional
Name of the currency, e.g. Indian Rupee
code
string
Optional
3-character currency code, e.g. INR, USD, EUR.
created_at
string
Optional
ISO 8601 timestamp of sales channel support currency creation
updated_at
string
Optional
ISO 8601 timestamp of sales channel support currency updation
decimal_digits
integer
| int32
Optional
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
Optional
Unique symbol for identifying the currency, e.g. ₹
Examples
Parameters
authorization:
"value"
query:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...