Planogram records

Methods allow you to get a complete list or a specific planogram record in Eyrene, view information about them, update all fields, or only select planogram record fields. Also, you can delete the planogram record by ID.

Retrieve a list of planograms records.

Request example

GET /planograms_records

GET

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

Header Parameters

Authorizationstringrequired
Description
String in "Token XXXXXX..." format.

Body Parameters

limitstring
Description
The number of results to return per page.
offsetstring
Description
The initial index from which to return the results.

curl

curl –i –X GET
  https://test.eyrene.com/api/v1.5/planogram_records/
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ 
  -F "limit=3" \
  -F "offset=0"

200

{
   "count":1,
   "next":"http://example.com",
   "previous":null,
   "results":[
      {
         "id":1,
         "rack_index":0,
         "shelf_index":0,
         "product_index":0,
         "facing_x":6,
         "facing_y":1,
         "width":null,
         "height":null,
         "created_at":"2018-09-02T18:53:39.743058Z",
         "updated_at":"2018-09-02T18:53:39.743081Z",
         "planogram":32,
         "sku":7386
      }
   ]
}

Response parameters

count integer

The number of planogram records.

next string (uri) Nullable

Next page.

previous string (uri) Nullable

Previous page.

results array of objects

An array of objects with information about planogram records.

id string Unique ID.
rack_index integer Rack number, from left to right starting from 0.
shelf_index integer Shelf number in the rack, from 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 the 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 of product.
height integer Height of product.
planogram string Planogram ID.
sku string SKU ID.

Сreate a new planogram record.

Request example

POST /planogram_records

POST

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

Header Parameters

Authorizationstringrequired
Description
String in "Token XXXXXX..." format.

Body Parameters

idstring
Description
Unique ID.
rack_indexNumber
Description
Rack number, from left to right starting from 0.
shelf_indexNumber
Description
Shelf number in the rack, from top to bottom starting from 0.
product_indexNumber
Description
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_xInteger
Description
Number of horizontal SKU facing.
facing_yInteger
Description
Number of vertical SKU facings (a pile).
widthInteger
Description
Width of a product.
heightInteger
Description
Height of a product.
planogramstring
Description
Planogram ID.
skustring
Description
SKU ID.

curl

curl –i –X POST
  https://test.eyrene.com/api/v1.5/planograms/ 
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ 
  -F "id=3" \
  -F "rack_index=1" \
  -F "shelf_index=0" \
  -F "product_index=7" \
  -F "facing_x=1" \
  -F  "facing_y=null" \
  -F  "width=null" \
  -F  "height=null" \
  -F  "planogram=11" \
  -F  "sku=1512"
}

201

{
   "result": "CREATED"
}

Retrieve detailed information about the planogram record by ID.

Request example

GET /planogram_records/{id}

GET

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

Path Parameters

idstringrequired
Description
Planogram record ID.

Header Parameters

Authorizationstringrequired
Description
String in "Token XXXXXX..." format.

curl

curl –i –X GET
  https://test.eyrene.com/api/v1.5/planograms/1/ 
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’

200

{
   "id":1,
   "rack_index":0,
   "shelf_index":0,
   "product_index":0,
   "facing_x":6,
   "facing_y":1,
   "width":null,
   "height":null,
   "created_at":"2018-09-02T18:53:39.743058Z",
   "updated_at":"2018-09-02T18:53:39.743081Z",
   "planogram":32,
   "sku":7386
}

Response parameters

id string

Unique ID.

rack_index integer

Rack number, from left to right starting from 0.

shelf_index integer

Shelf number in the rack, from 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 the bottom right one has a maximal product_index.

facing_x integer

A number of horizontal SKU facings.

facing_y integer

A number of vertical SKU facings (a pile).

width integer

Width of a product.

height integer

Height of a product.

planogram string

Planogram ID.

sku string

SKU ID.

Update all fields of the planogram record.

Request example

PUT /planogram_records/{id}

PUT

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

Path Parameters

idstringrequired
Description
Planogram ID.

Header Parameters

Authorizationstringrequired
Description
String in "Token XXXXXX..." format.

Body Parameters

idstring
Description
Unique ID.
rack_indexNumber
Description
Rack number, from left to right starting from 0.
shelf_indexNumber
Description
Shelf number in the rack, from top to bottom starting from 0.
product_indexNumber
Description
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_xstring
Description
Number of horizontal SKU facings.
facing_ystring
Description
Number of vertical SKU facings (a pile).
widthstring
Description
Width of a product.
heightstring
Description
Height of a product.
planogramstring
Description
Planogram ID.
skustring
Description
SKU ID.

curl

curl –i –X PUT
  https://test.inspector-cloud.com/api/v1.5/planogram_records/1/ 
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ 
  -F "id=3" \
  -F "rack_index=1" \
  -F "shelf_index=3" \
  -F "product_index=4" \
  -F "facing_x=6" \
  -F  "facing_y=1" \
  -F  "width=132" \
  -F  "height=30" \
  -F  "planogram=1" \
  -F  "sku=11"

200

{
   "id":3,
   "rack_index":1,
   "shelf_index":3,
   "product_index":4,
   "facing_x":6,
   "facing_y":1,
   "width":132,
   "height":30,
   "created_at":"2018-09-02T18:53:39.743058Z",
   "updated_at":"2018-09-02T18:53:39.743081Z",
   "planogram":1,
   "sku":11
}

Response parameters

id string

Unique ID.

rack_index integer

Rack number, from left to right starting from 0.

shelf_index integer

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

product_index integer

facing_x integer

A number of horizontal SKU facings.

facing_y integer

A number of vertical SKU facings (a pile).

width integer

Width of a product.

height integer

Height of a product.

planogram string

Planogram ID.

sku string

SKU ID.

Update some fields in the planogram record.

Request example

PATCH /planogram_records/{id}

PATCH

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

Path Parameters

idstringrequired
Description
Planogram ID.

Header Parameters

Authorizationstringrequired
Description
String in "Token XXXXXX..." format.

Body Parameters

idstring
Description
Unique ID.
rack_indexNumber
Description
Rack number, from left to right starting from 0.
shelf_indexNumber
Description
Shelf number in the rack, from top to bottom starting from 0.
product_indexNumber
Description
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_xInteger
Description
Number of horizontal SKU facings.
facing_yInteger
Description
Number of vertical SKU facings (a pile).
widthstring
Description
Width of a product.
heightstring
Description
Height of a product.
planogramstring
Description
Planogram ID.
skustring
Description
SKU ID.

curl

curl –i –X PATCH
  https://test.eyrene.com/api/v1.5/planogram_records/1/ 
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’
  -F "id=3" \
  -F "rack_index=1" \
  -F "shelf_index=3"

200

{
   "id":3,
   "rack_index":1,
   "shelf_index":3,
   "product_index":0,
   "facing_x":6,
   "facing_y":1,
   "width":null,
   "height":null,
   "created_at":"2018-09-02T18:53:39.743058Z",
   "updated_at":"2018-09-02T18:53:39.743081Z",
   "planogram":32,
   "sku":7386
}

Response parameters

id string

Unique ID.

rack_index integer

Rack number, from left to right starting from 0.

shelf_index integer

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

product_index integer

facing_x integer

A number of horizontal SKU facings.

facing_y integer

A number of vertical SKU facings (a pile).

width integer

Width of a product.

height integer

Height of a product.

planogram string

Planogram ID.

sku string

SKU ID.

Delete planogram record by ID.

Request example

DELETE /planogram_records/{id}

DELETE

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

Path Parameters

idstringrequired
Description
Planogram ID.

Header Parameters

Authorizationstringrequired
Description
String in "Token XXXXXX..." format.

curl

curl –i –X DELETE
  https://test.eyrene.com/api/v1.5/planogram_records/1/
  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’

200

{
   "result":"OK"
}

Planogram records

﻿GET /planogram_records

Response parameters​﻿

﻿POST /planogram_records

﻿GET /planogram_records/{id}

Response parameters

﻿PUT /planogram_records/{id}

﻿​Response parameters

﻿PATCH /planogram_records/{id}

Response parameters​﻿

﻿﻿﻿DELETE /planogram_records/{id}

GET /planogram_records

Response parameters

POST /planogram_records

GET /planogram_records/{id}

PUT /planogram_records/{id}

Response parameters

PATCH /planogram_records/{id}

Response parameters

DELETE /planogram_records/{id}