API
Image Recognition API

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
String
required
String in "Token XXXXXX..." format.
Body Parameters
limit
String
optional
The number of results to return per page.
offset
String
optional
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
String
required
String in "Token XXXXXX..." format.
Body Parameters
id
String
optional
Unique ID.
rack_index
Number
optional
Rack number, from left to right starting from 0.
shelf_index
Number
optional
Shelf number in the rack, from top to bottom starting from 0.
product_index
Number
optional
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
Integer
optional
Number of horizontal SKU facing.
facing_y
Integer
optional
Number of vertical SKU facings (a pile).
width
Integer
optional
Width of a product.
height
Integer
optional
Height of a product.
planogram
String
optional
Planogram ID.
sku
String
optional
SKU ID.



Retrieve detailed information about the planogram record by ID.

GET /planogram_records/{id}
GET
Request
Path Params
id
String
required
Planogram record ID.
Header Parameters
Authorization
String
required
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
String
required
Planogram ID.
Header Parameters
Authorization
String
required
String in "Token XXXXXX..." format.
Body Parameters
id
String
optional
Unique ID.
rack_index
Number
optional
Rack number, from left to right starting from 0.
shelf_index
Number
optional
Shelf number in the rack, from top to bottom starting from 0.
product_index
Number
optional
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
String
optional
Number of horizontal SKU facings.
facing_y
String
optional
Number of vertical SKU facings (a pile).
width
String
optional
Width of a product.
height
String
optional
Height of a product.
planogram
String
optional
Planogram ID.
sku
String
optional
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
String
required
Planogram ID.
Header Parameters
Authorization
String
required
String in "Token XXXXXX..." format.
Body Parameters
id
String
optional
Unique ID.
rack_index
Number
optional
Rack number, from left to right starting from 0.
shelf_index
Number
optional
Shelf number in the rack, from top to bottom starting from 0.
product_index
Number
optional
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
Integer
optional
Number of horizontal SKU facings.
facing_y
Integer
optional
Number of vertical SKU facings (a pile).
width
String
optional
Width of a product.
height
String
optional
Height of a product.
planogram
String
optional
Planogram ID.
sku
String
optional
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
String
required
Planogram ID.
Header Parameters
Authorization
String
required
String in "Token XXXXXX..." format.





Updated 03 Mar 2023
Did this page help you?