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.
﻿
Retrieve a list of displays.
GET /displays
GET
Request
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
﻿
﻿
﻿
Сreate a new display.
POST /displays
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.
planogram
optional
String
Planogram ID.
musthavelist
optional
String
Must have list ID.
﻿
﻿
Retrieve detailed information about the display by ID.
GET /displays/{id}
GET
Request
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.
﻿
﻿
﻿
Update all fields of the display.
﻿
﻿
PUT /displays/{id}
PUT
Request
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.
﻿
﻿
﻿
Update some of the fields in the display.
PATCH /displays/{id}
PATCH
Request
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 display by ID.
DELETE /displays/{id}
DELETE
Request
Path Params
id
required
String
Display ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
﻿
﻿
﻿

Updated 03 Mar 2023

Did this page help you?

SKU

Visits

Displays

﻿GET /displays

Response parameters​﻿

﻿POST /displays

﻿GET /displays/{id}

Response parameters

﻿PUT /displays/{id}

﻿​Response parameters

﻿PATCH /displays/{id}

Response parameters​﻿

﻿DELETE /displays/{id}

GET /displays

Response parameters

POST /displays

GET /displays/{id}

PUT /displays/{id}

Response parameters

PATCH /displays/{id}

Response parameters

DELETE /displays/{id}