API
Image Recognition API

Brands

Methods allow you to get a complete list or a specific brand in Eyrene, view information about them, update all fields, or only select brand fields.



Retrieves a list of brands.

GET /brands
GET
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
limit
optional
String
The number of results to return per page.
offset
optional
String
The initial index from which to return the results.


Response parameters



count integer

The number of brands.



next string (uri) Nullable

Next page.



previous string (uri) Nullable

Previous page.



results array of objects

An array of objects with information about brands:

  • id string Brand ID.
  • name string Brand name.






Сreate a new brand.

POST /brands
POST
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Brand ID.
name
optional
String
Brand name.



Retrieve detailed information about a brand by ID

GET /brands/{id}
GET
Request
Path Params
id
required
String
Brand ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.


Response parameters



id string

Brand ID.



name string

Brand name.







Update all brand fields.

PUT /brands/{id}
PUT
Request
Path Params
id
required
String
Brand ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
New brand ID.
name
optional
String
Brand new name.


Response parameters



id string

New brand ID.



name string

Brand new name.







Update some of the fields in the brand.

PATCH /brands/{id}
PATCH
Request
Path Params
id
required
String
Brand ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
New brand ID.
name
optional
String
Brand new name.


Response parameters



id string

New brand ID.



name string

Brand new name.









Updated 03 Mar 2023
Did this page help you?