CompanyProfile
Manages seller onboarding, provides insights into performance, brand information, and selling locations for enhanced visibility and reach.
Brand
The Brand resource encompasses operations related to managing and showcasing branding information for products or services within a business. This resource provides functionalities to retrieve specific brand details, edit and update brand information, create new brands, and list all available brands associated with the business. Brand has access including brand name, logo, description, and other relevant information, and make edits to ensure accuracy and currency. Brand can introduce new product lines or brand identities and facilitate navigation and access to branding information. Overall, the Brand resource streamlines brand management processes, allowing businesses to effectively showcase their brand identities and maintain consistency across their products or services.
Operations
GET
# Get a brand
PUT
# update brand
POST
# Create brand
GET
# list company brands
POST
# Create company-brand mapping
GET
Get a brand
Retrieve detailed information about a specific brand associated to a particular company.
Parameters
brandId
string
Id of the brand to be viewed.
Response
200
4XX
Brand object. See example below or refer `GetBrandResponseSerializer` for details
GetBrandResponseSerializer
modified_by
object (UserSerializer)
Optional
UserSerializer
banner
object (BrandBannerSerializer)
Optional
BrandBannerSerializer
name
string
_custom_json
object
Optional
verified_on
string
| date-time
Optional
created_by
object (UserSerializer)
Optional
UserSerializer
created_on
string
| date-time
Optional
warnings
object
Optional
_locale_language
object
Optional
mode
string
Optional
synonyms
array of string
Optional
modified_on
string
| date-time
Optional
uid
integer
Optional
reject_reason
string
Optional
stage
string
Optional
verified_by
object (UserSerializer)
Optional
UserSerializer
slug_key
string
Optional
logo
string
Optional
description
string
Optional
Examples
Parameters
brandId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get a brand
getBrand
PUT
update brand
Modify brand details and meta of a specific brand.
Parameters
brandId
string
Id of the brand to be viewed.
body
object (UpdateBrandRequestSerializer)
Brand object that needs to be updated.
UpdateBrandRequestSerializer
_custom_json
object
Optional
_locale_language
object
Optional
synonyms
array of string
Optional
company_id
integer
Optional
description
string
Optional
logo
string
brand_tier
string
Optional
Enum
uid
integer
Optional
banner
object (BrandBannerSerializer)
BrandBannerSerializer
name
string
Response
200
4XX
Returns a success response
ProfileSuccessResponse
uid
integer
Optional
message
string
Optional
success
boolean
Optional
Examples
Parameters
brandId:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
update brand
editBrand
POST
Create brand
Allows to create a brand associated to a company.
Parameters
body
object (CreateBrandRequestSerializer)
Brand object that needs to be added.
CreateBrandRequestSerializer
_custom_json
object
Optional
_locale_language
object
Optional
synonyms
array of string
Optional
company_id
integer
Optional
description
string
Optional
logo
string
brand_tier
string
Optional
Enum
uid
integer
Optional
banner
object (BrandBannerSerializer)
BrandBannerSerializer
name
string
slug_key
string
Optional
Response
200
4XX
Returns a success response
ProfileSuccessResponse
uid
integer
Optional
message
string
Optional
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create brand
createBrand
GET
list company brands
Retrieve a list of available brands associated to a company.
Parameters
pageNo
integer
Optional
The page number to navigate through the given set of results
Default Value : 1
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 10.
Default Value : 20
q
string
Optional
Search term for name.
Response
200
4XX
Brand object. See example below or refer `CompanyBrandListSerializer` for details
CompanyBrandListSerializer
items
array of object (CompanyBrandSerializer)
Optional
Array of CompanyBrandSerializer
page
object (Page)
Optional
Page
Examples
Parameters
pageNo:
0
pageSize:
0
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
list company brands
getBrands
POST
Create company-brand mapping
Establish a mapping between a company and a brand.
Parameters
body
object (CompanyBrandPostRequestSerializer)
Companybrand object.
CompanyBrandPostRequestSerializer
uid
integer
Optional
brands
array of integer
company
integer
Response
200
4XX
Returns a success response
ProfileSuccessResponse
uid
integer
Optional
message
string
Optional
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create company-brand mapping
createCompanyBrandMapping
Seller Onboarding
The Seller Onboarding used for management of seller accounts and provide insights into company metrics related to brand and store status, verified and unverified products, as well as company and store documents. Seller Onboarding can access company metrics, gaining valuable information on the performance and compliance status of seller accounts. Seller Onboarding accrss company profiles associated with seller accounts, allowing for a deeper understanding of the business, products, and services offered. Seller Onboarding enables users to edit and update company profiles directly, ensuring that the information reflected across platforms remains accurate and up-to-date.
Operations
GET
# Get company profile
PATCH
# Update company profile
GET
# Get company metrics
GET
Get company profile
View the company profile of the seller account.
Parameters
No Parameters
Response
200
4XX
Company profile object. See example below or refer `GetCompanyProfileSerializerResponse` for details
GetCompanyProfileSerializerResponse
business_info
string
Optional
taxes
array of object (CompanyTaxesSerializer)
Optional
Array of CompanyTaxesSerializer
business_type
string
Optional
name
string
Optional
_custom_json
object
Optional
verified_on
string
| date-time
Optional
created_by
object (UserSerializer)
Optional
UserSerializer
created_on
string
| date-time
Optional
warnings
object
Optional
business_details
object (BusinessDetails)
Optional
BusinessDetails
mode
string
Optional
contact_details
object (ContactDetails)
Optional
ContactDetails
business_country_info
object (BusinessCountryInfo)
Optional
BusinessCountryInfo
modified_on
string
| date-time
Optional
uid
integer
franchise_enabled
boolean
Optional
stage
string
Optional
company_type
string
documents
array of object (Document)
Optional
Array of Document
addresses
array of object (GetAddressSerializer)
Optional
Array of GetAddressSerializer
verified_by
object (UserSerializer)
Optional
UserSerializer
notification_emails
array of string
Optional
modified_by
object (UserSerializer)
Optional
UserSerializer
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get company profile
cbsOnboardGet
PATCH
Update company profile
Allows to edit the company profile of the seller account.
Parameters
body
object (UpdateCompany)
Onboard object that needs to be added.
UpdateCompany
franchise_enabled
boolean
Optional
business_info
string
Optional
warnings
object
Optional
company_type
string
Optional
_custom_json
object
Optional
taxes
array of object (CompanyTaxesSerializer1)
Optional
Array of CompanyTaxesSerializer1
business_details
object (BusinessDetails)
Optional
BusinessDetails
documents
array of object (Document)
Optional
Array of Document
business_type
string
Optional
addresses
array of object (CreateUpdateAddressSerializer)
Optional
Array of CreateUpdateAddressSerializer
notification_emails
array of string
Optional
contact_details
object (ContactDetails)
Optional
ContactDetails
reject_reason
string
Optional
name
string
Optional
Response
200
4XX
Returns a success message
ProfileSuccessResponse
uid
integer
Optional
message
string
Optional
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
PATCH
Loading...
Response
Loading...
Update company profile
updateCompany
GET
Get company metrics
Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents.
Parameters
No Parameters
Response
200
4XX
Metrics response object. See example below or refer `MetricsSerializer` for details
MetricsSerializer
stage
string
Optional
store
object (DocumentsObj)
Optional
DocumentsObj
company_documents
object (DocumentsObj)
Optional
DocumentsObj
store_documents
object (DocumentsObj)
Optional
DocumentsObj
product
object (DocumentsObj)
Optional
DocumentsObj
uid
integer
Optional
brand
object (DocumentsObj)
Optional
DocumentsObj
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get company metrics
getCompanyMetrics
Selling Location
Handle company specific location-related operations, including creating locations in bulk, updating and retrieving location details and also creating and retrieving location tags to categorize and manage locations effectively.
Operations
GET
# Get company specific stores
POST
# Create company stores
GET
# Get company stores
PUT
# Update company stores
POST
# Bulk create company stores
GET
# Get company store tags
GET
Get company specific stores
Retrieve a list of locations associated with the company.
Parameters
storeType
string
Optional
Helps to sort the location list on the basis of location type.
q
string
Optional
Query that is to be searched.
stage
string
Optional
to filter companies on basis of verified or unverified companies.
pageNo
integer
Optional
The page number to navigate through the given set of results
Default Value : 1
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 10.
Default Value : 20
locationIds
array of integer
Optional
Helps to filter stores on the basis of uids.
types
array of string
Optional
Helps to get the location list on the basis of multiple location type.
tags
array of string
Optional
Helps to get the location list on the basis of multiple location tag.
Response
200
4XX
Company profile object. See example below or refer `LocationListSerializer` for details
LocationListSerializer
items
array of object (GetLocationSerializer)
Optional
Array of GetLocationSerializer
page
object (Page)
Optional
Page
Examples
Parameters
storeType:
"value"
q:
"value"
stage:
"value"
pageNo:
0
pageSize:
0
locationIds:
0,1
types:
"lorem","ipsum"
tags:
"lorem","ipsum"
Was this section helpful?
GET
Loading...
Response
Loading...
Get company specific stores
getLocations
POST
Create company stores
Create a new location associated to a company.
Parameters
body
object (LocationSerializer)
Location object that needs to be added.
LocationSerializer
code
string
gst_credentials
object (InvoiceDetailsSerializer)
Optional
InvoiceDetailsSerializer
contact_numbers
array of object (SellerPhoneNumber)
Optional
Array of SellerPhoneNumber
name
string
_custom_json
object
Optional
warnings
object
Optional
address
object (AddressSerializer)
AddressSerializer
company
integer
store_type
string
Optional
manager
object (LocationManagerSerializer)
Optional
LocationManagerSerializer
auto_invoice
boolean
Optional
Default Value : false
uid
integer
Optional
timing
array of object (LocationDayWiseSerializer)
Optional
Array of LocationDayWiseSerializer
stage
string
Optional
documents
array of object (Document)
Array of Document
credit_note
boolean
Optional
Default Value : false
holiday
array of object (HolidaySchemaSerializer)
Optional
Array of HolidaySchemaSerializer
product_return_config
object (ProductReturnConfigSerializer)
Optional
ProductReturnConfigSerializer
display_name
string
notification_emails
array of string
Optional
tags
array of string
Optional
Default Value :
default_order_acceptance_timing
boolean
Optional
Flag to set order_acceptance_timing as default timing
order_acceptance_timing
array of object (LocationDayWiseSerializer)
Optional
Order acceptance timing of the store
Array of LocationDayWiseSerializer
avg_order_processing_time
object (AverageOrderProcessingTime)
Optional
AverageOrderProcessingTime
bulk_shipment
boolean
Optional
Default Value : false
auto_assign_courier_partner
boolean
Optional
Default Value : true
Response
200
4XX
Returns a success response
ProfileSuccessResponse
uid
integer
Optional
message
string
Optional
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create company stores
createLocation
GET
Get company stores
Retrive detailed information about a specific location associated to a specific company.
Parameters
locationId
string
Id of the location which you want to view.
Response
200
4XX
Brand object. See example below or refer `GetLocationSerializer` for details
GetLocationSerializer
code
string
phone_number
string
Optional
contact_numbers
array of object (SellerPhoneNumber)
Optional
Array of SellerPhoneNumber
gst_credentials
object (InvoiceDetailsSerializer)
Optional
InvoiceDetailsSerializer
name
string
_custom_json
object
Optional
verified_on
string
| date-time
Optional
created_by
object (UserSerializer)
Optional
UserSerializer
created_on
string
| date-time
Optional
company
object (GetCompanySerializer)
Optional
GetCompanySerializer
address
object (GetAddressSerializer)
GetAddressSerializer
warnings
object
Optional
store_type
string
Optional
manager
object (LocationManagerSerializer)
Optional
LocationManagerSerializer
auto_invoice
boolean
Optional
modified_on
string
| date-time
Optional
uid
integer
Optional
timing
array of object (LocationDayWiseSerializer)
Optional
Array of LocationDayWiseSerializer
stage
string
Optional
documents
array of object (Document)
Optional
Array of Document
credit_note
boolean
Optional
holiday
array of object (HolidaySchemaSerializer)
Optional
Array of HolidaySchemaSerializer
display_name
string
product_return_config
object (ProductReturnConfigSerializer)
Optional
ProductReturnConfigSerializer
verified_by
object (UserSerializer)
Optional
UserSerializer
notification_emails
array of string
Optional
modified_by
object (UserSerializer)
Optional
UserSerializer
tags
array of string
Optional
default_order_acceptance_timing
boolean
Optional
order_acceptance_timing
array of object (LocationDayWiseSerializer)
Optional
Array of LocationDayWiseSerializer
avg_order_processing_time
object (AverageOrderProcessingTime)
Optional
AverageOrderProcessingTime
bulk_shipment
boolean
Optional
auto_assign_courier_partner
boolean
Optional
Examples
Parameters
locationId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get company stores
getLocationDetail
PUT
Update company stores
Allows to edit a location associated to a company.
Parameters
locationId
string
Id of the location which you want to edit.
body
object (LocationSerializer)
Location object that needs to be added.
LocationSerializer
code
string
gst_credentials
object (InvoiceDetailsSerializer)
Optional
InvoiceDetailsSerializer
contact_numbers
array of object (SellerPhoneNumber)
Optional
Array of SellerPhoneNumber
name
string
_custom_json
object
Optional
warnings
object
Optional
address
object (AddressSerializer)
AddressSerializer
company
integer
store_type
string
Optional
manager
object (LocationManagerSerializer)
Optional
LocationManagerSerializer
auto_invoice
boolean
Optional
Default Value : false
uid
integer
Optional
timing
array of object (LocationDayWiseSerializer)
Optional
Array of LocationDayWiseSerializer
stage
string
Optional
documents
array of object (Document)
Array of Document
credit_note
boolean
Optional
Default Value : false
holiday
array of object (HolidaySchemaSerializer)
Optional
Array of HolidaySchemaSerializer
product_return_config
object (ProductReturnConfigSerializer)
Optional
ProductReturnConfigSerializer
display_name
string
notification_emails
array of string
Optional
tags
array of string
Optional
Default Value :
default_order_acceptance_timing
boolean
Optional
Flag to set order_acceptance_timing as default timing
order_acceptance_timing
array of object (LocationDayWiseSerializer)
Optional
Order acceptance timing of the store
Array of LocationDayWiseSerializer
avg_order_processing_time
object (AverageOrderProcessingTime)
Optional
AverageOrderProcessingTime
bulk_shipment
boolean
Optional
Default Value : false
auto_assign_courier_partner
boolean
Optional
Default Value : true
Response
200
4XX
Returns a success response
ProfileSuccessResponse
uid
integer
Optional
message
string
Optional
success
boolean
Optional
Examples
Parameters
locationId:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update company stores
updateLocation
POST
Bulk create company stores
Allows to create locations in bulk at once associated to a company
Parameters
body
object (BulkLocationSerializer)
Location object that needs to be added.
BulkLocationSerializer
data
array of object (LocationSerializer)
Optional
Array of LocationSerializer
Response
200
4XX
Returns a success response
ProfileSuccessResponse
uid
integer
Optional
message
string
Optional
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Bulk create company stores
createLocationBulk
GET
Get company store tags
Retrieve all the distinct tags associated to a company location.
Parameters
No Parameters
Response
200
4XX
Tags list. See example below or refer `StoreTagsResponseSchema` for details
StoreTagsResponseSchema
tags
array of string
Optional
success
boolean
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...