Planograms
Methods allow you to get a complete list or a specific planogram in Eyrene, view information about them, update all fields, or only select planogram fields. Also, you can delete the planogram by ID.
Retrieve a list of planograms.
- AuthorizationstringrequiredDescriptionString in "Token XXXXXX..." format
- limitstringDescriptionThe number of results to return per page.
- offsetstringDescriptionThe initial index from which to return the results.
curl –i –X GET
https://test.eyrene.com/api/v1.5/planograms/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’
-F "limit=3" \
-F "offset=0" {
"count":2,
"next":"http://example.com",
"previous":null,
"results":[
{
"id":1,
"name":"planogram_1",
"display":19
},
{
"id":2,
"name":"planogram_2",
"display":19
}
]
}Response parameters​
count integer
The number of planograms.
next string (uri) Nullable
Next page.
previous string (uri) Nullable
Previous page.
results array of objects
An array of objects with information about planograms.
- id string Unique ID.
- name string Human-readable name.

Сreate a new planogram.
- AuthorizationstringrequiredDescriptionString in "Token XXXXXX..." format
- idstringDescriptionUnique ID.
- namestringDescriptionHuman-readable name.
- displaystringDescriptionDisplay ID.
curl –i –X POST
https://test.eyrene.com/api/v1.5/planograms/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’
-F "id=3" \
-F "name=planogram_3" \
-F "display=20"{
"result": "CREATED"
}Retrieve detailed information about the planogram by ID.
- idstringrequiredDescriptionPlanogram ID.
- AuthorizationstringrequiredDescriptionString in "Token XXXXXX..." format
curl –i –X GET
https://test.eyrene.com/api/v1.5/planograms/1/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ {
"id":1,
"name":"planogram_1",
"display":19
}Response parameters
id string
Unique ID.
name string
Human-readable name.
display string
Display  ID.
musthavelist string
Planogram ID.

Update all planogram fields.
- idstringrequiredDescriptionPlanogram ID.
- AuthorizationstringrequiredDescriptionString in "Token XXXXXX..." format
- idstringDescriptionUnique ID.
- namestringDescriptionHuman-readable name.
- displaystringDescriptionDisplay ID.
curl –i –X PUT
https://test.inspector-cloud.com/api/v1.5/planograms/1/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’
-F "id=24" \
-F "name=new_planogram" \
-F "display=34"{
"id":24,
"name":"new_planogram",
"display":34
}​Response parameters
id string
Unique ID.
name string
Human-readable name.
display string
Display  ID.

Update some of the planogram fields.
- idstringrequiredDescriptionPlanogram ID.
- AuthorizationstringrequiredDescriptionString in "Token XXXXXX..." format
- idstringDescriptionUnique ID.
- namestringDescriptionHuman-readable name.
- displaystringDescriptionDisplay ID.
curl –i –X PATCH
https://test.eyrene.com/api/v1.5/planograms/1/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’
-F "name=new_planogram"{
"id":1,
"name":"new_planogram",
"display":19
}Response parameters​
id string
Unique ID.
name string
Human-readable name.
Display string
Display  ID.

Delete planogram by ID.
- idstringrequiredDescriptionPlanogram ID.
- AuthorizationstringrequiredDescriptionString in "Token XXXXXX..." format
curl –i –X DELETE
https://test.eyrene.com/api/v1.5/planograms/1/
-H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’{
"result":"OK"
}