Planogram records
Methods allow you to get a complete list or a specific planogram record in Eyrene, view information about them, update all fields, or only select planogram record fields. Also, you can delete the planogram record by ID.
GET /planogram_records
Retrieve a list of planograms records.
Response parameters
count integer
The number of planogram records.
next string (uri) Nullable
Next page.
previous string (uri) Nullable
Previous page.
results array of objects
An array of objects with information about planogram records.
- id string Unique ID.
- rack_index integer Rack number, from left to right starting from 0.
- shelf_index integer Shelf number in the rack, from top to bottom starting from 0.
- product_index integer Record position in the planogram. Positions are numbered left to right and top to bottom starting from 0, i.e. top left SKU in the planogram has product_index = 0 , and the bottom right one has a maximal product_index.
- facing_x integer Number of horizontal SKU facings.
- facing_y integer Number of vertical SKU facings (a pile).
- width integer Width of product.
- height integer Height of product.
POST /planogram_records
Сreate a new planogram record.
GET /planogram_records/{id}
Retrieve detailed information about the planogram record by ID.
Response parameters
id string
Unique ID.
rack_index integer
Rack number, from left to right starting from 0.
shelf_index integer
Shelf number in the rack, from top to bottom starting from 0.
product_index integer
Record position in the planogram. Positions are numbered left to right and top to bottom starting from 0, i.e. top left SKU in the planogram has product_index = 0 , and the bottom right one has a maximal product_index.
facing_x integer
A number of horizontal SKU facings.
facing_y integer
A number of vertical SKU facings (a pile).
width integer
Width of a product.
height integer
Height of a product.
planogram string
Planogram ID.
sku string
SKU ID.
PUT /planogram_records/{id}
Update all fields of the planogram record.
Response parameters
id string
Unique ID.
rack_index integer
Rack number, from left to right starting from 0.
shelf_index integer
Shelf number in the rack, from top to bottom starting from 0.
product_index integer
Record position in the planogram. Positions are numbered left to right and top to bottom starting from 0, i.e. top left SKU in the planogram has product_index = 0 , and the bottom right one has a maximal product_index.
facing_x integer
A number of horizontal SKU facings.
facing_y integer
A number of vertical SKU facings (a pile).
width integer
Width of a product.
height integer
Height of a product.
planogram string
Planogram ID.
sku string
SKU ID.
PATCH /planogram_records/{id}
Update some fields in the planogram record.
Response parameters
id string
Unique ID.
rack_index integer
Rack number, from left to right starting from 0.
shelf_index integer
Shelf number in the rack, from top to bottom starting from 0.
product_index integer
Record position in the planogram. Positions are numbered left to right and top to bottom starting from 0, i.e. top left SKU in the planogram has product_index = 0 , and the bottom right one has a maximal product_index.
facing_x integer
A number of horizontal SKU facings.
facing_y integer
A number of vertical SKU facings (a pile).
width integer
Width of a product.
height integer
Height of a product.
planogram string
Planogram ID.
sku string
SKU ID.
DELETE /planogram_records/{id}
Delete planogram record by ID.