Admin api stores
Get gondola planogram
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
storeId*integer
Id of a physical store. The id is required when retailer want to make a call to specified store.
gondolaId*integer
Id of a gondola
Query Parameters
tOrigin?string
Format
date-timeResponse Body
application/json
application/json
curl -X GET "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/stores/0/planogram/2?tOrigin=2023-07-03T10%3A00%3A00.000Z"{
"tOrigin": "2023-07-03T10:00:00.000Z",
"gondolas": [
0
],
"currentGondola": 0,
"gondolaPlanogram": {
"shelves": {
"property1": {
"shelfIndex": 5,
"coordinates": {
"dimX": 0,
"dimY": 0,
"dimZ": 0,
"transform": {
"translation": {
"x": "0.8978",
"y": "0.0254",
"z": "2.1645"
},
"rotation": {
"x": "0.8978",
"y": "0.0254",
"z": "2.1645"
}
}
},
"bins": [
{
"binSize": 0,
"productId": 0,
"productName": "string",
"productBarcode": "string",
"thumbnail": "string",
"restricted": true,
"productUnits": 0,
"unplannedProductsUnits": 0,
"products": [
{
"quantity": 0,
"product": {
"barcode": "850050071228",
"barcodeType": "upc",
"productId": 49427929792799,
"name": "White Claw Black Cherry",
"price": 1,
"thumbnail": "http://example.com",
"weight": 0,
"retailerType": "shopify",
"RIN": "string",
"restricted": true
}
}
]
}
],
"sizeType": "plate"
},
"property2": {
"shelfIndex": 5,
"coordinates": {
"dimX": 0,
"dimY": 0,
"dimZ": 0,
"transform": {
"translation": {
"x": "0.8978",
"y": "0.0254",
"z": "2.1645"
},
"rotation": {
"x": "0.8978",
"y": "0.0254",
"z": "2.1645"
}
}
},
"bins": [
{
"binSize": 0,
"productId": 0,
"productName": "string",
"productBarcode": "string",
"thumbnail": "string",
"restricted": true,
"productUnits": 0,
"unplannedProductsUnits": 0,
"products": [
{
"quantity": 0,
"product": {
"barcode": "850050071228",
"barcodeType": "upc",
"productId": 49427929792799,
"name": "White Claw Black Cherry",
"price": 1,
"thumbnail": "http://example.com",
"weight": 0,
"retailerType": "shopify",
"RIN": "string",
"restricted": true
}
}
]
}
],
"sizeType": "plate"
}
}
}
}Empty
{
"message": "Invalid request body",
"type": "E_INVALID_BODY",
"errors": [
{
"error": "\"email\" is required",
"rule": "any.required",
"field": "\"email\""
}
]
}How is this guide?