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.
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 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 a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
201
|
﻿GET /displays/{id}
Retrieve detailed information about the display 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.
planogram string
Planogram ID.
musthavelist string
Must-have list ID.
﻿﻿﻿
﻿PUT /displays/{id}
Update all fields of 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
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.
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.
planogram string
Planogram ID.
musthavelist string
Must-have list ID.
﻿
﻿﻿﻿DELETE /displays/{id}
Delete display by ID.
Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|