Choose a version:

inventoryBinsEdit

mutation

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

Creates, updates and deletes inventory bins in a single atomic operation. If any operation fails, no changes are applied.

Note

This mutation is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.

Anchor to Arguments

Arguments

Anchor to inputinput

•[InventoryBinsEditInput!]!

required

The bin operations to apply. Each entry is exactly one of create, update or delete.

Show input fields

Was this section helpful?

Anchor to InventoryBinsEditPayload returnsInventoryBinsEditPayload returns

Anchor to createdBinscreatedBins •[InventoryBin!]: The bins that were created.

Show fields
Anchor to deletedBinIdsdeletedBinIds •[ID!]: The IDs of the bins that were deleted.
Anchor to updatedBinsupdatedBins •[InventoryBin!]: The bins that were updated.

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

Show fields

Was this section helpful?

Examples

Create, update and delete bins in one request

Description

Create a bin, rename another, and delete an empty one in a single atomic request. If any operation fails, no changes are applied. This mutation is part of the [physical inventory feature preview](https://shopify.dev/changelog/physical-inventory-feature-preview).

Query

mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) {
  inventoryBinsEdit(input: $input) {
    createdBins {
      id
      name
      barcode
    }
    updatedBins {
      id
      name
    }
    deletedBinIds
    userErrors {
      field
      message
      code
    }
  }
}

Variables

{
  "input": [
    {
      "create": {
        "locationId": "gid://shopify/Location/275072021",
        "name": "Receiving",
        "barcode": "RCV-001"
      }
    },
    {
      "update": {
        "id": "gid://shopify/InventoryBin/522906105",
        "name": "Overflow"
      }
    },
    {
      "delete": {
        "deletedId": "gid://shopify/InventoryBin/103004229"
      }
    }
  ]
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) { inventoryBinsEdit(input: $input) { createdBins { id name barcode } updatedBins { id name } deletedBinIds userErrors { field message code } } }",
 "variables": {
    "input": [
      {
        "create": {
          "locationId": "gid://shopify/Location/275072021",
          "name": "Receiving",
          "barcode": "RCV-001"
        }
      },
      {
        "update": {
          "id": "gid://shopify/InventoryBin/522906105",
          "name": "Overflow"
        }
      },
      {
        "delete": {
          "deletedId": "gid://shopify/InventoryBin/103004229"
        }
      }
    ]
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) {
    inventoryBinsEdit(input: $input) {
      createdBins {
        id
        name
        barcode
      }
      updatedBins {
        id
        name
      }
      deletedBinIds
      userErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
        "input": [
            {
                "create": {
                    "locationId": "gid://shopify/Location/275072021",
                    "name": "Receiving",
                    "barcode": "RCV-001"
                }
            },
            {
                "update": {
                    "id": "gid://shopify/InventoryBin/522906105",
                    "name": "Overflow"
                }
            },
            {
                "delete": {
                    "deletedId": "gid://shopify/InventoryBin/103004229"
                }
            }
        ]
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) {
    inventoryBinsEdit(input: $input) {
      createdBins {
        id
        name
        barcode
      }
      updatedBins {
        id
        name
      }
      deletedBinIds
      userErrors {
        field
        message
        code
      }
    }
  }
QUERY

variables = {
  "input": [
    {
      "create": {
        "locationId": "gid://shopify/Location/275072021",
        "name": "Receiving",
        "barcode": "RCV-001"
      }
    },
    {
      "update": {
        "id": "gid://shopify/InventoryBin/522906105",
        "name": "Overflow"
      }
    },
    {
      "delete": {
        "deletedId": "gid://shopify/InventoryBin/103004229"
      }
    }
  ]
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) {
      inventoryBinsEdit(input: $input) {
        createdBins {
          id
          name
          barcode
        }
        updatedBins {
          id
          name
        }
        deletedBinIds
        userErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
        "input": [
            {
                "create": {
                    "locationId": "gid://shopify/Location/275072021",
                    "name": "Receiving",
                    "barcode": "RCV-001"
                }
            },
            {
                "update": {
                    "id": "gid://shopify/InventoryBin/522906105",
                    "name": "Overflow"
                }
            },
            {
                "delete": {
                    "deletedId": "gid://shopify/InventoryBin/103004229"
                }
            }
        ]
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) {
  inventoryBinsEdit(input: $input) {
    createdBins {
      id
      name
      barcode
    }
    updatedBins {
      id
      name
    }
    deletedBinIds
    userErrors {
      field
      message
      code
    }
  }
}' \
--variables \
'{
  "input": [
    {
      "create": {
        "locationId": "gid://shopify/Location/275072021",
        "name": "Receiving",
        "barcode": "RCV-001"
      }
    },
    {
      "update": {
        "id": "gid://shopify/InventoryBin/522906105",
        "name": "Overflow"
      }
    },
    {
      "delete": {
        "deletedId": "gid://shopify/InventoryBin/103004229"
      }
    }
  ]
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) {
        inventoryBinsEdit(input: $input) {
          createdBins {
            id
            name
            barcode
          }
          updatedBins {
            id
            name
          }
          deletedBinIds
          userErrors {
            field
            message
            code
          }
        }
      }
    `,
    variables: {
        "input": [
            {
                "create": {
                    "locationId": "gid://shopify/Location/275072021",
                    "name": "Receiving",
                    "barcode": "RCV-001"
                }
            },
            {
                "update": {
                    "id": "gid://shopify/InventoryBin/522906105",
                    "name": "Overflow"
                }
            },
            {
                "delete": {
                    "deletedId": "gid://shopify/InventoryBin/103004229"
                }
            }
        ]
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "inventoryBinsEdit": {
    "createdBins": [
      {
        "id": "gid://shopify/InventoryBin/1072404590",
        "name": "Receiving",
        "barcode": "RCV-001"
      }
    ],
    "updatedBins": [
      {
        "id": "gid://shopify/InventoryBin/522906105",
        "name": "Overflow"
      }
    ],
    "deletedBinIds": [
      "gid://shopify/InventoryBin/103004229"
    ],
    "userErrors": []
  }
}

inventoryBinsEdit reference

Examples

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) {

inventoryBinsEdit(input: $input) {

createdBins {

name

barcode

}

updatedBins {

name

}

deletedBinIds

userErrors {

field

message

code

}

}`,

{

variables: {

"input": [

{

"create": {

"locationId": "gid://shopify/Location/275072021",

"name": "Receiving",

"barcode": "RCV-001"

}

{

"update": {

"id": "gid://shopify/InventoryBin/522906105",

"name": "Overflow"

}

{

"delete": {

"deletedId": "gid://shopify/InventoryBin/103004229"

}

]

);

const json = await response.json();

return json.data;

}

GQL

mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) {
  inventoryBinsEdit(input: $input) {
    createdBins {
      id
      name
      barcode
    }
    updatedBins {
      id
      name
    }
    deletedBinIds
    userErrors {
      field
      message
      code
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) { inventoryBinsEdit(input: $input) { createdBins { id name barcode } updatedBins { id name } deletedBinIds userErrors { field message code } } }",
 "variables": {
    "input": [
      {
        "create": {
          "locationId": "gid://shopify/Location/275072021",
          "name": "Receiving",
          "barcode": "RCV-001"
        }
      },
      {
        "update": {
          "id": "gid://shopify/InventoryBin/522906105",
          "name": "Overflow"
        }
      },
      {
        "delete": {
          "deletedId": "gid://shopify/InventoryBin/103004229"
        }
      }
    ]
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) {
    inventoryBinsEdit(input: $input) {
      createdBins {
        id
        name
        barcode
      }
      updatedBins {
        id
        name
      }
      deletedBinIds
      userErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
        "input": [
            {
                "create": {
                    "locationId": "gid://shopify/Location/275072021",
                    "name": "Receiving",
                    "barcode": "RCV-001"
                }
            },
            {
                "update": {
                    "id": "gid://shopify/InventoryBin/522906105",
                    "name": "Overflow"
                }
            },
            {
                "delete": {
                    "deletedId": "gid://shopify/InventoryBin/103004229"
                }
            }
        ]
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) {
      inventoryBinsEdit(input: $input) {
        createdBins {
          id
          name
          barcode
        }
        updatedBins {
          id
          name
        }
        deletedBinIds
        userErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
        "input": [
            {
                "create": {
                    "locationId": "gid://shopify/Location/275072021",
                    "name": "Receiving",
                    "barcode": "RCV-001"
                }
            },
            {
                "update": {
                    "id": "gid://shopify/InventoryBin/522906105",
                    "name": "Overflow"
                }
            },
            {
                "delete": {
                    "deletedId": "gid://shopify/InventoryBin/103004229"
                }
            }
        ]
    },
  },
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) {
    inventoryBinsEdit(input: $input) {
      createdBins {
        id
        name
        barcode
      }
      updatedBins {
        id
        name
      }
      deletedBinIds
      userErrors {
        field
        message
        code
      }
    }
  }
QUERY

variables = {
  "input": [
    {
      "create": {
        "locationId": "gid://shopify/Location/275072021",
        "name": "Receiving",
        "barcode": "RCV-001"
      }
    },
    {
      "update": {
        "id": "gid://shopify/InventoryBin/522906105",
        "name": "Overflow"
      }
    },
    {
      "delete": {
        "deletedId": "gid://shopify/InventoryBin/103004229"
      }
    }
  ]
}

response = client.query(query: query, variables: variables)

Shopify CLI

shopify app execute \
--query \
'mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) {
  inventoryBinsEdit(input: $input) {
    createdBins {
      id
      name
      barcode
    }
    updatedBins {
      id
      name
    }
    deletedBinIds
    userErrors {
      field
      message
      code
    }
  }
}' \
--variables \
'{
  "input": [
    {
      "create": {
        "locationId": "gid://shopify/Location/275072021",
        "name": "Receiving",
        "barcode": "RCV-001"
      }
    },
    {
      "update": {
        "id": "gid://shopify/InventoryBin/522906105",
        "name": "Overflow"
      }
    },
    {
      "delete": {
        "deletedId": "gid://shopify/InventoryBin/103004229"
      }
    }
  ]
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation InventoryBinsEdit($input: [InventoryBinsEditInput!]!) {
        inventoryBinsEdit(input: $input) {
          createdBins {
            id
            name
            barcode
          }
          updatedBins {
            id
            name
          }
          deletedBinIds
          userErrors {
            field
            message
            code
          }
        }
      }
    `,
    variables: {
        "input": [
            {
                "create": {
                    "locationId": "gid://shopify/Location/275072021",
                    "name": "Receiving",
                    "barcode": "RCV-001"
                }
            },
            {
                "update": {
                    "id": "gid://shopify/InventoryBin/522906105",
                    "name": "Overflow"
                }
            },
            {
                "delete": {
                    "deletedId": "gid://shopify/InventoryBin/103004229"
                }
            }
        ]
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"input": [

{

"create": {

"locationId": "gid://shopify/Location/275072021",

"name": "Receiving",

"barcode": "RCV-001"

}

{

"update": {

"id": "gid://shopify/InventoryBin/522906105",

"name": "Overflow"

}

{

"delete": {

"deletedId": "gid://shopify/InventoryBin/103004229"

}

]

}

Response

JSON

{

"inventoryBinsEdit": {

"createdBins": [

{

"id": "gid://shopify/InventoryBin/1072404590",

"name": "Receiving",

"barcode": "RCV-001"

}

"updatedBins": [

{

"id": "gid://shopify/InventoryBin/522906105",

"name": "Overflow"

}

"deletedBinIds": [

"gid://shopify/InventoryBin/103004229"

"userErrors": []

}