Planograms

Endpoint is used to export product lists (entities) from Repsly database.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

More Info

To get the complete list of product list entities, start your request with parameter {lastProductListID} = 0.


Response definition

NameTypeDescription
MetaCollectionResult\TotalCountIntegerTotal count of product lists
MetaCollectionResult\FirstIDIntegerUnique ID of the first item in the list
MetaCollectionResult\LastIDIntegerUnique ID of the last item in the list
IDIntegerUnique planogram identifier
DisplayTypeStringDisplay type name (defined in DB, referenced by Name)
CategoryStringProduct category (defined in DB, referenced by Name)
AccountIDGuid?Assigned account ID
PlaceIDInteger?Assigned place (client) ID
NameStringGenerated planogram name
ValidFromDateTime?Planogram is valid FROM this date (can be open ended)
ValidToDateTime?Planogram is valid TO this date (can be open ended)
Items.ProductCodeStringProduct (defined in DB, referenced by Code)
Items.ShelfNumberIntegerShelf number (bottom = 1, goes up)
Items.HorizontalPositionIntegerProduct stack number (leftmost = 1, goes right)
Items.VerticalPositionIntegerProduct facing number within the stack (bottom = 1, goes up)

Path Params
int64
required
Defaults to 0
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json