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
/service/platform/company-profile/v1.0/company/{company_id}/brand/{brand_id}
# Get a brand
PUT
/service/platform/company-profile/v1.0/company/{company_id}/brand/{brand_id}
# update brand
POST
/service/platform/company-profile/v1.0/company/{company_id}/brand/
# Create brand
GET
/service/platform/company-profile/v1.0/company/{company_id}/company-brand
# list company brands
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
user_id
string
contact
string
username
string
banner
object (BrandBannerSerializer)
BrandBannerSerializer
portrait
string
landscape
string
name
string
_custom_json
object
verified_on
string
| date-time
created_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
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
user_id
string
contact
string
username
string
slug_key
string
logo
string
description
string
Examples
Parameters
company_id:
"value"
brand_id:
"value"
GET
/service/platform/company-profile/v1.0/company/{company_id}/brand/{brand_id}
Loading...
Response
Loading...
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
portrait
string
Required
landscape
string
Required
name
string
Required
Response
200
4XX
Returns a success response
ProfileSuccessResponse
uid
integer
message
string
success
boolean
Examples
Parameters
company_id:
"value"
brand_id:
"value"
body:
body
PUT
/service/platform/company-profile/v1.0/company/{company_id}/brand/{brand_id}
Loading...
Response
Loading...
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
portrait
string
Required
landscape
string
Required
name
string
Required
slug_key
string
Response
200
4XX
Returns a success response
ProfileSuccessResponse
uid
integer
message
string
success
boolean
Examples
Parameters
company_id:
"value"
body:
body
POST
/service/platform/company-profile/v1.0/company/{company_id}/brand/
Loading...
Response
Loading...
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
stage
string
verified_on
string
| date-time
verified_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
created_on
string
| date-time
created_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
company
object (CompanySerializer)
CompanySerializer
stage
string
_custom_json
object
verified_on
string
| date-time
verified_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
created_on
string
| date-time
created_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
company_type
string
modified_on
string
| date-time
market_channels
array of string
business_type
string
addresses
array of object (GetAddressSerializer)
Array of GetAddressSerializer
landmark
string
country_code
string
pincode
integer
address_type
string
longitude
number
| value >= -180
| value <= 180
country
string
address2
string
state
string
state_code
string
sector
string
address1
string
city
string
latitude
number
| value >= -90
| value <= 90
notification_emails
array of string
details
object (CompanyDetails)
CompanyDetails
socials
array of object (CompanySocialAccounts)
Array of CompanySocialAccounts
name
string
url
string
website_url
string
business_country_info
object (BusinessCountryInfo)
BusinessCountryInfo
country_code
string
country
string
currency
object (CountryCurrencyInfo)
CountryCurrencyInfo
code
string
symbol
string
name
string
timezone
string
uid
integer
reject_reason
string
name
string
modified_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
warnings
object
modified_on
string
| date-time
uid
integer
reject_reason
string
brand
object (GetBrandResponseSerializer)
GetBrandResponseSerializer
modified_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
banner
object (BrandBannerSerializer)
BrandBannerSerializer
portrait
string
landscape
string
name
string
_custom_json
object
verified_on
string
| date-time
created_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
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
user_id
string
contact
string
username
string
slug_key
string
logo
string
description
string
modified_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
"value"
page_no:
1
page_size:
1
q:
"value"
GET
/service/platform/company-profile/v1.0/company/{company_id}/company-brand
Loading...
Response
Loading...

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
/service/platform/company-profile/v1.0/company/{company_id}
# Get company profile
PATCH
/service/platform/company-profile/v1.0/company/{company_id}
# 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
effective_date
string
| date-time
rate
number
enable
boolean
business_type
string
name
string
_custom_json
object
verified_on
string
| date-time
created_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
created_on
string
| date-time
warnings
object
business_details
object (BusinessDetails)
BusinessDetails
website
object (Website)
Website
url
string
| url
mode
string
contact_details
object (ContactDetails)
ContactDetails
emails
array of string
phone
array of object (SellerPhoneNumber)
Array of SellerPhoneNumber
country_code
integer
number
string
business_country_info
object (BusinessCountryInfo)
BusinessCountryInfo
country_code
string
country
string
currency
object (CountryCurrencyInfo)
CountryCurrencyInfo
code
string
symbol
string
name
string
timezone
string
modified_on
string
| date-time
uid
integer
franchise_enabled
boolean
stage
string
company_type
string
documents
array of object (Document)
Array of Document
value
string
legal_name
string
verified
boolean
type
string
url
string
addresses
array of object (GetAddressSerializer)
Array of GetAddressSerializer
landmark
string
country_code
string
pincode
integer
address_type
string
longitude
number
| value >= -180
| value <= 180
country
string
address2
string
state
string
state_code
string
sector
string
address1
string
city
string
latitude
number
| value >= -90
| value <= 90
verified_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
notification_emails
array of string
modified_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
Examples
Parameters
company_id:
"value"
GET
/service/platform/company-profile/v1.0/company/{company_id}
Loading...
Response
Loading...
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
effective_date
string
| date-time
rate
number
enable
boolean
business_details
object (BusinessDetails)
BusinessDetails
website
object (Website)
Website
url
string
| url
documents
array of object (Document)
Array of Document
value
string
Required
legal_name
string
verified
boolean
type
string
Required
url
string
business_type
string
addresses
array of object (CreateUpdateAddressSerializer)
Array of CreateUpdateAddressSerializer
landmark
string
country_code
string
pincode
integer
Required
address_type
string
Required
Enum
longitude
number
| value >= -180
| value <= 180
Required
country
string
Required
address2
string
state
string
Required
address1
string
Required
city
string
Required
latitude
number
| value >= -90
| value <= 90
Required
notification_emails
array of string
contact_details
object (ContactDetails)
ContactDetails
emails
array of string
phone
array of object (SellerPhoneNumber)
Array of SellerPhoneNumber
country_code
integer
Required
number
string
Required
reject_reason
string
name
string
Response
200
4XX
Returns a success message
ProfileSuccessResponse
uid
integer
message
string
success
boolean
Examples
Parameters
company_id:
"value"
body:
body
PATCH
/service/platform/company-profile/v1.0/company/{company_id}
Loading...
Response
Loading...

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
/service/platform/company-profile/v1.0/company/{company_id}/location
# Create company stores
GET
/service/platform/company-profile/v1.0/company/{company_id}/location/{location_id}
# Get company stores
PUT
/service/platform/company-profile/v1.0/company/{company_id}/location/{location_id}
# Update company stores
POST
/service/platform/company-profile/v1.0/company/{company_id}/location/bulk
# Bulk create company stores
GET
/service/platform/company-profile/v1.0/company/{company_id}/location/tags
# 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
e_invoice
object (InvoiceCredSerializer)
InvoiceCredSerializer
username
string
enabled
boolean
password
string
e_waybill
object (InvoiceCredSerializer)
InvoiceCredSerializer
username
string
enabled
boolean
password
string
contact_numbers
array of object (SellerPhoneNumber)
Array of SellerPhoneNumber
country_code
integer
Required
number
string
Required
name
string
Required
_custom_json
object
warnings
object
address
object (AddressSerializer)
Required
AddressSerializer
landmark
string
country_code
string
Required
pincode
integer
address_type
string
longitude
number
| value >= -180
| value <= 180
Required
country
string
address2
string
state
string
sector
string
state_code
string
address1
string
city
string
latitude
number
| value >= -90
| value <= 90
Required
company
integer
Required
store_type
string
manager
object (LocationManagerSerializer)
LocationManagerSerializer
email
string
| email
mobile_no
object (SellerPhoneNumber)
Required
SellerPhoneNumber
country_code
integer
Required
number
string
Required
name
string
auto_invoice
boolean
Default Value : false
uid
integer
timing
array of object (LocationDayWiseSerializer)
Array of LocationDayWiseSerializer
open
boolean
Required
weekday
string
Required
Enum
opening
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
Required
minute
integer
Required
closing
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
Required
minute
integer
Required
stage
string
documents
array of object (Document)
Required
Array of Document
value
string
Required
legal_name
string
verified
boolean
type
string
Required
url
string
credit_note
boolean
Default Value : false
holiday
array of object (HolidaySchemaSerializer)
Array of HolidaySchemaSerializer
date
object (HolidayDateSerializer)
Required
HolidayDateSerializer
end_date
string
| date-time
Required
start_date
string
| date-time
Required
title
string
Required
holiday_type
string
Required
Enum
product_return_config
object (ProductReturnConfigSerializer)
ProductReturnConfigSerializer
on_same_store
boolean
store_uid
integer
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
open
boolean
Required
weekday
string
Required
Enum
opening
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
Required
minute
integer
Required
closing
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
Required
minute
integer
Required
avg_order_processing_time
object (AverageOrderProcessingTime)
AverageOrderProcessingTime
duration
integer
duration_type
string
Enum
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
company_id:
"value"
body:
body
POST
/service/platform/company-profile/v1.0/company/{company_id}/location
Loading...
Response
Loading...
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
country_code
integer
number
string
gst_credentials
object (InvoiceDetailsSerializer)
InvoiceDetailsSerializer
e_invoice
object (InvoiceCredSerializer)
InvoiceCredSerializer
username
string
enabled
boolean
password
string
e_waybill
object (InvoiceCredSerializer)
InvoiceCredSerializer
username
string
enabled
boolean
password
string
name
string
_custom_json
object
verified_on
string
| date-time
created_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
created_on
string
| date-time
company
object (GetCompanySerializer)
GetCompanySerializer
stage
string
verified_on
string
| date-time
verified_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
created_on
string
| date-time
created_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
company_type
string
modified_on
string
| date-time
business_type
string
addresses
array of object (GetAddressSerializer)
Array of GetAddressSerializer
landmark
string
country_code
string
pincode
integer
address_type
string
longitude
number
| value >= -180
| value <= 180
country
string
address2
string
state
string
state_code
string
sector
string
address1
string
city
string
latitude
number
| value >= -90
| value <= 90
uid
integer
reject_reason
string
name
string
modified_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
address
object (GetAddressSerializer)
GetAddressSerializer
landmark
string
country_code
string
pincode
integer
address_type
string
longitude
number
| value >= -180
| value <= 180
country
string
address2
string
state
string
state_code
string
sector
string
address1
string
city
string
latitude
number
| value >= -90
| value <= 90
warnings
object
store_type
string
manager
object (LocationManagerSerializer)
LocationManagerSerializer
email
string
| email
mobile_no
object (SellerPhoneNumber)
SellerPhoneNumber
country_code
integer
number
string
name
string
auto_invoice
boolean
modified_on
string
| date-time
uid
integer
timing
array of object (LocationDayWiseSerializer)
Array of LocationDayWiseSerializer
open
boolean
weekday
string
Enum
opening
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
minute
integer
closing
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
minute
integer
stage
string
documents
array of object (Document)
Array of Document
value
string
legal_name
string
verified
boolean
type
string
url
string
credit_note
boolean
holiday
array of object (HolidaySchemaSerializer)
Array of HolidaySchemaSerializer
date
object (HolidayDateSerializer)
HolidayDateSerializer
end_date
string
| date-time
start_date
string
| date-time
title
string
holiday_type
string
Enum
display_name
string
product_return_config
object (ProductReturnConfigSerializer)
ProductReturnConfigSerializer
on_same_store
boolean
store_uid
integer
verified_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
notification_emails
array of string
modified_by
object (UserSerializer)
UserSerializer
user_id
string
contact
string
username
string
tags
array of string
default_order_acceptance_timing
boolean
order_acceptance_timing
array of object (LocationDayWiseSerializer)
Array of LocationDayWiseSerializer
open
boolean
weekday
string
Enum
opening
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
minute
integer
closing
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
minute
integer
avg_order_processing_time
object (AverageOrderProcessingTime)
AverageOrderProcessingTime
duration
integer
duration_type
string
Enum
bulk_shipment
boolean
auto_assign_courier_partner
boolean
Examples
Parameters
company_id:
"value"
location_id:
"value"
GET
/service/platform/company-profile/v1.0/company/{company_id}/location/{location_id}
Loading...
Response
Loading...
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
e_invoice
object (InvoiceCredSerializer)
InvoiceCredSerializer
username
string
enabled
boolean
password
string
e_waybill
object (InvoiceCredSerializer)
InvoiceCredSerializer
username
string
enabled
boolean
password
string
contact_numbers
array of object (SellerPhoneNumber)
Array of SellerPhoneNumber
country_code
integer
Required
number
string
Required
name
string
Required
_custom_json
object
warnings
object
address
object (AddressSerializer)
Required
AddressSerializer
landmark
string
country_code
string
Required
pincode
integer
address_type
string
longitude
number
| value >= -180
| value <= 180
Required
country
string
address2
string
state
string
sector
string
state_code
string
address1
string
city
string
latitude
number
| value >= -90
| value <= 90
Required
company
integer
Required
store_type
string
manager
object (LocationManagerSerializer)
LocationManagerSerializer
email
string
| email
mobile_no
object (SellerPhoneNumber)
Required
SellerPhoneNumber
country_code
integer
Required
number
string
Required
name
string
auto_invoice
boolean
Default Value : false
uid
integer
timing
array of object (LocationDayWiseSerializer)
Array of LocationDayWiseSerializer
open
boolean
Required
weekday
string
Required
Enum
opening
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
Required
minute
integer
Required
closing
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
Required
minute
integer
Required
stage
string
documents
array of object (Document)
Required
Array of Document
value
string
Required
legal_name
string
verified
boolean
type
string
Required
url
string
credit_note
boolean
Default Value : false
holiday
array of object (HolidaySchemaSerializer)
Array of HolidaySchemaSerializer
date
object (HolidayDateSerializer)
Required
HolidayDateSerializer
end_date
string
| date-time
Required
start_date
string
| date-time
Required
title
string
Required
holiday_type
string
Required
Enum
product_return_config
object (ProductReturnConfigSerializer)
ProductReturnConfigSerializer
on_same_store
boolean
store_uid
integer
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
open
boolean
Required
weekday
string
Required
Enum
opening
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
Required
minute
integer
Required
closing
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
Required
minute
integer
Required
avg_order_processing_time
object (AverageOrderProcessingTime)
AverageOrderProcessingTime
duration
integer
duration_type
string
Enum
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
company_id:
"value"
location_id:
"value"
body:
body
PUT
/service/platform/company-profile/v1.0/company/{company_id}/location/{location_id}
Loading...
Response
Loading...
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
code
string
Required
gst_credentials
object (InvoiceDetailsSerializer)
InvoiceDetailsSerializer
e_invoice
object (InvoiceCredSerializer)
InvoiceCredSerializer
username
string
enabled
boolean
password
string
e_waybill
object (InvoiceCredSerializer)
InvoiceCredSerializer
username
string
enabled
boolean
password
string
contact_numbers
array of object (SellerPhoneNumber)
Array of SellerPhoneNumber
country_code
integer
Required
number
string
Required
name
string
Required
_custom_json
object
warnings
object
address
object (AddressSerializer)
Required
AddressSerializer
landmark
string
country_code
string
Required
pincode
integer
address_type
string
longitude
number
| value >= -180
| value <= 180
Required
country
string
address2
string
state
string
sector
string
state_code
string
address1
string
city
string
latitude
number
| value >= -90
| value <= 90
Required
company
integer
Required
store_type
string
manager
object (LocationManagerSerializer)
LocationManagerSerializer
email
string
| email
mobile_no
object (SellerPhoneNumber)
Required
SellerPhoneNumber
country_code
integer
Required
number
string
Required
name
string
auto_invoice
boolean
Default Value : false
uid
integer
timing
array of object (LocationDayWiseSerializer)
Array of LocationDayWiseSerializer
open
boolean
Required
weekday
string
Required
Enum
opening
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
Required
minute
integer
Required
closing
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
Required
minute
integer
Required
stage
string
documents
array of object (Document)
Required
Array of Document
value
string
Required
legal_name
string
verified
boolean
type
string
Required
url
string
credit_note
boolean
Default Value : false
holiday
array of object (HolidaySchemaSerializer)
Array of HolidaySchemaSerializer
date
object (HolidayDateSerializer)
Required
HolidayDateSerializer
end_date
string
| date-time
Required
start_date
string
| date-time
Required
title
string
Required
holiday_type
string
Required
Enum
product_return_config
object (ProductReturnConfigSerializer)
ProductReturnConfigSerializer
on_same_store
boolean
store_uid
integer
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
open
boolean
Required
weekday
string
Required
Enum
opening
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
Required
minute
integer
Required
closing
object (LocationTimingSerializer)
LocationTimingSerializer
hour
integer
Required
minute
integer
Required
avg_order_processing_time
object (AverageOrderProcessingTime)
AverageOrderProcessingTime
duration
integer
duration_type
string
Enum
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
company_id:
"value"
body:
body
POST
/service/platform/company-profile/v1.0/company/{company_id}/location/bulk
Loading...
Response
Loading...
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.
GET
/service/platform/company-profile/v1.0/company/{company_id}/location/tags
Loading...
Response
Loading...