openapi-schemas icon indicating copy to clipboard operation
openapi-schemas copied to clipboard

Added description to fields in UpdateInventory

Open georgebrindeiro opened this issue 4 years ago • 1 comments

georgebrindeiro avatar Apr 14 '20 01:04 georgebrindeiro

Idea is to add this info to endpoint:

With this endpoint, you are able to manage the Last Count of a specific SKU in your store’s warehouses. Start filling the endpoint’s path parameters: Environment: VTEX development environment. Use myvtex. skuId: the ID of the SKU whose inventory you want to update; warehouseId: the ID of the warehouse; accountName: your store’s account name.

Then fill the request body’s variables: unlimitedQuantity: If you fill this field with the value “true”, you’ll be setting the warehouse as “infinite inventory”. In such a case, it will not be necessary to fill the “quantity” field because the stock will never end. dateUtcOnBalanceSystem: optional date parameter. It is only used for backend purposes and does not reflect in your store administration. If you want to send this data in your request, always use it in the UTC time format. Otherwise, just fill the field with “null”. Quantity: the new quantity of the SKU.

By making this request, you’ll be informing how many items of the specified SKU there are in a particular warehouse.

Keep in mind that it’s possible to manage all the store’s warehouses, but just one at a time. If you want to change the quantity of SKUs in another warehouse, simply make another request, changing the warehouseId value.

Expect a 200 OK status with the value “true” inside the body for a successful response.

georgebrindeiro avatar Apr 14 '20 02:04 georgebrindeiro