Choose a version:

inventoryBinDelete

mutation

Requires write_inventory access scope. Also: The user must have permission to update inventory.

Deletes inventory bins.

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 idsids •[ID!]! required: The IDs of the inventory bins to delete.

Was this section helpful?

Anchor to InventoryBinDeletePayload returnsInventoryBinDeletePayload returns

Anchor to deletedIdsdeletedIds •[ID!]: The IDs of the inventory bins that were deleted.
Anchor to userErrorsuserErrors •[InventoryBinDeleteUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Delete bins by ID

Description

Delete one or more inventory bins by ID. The mutation returns the IDs of the bins that were deleted. This mutation is part of the [physical inventory feature preview](https://shopify.dev/changelog/physical-inventory-feature-preview).

Query

mutation InventoryBinDelete($ids: [ID!]!) {
  inventoryBinDelete(ids: $ids) {
    deletedIds
    userErrors {
      field
      message
      code
    }
  }
}

Variables

{
  "ids": [
    "gid://shopify/InventoryBin/522906105"
  ]
}

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 InventoryBinDelete($ids: [ID!]!) { inventoryBinDelete(ids: $ids) { deletedIds userErrors { field message code } } }",
 "variables": {
    "ids": [
      "gid://shopify/InventoryBin/522906105"
    ]
  }
}'

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 InventoryBinDelete($ids: [ID!]!) {
    inventoryBinDelete(ids: $ids) {
      deletedIds
      userErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
        "ids": [
            "gid://shopify/InventoryBin/522906105"
        ]
    },
  },
  );
  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 InventoryBinDelete($ids: [ID!]!) {
    inventoryBinDelete(ids: $ids) {
      deletedIds
      userErrors {
        field
        message
        code
      }
    }
  }
QUERY

variables = {
  "ids": [
    "gid://shopify/InventoryBin/522906105"
  ]
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation InventoryBinDelete($ids: [ID!]!) {
      inventoryBinDelete(ids: $ids) {
        deletedIds
        userErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
        "ids": [
            "gid://shopify/InventoryBin/522906105"
        ]
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation InventoryBinDelete($ids: [ID!]!) {
  inventoryBinDelete(ids: $ids) {
    deletedIds
    userErrors {
      field
      message
      code
    }
  }
}' \
--variables \
'{
  "ids": [
    "gid://shopify/InventoryBin/522906105"
  ]
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation InventoryBinDelete($ids: [ID!]!) {
        inventoryBinDelete(ids: $ids) {
          deletedIds
          userErrors {
            field
            message
            code
          }
        }
      }
    `,
    variables: {
        "ids": [
            "gid://shopify/InventoryBin/522906105"
        ]
    },
  }),
});

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

Response

{
  "inventoryBinDelete": {
    "deletedIds": [
      "gid://shopify/InventoryBin/522906105"
    ],
    "userErrors": []
  }
}

inventoryBinDelete 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 InventoryBinDelete($ids: [ID!]!) {

inventoryBinDelete(ids: $ids) {

deletedIds

userErrors {

field

message

code

}

}`,

{

variables: {

"ids": [

"gid://shopify/InventoryBin/522906105"

]

);

const json = await response.json();

return json.data;

}

GQL

mutation InventoryBinDelete($ids: [ID!]!) {
  inventoryBinDelete(ids: $ids) {
    deletedIds
    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 InventoryBinDelete($ids: [ID!]!) { inventoryBinDelete(ids: $ids) { deletedIds userErrors { field message code } } }",
 "variables": {
    "ids": [
      "gid://shopify/InventoryBin/522906105"
    ]
  }
}'

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 InventoryBinDelete($ids: [ID!]!) {
    inventoryBinDelete(ids: $ids) {
      deletedIds
      userErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
        "ids": [
            "gid://shopify/InventoryBin/522906105"
        ]
    },
  },
  );
  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 InventoryBinDelete($ids: [ID!]!) {
      inventoryBinDelete(ids: $ids) {
        deletedIds
        userErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
        "ids": [
            "gid://shopify/InventoryBin/522906105"
        ]
    },
  },
});

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 InventoryBinDelete($ids: [ID!]!) {
    inventoryBinDelete(ids: $ids) {
      deletedIds
      userErrors {
        field
        message
        code
      }
    }
  }
QUERY

variables = {
  "ids": [
    "gid://shopify/InventoryBin/522906105"
  ]
}

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

Shopify CLI

shopify app execute \
--query \
'mutation InventoryBinDelete($ids: [ID!]!) {
  inventoryBinDelete(ids: $ids) {
    deletedIds
    userErrors {
      field
      message
      code
    }
  }
}' \
--variables \
'{
  "ids": [
    "gid://shopify/InventoryBin/522906105"
  ]
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation InventoryBinDelete($ids: [ID!]!) {
        inventoryBinDelete(ids: $ids) {
          deletedIds
          userErrors {
            field
            message
            code
          }
        }
      }
    `,
    variables: {
        "ids": [
            "gid://shopify/InventoryBin/522906105"
        ]
    },
  }),
});

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

Input variables

JSON

{

"ids": [

"gid://shopify/InventoryBin/522906105"

]

}

Response

JSON

{

"inventoryBinDelete": {

"deletedIds": [

"gid://shopify/InventoryBin/522906105"

"userErrors": []

}