API
Image Recognition API
Planograms
methods allow you to get a complete list or a specific planogram in eyrene, view information about them, update all fields, or only select planogram fields also, you can delete the planogram by id get get /planograms retrieve a list of planograms { "tab" "request", "url" "https //instance name/api/v1 5/planograms/", "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\\" 2,\n \\"next\\" \\"http //example com\\",\n \\"previous\\"\ null,\n \\"results\\" \[\n {\n \\"id\\" 1,\n \\"name\\" \\"planogram 1\\",\n \\"display\\" 19\n },\n {\n \\"id\\" 2,\n \\"name\\" \\"planogram 2\\",\n \\"display\\" 19\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/planograms/\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", "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 planograms 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 planograms id string unique id name string human readable name display string display https //docs eyrene com/displays id post post /planograms Ńreate a new planogram { "tab" "examples", "url" "https //instance name/api/v1 5/planograms/", "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" "name", "type" "string", "description" "human readable name " }, { "kind" "optional", "name" "display", "type" "string", "description" "display 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 \\"name=planogram 3\\" \\\\\r\n f \\"display=20\\"", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "post /planograms", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } get get /planograms/{id} retrieve detailed information about the planogram by id { "tab" "request", "url" "https //instance name/api/data/v1 5/planograms/{id}", "name" "request example", "method" "get", "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" "bcmdi d9um v1lp9epj4i", "code" "{\n \\"id\\" 1,\n \\"name\\" \\"planogram 1\\",\n \\"display\\" 19\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 /planograms/{id}", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } response parameters id string unique id name string human readable name display string display id musthavelist string planogram id https //help inspector cloud com/en/docs/api/backend/methods/v1 5/catalog/brands id#response definitions put put /planograms/{id} update all planogram fields { "tab" "request", "url" "https //instance name/api/v1 5/planograms/{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" "name", "type" "string", "description" "human readable name " }, { "kind" "optional", "name" "display", "type" "string", "description" "display id " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "l7odtgv1iy14re9xv3axq", "code" "{\n \\"id\\" 24,\n \\"name\\" \\"new planogram\\",\n \\"display\\" 34\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "l7odtgv1iy14re9xv3axq" }, "examples" { "languages" \[ { "id" "gbxujakfuej3yazlqwoid", "code" "curl āi āx put\n https //test inspector cloud com/api/v1 5/planograms/1/ \n h āauthorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875eā \n f \\"id=24\\" \\\\\n f \\"name=new planogram\\" \\\\\n f \\"display=34\\"", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "gbxujakfuej3yazlqwoid" }, "description" "put /planograms/{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 name string human readable name display string display id patch patch /planograms/{id} update some of the planogram fields { "tab" "request", "url" "https //instance name/api/v1 5/planograms/{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" "name", "type" "string", "description" "human readable name " }, { "kind" "optional", "name" "display", "type" "string", "description" "display id " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "bcmdi d9um v1lp9epj4i", "code" "{\n \\"id\\" 1,\n \\"name\\" \\"new planogram\\",\n \\"display\\" 19\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/planograms/1/ \r\n h āauthorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875eā\r\n f \\"name=new planogram\\"", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "patch /planograms/{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 name string human readable name display string display id delete delete /planograms/{id} delete planogram by id { "tab" "request", "url" "https //instance name/api/v1 5/planograms/{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/planograms/1/\n h āauthorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875eā", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "n8qhhtsdo9fbqybtrcldg" }, "description" "delete /planograms/{id}", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } }