Перейти к основному содержимому

/planograms

Получает список планограмм или добавляет контейнер для новой.

Адрес: https://instance_name/api/v1.5/planograms

Методы:

  • GET — получает список планограмм;
  • POST —добавляет новый контейнер планограммы.

Content-type: application/json

Параметры тела запроса

limit integer

Количество результатов, которые возвращаются в ответе.

offset integer

Начальный индекс, с которого возвращаются результаты.

Пример запроса

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

Пример ответа

{
  "count": 2,
  "next": "http://example.com",
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "planogram_1",
      "display": 19
    },
    {
      "id": 2,
      "name": "planogram_2",
      "display": 19
    }
  ]
}

Параметры ответа

count integer

Обязательный. Количество планограмм в ответе.

next string (uri) Nullable

Следующая страница списка.

previous string (uri) Nullable

Предыдущая страница списка.

results Array of objects

Обязательный. Массив объектов с информацией по планограммам.

id string

Уникальный идентификатор планограммы.

name string

Человекочитаемое название планограммы.

display string

Идентификатор экрана.