Choose a version:

inventoryBinMoveCreate

mutation

Requires write_inventory access scope. Also: The shop must have access to the physical inventory feature preview.

Moves inventory between bins at a location, or between a bin and a system bin. Requires an @idempotent directive. Retrying with the same key returns the original bin move.

Anchor to Arguments

Arguments

Anchor to itemsitems

•[InventoryBinMoveItemInput!]!

required

The inventory items to move, each with an origin and a destination.

Show input fields

Anchor to locationIdlocationId

•ID!

required

The ID of the location where the inventory is moving.

Was this section helpful?

Anchor to InventoryBinMoveCreatePayload returnsInventoryBinMoveCreatePayload returns

Anchor to inventoryBinMoveinventoryBinMove •InventoryBinMove: The bin move that was created.

Show fields
Anchor to userErrorsuserErrors •[InventoryBinMoveCreateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

inventoryBinMoveCreate reference

Mutation Reference

mutation inventoryBinMoveCreate($items: [InventoryBinMoveItemInput!]!, $locationId: ID!) {

inventoryBinMoveCreate(items: $items, locationId: $locationId) {

inventoryBinMove {

# InventoryBinMove fields

}

userErrors {

field

message

}

Input

{

"items": [

{

"from": {

"bin": {},

"systemBinIdentifier": "ADDED"

"inventoryItemId": "gid://shopify/InventoryItem/10079785100",

"quantity": 1,

"to": {

"bin": {},

"systemBinIdentifier": "ADDED"

}

"locationId": "gid://shopify/Location/10079785100"

}

Variables

{
  "items": [
    {
      "from": {
        "bin": {},
        "systemBinIdentifier": "ADDED"
      },
      "inventoryItemId": "gid://shopify/InventoryItem/10079785100",
      "quantity": 1,
      "to": {
        "bin": {},
        "systemBinIdentifier": "ADDED"
      }
    }
  ],
  "locationId": "gid://shopify/Location/10079785100"
}

Schema

input InventoryBinMoveItemInput {
  from: InventoryMovementEndpointInput!
  inventoryItemId: ID!
  quantity: Int!
  to: InventoryMovementEndpointInput!
}

input InventoryMovementEndpointInput {
  bin: InventoryMovementBinInput
  systemBinIdentifier: InventorySystemBinIdentifier
}