API
Image Recognition API
Visits
methods allow you to get a complete list or a specific visit in eyrene, view information about them, update all fields, or only select visit fields get get /visits retrieve a list of visits { "tab" "request", "url" "https //instance name/api/v1 5/visits/", "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\\" 2323,\n \\"shop\\" \\"1504553224092\\",\n \\"agent\\" \\"agent\\",\n \\"started date\\" \\"2020 07 27t18 35 46 586695z\\",\n \\"task\\"\ null,\n \\"latitude\\" 53 7356226,\n \\"longitude\\" 91 4279673,\n \\"shop name\\" \\"the one with ondemand task groups\\",\n \\"shop area\\"\ null,\n \\"gps shop\\" {\n \\"id\\" 5316,\n \\"logo\\"\ null,\n \\"route\\" \\"939 eah\\",\n \\"route type description\\"\ null,\n \\"customer id\\" \\"1504553224092\\",\n \\"customer name\\" \\"the one with ondemand task groups\\",\n \\"region\\" \\"south ashley\\",\n \\"region l3\\"\ null,\n \\"region l4\\"\ null,\n \\"area\\"\ null,\n \\"area l5\\"\ null,\n \\"area l6\\"\ null,\n \\"city\\" \\"garrisonfurt\\",\n \\"sales route id\\"\ null,\n \\"latitude\\" 45 5718055,\n \\"longitude\\" 110 701806,\n \\"created at\\" \\"2020 06 29t15 24 18 290885z\\",\n \\"updated at\\" \\"2021 10 08t08 16 02 513126z\\",\n \\"address\\" \\"51805 james streamwilliamsview, nm 65300\\",\n \\"distr name\\"\ null,\n \\"team id\\"\ null,\n \\"rsm name\\"\ null,\n \\"rsm code\\"\ null,\n \\"tsm name\\"\ null,\n \\"route type full\\"\ null,\n \\"segment\\"\ null,\n \\"pos code\\"\ null,\n \\"matrix name\\"\ null,\n \\"gtm role id description\\"\ null,\n \\"id dealer\\"\ null,\n \\"golden id\\"\ null,\n \\"sector\\"\ null,\n \\"manager\\"\ null,\n \\"inn\\"\ null,\n \\"kpp\\"\ null,\n \\"sale channel\\"\ null,\n \\"country\\" \\"somalia\\",\n \\"fss\\"\ null,\n \\"fss code\\"\ null,\n \\"sfss\\"\ null,\n \\"sfss code\\"\ null,\n \\"em\\"\ null,\n \\"em code\\"\ null,\n \\"agency\\"\ null,\n \\"agency region\\"\ null,\n \\"kam food\\"\ null,\n \\"kam food code\\"\ null,\n \\"kam hpc\\"\ null,\n \\"kam hpc code\\"\ null,\n \\"ctl\\"\ null,\n \\"ctl code\\"\ null,\n \\"mte\\"\ null,\n \\"mte code\\"\ null,\n \\"nsd\\"\ null,\n \\"nsd code\\"\ null,\n \\"visit plan id\\"\ null,\n \\"driver id\\"\ null,\n \\"sap code\\"\ null,\n \\"sales group\\"\ null,\n \\"visit type\\"\ null,\n \\"hierarchy l5\\"\ null,\n \\"hierarchy l6\\"\ null,\n \\"visit frequency\\"\ null,\n \\"dsd distr\\"\ null,\n \\"store number\\"\ null,\n \\"virtual flag\\"\ null,\n \\"lka segment\\"\ null,\n \\"customer segment\\"\ null,\n \\"y cust hier level 6\\"\ null,\n \\"y cust hier level 8\\"\ null,\n \\"store format\\"\ null,\n \\"team route\\"\ null,\n \\"route type dsd\\"\ null,\n \\"route merch\\"\ null,\n \\"service type\\"\ null,\n \\"svm\\"\ null,\n \\"tm\\"\ null,\n \\"rmm\\"\ null,\n \\"kam ekam\\"\ null,\n \\"skam\\"\ null,\n \\"days sequence code\\"\ null,\n \\"weekly frequency\\"\ null,\n \\"bm\\"\ null,\n \\"sv\\"\ null,\n \\"se\\"\ null,\n \\"task type\\"\ null,\n \\"task subtype\\"\ null,\n \\"enabled\\"\ true,\n \\"week days\\" \\"1,2,3,4,5,6,7\\",\n \\"uuid\\" \\"5be684a7 7fd8 4256 92cc b8d50e279a20\\",\n \\"global channel\\"\ null,\n \\"sync point\\"\ null,\n \\"master code\\"\ null,\n \\"dt\\"\ null,\n \\"svme\\"\ null,\n \\"me\\"\ null,\n \\"description toloka\\"\ null,\n \\"visits per month\\" 1,\n \\"supervisor code\\"\ null,\n \\"ka dt\\"\ null,\n \\"svme code\\"\ null,\n \\"svme email\\"\ null,\n \\"me code\\"\ null,\n \\"json\\" {\n \\"rar\\" 16,\n \\"wav\\" 17,\n \\"attr\\" \\"test value\\"\n },\n \\"description\\" \\"stop again across arrive across develop address across business suffer responsibility choice rich account involve \\",\n \\"retail chain\\" 5,\n \\"store type\\"\ null,\n \\"group\\"\ null,\n \\"agent routes\\" \[\n \n ]\n },\n \\"images\\" \[\n {\n \\"12859\\" \\"https //test inspector cloud com/media/2020/07/27/b42e4d19 05aa 4485 8141 4bb59775fce8 jpg\\"\n }\n ],\n \\"current agent name\\" \\"agent\\",\n \\"current agent route\\" \\"staging\\",\n \\"moderation\\"\ null,\n \\"results\\" {\n \\"id\\" 25314,\n \\"status\\" \\"positive\\",\n \\"update type\\" \\"visit results\\",\n \\"message type\\" \\"text\\",\n \\"message\\" \\" \<h2> ŠŗŠ¾Š»ŠøŃŠµŃŃŠ²Š¾ Š¾Š±ŃŠ°Š±Š¾ŃŠ°Š½Š½ŃŃ
ŠŗŠ°ŃŃŠ¾Š²ŃŃ
ŃŠ·Š»Š¾Š² 5 ŠøŠ· 3 \</h2> \\",\n \\"created date\\" \\"2020 07 27t18 43 13 624437z\\",\n \\"updated at\\" \\"2020 07 27t18 43 13 624482z\\",\n \\"message short\\"\ null,\n \\"agent\\" 864,\n \\"visit\\" 2323,\n \\"scene\\"\ null\n },\n \\"helpdesk\\"\ null\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/sku/\r\n h āauthorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875eā \r\n āf \\"limit=1\\" \\\\\r\n āf \\"offset=0\\" ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "get /visits", "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 visits next string (uri) nullable nullable next page previous string (uri) nullable nullable previous page results a rray of objects an array of objects with information about visits id string visit id shop string shop id agent string the agent who performs the visit started date string (date time) date and time of the start of the visit (utc) in the format Ā«yyyy mm ddthh\ mm\ sszĀ» task string latitude float the coordinates of the merchandiser during the visit width longitude float the coordinates of the merchandiser during the visit longitude shop name string shop area string gps shop array of objects an array with information about the point of sale where the visit takes place images array of objects photos the visit current agent name string current agent route string moderation string results array of objects visit results id string status string update type string message type string the data type in which the result is output message text information about the results of the visit helpdesk string post post /visits Ńreate a new visit { "tab" "request", "url" "https //instance name/api/v1 5/visits/", "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" "visit id " }, { "kind" "optional", "name" "shop", "type" "string", "description" "client specific customer/outlet/shop/ id " }, { "kind" "optional", "name" "agent", "type" "string", "description" "client specific agent name/id/route/ " }, { "kind" "optional", "name" "started date", "type" "string", "description" "date and time of the visit start (utc time) to create a visit, expect a date in the format Ā«yyyy mm ddthh\ mm\ sszĀ» " }, { "kind" "optional", "name" "latitude", "type" "integer", "description" "location of the merchandiser at the time of the visit by latitude " }, { "kind" "optional", "name" "longitude", "type" "string", "description" "location of the merchandiser at the time of the visit by longitude " } ], "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/sku/ \r\n h āauthorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875eā \r\n f \\"id=2323\\" \\\ \r\n f \\"shop=1504553224092\\" \\\\\r\n f \\"agent=alex\\"\r\n ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "post /sku", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } get get /visits/{id} retrieve detailed information about a visit by id { "tab" "request", "url" "https //instance name/api/v1 5/visits/{id}", "name" "request example", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "visit 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\\" 2032,\n \\"shop\\" \\"1504553224092\\",\n \\"agent\\" \\"agent\\",\n \\"started date\\" \\"2020 07 27t18 35 46 586695z\\",\n \\"task\\"\ null,\n \\"latitude\\" 53 7356226,\n \\"longitude\\" 91 4279673,\n \\"shop name\\" \\"the one with ondemand task groups\\",\n \\"shop area\\"\ null,\n \\"gps shop\\" {\n \\"id\\" 5316,\n \\"logo\\"\ null,\n \\"route\\" \\"939 eah\\",\n \\"route type description\\"\ null,\n \\"customer id\\" \\"1504553224092\\",\n \\"customer name\\" \\"the one with ondemand task groups\\",\n \\"region\\" \\"south ashley\\",\n \\"region l3\\"\ null,\n \\"region l4\\"\ null,\n \\"area\\"\ null,\n \\"area l5\\"\ null,\n \\"area l6\\"\ null,\n \\"city\\" \\"garrisonfurt\\",\n \\"sales route id\\"\ null,\n \\"latitude\\" 45 5718055,\n \\"longitude\\" 110 701806,\n \\"created at\\" \\"2020 06 29t15 24 18 290885z\\",\n \\"updated at\\" \\"2021 10 08t08 16 02 513126z\\",\n \\"address\\" \\"51805 james streamwilliamsview, nm 65300\\",\n \\"distr name\\"\ null,\n \\"team id\\"\ null,\n \\"rsm name\\"\ null,\n \\"rsm code\\"\ null,\n \\"tsm name\\"\ null,\n \\"route type full\\"\ null,\n \\"segment\\"\ null,\n \\"pos code\\"\ null,\n \\"matrix name\\"\ null,\n \\"gtm role id description\\"\ null,\n \\"id dealer\\"\ null,\n \\"golden id\\"\ null,\n \\"sector\\"\ null,\n \\"manager\\"\ null,\n \\"inn\\"\ null,\n \\"kpp\\"\ null,\n \\"sale channel\\"\ null,\n \\"country\\" \\"somalia\\",\n \\"fss\\"\ null,\n \\"fss code\\"\ null,\n \\"sfss\\"\ null,\n \\"sfss code\\"\ null,\n \\"em\\"\ null,\n \\"em code\\"\ null,\n \\"agency\\"\ null,\n \\"agency region\\"\ null,\n \\"kam food\\"\ null,\n \\"kam food code\\"\ null,\n \\"kam hpc\\"\ null,\n \\"kam hpc code\\"\ null,\n \\"ctl\\"\ null,\n \\"ctl code\\"\ null,\n \\"mte\\"\ null,\n \\"mte code\\"\ null,\n \\"nsd\\"\ null,\n \\"nsd code\\"\ null,\n \\"visit plan id\\"\ null,\n \\"driver id\\"\ null,\n \\"sap code\\"\ null,\n \\"sales group\\"\ null,\n \\"visit type\\"\ null,\n \\"hierarchy l5\\"\ null,\n \\"hierarchy l6\\"\ null,\n \\"visit frequency\\"\ null,\n \\"dsd distr\\"\ null,\n \\"store number\\"\ null,\n \\"virtual flag\\"\ null,\n \\"lka segment\\"\ null,\n \\"customer segment\\"\ null,\n \\"y cust hier level 6\\"\ null,\n \\"y cust hier level 8\\"\ null,\n \\"store format\\"\ null,\n \\"team route\\"\ null,\n \\"route type dsd\\"\ null,\n \\"route merch\\"\ null,\n \\"service type\\"\ null,\n \\"svm\\"\ null,\n \\"tm\\"\ null,\n \\"rmm\\"\ null,\n \\"kam ekam\\"\ null,\n \\"skam\\"\ null,\n \\"days sequence code\\"\ null,\n \\"weekly frequency\\"\ null,\n \\"bm\\"\ null,\n \\"sv\\"\ null,\n \\"se\\"\ null,\n \\"task type\\"\ null,\n \\"task subtype\\"\ null,\n \\"enabled\\"\ true,\n \\"week days\\" \\"1,2,3,4,5,6,7\\",\n \\"uuid\\" \\"5be684a7 7fd8 4256 92cc b8d50e279a\\",\n \\"global channel\\"\ null,\n \\"sync point\\"\ null,\n \\"master code\\"\ null,\n \\"dt\\"\ null,\n \\"svme\\"\ null,\n \\"me\\"\ null,\n \\"description toloka\\"\ null,\n \\"visits per month\\" 1,\n \\"supervisor code\\"\ null,\n \\"ka dt\\"\ null,\n \\"svme code\\"\ null,\n \\"svme email\\"\ null,\n \\"me code\\"\ null,\n \\"json\\" {\n \\"rar\\" 16,\n \\"wav\\" 17,\n \\"attr\\" \\"test value\\"\n },\n \\"description\\" \\"stop again across \\",\n \\"retail chain\\" 5,\n \\"store type\\"\ null,\n \\"group\\"\ null,\n \\"agent routes\\" \[\n \n ]\n },\n \\"images\\" \[\n \\" \\"\n ],\n \\"current agent name\\" \\"agent\\",\n \\"current agent route\\" \\"staging\\",\n \\"moderation\\"\ null,\n \\"results\\" {\n \\" \\"\n },\n \\"helpdesk\\"\ null\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/visits/2032/ \r\n h āauthorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875eā ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "get /visits/{id}", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } response parameters id string visit id shop string shop id agent string the agent who performs the visit started date string (date time) date and time of the start of the visit (utc) in the format Ā«yyyy mm ddthh\ mm\ sszĀ» task string latitude float the coordinates of the merchandiser during the visit width longitude float the coordinates of the merchandiser during the visit longitude shop name string shop area string gps shop array of objects an array of information about the point of sale where the visit takes place images array of objects photos in the visit current agent name string current agent route string moderation string results array of objects visit results helpdesk string https //help inspector cloud com/en/docs/api/backend/methods/v1 5/catalog/brands id#response definitions put put /visits/{id} update all fields of visit { "tab" "request", "url" "https //instance name/api/v1 5/visits/{id}", "name" "request example", "method" "put", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "sku 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\\" 9846,\n \\"shop\\" \\"1504553224092\\",\n \\"agent\\" \\"agent\\",\n \\"started date\\" \\"2020 07 27t18 35 46 586695z\\",\n \\"task\\"\ null,\n \\"latitude\\" 53 7356226,\n \\"longitude\\" 91 4279673,\n \\"shop name\\" \\"the one with ondemand task groups\\",\n \\"shop area\\"\ null,\n \\"gps shop\\" {\n \\" \\"\n },\n \\"images\\" \[\n \\" \\"\n ],\n \\"current agent name\\" \\"agent\\",\n \\"current agent route\\" \\"staging\\",\n \\"moderation\\"\ null,\n \\"results\\" {\n \\" \\"\n },\n \\"helpdesk\\"\ null\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "bcmdi d9um v1lp9epj4i" }, "examples" { "languages" \[ { "id" "cu1xhlxz5phaulfx iif1", "code" "curl āi āx put\r\n https //test eyrene com/api/v1 5/visits/2032/ \r\n h āauthorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875eā\r\n f \\"id=9846\\"\r\n ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "put /visits/{id}", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } patch patch /visits/{id} update some of the visit fields { "tab" "request", "url" "https //instance name/api/v1 5/visits/{id}", "name" "request example", "method" "patch", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "sku id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "id", "type" "string", "description" "sku id " }, { "kind" "optional", "name" "cid", "type" "string", "description" "client specific sku id, e g internal code " }, { "kind" "optional", "name" "ean13", "type" "string", "description" "european article number " }, { "kind" "optional", "name" "image", "type" "string", "description" "sku image id, available via /uploads or /uploads by url " }, { "kind" "optional", "name" "name", "type" "string", "description" "human readable sku name " }, { "kind" "optional", "name" "brand", "type" "string", "description" "brand id " }, { "kind" "optional", "name" "category", "type" "string", "description" "category id " }, { "kind" "optional", "name" "manufacturer", "type" "string", "description" "manufacturer id " }, { "kind" "optional", "name" "size x mm", "type" "integer", "description" "product width in mm " }, { "kind" "optional", "name" "size y mm", "type" "integer", "description" "product height in mm " }, { "kind" "optional", "name" "size z mm", "type" "integer", "description" "product depth in mm " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "bcmdi d9um v1lp9epj4i", "code" "{\n \\"id\\" 9846,\n \\"shop\\" \\"1504553224\\",\n \\"agent\\" \\"agent\\",\n \\"started date\\" \\"2020 07 27t18 35 46 586695z\\",\n \\"task\\"\ null,\n \\"latitude\\" 53 7356226,\n \\"longitude\\" 91 4279673,\n \\"shop name\\" \\"the one with ondemand task groups\\",\n \\"shop area\\"\ null,\n \\"gps shop\\" {\n \\" \\"\n },\n \\"images\\" \[\n \\" \\"\n ],\n \\"current agent name\\" \\"agent\\",\n \\"current agent route\\" \\"staging\\",\n \\"moderation\\"\ null,\n \\"results\\" {\n \\" \\"\n },\n \\"helpdesk\\"\ null\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/sku/2032/ \r\n h āauthorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875eā\r\n f \\"id=9846\\" \\\\\r\n f \\"shop=1504553224\\"", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "patch /visits/{id}", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }