Choose a version:

inventoryTransferEdit

mutation

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

Edits an inventory transfer.

Anchor to Arguments

Arguments

Anchor to idid

•ID!

required

The ID of the inventory Transfer to be edited.

Anchor to inputinput

•InventoryTransferEditInput!

required

The input fields to edit the inventory transfer.

Show input fields

Was this section helpful?

Anchor to InventoryTransferEditPayload returnsInventoryTransferEditPayload returns

Anchor to inventoryTransferinventoryTransfer •InventoryTransfer: The edited inventory transfer.

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

Show fields

Was this section helpful?

Examples

inventoryTransferEdit reference

Mutation Reference

mutation inventoryTransferEdit($id: ID!, $input: InventoryTransferEditInput!) {

inventoryTransferEdit(id: $id, input: $input) {

inventoryTransfer {

# InventoryTransfer fields

}

userErrors {

field

message

}

Input

{

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

"input": {

"dateCreated": "2019-07-16",

"destinationId": "gid://shopify/Location/10079785100",

"metafields": [

{

"id": "gid://shopify/Metafield/10079785100",

"key": "<your-key>",

"namespace": "<your-namespace>",

"type": "<your-type>",

"value": "<your-value>"

}

"note": "<your-note>",

"originId": "gid://shopify/Location/10079785100",

"referenceName": "<your-referenceName>",

"tags": [

"<your-tags>"

]

}

Variables

{
  "id": "gid://shopify/InventoryTransfer/10079785100",
  "input": {
    "dateCreated": "2019-07-16",
    "destinationId": "gid://shopify/Location/10079785100",
    "metafields": [
      {
        "id": "gid://shopify/Metafield/10079785100",
        "key": "<your-key>",
        "namespace": "<your-namespace>",
        "type": "<your-type>",
        "value": "<your-value>"
      }
    ],
    "note": "<your-note>",
    "originId": "gid://shopify/Location/10079785100",
    "referenceName": "<your-referenceName>",
    "tags": [
      "<your-tags>"
    ]
  }
}

Schema

input InventoryTransferEditInput {
  dateCreated: Date
  destinationId: ID
  metafields: [MetafieldInput!]
  note: String
  originId: ID
  referenceName: String
  tags: [String!]
}

input MetafieldInput {
  id: ID
  key: String
  namespace: String
  type: String
  value: String
}