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
company_id
string
Required
Id of the company associated to brand that is to be viewed.
brand_id
string
Required
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)
UserSerializer
banner
object (BrandBannerSerializer)
BrandBannerSerializer
name
string
_custom_json
object
verified_on
string
| date-time
created_by
object (UserSerializer)
UserSerializer
created_on
string
| date-time
warnings
object
_locale_language
object
mode
string
synonyms
array of string
modified_on
string
| date-time
uid
integer
reject_reason
string
stage
string
verified_by
object (UserSerializer)
UserSerializer
slug_key
string
logo
string
description
string
Examples
Parameters
companyId:
"value"
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
company_id
string
Required
Id of the company associated to brand that is to be viewed.
brand_id
string
Required
Id of the brand to be viewed.
Request body
_custom_json
object
_locale_language
object
synonyms
array of string
company_id
integer
description
string
logo
string
Required
brand_tier
string
Enum
uid
integer
banner
object (BrandBannerSerializer)
Required
BrandBannerSerializer
name
string
Required
Response
200
4XX
Returns a success response
ProfileSuccessResponse
uid
integer
message
string
success
boolean
Examples
Parameters
companyId:
"value"
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
company_id
string
Required
Id of the company.
Request body
_custom_json
object
_locale_language
object
synonyms
array of string
company_id
integer
description
string
logo
string
Required
brand_tier
string
Enum
uid
integer
banner
object (BrandBannerSerializer)
Required
BrandBannerSerializer
name
string
Required
slug_key
string
Response
200
4XX
Returns a success response
ProfileSuccessResponse
uid
integer
message
string
success
boolean
Examples
Parameters
companyId:
"value"
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
company_id
string
Required
Id of the company.
page_no
integer
The page number to navigate through the given set of results
Default Value : 1
page_size
integer
Number of items to retrieve in each page. Default is 10.
Default Value : 20
q
string
Search term for name.
Response
200
4XX
Brand object. See example below or refer `CompanyBrandListSerializer` for details
CompanyBrandListSerializer
items
array of object (CompanyBrandSerializer)
Array of CompanyBrandSerializer
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
pageNo:
1
pageSize:
1
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
company_id
string
Required
Id of the company inside which the brand is to be mapped.
Request body
uid
integer
brands
array of integer
Required
company
integer
Required
Response
200
4XX
Returns a success response
ProfileSuccessResponse
uid
integer
message
string
success
boolean
Examples
Parameters
companyId:
"value"
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 profile
View the company profile of the seller account.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
Response
200
4XX
Company profile object. See example below or refer `GetCompanyProfileSerializerResponse` for details
GetCompanyProfileSerializerResponse
business_info
string
taxes
array of object (CompanyTaxesSerializer)
Array of CompanyTaxesSerializer
business_type
string
name
string
_custom_json
object
verified_on
string
| date-time
created_by
object (UserSerializer)
UserSerializer
created_on
string
| date-time
warnings
object
business_details
object (BusinessDetails)
BusinessDetails
mode
string
contact_details
object (ContactDetails)
ContactDetails
business_country_info
object (BusinessCountryInfo)
BusinessCountryInfo
modified_on
string
| date-time
uid
integer
franchise_enabled
boolean
stage
string
company_type
string
documents
array of object (Document)
Array of Document
addresses
array of object (GetAddressSerializer)
Array of GetAddressSerializer
verified_by
object (UserSerializer)
UserSerializer
notification_emails
array of string
modified_by
object (UserSerializer)
UserSerializer
Examples
Parameters
companyId:
"value"
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
Request body
franchise_enabled
boolean
business_info
string
warnings
object
company_type
string
_custom_json
object
taxes
array of object (CompanyTaxesSerializer1)
Array of CompanyTaxesSerializer1
business_details
object (BusinessDetails)
BusinessDetails
documents
array of object (Document)
Array of Document
business_type
string
addresses
array of object (CreateUpdateAddressSerializer)
Array of CreateUpdateAddressSerializer
notification_emails
array of string
contact_details
object (ContactDetails)
ContactDetails
reject_reason
string
name
string
Response
200
4XX
Returns a success message
ProfileSuccessResponse
uid
integer
message
string
success
boolean
Examples
Parameters
companyId:
"value"
body:
body
Was this section helpful?
PATCH
Loading...
Response
Loading...
Update company profile
updateCompany
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
POST
# Create company stores
GET
# Get company stores
PUT
# Update company stores
POST
# Bulk create company stores
GET
# Get company store tags
POST
Create company stores
Create a new location associated to a company.
Parameters
company_id
string
Required
Id of the company inside which the location is to be created.
Request body
code
string
Required
gst_credentials
object (InvoiceDetailsSerializer)
InvoiceDetailsSerializer
contact_numbers
array of object (SellerPhoneNumber)
Array of SellerPhoneNumber
name
string
Required
_custom_json
object
warnings
object
address
object (AddressSerializer)
Required
AddressSerializer
company
integer
Required
store_type
string
manager
object (LocationManagerSerializer)
LocationManagerSerializer
auto_invoice
boolean
Default Value : false
uid
integer
timing
array of object (LocationDayWiseSerializer)
Array of LocationDayWiseSerializer
stage
string
documents
array of object (Document)
Required
Array of Document
credit_note
boolean
Default Value : false
holiday
array of object (HolidaySchemaSerializer)
Array of HolidaySchemaSerializer
product_return_config
object (ProductReturnConfigSerializer)
ProductReturnConfigSerializer
display_name
string
Required
notification_emails
array of string
tags
array of string
Default Value :
default_order_acceptance_timing
boolean
Flag to set order_acceptance_timing as default timing
order_acceptance_timing
array of object (LocationDayWiseSerializer)
Order acceptance timing of the store
Array of LocationDayWiseSerializer
avg_order_processing_time
object (AverageOrderProcessingTime)
AverageOrderProcessingTime
bulk_shipment
boolean
Default Value : false
auto_assign_courier_partner
boolean
Default Value : true
Response
200
4XX
Returns a success response
ProfileSuccessResponse
uid
integer
message
string
success
boolean
Examples
Parameters
companyId:
"value"
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
company_id
string
Required
Id of the company inside which the location lies.
location_id
string
Required
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
contact_numbers
array of object (SellerPhoneNumber)
Array of SellerPhoneNumber
gst_credentials
object (InvoiceDetailsSerializer)
InvoiceDetailsSerializer
name
string
_custom_json
object
verified_on
string
| date-time
created_by
object (UserSerializer)
UserSerializer
created_on
string
| date-time
company
object (GetCompanySerializer)
GetCompanySerializer
address
object (GetAddressSerializer)
GetAddressSerializer
warnings
object
store_type
string
manager
object (LocationManagerSerializer)
LocationManagerSerializer
auto_invoice
boolean
modified_on
string
| date-time
uid
integer
timing
array of object (LocationDayWiseSerializer)
Array of LocationDayWiseSerializer
stage
string
documents
array of object (Document)
Array of Document
credit_note
boolean
holiday
array of object (HolidaySchemaSerializer)
Array of HolidaySchemaSerializer
display_name
string
product_return_config
object (ProductReturnConfigSerializer)
ProductReturnConfigSerializer
verified_by
object (UserSerializer)
UserSerializer
notification_emails
array of string
modified_by
object (UserSerializer)
UserSerializer
tags
array of string
default_order_acceptance_timing
boolean
order_acceptance_timing
array of object (LocationDayWiseSerializer)
Array of LocationDayWiseSerializer
avg_order_processing_time
object (AverageOrderProcessingTime)
AverageOrderProcessingTime
bulk_shipment
boolean
auto_assign_courier_partner
boolean
Examples
Parameters
companyId:
"value"
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
company_id
string
Required
Id of the company inside which the location is to be created.
location_id
string
Required
Id of the location which you want to edit.
Request body
code
string
Required
gst_credentials
object (InvoiceDetailsSerializer)
InvoiceDetailsSerializer
contact_numbers
array of object (SellerPhoneNumber)
Array of SellerPhoneNumber
name
string
Required
_custom_json
object
warnings
object
address
object (AddressSerializer)
Required
AddressSerializer
company
integer
Required
store_type
string
manager
object (LocationManagerSerializer)
LocationManagerSerializer
auto_invoice
boolean
Default Value : false
uid
integer
timing
array of object (LocationDayWiseSerializer)
Array of LocationDayWiseSerializer
stage
string
documents
array of object (Document)
Required
Array of Document
credit_note
boolean
Default Value : false
holiday
array of object (HolidaySchemaSerializer)
Array of HolidaySchemaSerializer
product_return_config
object (ProductReturnConfigSerializer)
ProductReturnConfigSerializer
display_name
string
Required
notification_emails
array of string
tags
array of string
Default Value :
default_order_acceptance_timing
boolean
Flag to set order_acceptance_timing as default timing
order_acceptance_timing
array of object (LocationDayWiseSerializer)
Order acceptance timing of the store
Array of LocationDayWiseSerializer
avg_order_processing_time
object (AverageOrderProcessingTime)
AverageOrderProcessingTime
bulk_shipment
boolean
Default Value : false
auto_assign_courier_partner
boolean
Default Value : true
Response
200
4XX
Returns a success response
ProfileSuccessResponse
uid
integer
message
string
success
boolean
Examples
Parameters
companyId:
"value"
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
company_id
string
Required
Id of the company inside which the location is to be created.
Request body
data
array of object (LocationSerializer)
Array of LocationSerializer
Response
200
4XX
Returns a success response
ProfileSuccessResponse
uid
integer
message
string
success
boolean
Examples
Parameters
companyId:
"value"
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
company_id
integer
Required
Id of the company inside which the location is to be created.
Response
200
4XX
Tags list. See example below or refer `StoreTagsResponseSchema` for details
StoreTagsResponseSchema
tags
array of string
success
boolean
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...