SHshipstation
inventory

Update SKU stock levels and related properties

<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>

Updates the stock levels and other inventory-related properties of your SKUs.

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: Decrease 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.
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 30 revisions of this API.