releaseInventory
View as MarkdownRelease inventory from committed. If there are not enough committed inventory, this mutation will error. Released units leave COMMITTED and are not moved to…
mutation
Requires commerce.product:write.
Release inventory from committed. If there are not enough committed inventory, this mutation will error. Released units leave COMMITTED and are not moved to AVAILABLE.
releaseInventory decreases COMMITTED quantity only. It does not increase AVAILABLE. To move units back to AVAILABLE, use restockFromCommittedInventory.Required headers
| Header | Required | Description |
|---|---|---|
x-store-id | Yes | ID 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
inputMutationReleaseInventoryInput!requiredlocationIdID!requiredquantityInt!requiredskuIdID!requiredreasonNameStringoptionalreferences[CreateReferenceInput!]optionaloriginString!requiredvalueString!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?