API
Image Recognition API

MHL

Methods allow you to get a complete list or a specific must-have list in Eyrene, view information about them, update all fields, or only select MHL fields. Also, you can delete MHL by ID.



Retrieve a must-have list.

Use MHL to define a list of products that must necessarily be on the shelf. MHL_COMPLIANCE report based on the MHL. MHL is associated with other entities using the display.

GET /mhl
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 MHLs.



next string (uri) Nullable

Next page.



previous string (uri) Nullable

Previous page.



results array of objects

An array of objects with information about MHLs.

  • id string Unique ID.
  • name string Human-readable name.
  • display string Display ID.






Сreate a new must-have list.

Use MHL to define a list of products that must necessarily be on the shelf. MHL_COMPLIANCE report based on the MHL. MHL is associated with other entities using the display.mhl.

POST /mhl
POST
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Unique ID.
name
optional
String
Human-readable name.
display
optional
String
Display ID.



Retrieve detailed information about must-have list by ID.

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


Response parameters



id string

Unique ID.



name string

Human-readable name.



display string

Display ID.



musthavelist string

Must-have list ID.







Update all must-have list fields.

PUT /mhl/{id}
PUT
Request
Path Params
id
required
String
MHL ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Unique ID.
name
optional
String
Human-readable name.
display
optional
String
Display ID.


Response parameters



id string

Unique ID.



name string

Human-readable name.



display string

Display ID.







Update some of must-have list fields.

PATCH /mhl/{id}
PATCH
Request
Path Params
id
required
String
MHL ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Unique ID.
name
optional
String
Human-readable name.
display
optional
String
Display ID.


Response parameters



id string

Unique ID.



name string

Human-readable name.



Display string

Display ID.







Delete must-have list by ID.

DELETE /mhl/{id}
DELETE
Request
Path Params
id
required
String
MHL ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.





Updated 03 Mar 2023
Did this page help you?