Choose a version:

inventoryBinUpsert

mutation

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

Creates or updates bins at a given location.

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 inventoryBinsinventoryBins

•[InventoryBinInput!]!

required

The list of inventory bins to create or update at the given location.

Anchor to locationIdlocationId

•ID!

required

The ID of the location where these inventory bins reside.

Was this section helpful?

Anchor to InventoryBinUpsertPayload returnsInventoryBinUpsertPayload returns

Anchor to inventoryBinsinventoryBins •[InventoryBin!]: The list of inventory bins that were created or updated.
Anchor to userErrorsuserErrors •[InventoryBinUpsertUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Create bins at a location

Description

Create or update inventory bins at a location. Each entry is identified by `name` (upsert by the per-location name) or by `id` (update an existing bin), and may carry an optional `barcode`. This example creates two new bins at a location. This mutation is part of the [physical inventory feature preview](https://shopify.dev/changelog/physical-inventory-feature-preview).

Query

mutation InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) {
  inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) {
    inventoryBins {
      id
      name
      barcode
    }
    userErrors {
      field
      message
      code
    }
  }
}

Variables

{
  "locationId": "gid://shopify/Location/275072021",
  "inventoryBins": [
    {
      "name": "Receiving"
    },
    {
      "name": "Shipping",
      "barcode": "SHIP-001"
    }
  ]
}

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 InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) { inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) { inventoryBins { id name barcode } userErrors { field message code } } }",
 "variables": {
    "locationId": "gid://shopify/Location/275072021",
    "inventoryBins": [
      {
        "name": "Receiving"
      },
      {
        "name": "Shipping",
        "barcode": "SHIP-001"
      }
    ]
  }
}'

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 InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) {
    inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) {
      inventoryBins {
        id
        name
        barcode
      }
      userErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
        "locationId": "gid://shopify/Location/275072021",
        "inventoryBins": [
            {
                "name": "Receiving"
            },
            {
                "name": "Shipping",
                "barcode": "SHIP-001"
            }
        ]
    },
  },
  );
  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 InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) {
    inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) {
      inventoryBins {
        id
        name
        barcode
      }
      userErrors {
        field
        message
        code
      }
    }
  }
QUERY

variables = {
  "locationId": "gid://shopify/Location/275072021",
  "inventoryBins": [
    {
      "name": "Receiving"
    },
    {
      "name": "Shipping",
      "barcode": "SHIP-001"
    }
  ]
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) {
      inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) {
        inventoryBins {
          id
          name
          barcode
        }
        userErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
        "locationId": "gid://shopify/Location/275072021",
        "inventoryBins": [
            {
                "name": "Receiving"
            },
            {
                "name": "Shipping",
                "barcode": "SHIP-001"
            }
        ]
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) {
  inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) {
    inventoryBins {
      id
      name
      barcode
    }
    userErrors {
      field
      message
      code
    }
  }
}' \
--variables \
'{
  "locationId": "gid://shopify/Location/275072021",
  "inventoryBins": [
    {
      "name": "Receiving"
    },
    {
      "name": "Shipping",
      "barcode": "SHIP-001"
    }
  ]
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) {
        inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) {
          inventoryBins {
            id
            name
            barcode
          }
          userErrors {
            field
            message
            code
          }
        }
      }
    `,
    variables: {
        "locationId": "gid://shopify/Location/275072021",
        "inventoryBins": [
            {
                "name": "Receiving"
            },
            {
                "name": "Shipping",
                "barcode": "SHIP-001"
            }
        ]
    },
  }),
});

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

Response

{
  "inventoryBinUpsert": {
    "inventoryBins": [
      {
        "id": "gid://shopify/InventoryBin/1072404543",
        "name": "Receiving",
        "barcode": null
      },
      {
        "id": "gid://shopify/InventoryBin/1072404544",
        "name": "Shipping",
        "barcode": "SHIP-001"
      }
    ],
    "userErrors": []
  }
}

inventoryBinUpsert 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 InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) {

inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) {

inventoryBins {

name

barcode

}

userErrors {

field

message

code

}

}`,

{

variables: {

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

"inventoryBins": [

{

"name": "Receiving"

{

"name": "Shipping",

"barcode": "SHIP-001"

}

]

);

const json = await response.json();

return json.data;

}

GQL

mutation InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) {
  inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) {
    inventoryBins {
      id
      name
      barcode
    }
    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 InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) { inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) { inventoryBins { id name barcode } userErrors { field message code } } }",
 "variables": {
    "locationId": "gid://shopify/Location/275072021",
    "inventoryBins": [
      {
        "name": "Receiving"
      },
      {
        "name": "Shipping",
        "barcode": "SHIP-001"
      }
    ]
  }
}'

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 InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) {
    inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) {
      inventoryBins {
        id
        name
        barcode
      }
      userErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
        "locationId": "gid://shopify/Location/275072021",
        "inventoryBins": [
            {
                "name": "Receiving"
            },
            {
                "name": "Shipping",
                "barcode": "SHIP-001"
            }
        ]
    },
  },
  );
  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 InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) {
      inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) {
        inventoryBins {
          id
          name
          barcode
        }
        userErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
        "locationId": "gid://shopify/Location/275072021",
        "inventoryBins": [
            {
                "name": "Receiving"
            },
            {
                "name": "Shipping",
                "barcode": "SHIP-001"
            }
        ]
    },
  },
});

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 InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) {
    inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) {
      inventoryBins {
        id
        name
        barcode
      }
      userErrors {
        field
        message
        code
      }
    }
  }
QUERY

variables = {
  "locationId": "gid://shopify/Location/275072021",
  "inventoryBins": [
    {
      "name": "Receiving"
    },
    {
      "name": "Shipping",
      "barcode": "SHIP-001"
    }
  ]
}

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

Shopify CLI

shopify app execute \
--query \
'mutation InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) {
  inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) {
    inventoryBins {
      id
      name
      barcode
    }
    userErrors {
      field
      message
      code
    }
  }
}' \
--variables \
'{
  "locationId": "gid://shopify/Location/275072021",
  "inventoryBins": [
    {
      "name": "Receiving"
    },
    {
      "name": "Shipping",
      "barcode": "SHIP-001"
    }
  ]
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation InventoryBinUpsert($locationId: ID!, $inventoryBins: [InventoryBinInput!]!) {
        inventoryBinUpsert(locationId: $locationId, inventoryBins: $inventoryBins) {
          inventoryBins {
            id
            name
            barcode
          }
          userErrors {
            field
            message
            code
          }
        }
      }
    `,
    variables: {
        "locationId": "gid://shopify/Location/275072021",
        "inventoryBins": [
            {
                "name": "Receiving"
            },
            {
                "name": "Shipping",
                "barcode": "SHIP-001"
            }
        ]
    },
  }),
});

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

Input variables

JSON

{

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

"inventoryBins": [

{

"name": "Receiving"

{

"name": "Shipping",

"barcode": "SHIP-001"

}

]

}

Response

JSON

{

"inventoryBinUpsert": {

"inventoryBins": [

{

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

"name": "Receiving",

"barcode": null

{

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

"name": "Shipping",

"barcode": "SHIP-001"

}

"userErrors": []

}