website logo
⌘K
🚀Welcome to Eyrene
🎉What's New
😎Tutorials
📱Mobile App
💻Web Portal
🔌API
Docs powered by archbee 

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.

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 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.



POST /planogram_records

Сreate a new planogram record.

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
201
|

GET /planogram_records/{id}

Retrieve detailed information about the planogram record 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.

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.

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.

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.

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.

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.

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
|
RESPONSES
200
|
Updated 14 Apr 2022
Did this page help you?
Yes
No
UP NEXT
OOS reason
Docs powered by archbee 
Request example
TABLE OF CONTENTS
GET /planogram_records
GET
Request example
Response parameters​
POST /planogram_records
POST
Request example
GET /planogram_records/{id}
GET
Request example
Response parameters
PUT /planogram_records/{id}
PUT
Request example
​Response parameters
PATCH /planogram_records/{id}
PATCH
Request example
Response parameters​
DELETE /planogram_records/{id}
DELETE
Request example