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

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 /displays
GET
Params
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
limit
optional
String
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 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.

POST /displays
POST
Params
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Unique ID.
name
optional
String
Human-readable name.
planogram
optional
String
Planogram ID.
musthavelist
optional
String
Must have list ID.



GET /displays/{id}

Retrieve detailed information about the display by ID.

GET /displays/{id}
GET
Params
Path Params
id
required
String
Display ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.


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.





PUT /displays/{id}
PUT
Params
Path Params
id
required
String
Display ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Unique ID.
name
optional
String
Human-readable name.
planogram
optional
String
Planogram ID.
musthavelist
optional
String
Must have list ID.


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

PATCH /displays/{id}
PATCH
Params
Path Params
id
required
String
Display ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Unique ID.
name
optional
String
Human-readable name.
planogram
optional
String
Planogram ID.
musthavelist
optional
String
Must have list ID.


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.

DELETE /displays/{id}
DELETE
Params
Path Params
id
required
String
Display ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.





Updated 14 Apr 2022
Did this page help you?
Yes
No
PREVIOUS
SKU
NEXT
Visits
Docs powered by archbee 
Request example