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