API
Image Recognition API

Planograms

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



Retrieve a list of planograms.

GET /planograms
GET
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format
Body Parameters
limit
optional
String
The number of results to return per page.
offset
optional
String
The initial index from which to return the results.


Response parameters



count integer

The number of planograms.



next string (uri) Nullable

Next page.



previous string (uri) Nullable

Previous page.



results array of objects

An array of objects with information about planograms.

  • id string Unique ID.
  • name string Human-readable name.
  • display string Display ID.






Сreate a new planogram.

POST /planograms
POST
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format
Body Parameters
id
optional
String
Unique ID.
name
optional
String
Human-readable name.
display
optional
String
Display ID.



Retrieve detailed information about the planogram by ID.

GET /planograms/{id}
GET
Request
Path Params
id
required
String
Planogram ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format


Response parameters



id string

Unique ID.



name string

Human-readable name.



display string

Display ID.



musthavelist string

Planogram ID.







Update all planogram fields.

PUT /planograms/{id}
PUT
Request
Path Params
id
required
String
Planogram ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format
Body Parameters
id
optional
String
Unique ID.
name
optional
String
Human-readable name.
display
optional
String
Display ID.


Response parameters



id string

Unique ID.



name string

Human-readable name.



display string

Display ID.







Update some of the planogram fields.

PATCH /planograms/{id}
PATCH
Request
Path Params
id
required
String
Planogram ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format
Body Parameters
id
optional
String
Unique ID.
name
optional
String
Human-readable name.
display
optional
String
Display ID.


Response parameters



id string

Unique ID.



name string

Human-readable name.



Display string

Display ID.







Delete planogram by ID.

DELETE /planograms/{id}
DELETE
Request
Path Params
id
required
String
Planogram ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format





Updated 03 Mar 2023
Did this page help you?