Skip to main content

/planogram_records/{id}

Retrieve detailed planogram record information by ID, or updates the fields in the planogram record (specified or all). Also allows you to delete the planogram record via DELETE method.

Adress: https://instance_name/api/v1.5/planogram_records/{id}

Methods:

  • GET — retrieve detailed planogram record information by ID;
  • PUT — update all planogram record fields;
  • PATCH — update some planogram record fields.
  • DELETE — delete planogram record.

Content-type: application/json

Path parameters​

id string

Required. Planogram record ID.

Request example

curl –i –X GET
  https://test.inspector-cloud.com/api/v1.5/planogram_records/1/ 
  -H ‘Authorization: Token <<your_token>>’

Response example

Response code: 200


{
      "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

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.