Company API

Contents:

• Method GET/public/v1/companies/
• Method POST/public/v1/companies/
• Method GET/public/v1/companies/{company_id}/gallery/
• Method GET/public/v1/companies/{company_id}/gallery/{id}/
• Method GET/public/v1/companies/{company_id}/images/{id}/
• Method GET/public/v1/companies/{id}/
• Method PATCH/public/v1/companies/{id}/
• Method GET/public/v1/companies/{id}/rating_dynamic/
• Method GET/public/v1/companies/legal_types/
• Method GET/public/v1/companies/rating/

---

In this documentation, you can find a description of the methods of the BrandWizard API section Company.

 

 

Method GET/public/v1/companies/

• Description: Get a list of company objects.
• Request parameters:

Parameter	Type	Required?	Description
active	boolean	No	Active companies: Yes/No
brand_ids	array[integer]	No	List of brand IDs
catalog_ids	array[integer]	No	List of catalog IDs
city_ids	array[integer]	No	List of city IDs
closed	boolean	No	Closed companies: Yes/No
code	array[string]	No	List of branch codes
company_group_ids	array[integer]	No	List of company group IDs
company_ids	array[integer]	No	List of company IDs
count	integer	No	Number of results for paginated return
ids	array[string]	No	Company IDs
is_active	boolean	No	Company is active, does not require moderation, and is not closed: Yes/No
need_action	boolean	No	CCL (company–catalog link) status "action required": Yes/No
page	integer	No	Page number within the pagination result set
q	string	No	Search string

• Response fields:

Field				Type	Description
count				integer	Number of results
next				string	Link to the next page
previous				string	Link to the previous page
results	id			integer	Company ID
	code			string	Company code
	name			string	Company name
	address	country		string	Country where the company is located
		country_code		string	Country code
		region		string	Region
		city		string	City
		street		string	Street
		housenumber		string	House number
		postcode		string	Postal code
		description		string	Additional information about the company's location
		string_address		string	Full company address
		lat		number	Latitude coordinates
		lon		number	Longitude coordinates
	closed			boolean	Company closed: Yes/No
	expired			string	License expiration date
	payment_plan	id		integer	Tariff plan ID
		name		string	Tariff plan name
	brand			integer	Brand name
	work_time (1-7)	start		string	Opening time (Monday – Sunday)
		end		string	Closing time (Monday – Sunday)
		breaks	start	string	Break start time (Monday – Sunday)
			end	string	Break end time (Monday – Sunday)
	special_hours	start		string	Start time of special working hours
		end		string	End time of special working hours
		breaks	start	string	Break start time during special working hours
			end	string	Break end time during special working hours
		start_date		string	Start date of the special working hours period
		end_date		string	End date of the special working hours period

 

---

 

Method POST/public/v1/companies/

• Description: creating a company under an existing brand. The set of fields mirrors the Create company page in the personal account.
• Request parameters:

  Parameter				Type	Required	Description
  name				string	Yes	Company name
  code				string	No	Branch code. Maximum length: 300
  brand	id			integer	No	Brand identifier
  	name			string	Yes	Brand name. Minimum length: 2
  	alt_names			string	No	Alternative brand names. Array of strings (max. 5 items), minimum string length: 2
  legal	ogrn			string	No	Primary state registration number (OGRN)
  	inn			string	No	Taxpayer identification number (INN). Maximum length: 160
  	form			string	No	Legal form. Minimum length: 1
  	name			string	No	Legal entity name
  categories	id			integer	Yes	Category identifier
  	is_main			boolean	No	Main category (yes/no). Default value: false
  expired				string	No	License expiry date
  payment_plan	name			string	No	Payment plan name. Minimum length: 1, maximum length: 50
  description_short				string	Yes	Deprecated. No longer populated by RocketData processes - use description instead.
  description				string	Yes	Description. Maximum length: 500
  email				string	Yes	Email
  phones	phone			string	Yes	Phone number. Minimum length: 1
  	is_main			boolean	Yes	Main phone (yes/no)
  website				string	Yes	Website
  socials	url			string	No	Social network link. Maximum length: 1024
  work_time (1-7)	start			string	No	Opening time (Monday - Sunday)
  	end			string	No	Closing time (Monday - Sunday)
  	breaks	start		string	No	Break start time (Monday - Sunday)
  		end		string	No	Break end time (Monday - Sunday)
  is_temporary_closed				boolean	Yes	Temporarily closed
  opening_date				string	No	Opening date
  special_hours		start		string	No	Special hours start time
  		end		string	No	Special hours end time
  		breaks	start	string	No	Break start time within special hours
  			end	string	No	Break end time within special hours
  		start_date		string	Yes	Special hours start date
  		end_date		string	Yes	Special hours end date
  payment_methods		id		string	Yes	Payment method identifier. Minimum length: 1
  		name		string	No	Payment method name. Maximum length: 1024
  closed				boolean	No	Closed
  address		country		string	Yes	Country. Minimum length: 1, maximum length: 128
  		country_code		string	Yes	Country code
  		region		string	Yes	Region. Minimum length: 1, maximum length: 128
  		city		string	No	City. Maximum length: 128
  		street		string	No	Street. Maximum length: 128
  		housenumber		string	No	House number. Maximum length: 32
  		postcode		string	No	Postal code
  		description		string	No	Address description
  		lat		number	Yes	Latitude
  		lon		number	Yes	Longitude

• Response fields:

  Parameter				Type	Description
  id				integer	Company identifier
  name				string	Company name
  code				string	Branch code. Maximum length: 300
  brand	id			integer	Brand identifier
  	name			string	Brand name. Minimum length: 2
  	alt_names			string	Alternative brand names. Array of strings (max. 5 items), minimum string length: 2
  legal	ogrn			string	Primary state registration number (OGRN)
  	inn			string	Taxpayer identification number (INN). Maximum length: 160
  	form			string	Legal form. Minimum length: 1
  	name			string	Legal entity name
  categories	id			integer	Category identifier
  	name			string	Category name
  	is_main			boolean	Main category (yes/no). Default value: false
  created				string	Creation date
  expired				string	License expiry date
  is_payed				boolean	Paid
  payment_plan	id			integer	Payment plan identifier
  	name			string	Payment plan name. Minimum length: 1, maximum length: 50
  description_short				string	Deprecated. No longer populated by RocketData processes - use description instead.
  description				string	Description. Maximum length: 500
  email				string	Email
  phones	phone			string	Phone number. Minimum length: 1
  	is_main			boolean	Main phone (yes/no)
  website				string	Website
  socials	url			string	Social network link. Maximum length: 1024
  	social_service		name	string	Social network name. Max. length: 300
  			logo	string	Social network logo
  			icon	string	Social network icon. Max. length: 255
  work_time (1-7)	start			string	Opening time (Monday - Sunday)
  	end			string	Closing time (Monday - Sunday)
  	breaks	start		string	Break start time (Monday - Sunday)
  		end		string	Break end time (Monday - Sunday)
  is_temporary_closed				boolean	Temporarily closed
  opening_date				string	Opening date
  special_hours		start		string	Special hours start time
  		end		string	Special hours end time
  		breaks	start	string	Break start time within special hours
  			end	string	Break end time within special hours
  		start_date		string	Special hours start date
  		end_date		string	Special hours end date
  payment_methods		id		string	Payment method identifier. Minimum length: 1
  		name		string	Payment method name. Maximum length: 1024
  image		logo		object	Company logo
  		cover		object	Company cover image
  closed				boolean	Closed
  address		country		string	Country. Minimum length: 1, maximum length: 128
  		country_code		string	Country code
  		region		string	Region. Minimum length: 1, maximum length: 128
  		city		string	City. Maximum length: 128
  		street		string	Street. Maximum length: 128
  		housenumber		string	House number. Maximum length: 32
  		postcode		string	Postal code
  		description		string	Address description
  		string_address		string	Address as a single line (read only)
  		lat		number	Latitude
  		lon		number	Longitude
  permissions				string	User access permissions for the company

 

---

 

Method GET/public/v1/companies/{company_id}/gallery/

• Description: Get a list of company galleries.
• Request parameters:

Parameter	Type	Required?	Description
company_id	string	Yes	Company ID

• Response fields:

  Field	Type	Description
  id	integer	Gallery image ID
  image	string	Image

 

---

 

Method GET/public/v1/companies/{company_id}/gallery/{id}/

• Description: Get the company gallery.
• Request parameters:

Parameter	Type	Required?	Description
company_id	string	Yes	Company ID
id	string	Yes	Gallery image ID

• Response fields:

Field	Type	Description
id	integer	Gallery image ID
image	string	Photo link

 

---

 

Method GET/public/v1/companies/{company_id}/images/{id}/

• Description: Get a list of images by unique company ID.
• Request parameters:

Parameter	Type	Required?	Description
company_id	string	Yes	Company ID
id	integer	Yes	Logo and cover ID

• Response fields:

Field	Type	Description
image_logo	string	List of company logo images
image_cover	string	List of company cover images

 

---

 

Method GET/public/v1/companies/{id}/

• Description: Get a company object by its unique identifier.
• Request parameters:

Parameter	Type	Required?	Description
id	integer	Yes	Company ID

• Response fields:

Field				Type	Description
id				integer	Company ID
name				string	Company name
name_for_push				string	Company name sent to catalog
code				string	Branch code
brand		id		integer	Brand ID
		name		string	Brand name
		alt_names		string	Alternative names
legal		ogrn		string	Primary State Registration Number (for Russia)
		inn		string	Taxpayer Identification Number (INN) (for Belarus)
		form		string	Legal form
		name		string	Legal name
categories		id		integer	Category ID
		name		string	Category name
		is_main		boolean	Main category: Yes/No
created				string	Creation date
expired				string	License expiration date
is_payed				boolean	Paid: Yes/No
payment_plan		id		integer	Tariff plan ID
		name		string	Tariff plan name
description_short				string	Short description
description				string	Description
email				string	Email address
phones		phone		string	Phone number
		is_main		boolean	Main phone number: Yes/No
website				string	Website link
socials		url		string	Social network link
			name	string	Social network name
			logo	string	Logo
			icon	string	Icon
work_time	1	start		string	Workday start time
		end		string	Workday end time
		breaks	start	string	Break start time
			end	string	Break end time
	2	start		string	Workday start time
		end		string	Workday end time
		breaks	start	string	Break start time
			end	string	Break end time
	3	start		string	Workday start time
		end		string	Workday end time
		breaks	start	string	Break start time
			end	string	Break end time
	4	start		string	Workday start time
		end		string	Workday end time
		breaks	start	string	Break start time
			end	string	Break end time
	5	start		string	Workday start time
		end		string	Workday end time
		breaks	start	string	Break start time
			end	string	Break end time
	6	start		string	Workday start time
		end		string	Workday end time
		breaks	start	string	Break start time
			end	string	Break end time
	7	start		string	Workday start time
		end		string	Workday end time
		breaks	start	string	Break start time
			end	string	Break end time
is_temporary_closed				boolean	Temporarily closed: Yes/No
special_hours	start			string	Special schedule workday start time
	end			string	Special schedule workday end time
	breaks		start	string	Special schedule break start time
			end	string	Special schedule break end time
	start_date			string	Special schedule start date
	end_date			string	Special schedule end date
payment_methods	id			string	Payment method ID
	name			string	Payment method name
image_logo				-	Company logo image
image_cover				-	Company cover image
closed				boolean	Company closed: Yes/No
address		country		string	Country where the company is located
		country_code		string	Country code
		region		string	Region
		city		string	City
		street		string	Street
		housenumber		string	House number
		postcode		string	Postal code
		description		string	Additional information about company location
		string_address		string	Full address
		lat		number	Latitude coordinates
		lon		number	Longitude coordinates
permissions				string	User permissions for the company

 

---

 

Method PATCH/public/v1/companies/{id}/

• Description: partial update of a company. The set of editable fields mirrors the Edit company page in the personal account.
• Request parameters:
  

  Parameter	Type	Required	Description
  id	integer	Yes	Company identifier

• Request body:

  Parameter				Type	Required	Description
  name				string	Yes	Company name
  code				string	No	Branch code. Maximum length: 300
  brand	id			integer	No	Brand identifier
  	name			string	Yes	Brand name. Minimum length: 2
  	alt_names			string	No	Alternative brand names. Array of strings (max. 5 items), minimum string length: 2
  legal	ogrn			string	No	Primary state registration number (OGRN)
  	inn			string	No	Taxpayer identification number (INN). Maximum length: 160
  	form			string	No	Legal form. Minimum length: 1
  	name			string	No	Legal entity name
  categories	id			integer	Yes	Category identifier
  	is_main			boolean	No	Main category (yes/no). Default value: false
  expired				string	No	License expiry date.
  payment_plan	name			string	No	Payment plan name. Minimum length: 1, maximum length: 50
  description_short				string	Yes	Deprecated. No longer populated by RocketData processes - use description instead.
  description				string	Yes	Description. Maximum length: 500
  email				string	Yes	Email
  phones	phone			string	Yes	Phone number. Minimum length: 1
  	is_main			boolean	Yes	Main phone (yes/no)
  website				string	Yes	Website
  socials	url			string	No	Social network link. Maximum length: 1024
  work_time (1-7)	start			string	No	Opening time (Monday - Sunday).
  	end			string	No	Closing time (Monday - Sunday).
  	breaks	start		string	No	Break start time (Monday - Sunday).
  		end		string	No	Break end time (Monday - Sunday).
  is_temporary_closed				boolean	Yes	Temporarily closed
  opening_date				string	No	Opening date
  special_hours		start		string	No	Special hours start time
  		end		string	No	Special hours end time
  		breaks	start	string	No	Break start time within special hours
  			end	string	No	Break end time within special hours
  		start_date		string	Yes	Special hours start date
  		end_date		string	Yes	Special hours end date
  payment_methods		id		string	Yes	Payment method identifier. Minimum length: 1
  		name		string	No	Payment method name. Maximum length: 1024
  closed				boolean	No	Closed
  address		country		string	Yes	Country. Minimum length: 1, maximum length: 128
  		country_code		string	Yes	Country code
  		region		string	Yes	Region. Minimum length: 1, maximum length: 128
  		city		string	No	City. Maximum length: 128
  		street		string	No	Street. Maximum length: 128
  		housenumber		string	No	House number. Maximum length: 32
  		postcode		string	No	Postal code
  		description		string	No	Address description
  		lat		number	Yes	Latitude
  		lon		number	Yes	Longitude

• Response fields:

  Parameter				Type	Description
  id				integer	Company identifier
  name				string	Company name
  code				string	Branch code. Maximum length: 300
  brand	id			integer	Brand identifier
  	name			string	Brand name. Minimum length: 2
  	alt_names			string	Alternative brand names. Array of strings (max. 5 items), minimum string length: 2
  legal	ogrn			string	Primary state registration number (OGRN)
  	inn			string	Taxpayer identification number (INN). Maximum length: 160
  	form			string	Legal form. Minimum length: 1
  	name			string	Legal entity name
  categories	id			integer	Category identifier
  	name			string	Category name
  	is_main			boolean	Main category (yes/no). Default value: false
  created				string	Creation date
  expired				string	License expiry date
  is_payed				boolean	Paid
  payment_plan	id			integer	Payment plan identifier
  	name			string	Payment plan name. Minimum length: 1, maximum length: 50
  description_short				string	Deprecated. No longer populated by RocketData processes - use description instead.
  description				string	Description. Maximum length: 500
  email				string	Email
  phones	phone			string	Phone number. Minimum length: 1
  	is_main			boolean	Main phone (yes/no)
  website				string	Website
  socials	url			string	Social network link. Maximum length: 1024
  	social_service		name	string	Social network name. Max. length: 300
  			logo	string	Social network logo
  			icon	string	Social network icon. Max. length: 255
  work_time (1-7)	start			string	Opening time (Monday - Sunday)
  	end			string	Closing time (Monday - Sunday)
  	breaks	start		string	Break start time (Monday - Sunday)
  		end		string	Break end time (Monday - Sunday)
  is_temporary_closed				boolean	Temporarily closed
  opening_date				string	Opening date
  special_hours		start		string	Special hours start time
  		end		string	Special hours end time
  		breaks	start	string	Break start time within special hours
  			end	string	Break end time within special hours
  		start_date		string	Special hours start date
  		end_date		string	Special hours end date
  payment_methods		id		string	Payment method identifier. Minimum length: 1
  		name		string	Payment method name. Maximum length: 1024
  image		logo		object	Company logo
  		cover		object	Company cover image
  closed				boolean	Closed
  address		country		string	Country. Minimum length: 1, maximum length: 128
  		country_code		string	Country code
  		region		string	Region. Minimum length: 1, maximum length: 128
  		city		string	City. Maximum length: 128
  		street		string	Street. Maximum length: 128
  		housenumber		string	House number. Maximum length: 32
  		postcode		string	Postal code
  		description		string	Address description
  		string_address		string	Address as a single line (read only)
  		lat		number	Latitude
  		lon		number	Longitude
  permissions				string	User access permissions for the company

 

---

 

Method GET/public/v1/companies/{id}/rating_dynamic/

• Description: Returns a dynamic rating for a specific company based on catalog IDs.
• Request parameters:

Parameter	Type	Required?	Description
catalog_ids	string	Yes	Catalog IDs, separated by commas, for rating filtering
id	integer	Yes	Company ID

• Response fields:

  Field		Type	Description
  month		string	Month
  date		string	Date
  total		integer	Total rating value
  sentiments	negative	integer	Number of negative reviews
  	positive	integer	Number of positive reviews
  	neutral	integer	Number of neutral reviews
  	unspecified	integer	Number of unspecified reviews

 

---

 

Method GET/public/v1/companies/legal_types/

• Description: Get a list of organizational form types.
• Request parameters: None.
• Response fields: None.

 

---

 

Method GET/public/v1/companies/rating/

• Description: Get ratings of companies from catalogs (Google Business Profile, Yandex Maps, 2GIS) for the last 24 hours.
• Request parameters: 

Parameter	Type	Required?	Description
active	boolean	No	Active companies: Yes/No
brand_ids	array[integer]	No	List of brand IDs
catalog_ids	array[integer]	No	List of catalog IDs
city_ids	array[integer]	No	List of city IDs
closed	boolean	No	Closed companies: Yes/No
code	array[string]	No	List of branch codes
company_group_ids	array[integer]	No	List of company group IDs
company_ids	array[integer]	No	List of company IDs
count	integer	No	Number of results for paginated return
ids	array[string]	No	Company IDs
is_active	boolean	No	Company is active, does not require moderation, and is not closed: Yes/No
need_action	boolean	No	CCL (company–catalog link) status "action required": Yes/No
page	integer	No	Page number within the pagination result set
q	string	No	Search string

• Response fields: None.