Admin api stores

Get shelves inventory

GET
/api/admin/v2/stores/{storeId}/shelves/{shelfId}/inventory

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.

shelfId*string

Combination of gondola id and shelf index

Length3 <= length <= 64

Response Body

application/json

application/json

curl -X GET "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/stores/0/shelves/2-5/inventory"
{
  "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?

AiFI AI Chat

Beta

Powered by AiFi

Ask docs or API questions to get grounded answers.