Sign in
inventory

Update SKU stock levels and related properties

post/v2/inventory

Request

  • Base URL: https://api.shipstation.com
  • URL: https://api.shipstation.com/v2/inventory
  • Auth: API key in header api-key

Request body

transaction_type'increment' | 'decrement' | 'adjust' | 'modify' required

The type of update to perform: increment: Increase inventory quantity for specified location. decrement: Decreate inventory quantity for specified location given a set of filters. adjust: Adjust on hand quantity of inventory for specified location to the quantity indicated. This is done by either adding or removing inventory in the condition specified. modify: Modify attributes on specified inventory. The filters work the same as for decrement transaction type.

inventory_location_idstring required
skustring required
quantityinteger required
condition'sellable' | 'damaged' | 'expired' | 'qa_hold'
lotstring
usable_start_datestring date-time
usable_end_datestring date-time
effective_atstring date-time
reasonstring
notesstring
new_inventory_location_idstring

Used with the modify transaction type to move inventory to a new location

new_condition'sellable' | 'damaged' | 'expired' | 'qa_hold'

Used with the modify transaction type to change the condition of existing inventory

Response

Inventory successfully updated

Changes

No recorded changes to this operation across all 1 revision of this API.