Displays
Methods allow you to get a complete list or a specific display in Eyrene, view information about them, update all fields, or only select display fields. Also, you can delete the display by ID.
GET /displays
Retrieve a list of displays.
Response parameters
count integer
The number of displays.
next string (uri) Nullable
Next page.
previous string (uri) Nullable
Previous page.
results array of objects
An array of objects with information about displays:
- id string Unique ID.
- name string Human-readable name.
- planogram string Planogram ID. Optional.
- musthavelist string Must-have list ID. Optional
POST /displays
Сreate a new display.
GET /displays/{id}
Retrieve detailed information about the display by ID.
Response parameters
id string
Unique ID.
name string
Human-readable name.
planogram string
Planogram ID.
musthavelist string
Must-have list ID.
PUT /displays/{id}
Update all fields of the display.
Response parameters
id string
Unique ID.
name string
Human-readable name.
planogram string
Planogram ID.
musthavelist string
Must-have list ID.
PATCH /displays/{id}
Update some of the fields in the display.
Response parameters
id string
Unique ID.
name string
Human-readable name.
planogram string
Planogram ID.
musthavelist string
Must-have list ID.
DELETE /displays/{id}
Delete display by ID.