Skip to main content

/mhl

Retrieves a list of MHL or creates a new one.

Use MHL to define a list of goods that must necessarily be on the shelf. MHL_COMPLIANCE report based on the MHL. MHL is associated with other entities using the display.mhl.

Adress: https://instance_name/api/v1.5/mhl

Methods:

  • GET — list MHL;
  • POST — create MHL.

Content-type: application/json

Request body parameters

limit integer

Number of results to return per page.

offset integer

The initial index from which to return the results.

Request example

curl –i –X GET
  https://test.inspector-cloud.com/api/v1.5/mhl/
  -H ‘Authorization: Token <<your_token>>’ 
  -F "limit=3" \
  -F "offset=0"

Response example

{
  "count": 3,
  "next": "http://example.com",
  "previous": null,
  "results": [
    {
      "id": 31,
      "name": "TOP 45",
      "display": 19
    },
    {
      "id": 32,
      "name": "WBD",
      "display": 19
    },
    {
      "id": 33,
      "name": "TOP 45",
      "display": 20
    }
  ]
}

Response definitions

count integer

Required. Number of MHL's.

next string (uri) Nullable

Next page.

previous string (uri) Nullable

Previous page.

results Array of objects

Required. Array of objects with information about MHL's.

id string

Unique ID.

name string

Human-readable name. Optional

display string

Display ID.