Choose a version:

inventoryTransferDuplicate

mutation

Requires write_inventory_transfers access scope. Also: The user must have permission to manage inventory.

This mutation allows duplicating an existing inventory transfer. The duplicated transfer will have the same line items and quantities as the original transfer, but will be in a draft state with no shipments.

Caution

As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the inventory transfer to duplicate.

Was this section helpful?

Anchor to InventoryTransferDuplicatePayload returnsInventoryTransferDuplicatePayload returns

Anchor to inventoryTransferinventoryTransfer •InventoryTransfer: The duplicated inventory transfer.
Anchor to userErrorsuserErrors •[InventoryTransferDuplicateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Duplicates a transfer with idempotency enabled (2026-01 onwards)

Query

mutation inventoryTransferDuplicate($id: ID!, $idempotencyKey: String!) {
  inventoryTransferDuplicate(id: $id) @idempotent(key: $idempotencyKey) {
    inventoryTransfer {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/InventoryTransfer/825890269",
  "idempotencyKey": "550e8400-e29b-41d4-a716-446655440000"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation inventoryTransferDuplicate($id: ID!, $idempotencyKey: String!) { inventoryTransferDuplicate(id: $id) @idempotent(key: $idempotencyKey) { inventoryTransfer { id } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/InventoryTransfer/825890269",
    "idempotencyKey": "550e8400-e29b-41d4-a716-446655440000"
  }
}'

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 inventoryTransferDuplicate($id: ID!, $idempotencyKey: String!) {
    inventoryTransferDuplicate(id: $id) @idempotent(key: $idempotencyKey) {
      inventoryTransfer {
        id
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/InventoryTransfer/825890269",
        "idempotencyKey": "550e8400-e29b-41d4-a716-446655440000"
    },
  },
  );
  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 inventoryTransferDuplicate($id: ID!, $idempotencyKey: String!) {
    inventoryTransferDuplicate(id: $id) @idempotent(key: $idempotencyKey) {
      inventoryTransfer {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/InventoryTransfer/825890269",
  "idempotencyKey": "550e8400-e29b-41d4-a716-446655440000"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation inventoryTransferDuplicate($id: ID!, $idempotencyKey: String!) {
      inventoryTransferDuplicate(id: $id) @idempotent(key: $idempotencyKey) {
        inventoryTransfer {
          id
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/InventoryTransfer/825890269",
        "idempotencyKey": "550e8400-e29b-41d4-a716-446655440000"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation inventoryTransferDuplicate($id: ID!, $idempotencyKey: String!) {
  inventoryTransferDuplicate(id: $id) @idempotent(key: $idempotencyKey) {
    inventoryTransfer {
      id
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/InventoryTransfer/825890269",
  "idempotencyKey": "550e8400-e29b-41d4-a716-446655440000"
}'

Response

{
  "inventoryTransferDuplicate": {
    "inventoryTransfer": {
      "id": "gid://shopify/InventoryTransfer/1061783019"
    },
    "userErrors": []
  }
}

inventoryTransferDuplicate reference

Examples

Open in GraphiQL

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

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

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

const response = await admin.graphql(

`#graphql

mutation inventoryTransferDuplicate($id: ID!, $idempotencyKey: String!) {

inventoryTransferDuplicate(id: $id) @idempotent(key: $idempotencyKey) {

inventoryTransfer {

}

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/InventoryTransfer/825890269",

"idempotencyKey": "550e8400-e29b-41d4-a716-446655440000"

);

const json = await response.json();

return json.data;

}

GQL

mutation inventoryTransferDuplicate($id: ID!, $idempotencyKey: String!) {
  inventoryTransferDuplicate(id: $id) @idempotent(key: $idempotencyKey) {
    inventoryTransfer {
      id
    }
    userErrors {
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation inventoryTransferDuplicate($id: ID!, $idempotencyKey: String!) { inventoryTransferDuplicate(id: $id) @idempotent(key: $idempotencyKey) { inventoryTransfer { id } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/InventoryTransfer/825890269",
    "idempotencyKey": "550e8400-e29b-41d4-a716-446655440000"
  }
}'

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 inventoryTransferDuplicate($id: ID!, $idempotencyKey: String!) {
    inventoryTransferDuplicate(id: $id) @idempotent(key: $idempotencyKey) {
      inventoryTransfer {
        id
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/InventoryTransfer/825890269",
        "idempotencyKey": "550e8400-e29b-41d4-a716-446655440000"
    },
  },
  );
  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 inventoryTransferDuplicate($id: ID!, $idempotencyKey: String!) {
      inventoryTransferDuplicate(id: $id) @idempotent(key: $idempotencyKey) {
        inventoryTransfer {
          id
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/InventoryTransfer/825890269",
        "idempotencyKey": "550e8400-e29b-41d4-a716-446655440000"
    },
  },
});

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 inventoryTransferDuplicate($id: ID!, $idempotencyKey: String!) {
    inventoryTransferDuplicate(id: $id) @idempotent(key: $idempotencyKey) {
      inventoryTransfer {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/InventoryTransfer/825890269",
  "idempotencyKey": "550e8400-e29b-41d4-a716-446655440000"
}

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

Shopify CLI

shopify app execute \
--query \
'mutation inventoryTransferDuplicate($id: ID!, $idempotencyKey: String!) {
  inventoryTransferDuplicate(id: $id) @idempotent(key: $idempotencyKey) {
    inventoryTransfer {
      id
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/InventoryTransfer/825890269",
  "idempotencyKey": "550e8400-e29b-41d4-a716-446655440000"
}'

Input variables

JSON

{

"id": "gid://shopify/InventoryTransfer/825890269",

"idempotencyKey": "550e8400-e29b-41d4-a716-446655440000"

}

Response

JSON

{

"inventoryTransferDuplicate": {

"inventoryTransfer": {

"id": "gid://shopify/InventoryTransfer/1061783019"

"userErrors": []

}