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 get get /planogram records retrieve a list of planograms records response parameters ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/catalog/brands#response definitions count integer the number of planogram records next string (uri) nullable nullable next page previous string (uri) nullable 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 https //docs eyrene com/planograms id sku string sku https //docs eyrene com/sku id post post /planogram records сreate a new planogram record get 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 https //docs eyrene com/planograms id sku string sku https //docs eyrene com/sku id https //help inspector cloud com/en/docs/api/backend/methods/v1 5/catalog/brands id#response definitions put put /planogram records/{id} update all fields of the planogram record ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/catalog/brands id#response definitions 1 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 https //docs eyrene com/planograms id sku string sku https //docs eyrene com/sku id patch patch /planogram records/{id} update some fields in the planogram record response parameters ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/catalog/brands id#response definitions 1 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 https //docs eyrene com/planograms id sku string sku https //docs eyrene com/sku id delete delete /planogram records/{id} delete planogram record by id