Anchor to section titled 'undefined'

InventoryAdjustmentGroup
object

Requires read_inventory access scope.

Represents a group of adjustments made as part of the same operation.

Anchor to section titled 'Fields'

Fields

Anchor to InventoryAdjustmentGroup.app
app
App

The app that triggered the inventory event, if one exists.

Anchor to InventoryAdjustmentGroup.changes
changes
[InventoryChange!]!
non-null

The set of inventory quantity changes that occurred in the inventory event.

Anchor to InventoryAdjustmentGroup.createdAt
createdAt
DateTime!
non-null

The date and time the inventory adjustment group was created.

Anchor to InventoryAdjustmentGroup.id
id
ID!
non-null

A globally-unique ID.

Anchor to InventoryAdjustmentGroup.reason
reason
String!
non-null

The reason for the group of adjustments.

Anchor to InventoryAdjustmentGroup.referenceDocumentUri
referenceDocumentUri
String

A freeform URI that represents why the inventory change happened. This can be the entity adjusting inventory quantities or the Shopify resource that's associated with the inventory adjustment. For example, a unit in a draft order might have been previously reserved, and a merchant later creates an order from the draft order. In this case, the referenceDocumentUri for the inventory adjustment is a URI referencing the order ID.

Anchor to InventoryAdjustmentGroup.staffMember
staffMember
StaffMember

The staff member associated with the inventory event.

Was this section helpful?
Map
  • No referencing fields
    • InventoryAdjustmentGroup
    Anchor to section titled 'Mutations'

    Mutations

    Anchor to inventoryAdjustQuantities
    inventoryAdjustQuantities
    mutation
    Access requirements

    Apply changes to inventory quantities.

    Anchor to inventoryMoveQuantities
    inventoryMoveQuantities
    mutation
    Access requirements

    Moves inventory between inventory quantity names at a single location.

    Anchor to inventorySetQuantities
    inventorySetQuantities
    mutation
    Access requirements

    Set quantities of specified name using absolute values. This mutation supports compare-and-set functionality to handle concurrent requests properly. If ignoreCompareQuantity is not set to true, the mutation will only update the quantity if the persisted quantity matches the compareQuantity value. If the compareQuantity value does not match the persisted value, the mutation will return an error. In order to opt out of the compareQuantity check, the ignoreCompareQuantity argument can be set to true.

    Note

    Only use this mutation if calling on behalf of a system that acts as the source of truth for inventory quantities, otherwise please consider using the inventoryAdjustQuantities mutation.

    Opting out of the compareQuantity check can lead to inaccurate inventory quantities if multiple requests are made concurrently. It is recommended to always include the compareQuantity value to ensure the accuracy of the inventory quantities and to opt out of the check using ignoreCompareQuantity only when necessary.

    Was this section helpful?
    <~>
    InventoryAdjustmentGroup Mutations
    InventoryAdjustmentGroup

    Mutated by

    Anchor to section titled 'Implements'

    Implements

    Anchor to Node
    Node
    interface
    Was this section helpful?
    ||-
    InventoryAdjustmentGroup Implements
    InventoryAdjustmentGroup

    Implements