Skip to main content

/planograms

Retrieves a list of planograms or creates a new one.

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

Methods:

  • GET — list planograms;
  • POST — create planogram.

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

Response example

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

Response definitions

count integer

Required. Number of planograms.

next string (uri) Nullable

Next page.

previous string (uri) Nullable

Previous page.

results Array of objects

Required. Array of objects with information about planograms.

id string

Unique ID.

name string

Human-readable name. Optional

display string

Display ID.