Skip to main content

/displays

Retrieves a list of displays or creates a new one.

Use displays to define all merchandising requirements, e.g. planograms, must have lists, etc., for a scene.

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

Methods:

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

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/displays/
  -H ‘Authorization: Token <<your_token>>’ 
  -F "limit=4" \
  -F "offset=0"

Response example

{
  "count": 2,
  "next": "http://example.com",
  "previous": null,
  "results": [
    {
      "id": 29,
      "name": "Н.НОВГОРОДЛК ПОВОЛЖЬЕ ТОЧКА ММ2/2019-03-31",
      "musthavelist": null
    },
    {
      "id": 4,
      "name": "МОСКВАМОСКВА Х5 СТАНДАРТ (20)/2019-03-15",
      "musthavelist": 6
    },
    {
      "id": 3,
      "name": "МОСКВАМОСКВА БИЛЛА 409/2019-03-15",
      "musthavelist": 5
    },
    {
      "id": 37,
      "name": "Н.НОВГОРОДЛКА ПОВОЛЖЬЕ СПАР НН/ЕВРО ФОРМАТ 6/2019-03-31",
      "musthavelist": null
    }
  ]
}

Response definitions

count integer

Required. Number of displays's.

next string (uri) Nullable

Next page.

previous string (uri) Nullable

Previous page.

results Array of objects

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

id string

Unique ID.

name string

Human-readable name.

planogram string

Planogram ID. Optional.

musthavelist string

Must have list ID. Optional.