website logo
⌘K
🚀Welcome to Eyrene
🎉What's New
😎Tutorials
📱Mobile App
💻Web Portal
🔌API
Docs powered by archbee 

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.

GET /mhl

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 a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|

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.



POST /mhl

С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.

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
201
|

GET /mhl/{id}

Retrieve detailed information about must-have list by ID.

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|

Response parameters

id string

Unique ID.

name string

Human-readable name.

display string

Display ID.

musthavelist string

Must-have list ID.



PUT /mhl/{id}

Update all must-have list fields.

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|

​Response parameters

id string

Unique ID.

name string

Human-readable name.

display string

Display ID.



PATCH /mhl/{id}

Update some of must-have list fields.

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|

Response parameters​

id string

Unique ID.

name string

Human-readable name.

Display string

Display ID.



DELETE /mhl/{id}

Delete must-have list by ID.

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|
Updated 14 Apr 2022
Did this page help you?
Yes
No
UP NEXT
MHL record
Docs powered by archbee 
Request example
TABLE OF CONTENTS
GET /mhl
GET
Request example
Response parameters​
POST /mhl
POST
Request example
GET /mhl/{id}
GET
Request example
Response parameters
PUT /mhl/{id}
PUT
Request example
​Response parameters
PATCH /mhl/{id}
PATCH
Request example
Response parameters​
DELETE /mhl/{id}
DELETE
Request example