archiveInventoryAdjustmentReason

Archive a store-scoped inventory adjustment reason. Global reasons cannot be archived.

mutation

Requires commerce.product:write.

Archive a store-scoped inventory adjustment reason. Global reasons cannot be archived.

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

input MutationArchiveInventoryAdjustmentReasonInput! required
- id ID! required

Possible returns

InventoryAdjustmentReason InventoryAdjustmentReason — A reason that can be associated with an inventory adjustment to explain why it occurred. Global preset reasons are prefixed with "g-" (e.g. g-damage, g-shrinkage). Store-scoped reasons use plain kebab-case names.

mutation RunArchiveInventoryAdjustmentReason($input: MutationArchiveInventoryAdjustmentReasonInput!) {  archiveInventoryAdjustmentReason(input: $input) {    id    name    status    label    createdAt    updatedAt  }}

{  "data": {    "archiveInventoryAdjustmentReason": {      "id": "ID_VALUE",      "name": "Example",      "status": "ACTIVE",      "label": "Example",      "createdAt": "2026-01-15T12:00:00.000Z",      "updatedAt": "2026-01-15T12:00:00.000Z"    }  }}

Last updated on