/mhl
MHL (Must Have List) — это ассортиментная матрица, список товаров, которые обязательно должны быть представлены на полках. На основе MHL формируется отчет MHL_COMPLIANCE. MHL связан с другими объектами, которые используют display.mhl
.
Метод получает список контейнеров с объектами mhl_record
или добавляет новый.
Адрес: https://instance_name/api/v1.5/mhl
Методы:
- GET — получает список объектов
mhl_record
; - POST —добавляет новый контейнер для
mhl_record
.
Content-type: application/json
- GET
- POST
Параметры тела запроса
limit
integer
Количество результатов, которые возвращаются в ответе.
offset
integer
Начальный индекс, с которого возвращаются результаты.
Пример запроса
curl –i –X GET
https://test.inspector-cloud.com/api/v1.5/mhl/
-H ‘Authorization: Token <<your_token>>’
-F "limit=3" \
-F "offset=0"
Пример ответа
{
"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
}
]
}
Параметры ответа
count
integer
next
string (uri) Nullable
Следующая страница списка.
previous
string (uri) Nullable
Предыдущая страница списка.
results
Array of objects
Обязательный. Массив объектов с информацией по MHL-контейнерам.
id
string
Уникальный идентификатор MHL.
name
string
Человекочитаемое название MHL.
display
string
Идентификатор экрана.
Параметры тела запроса
id
string
Уникальный идентификатор MHL.
name
string
Человекочитаемое название MHL.
display
string
Идентификатор экрана.
Пример запроса
curl –i –X POST
https://test.inspector-cloud.com/api/v1.5/mhl/
-H ‘Authorization: Token <<your_token>>’
-F "id=46" \
-F "name=new_products_matrix"
Пример ответа
Код ответа: 201