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.

Request example

GET /displays

GET

https://instance_name/api/v1.5/displays/

curl –i –X GET
  https://test.eyrene.com/api/v1.5/displays/
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ 
  –F "limit=2" \
  –F "offset=0"

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.

Request example

POST /displays

POST

https://instance_name/api/v1.5/displays/

curl –i –X POST
  https://test.eyrene.com/api/v1.5/displays/ 
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ 
  -F "id=458" \
  -F "name=Hermess" \
  -F "planogram=45" \
  -F "musthavelist=5"

Retrieve detailed information about the display by ID.

Request example

GET /displays/{id}

GET

https://instance_name/api/data/v1.5/displays/{id}

curl –i –X GET
  https://test.eyrene.com/api/v1.5/displays/69/ 
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’

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.

Request example

PUT /displays/{id}

PUT

https://instance_name/api/v1.5/displays/{id}

curl –i –X PUT
  https://test.inspector-cloud.com/api/v1.5/displays/69/ 
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ 
  -F "id=101" \
  -F "name"="Hermess" \
  -F "planogram"="15" \
  -F "musthavelist"="3"

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.

Request example

PATCH /displays/{id}

PATCH

https://instance_name/api/v1.5/displays/{id}

curl –i –X PATCH
  https://test.eyrene.com/api/v1.5/displays/69/ 
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’
  -F "name"="Hermess" \
  -F "planogram"="15"

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.

Request example

DELETE /displays/{id}

DELETE

https://instance_name/api/v1.5/displays/{id}

curl –i –X DELETE
  https://test.eyrene.com/api/v1.5/displays/69/
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’

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}