Support

releaseInventory

View as Markdown

Release inventory from committed and/or backordered. Releases from committed first, then backordered. Errors if the requested quantity exceeds committed +…

mutation

Requires commerce.product:write.

Release inventory from committed and/or backordered. Releases from committed first, then backordered. Errors if the requested quantity exceeds committed + backordered.

releaseInventory decreases COMMITTED first, then BACKORDERED. It does not increase AVAILABLE. To move units back to AVAILABLE, use restockFromCommittedInventory.

Required headers

HeaderRequiredDescription
x-store-idYesID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: extensions.code: "UNAUTHENTICATED".

Go to Authentication for credential setup.

Arguments

  • input MutationReleaseInventoryInput! required
    • locationId ID! required
    • quantity Int! required
    • skuId ID! required
    • reasonName String optional
    • references [CreateReferenceInput!] optional
      • origin String! required
      • value String! required

Possible returns

  • InventoryAdjustment [InventoryAdjustment!] — An immutable entity that represents a change in state of a quantity of SKU at a particular time and location.

Last updated on

How is this guide?

On this page