MHL

methods allow you to get a complete list or a specific must have list in eyrene, view information about them, update all fields, or only select mhl fields also, you can delete mhl by id get get /mhl retrieve a must have list use mhl to define a list of products that must necessarily be on the shelf mhl compliance https //docs eyrene com/reports#sn mhlcompliance report based on the mhl mhl is associated with other entities using the display { "tab" "request", "url" "https //instance name/api/v1 5/mhl/", "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\\" 3,\n \\"next\\" \\"http //example com\\",\n \\"previous\\"\ null,\n \\"results\\" \[\n {\n \\"id\\" 31,\n \\"name\\" \\"top 45\\",\n \\"display\\" 19\n },\n {\n \\"id\\" 32,\n \\"name\\" \\"wbd\\",\n \\"display\\" 19\n },\n {\n \\"id\\" 33,\n \\"name\\" \\"top 45\\",\n \\"display\\" 20\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/mhl/\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 /mhl", "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 mhls 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 mhls id string unique id name string human readable name display string display https //docs eyrene com/displays id post post /mhl сreate a new must have list use mhl to define a list of products that must necessarily be on the shelf mhl compliance https //docs eyrene com/reports#sn mhlcompliance report based on the mhl mhl is associated with other entities using the display mhl { "tab" "request", "url" "https //instance name/api/v1 5/mhl/", "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/mhl/ \r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’ \r\n f \\"id=46\\" \\\\\r\n f \\"name=new products matrix\\"", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "post /mhl", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } get get /mhl/{id} retrieve detailed information about must have list by id { "tab" "request", "url" "https //instance name/api/data/v1 5/mhl/{id}", "name" "request example", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "mhl 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\\" 31,\n \\"name\\" \\"top 45\\",\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/mhl/31/ \r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’ ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "get /mhl/{id}", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } response parameters id string unique id name string human readable name display string display id musthavelist string must have list id https //help inspector cloud com/en/docs/api/backend/methods/v1 5/catalog/brands id#response definitions put put /mhl/{id} update all must have list fields { "tab" "request", "url" "https //instance name/api/v1 5/mhl/{id}", "name" "request example", "method" "put", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "mhl 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\\" 45,\n \\"name\\" \\"new products matrix\\",\n \\"display\\" 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/mhl/31/ \n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’ \n f \\"id=45\\" \\\\\n f \\"name=new products matrix\\" \\\\\n f \\"display=11\\"", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "gbxujakfuej3yazlqwoid" }, "description" "put /mhl/{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 /mhl/{id} update some of must have list fields { "tab" "request", "url" "https //instance name/api/v1 5/mhl/{id}", "name" "request example", "method" "patch", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "mhl 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\\" 31,\n \\"name\\" \\"new products matrix\\",\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/mhl/31/ \r\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’\r\n f \\"name=new products matrix\\" ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cu1xhlxz5phaulfx iif1" }, "description" "patch /mhl/{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 /mhl/{id} delete must have list by id { "tab" "request", "url" "https //instance name/api/v1 5/mhl/{id}", "name" "request example", "method" "delete", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "mhl 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/mhl/31/\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "n8qhhtsdo9fbqybtrcldg" }, "description" "delete /mhl/{id}", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } }