/planograms/{id}
Retrieve detailed planogram information by ID, or updates the fields in the planogram (specified or all). Also allows you to delete the planogram via DELETE method.
Adress: https://instance_name/api/v1.5/planograms/{id}
Methods:
- GET — retrieve detailed planogram information by ID;
- PUT — update all planogram fields;
- PATCH — update some planogram fields.
- DELETE — delete planogram.
Content-type: application/json
- GET
- PUT
- PATCH
- DELETE
Path parameters
id string
Request example
curl –i –X GET
https://test.inspector-cloud.com/api/v1.5/planograms/1/
-H ‘Authorization: Token <<your_token>>’
Response example
Response code: 200
{
"id": 1,
"name": "planogram_1",
"display": 19
}
Response definitions
id string
Unique ID.
name string
Human-readable name. Optional
display string
Display ID.
Path parameters
id string
Request body parameters
id string
Unique ID.
name string
Human-readable name. Optional
display string
Display ID.
Request example
curl –i –X PUT
https://test.inspector-cloud.com/api/v1.5/planograms/1/
-H ‘Authorization: Token <<your_token>>’
-F "id=24" \
-F "name=new_planogram" \
-F "display=34"
Response example
Response code: 200
{
"id": 24,
"name": "new_planogram",
"display": 34
}
Path parameters
id string
Request body parameters
id string
Unique ID.
name string
Human-readable name. Optional
display string
Display ID.
Request example
curl –i –X PATCH
https://test.inspector-cloud.com/api/v1.5/planograms/1/
-H ‘Authorization: Token <<your_token>>’
-F "name=new_planogram"
Response example
Response code: 200
{
"id": 1,
"name": "new_planogram",
"display": 19
}
Path parameters
id string
Request example
curl –i –X DELETE
https://test.inspector-cloud.com/api/v1.5/planograms/1/
-H ‘Authorization: Token <<your_token>>’
Response example
Response code: 200