Skip to main content

/planogram_records

Retrieves a list of planograms records or creates a new one.

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

Methods:

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

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

Response example

{
  "count": 1,
  "next": "http://example.com",
  "previous": null,
  "results": [
    {
      "id": 1,
      "rack_index": null,
      "shelf_index": null,
      "product_index": null,
      "facing_x": null,
      "facing_y": null,
      "width": null,
      "height": null,
      "planogram": null,
      "sku": null
    }
  ]
}

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.

rack_index integer

Rack number, left to right starting from 0.

shelf_index integer

Shelf number in the rack, top to bottom starting from 0.

product_index integer

Record position in the planogram. Positions are numbered left to right and top to bottom starting from 0, i.e. top left SKU in the planogram has product_index = 0 and bottom right one has a maximal product_index.

facing_x integer

Number of horizontal SKU facings.

facing_y integer

Number of vertical SKU facings (a pile).

width integer

Width.

height integer

Height.

planogram string

Planogram ID.

sku string

SKU ID.