API
Image Recognition API
SKU
methods allow you to get a complete list or a specific sku in eyrene, view information about them, update all fields, or only select sku fields get get /sku retrieve a list of skus { "tab" "request", "url" "https //instance name/api/v1 5/sku/", "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\\" 703,\n \\"cid\\" \\"9000101421\\",\n \\"ean13\\"\ null,\n \\"image\\" 86824084,\n \\"name\\" \\"bref 2x50g pronature fresh mint\\",\n \\"brand\\" 376,\n \\"category\\" 49,\n \\"manufacturer\\" 6,\n \\"size x mm\\" 125,\n \\"size y mm\\" 176,\n \\"size z mm\\" 50\n },\n {\n \\"id\\" 704,\n \\"cid\\" \\"7441078217\\",\n \\"ean13\\"\ null,\n \\"image\\" 86824149,\n \\"name\\" \\"papel higienico super max 220 max 4 rollos\\",\n \\"brand\\" 10285,\n \\"category\\" 3235,\n \\"manufacturer\\" 474,\n \\"size x mm\\" 200,\n \\"size y mm\\" 210,\n \\"size z mm\\" 110\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=2\\" \\\\\r\n āf \\"offset=0\\" ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "get /sku", "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 skus 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 skus id string sku id cid string client specific sku id, e g internal code ean13 string european article number image string sku image id, available via /uploads https //docs eyrene com/uploads#ou post uploads or /uploads by url https //docs eyrene com/uploads#qa post uploadsuploadsbyurl name string human readable sku name brand string brand https //docs eyrene com/brands id category string category https //docs eyrene com/categories id manufacturer string manufacturer id size x mm float product width in mm size y mm float product height in mm size z mm float product depth in mm post post /sku Ńreate a new sku { "tab" "request", "url" "https //instance name/api/v1 5/sku/", "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" "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" "string", "description" "product depth in mm " } ], "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=704\\" \\\\\r\n f \\"cid=7441078217\\" \\\\\r\n f \\"image=86824149\\" \\\\\r\n f \\"name=papel higienico super max 220 max 4 rollos\\" \\\\\r\n f \\"brand=10285\\" \\\\\r\n f \\"category=3235\\" \\\\\r\n f \\"manufacturer=474\\" \\\\\r\n f \\"size x mm=200\\" \\\\\r\n f \\"size x mm=210\\" \\\\\r\n f \\"size z mm=110\\" \\\\", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "post /sku", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } get get /sku/{id} retrieve detailed information about sku by id { "tab" "request", "url" "https //instance name/api/v1 5/sku/{id}", "name" "request example", "method" "get", "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\\" 703,\n \\"cid\\" \\"9000101421\\",\n \\"ean13\\"\ null,\n \\"image\\" 86824084,\n \\"name\\" \\"bref 2x50g pronature fresh mint\\",\n \\"brand\\" 376,\n \\"category\\" 49,\n \\"manufacturer\\" 6,\n \\"size x mm\\" 125,\n \\"size y mm\\" 176,\n \\"size z mm\\" 50\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/sku/703/ \r\n h āauthorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875eā ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "get /sku/{id}", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } response parameters id string sku id cid string client specific sku id, e g internal code ean13 string european article number image string sku image id, available via /uploads https //docs eyrene com/uploads#ou post uploads or /uploads by url https //docs eyrene com/uploads#qa post uploadsuploadsbyurl name string human readable sku name brand string https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/brand brand https //docs eyrene com/brands id category string https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/categories category https //docs eyrene com/categories id manufacturer string https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/monofacturers manufacturer https //docs eyrene com/manufacturers id size x mm float product width in mm size y mm float product height in mm size z mm float product depth in mm https //help inspector cloud com/en/docs/api/backend/methods/v1 5/catalog/brands id#response definitions put put /sku/{id} update all sku fields { "tab" "request", "url" "https //instance name/api/v1 5/sku/{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" \[ { "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" "manufacture", "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" "string", "description" "product height in mm " }, { "kind" "optional", "name" "size z mm", "type" "string", "description" "product depth in mm " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "bcmdi d9um v1lp9epj4i", "code" "{\n \\"id\\" 9846,\n \\"cid\\" \\"9000101421\\",\n \\"ean13\\"\ null,\n \\"image\\" 86824084,\n \\"name\\" \\"bref 2x50g pronature fresh mint\\",\n \\"brand\\" 376,\n \\"category\\" 49,\n \\"manufacturer\\" 6,\n \\"size x mm\\" 125,\n \\"size y mm\\" 176,\n \\"size z mm\\" 50\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/sku/704/ \r\n h āauthorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875eā\r\n f \\"id=9846\\" \\\\\r\n f \\"cid=9000101421\\" \\\\\r\n f \\"image=86824084\\" \\\\\r\n f \\"name=bref 2x50g pronature fresh mint\\" \\\\\r\n f \\"brand=376\\" \\\\\r\n f \\"category=49\\" \\\\\r\n f \\"manufacturer=6\\" \\\\\r\n f \\"size x mm=125\\" \\\\\r\n f \\"size x mm=176\\" \\\\\r\n f \\"size z mm=50\\" \\\\", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "put /sku/{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 sku id cid string client specific sku id, e g internal code ean13 string european article number image string sku image id, available via /uploads https //docs eyrene com/uploads#ou post uploads or /uploads by url https //docs eyrene com/uploads#qa post uploadsuploadsbyurl name string human readable sku name brand string https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/brand brand https //docs eyrene com/brands id category string https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/categories category https //docs eyrene com/categories id manufacturer string https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/monofacturers manufacturer https //docs eyrene com/manufacturers id size x mm float product width in mm size y mm float product height in mm size z mm float product depth in mm patch patch /sku/{id} update some of sku { "tab" "request", "url" "https //instance name/api/v1 5/sku/{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 \\"cid\\" \\"9000101421\\",\n \\"ean13\\"\ null,\n \\"image\\" 86824084,\n \\"name\\" \\"papel higienico super max 220 max 4 rollos\\",\n \\"brand\\" 376,\n \\"category\\" 49,\n \\"manufacturer\\" 6,\n \\"size x mm\\" 125,\n \\"size y mm\\" 176,\n \\"size z mm\\" 50\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/704/ \r\n h āauthorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875eā\r\n f \\"id=9846\\" \\\\\r\n f \\"name=papel higienico super max 220 max 4 rollos\\" \\\\", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "patch /sku/{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 sku id cid string client specific sku id, e g internal code ean13 string european article number image string sku image id, available via /uploads https //docs eyrene com/uploads#ou post uploads or /uploads by url https //docs eyrene com/uploads#qa post uploadsuploadsbyurl name string human readable sku name brand string https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/brand brand https //docs eyrene com/brands id category string https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/categories category https //docs eyrene com/categories id manufacturer string https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/monofacturers manufacturer https //docs eyrene com/manufacturers id size x mm float product width in mm size y mm float product height in mm size z mm float product depth in mm get get /sku/?cid={cid} list sku with the given customer id ( cid ) field { "tab" "request", "url" "https //instance name/api/v1 5/sku/?cid={cid}", "name" "request example", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "cid", "type" "string", "description" "customer sku id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "optional", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "du9xr9j8bu4jftmv8bpry", "code" "{\n \\"id\\" 703,\n \\"cid\\" \\"9000101421\\",\n \\"ean13\\"\ null,\n \\"image\\" 86824084,\n \\"name\\" \\"bref 2x50g pronature fresh mint\\",\n \\"brand\\" 376,\n \\"category\\" 49,\n \\"manufacturer\\" 6,\n \\"size x mm\\" 125,\n \\"size y mm\\" 176,\n \\"size z mm\\" 50\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "du9xr9j8bu4jftmv8bpry" }, "examples" { "languages" \[ { "id" "n8qhhtsdo9fbqybtrcldg", "code" "curl āi āx get\n https //test eyrene com/api/v1 5/sku/?cid=9000101421 \n h āauthorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875eā", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "n8qhhtsdo9fbqybtrcldg" }, "description" "get /sku/?cid={cid}", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } response parameters id string sku id cid string client specific sku id, e g internal code ean13 string european article number image string sku image id, available via /uploads https //help inspector cloud com/en/docs/api/backend/methods/v1 5/upload/uploads or /uploads by url https //help inspector cloud com/en/docs/api/backend/methods/v1 5/upload/uploads by url name string human readable sku name brand string https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/brand brand https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/brand id category string https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/categories category https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/categories id manufacturer string https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/monofacturers manufacturer https //help inspector cloud com/en/docs/api/backend/methods/v1 5/sku/monofacturers id size x mm float product width in mm size y mm float product height in mm size z mm float product depth in mm