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.
﻿
Retrieve a list of planograms records.
GET /planograms_records
GET
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
limit
optional
String
The 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 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.
planogram string
Planogram ID.
sku string
SKU ID.
﻿
﻿
﻿
Сreate a new planogram record.
POST /planogram_records
POST
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Unique ID.
rack_index
optional
Number
Rack number, from left to right starting from 0.
shelf_index
optional
Number
Shelf number in the rack, from top to bottom starting from 0.
product_index
optional
Number
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 bottom right one has a maximal product_index.
facing_x
optional
Integer
Number of horizontal SKU facing.
facing_y
optional
Integer
Number of vertical SKU facings (a pile).
width
optional
Integer
Width of a product.
height
optional
Integer
Height of a product.
planogram
optional
String
Planogram ID.
sku
optional
String
SKU ID.
﻿
﻿
Retrieve detailed information about the planogram record by ID.
GET /planogram_records/{id}
GET
Request
Path Params
id
required
String
Planogram record ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
﻿
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.
﻿
﻿
﻿
Update all fields of the planogram record.
PUT /planogram_records/{id}
PUT
Request
Path Params
id
required
String
Planogram ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Unique ID.
rack_index
optional
Number
Rack number, from left to right starting from 0.
shelf_index
optional
Number
Shelf number in the rack, from top to bottom starting from 0.
product_index
optional
Number
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 bottom right one has a maximal product_index.
facing_x
optional
String
Number of horizontal SKU facings.
facing_y
optional
String
Number of vertical SKU facings (a pile).
width
optional
String
Width of a product.
height
optional
String
Height of a product.
planogram
optional
String
Planogram ID.
sku
optional
String
SKU 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.
﻿
﻿
﻿
Update some fields in the planogram record.
PATCH /planogram_records/{id}
PATCH
Request
Path Params
id
required
String
Planogram ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Unique ID.
rack_index
optional
Number
Rack number, from left to right starting from 0.
shelf_index
optional
Number
Shelf number in the rack, from top to bottom starting from 0.
product_index
optional
Number
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 bottom right one has a maximal product_index.
facing_x
optional
Integer
Number of horizontal SKU facings.
facing_y
optional
Integer
Number of vertical SKU facings (a pile).
width
optional
String
Width of a product.
height
optional
String
Height of a product.
planogram
optional
String
Planogram ID.
sku
optional
String
SKU 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.
﻿
﻿
﻿
Delete planogram record by ID.
DELETE /planogram_records/{id}
DELETE
Request
Path Params
id
required
String
Planogram ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
﻿
﻿
﻿
Updated 03 Mar 2023
Did this page help you?
Planograms
OOS reason
Planogram records

﻿GET /planogram_records

Response parameters​﻿

﻿POST /planogram_records

﻿GET /planogram_records/{id}

Response parameters

﻿PUT /planogram_records/{id}

﻿​Response parameters

﻿PATCH /planogram_records/{id}

Response parameters​﻿

﻿DELETE /planogram_records/{id}

GET /planogram_records

Response parameters

POST /planogram_records

GET /planogram_records/{id}

PUT /planogram_records/{id}

Response parameters

PATCH /planogram_records/{id}

Response parameters

DELETE /planogram_records/{id}
