EcommerceInventory

Update Item Inventory

Updates the current inventory levels for a particular SKU item.

Updates may be given in one or two methods, absolutely or incrementally.

  • Absolute updates are done by setting quantity directly.
  • Incremental updates are by specifying the inventory delta in updateQuantity which is then added to the quantity stored on the server.

Required scope | ecommerce:write

Path parameters

collection_idstringRequired

Unique identifier for a Collection

item_idstringRequired

Unique identifier for an Item

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
inventoryTypeenumRequired

infinite or finite

Allowed values:
updateQuantitydoubleOptional

Adds this quantity to currently store quantity. Can be negative.

quantitydoubleOptional

Immediately sets quantity to this value.

Response

Request was successful

idstringOptional

Unique identifier for a SKU item

quantitydoubleOptional

Total quantity of items remaining in inventory (if inventoryType is finite)

inventoryTypeenumOptional

infinite or finite

Allowed values:

Errors