Categories

methods allow you to get a complete list or a specific category in eyrene, view information about them, update all fields, or only select category fields get get /сategories retrieves a list of categories { "tab" "request", "url" "https //instance name/api/v1 5/categories/", "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\\" \\"http //example com\\",\n \\"results\\" \[\n {\n \\"id\\" 3155,\n \\"name\\" \\"ground coffee\\"\n },\n {\n \\"id\\" 47,\n \\"name\\" \\"hair care\\"\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/categories/\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 /categories", "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 categories 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 categories id string category id name string category name post post /сategories сreate a new category { "tab" "request", "url" "https //instance name/api/v1 5/сategories/", "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" "category id " }, { "kind" "optional", "name" "name", "type" "string", "description" "category name " } ], "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/categories/ \r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’ \r\n f \\"id=1234567890\\" \\\\\r\n f \\"name=washing powder\\"", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "post /сategories", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } get get /сategories/{id} retrieve detailed information about a category by id { "tab" "request", "url" "https //instance name/api/v1 5/сategories/{id}", "name" "request example", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "category 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\\" 1234567890,\n \\"name\\" \\"washing powder\\"\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/сategories/1234567890/ \r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’ ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "get /сategories/{id}", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } response parameters ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/catalog/brands id#response definitions id string category id name string category name /brands/{id} put put /сategories/{id} update all category fields { "tab" "request", "url" "https //instance name/api/v1 5/categories/{id}", "name" "request example", "method" "put", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "category id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "id", "type" "string", "description" "new category id " }, { "kind" "optional", "name" "name", "type" "string", "description" "category new name " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "bcmdi d9um v1lp9epj4i", "code" "{\n \\"id\\" 1234567890112,\n \\"name\\" \\"cat food\\"\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/categories/1234567890/ \r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’\r\n f \\"id=1234567890112\\" \\\\\r\n f \\"name=cat food\\" ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "put /categories/{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 new category id name string category new name patch patch /сategories/{id} update some of the category fields { "tab" "request", "url" "https //instance name/api/v1 5/categories/{id}", "name" "request example", "method" "patch", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "category id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "id", "type" "string", "description" "new category id " }, { "kind" "optional", "name" "name", "type" "string", "description" "category new name " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "bcmdi d9um v1lp9epj4i", "code" "{\n \\"id\\" 1234567890,\n \\"name\\" \\"dishwashing\\"\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/categories/1234567890/ \r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’\r\n f \\"name=dishwashing\\"", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "patch /categories/{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 new category id name string category new name