inventoryShipmentSetTracking

mutation

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

Edits the tracking info on an inventory shipment.

Arguments

Anchor to idid • ID!required: The ID of the inventory shipment whose tracking info is being edited.
Anchor to trackingtracking • InventoryShipmentTrackingInput: The tracking info to edit on the inventory shipment.

Was this section helpful?

Anchor to InventoryShipmentSetTrackingPayload returnsInventoryShipmentSetTrackingPayload returns

Anchor to inventoryShipmentinventoryShipment • InventoryShipment: The inventory shipment with the edited tracking info.
Anchor to userErrorsuserErrors • [InventoryShipmentSetTrackingUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation inventoryShipmentSetTracking($id: ID!, $tracking: InventoryShipmentTrackingInput) {
2  inventoryShipmentSetTracking(id: $id, tracking: $tracking) {
3    inventoryShipment {
4      # InventoryShipment fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "id": "gid://shopify/<objectName>/10079785100",
3  "tracking": {
4    "arrivesAt": "2019-09-07T15:50:00Z",
5    "company": "<your-company>",
6    "trackingNumber": "<your-trackingNumber>",
7    "trackingUrl": "https://example.myshopify.com"
8  }
9}

{
  "id": "gid://shopify/<objectName>/10079785100",
  "tracking": {
    "arrivesAt": "2019-09-07T15:50:00Z",
    "company": "<your-company>",
    "trackingNumber": "<your-trackingNumber>",
    "trackingUrl": "https://example.myshopify.com"
  }
}

input InventoryShipmentTrackingInput {
  arrivesAt: DateTime
  company: String
  trackingNumber: String
  trackingUrl: URL
}