Admin api stores

Update inventory

PUT
/api/admin/v2/stores/{storeId}/shelves/{shelfId}/bins/{binIndex}/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
binIndex*integer

Index of target bin

Range0 <= value

Request Body

application/json

product*
quantityDifference*integer

Update with quantity difference

Range-1000 <= value <= 1000

Response Body

application/json

application/json

curl -X PUT "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/stores/0/shelves/2-5/bins/0/inventory" \  -H "Content-Type: application/json" \  -d '{    "product": {      "barcode": "850050071228"    },    "quantityDifference": -1000  }'
{
  "gondolaId": 2,
  "shelfIndex": 5,
  "id": "2-5",
  "coordinates": {
    "dimX": 0,
    "dimY": 0,
    "dimZ": 0,
    "transform": {
      "translation": {
        "translationX": 0,
        "translationY": 0,
        "translationZ": 0
      },
      "rotation": {
        "rotationX": 0,
        "rotationY": 0,
        "rotationZ": 0
      }
    }
  },
  "bins": [
    {
      "products": [
        {
          "product": {
            "barcode": "850050071228",
            "barcodeType": "upc",
            "name": "White Claw Black Cherry",
            "price": 1,
            "thumbnail": "http://example.com",
            "weight": 0,
            "retailerType": "shopify",
            "RIN": "string",
            "restricted": true
          },
          "quantity": 0
        }
      ],
      "size": 0,
      "defaultProduct": {
        "barcode": "850050071228",
        "barcodeType": "upc"
      }
    }
  ]
}
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.