Brands API

Contents:

• Method GET/public/v1/brands/
• Method POST/public/v1/brands/
• Method GET/public/v1/brands/{id}/
• Method PUT/public/v1/brands/{id}/
• Method PATCH/public/v1/brands/{id}/

In this documentation, you can find descriptions of the methods in the BrandWizard API for the Brands section.

Method GET/public/v1/brands/

• Description: Retrieve a list of brand objects.

• Request parameters:

  Parameter	Type	Required?	Description
  brand_id	array[string]	No	List of brand IDs
  company_group_ids	array[string]	No	List of company group IDs
  count	integer	No	Number of results for pagination
  page	integer	No	Page number within pagination set
  q	string	No	Search string
  related	boolean	No	Brands with ACL permission
  with_companies	boolean	No	Whether the brand has companies: Yes/No

• 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	Brand ID
  	name	string	Brand name
  	features	string	Brand features

Method POST/public/v1/brands/

• Description: Create a new brand.
• Request parameters: None.
• Request body:

• Response fields:

  Field	Type	Description
  id	integer	Brand ID
  name	string	Brand name
  features	string	Brand features

  Example: After executing a POST request, a brand with the name "Horns and hooves" will be created and returned with a unique identifier. If it is a PUT request, the brand name of the specified unique identifier will be updated to "Horns and hooves".

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

• Description: Retrieve a brand object by its unique identifier.

• Request parameters:

  Parameter	Type	Required?	Description
  id	integer	Yes	Unique brand ID

• Response fields:

  Field	Type	Description
  id	integer	Brand ID
  name	string	Brand name
  features	string	Feature

Method PUT/public/v1/brands/{id}/

• Description: Update an existing brand by its unique identifier.

• Request parameters:

  Parameter	Type	Required?	Description
  id	integer	Yes	Unique brand ID

• Request body:

  Field	Type	Description
  name	string	Brand name

• Response fields:

  Field	Type	Description
  id	integer	Brand ID
  name	string	Brand name

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

• Description: Update an existing brand by its unique identifier.

• Request parameters:

  Parameter	Type	Required?	Description
  id	integer	Yes	Unique brand ID

   

• Request body:

  Field	Type	Description
  name	string	Brand name

   

• Response fields:

  Field	Type	Description
  id	integer	Brand ID
  name	string	Brand name
  features	string	Features