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 { "tab" "request", "url" "https //instance name/api/v1 5/planogram records/", "name" "request example", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "limit", "type" "string", "description" "the number of results to return per page " }, { "kind" "optional", "name" "offset", "type" "string", "description" "the initial index from which to return the results " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "1rlklko5jlhtk3s80ce0g", "code" "{\n \\"count\\" 1,\n \\"next\\" \\"http //example com\\",\n \\"previous\\"\ null,\n \\"results\\" \[\n {\n \\"id\\" 1,\n \\"rack index\\" 0,\n \\"shelf index\\" 0,\n \\"product index\\" 0,\n \\"facing x\\" 6,\n \\"facing y\\" 1,\n \\"width\\"\ null,\n \\"height\\"\ null,\n \\"created at\\" \\"2018 09 02t18 53 39 743058z\\",\n \\"updated at\\" \\"2018 09 02t18 53 39 743081z\\",\n \\"planogram\\" 32,\n \\"sku\\" 7386\n }\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "1rlklko5jlhtk3s80ce0g" }, "examples" { "languages" \[ { "id" "cu1xhlxz5phaulfx iif1", "code" "curl –i –x get\r\n https //test eyrene com/api/v1 5/planogram records/\r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’ \r\n f \\"limit=3\\" \\\\\r\n f \\"offset=0\\" ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "get /planograms records", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } 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 { "tab" "request", "url" "https //instance name/api/v1 5/planogram records/", "name" "request example", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "id", "type" "string", "description" "unique id " }, { "kind" "optional", "name" "rack index", "type" "number", "description" "rack number, from left to right starting from 0 " }, { "kind" "optional", "name" "shelf index", "type" "number", "description" "shelf number in the rack, from top to bottom starting from 0 " }, { "kind" "optional", "name" "product index", "type" "number", "description" "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 " }, { "kind" "optional", "name" "facing x", "type" "integer", "description" "number of horizontal sku facing " }, { "kind" "optional", "name" "facing y", "type" "integer", "description" "number of vertical sku facings (a pile) " }, { "kind" "optional", "name" "width", "type" "integer", "description" "width of a product " }, { "kind" "optional", "name" "height", "type" "integer", "description" "height of a product " }, { "kind" "optional", "name" "planogram", "type" "string", "description" "planogram id " }, { "kind" "optional", "name" "sku", "type" "string", "description" "sku id " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "xcvqafq2rcx iopukqj43", "code" "{\n \\"result\\" \\"created\\"\n}", "language" "201", "customlabel" "" } ], "selectedlanguageid" "xcvqafq2rcx iopukqj43" }, "examples" { "languages" \[ { "id" "cu1xhlxz5phaulfx iif1", "code" "curl –i –x post\r\n https //test eyrene com/api/v1 5/planograms/ \r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’ \r\n f \\"id=3\\" \\\\\r\n f \\"rack index=1\\" \\\\\r\n f \\"shelf index=0\\" \\\\\r\n f \\"product index=7\\" \\\\\r\n f \\"facing x=1\\" \\\\\r\n f \\"facing y=null\\" \\\\\r\n f \\"width=null\\" \\\\\r\n f \\"height=null\\" \\\\\r\n f \\"planogram=11\\" \\\\\r\n f \\"sku=1512\\"\r\n}", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "post /planogram records", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } get get /planogram records/{id} retrieve detailed information about the planogram record by id { "tab" "request", "url" "https //instance name/api/data/v1 5/planogram records/{id}", "name" "request example", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "planogram record id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "bcmdi d9um v1lp9epj4i", "code" "{\n \\"id\\" 1,\n \\"rack index\\" 0,\n \\"shelf index\\" 0,\n \\"product index\\" 0,\n \\"facing x\\" 6,\n \\"facing y\\" 1,\n \\"width\\"\ null,\n \\"height\\"\ null,\n \\"created at\\" \\"2018 09 02t18 53 39 743058z\\",\n \\"updated at\\" \\"2018 09 02t18 53 39 743081z\\",\n \\"planogram\\" 32,\n \\"sku\\" 7386\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "bcmdi d9um v1lp9epj4i" }, "examples" { "languages" \[ { "id" "cu1xhlxz5phaulfx iif1", "code" "curl –i –x get\r\n https //test eyrene com/api/v1 5/planograms/1/ \r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’ ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "get /planogram records/{id}", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } 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 { "tab" "request", "url" "https //instance name/api/v1 5/planogram records/{id}", "name" "request example", "method" "put", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "planogram id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "id", "type" "string", "description" "unique id " }, { "kind" "optional", "name" "rack index", "type" "number", "description" "rack number, from left to right starting from 0 " }, { "kind" "optional", "name" "shelf index", "type" "number", "description" "shelf number in the rack, from top to bottom starting from 0 " }, { "kind" "optional", "name" "product index", "type" "number", "description" "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 " }, { "kind" "optional", "name" "facing x", "type" "string", "description" "number of horizontal sku facings " }, { "kind" "optional", "name" "facing y", "type" "string", "description" "number of vertical sku facings (a pile) " }, { "kind" "optional", "name" "width", "type" "string", "description" "width of a product " }, { "kind" "optional", "name" "height", "type" "string", "description" "height of a product " }, { "kind" "optional", "name" "planogram", "type" "string", "description" "planogram id " }, { "kind" "optional", "name" "sku", "type" "string", "description" "sku id " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "l7odtgv1iy14re9xv3axq", "code" "{\n \\"id\\" 3,\n \\"rack index\\" 1,\n \\"shelf index\\" 3,\n \\"product index\\" 4,\n \\"facing x\\" 6,\n \\"facing y\\" 1,\n \\"width\\" 132,\n \\"height\\" 30,\n \\"created at\\" \\"2018 09 02t18 53 39 743058z\\",\n \\"updated at\\" \\"2018 09 02t18 53 39 743081z\\",\n \\"planogram\\" 1,\n \\"sku\\" 11\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "l7odtgv1iy14re9xv3axq" }, "examples" { "languages" \[ { "id" "gbxujakfuej3yazlqwoid", "code" "curl –i –x put\n https //test inspector cloud com/api/v1 5/planogram records/1/ \n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’ \n f \\"id=3\\" \\\\\n f \\"rack index=1\\" \\\\\n f \\"shelf index=3\\" \\\\\n f \\"product index=4\\" \\\\\n f \\"facing x=6\\" \\\\\n f \\"facing y=1\\" \\\\\n f \\"width=132\\" \\\\\n f \\"height=30\\" \\\\\n f \\"planogram=1\\" \\\\\n f \\"sku=11\\"", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "gbxujakfuej3yazlqwoid" }, "description" "put /planogram records/{id}", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } ​ 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 { "tab" "request", "url" "https //instance name/api/v1 5/planogram records/{id}", "name" "request example", "method" "patch", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "planogram id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "id", "type" "string", "description" "unique id " }, { "kind" "optional", "name" "rack index", "type" "number", "description" "rack number, from left to right starting from 0 " }, { "kind" "optional", "name" "shelf index", "type" "number", "description" "shelf number in the rack, from top to bottom starting from 0 " }, { "kind" "optional", "name" "product index", "type" "number", "description" "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 " }, { "kind" "optional", "name" "facing x", "type" "integer", "description" "number of horizontal sku facings " }, { "kind" "optional", "name" "facing y", "type" "integer", "description" "number of vertical sku facings (a pile) " }, { "kind" "optional", "name" "width", "type" "string", "description" "width of a product " }, { "kind" "optional", "name" "height", "type" "string", "description" "height of a product " }, { "kind" "optional", "name" "planogram", "type" "string", "description" "planogram id " }, { "kind" "optional", "name" "sku", "type" "string", "description" "sku id " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "bcmdi d9um v1lp9epj4i", "code" "{\n \\"id\\" 3,\n \\"rack index\\" 1,\n \\"shelf index\\" 3,\n \\"product index\\" 0,\n \\"facing x\\" 6,\n \\"facing y\\" 1,\n \\"width\\"\ null,\n \\"height\\"\ null,\n \\"created at\\" \\"2018 09 02t18 53 39 743058z\\",\n \\"updated at\\" \\"2018 09 02t18 53 39 743081z\\",\n \\"planogram\\" 32,\n \\"sku\\" 7386\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "bcmdi d9um v1lp9epj4i" }, "examples" { "languages" \[ { "id" "cu1xhlxz5phaulfx iif1", "code" "curl –i –x patch\r\n https //test eyrene com/api/v1 5/planogram records/1/ \r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’\r\n f \\"id=3\\" \\\\\r\n f \\"rack index=1\\" \\\\\r\n f \\"shelf index=3\\" ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "patch /planogram records/{id}", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } 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 { "tab" "request", "url" "https //instance name/api/v1 5/planogram records/{id}", "name" "request example", "method" "delete", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "planogram id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "du9xr9j8bu4jftmv8bpry", "code" "{\n \\"result\\" \\"ok\\"\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "du9xr9j8bu4jftmv8bpry" }, "examples" { "languages" \[ { "id" "n8qhhtsdo9fbqybtrcldg", "code" "curl –i –x delete\n https //test eyrene com/api/v1 5/planogram records/1/\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "n8qhhtsdo9fbqybtrcldg" }, "description" "delete /planogram records/{id}", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } }