addReturnTracking mutation

The addReturnTracking mutation adds customer-entered shipping tracking information to the specified return request. Use the available_shipping_carriers object in the customer query to retrieve valid carrier_uid values.

Syntax

Copy
mutation: {
    addReturnTracking(input: AddReturnTrackingInput!): AddReturnTrackingOutput
}
Copied to your clipboard
mutation: {
    addReturnTracking(input: AddReturnTrackingInput!): AddReturnTrackingOutput
}

Reference

The addReturnTracking reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following example adds the shipping carrier and a tracking number for the specified return request.

Request:

Copy
mutation{
  addReturnTracking(input: {
    return_uid: "Mw=="
    carrier_uid: "dXBzLTE="
    tracking_number: "1Z9876543"
  }){
    return_shipping_tracking {
      uid
      carrier {
        uid
        label
      }
      tracking_number
    }
  }
}
Copied to your clipboard
mutation{
  addReturnTracking(input: {
    return_uid: "Mw=="
    carrier_uid: "dXBzLTE="
    tracking_number: "1Z9876543"
  }){
    return_shipping_tracking {
      uid
      carrier {
        uid
        label
      }
      tracking_number
    }
  }
}

Response:

Copy
{
  "data": {
    "addReturnTracking": {
      "return_shipping_tracking": {
        "uid": "Mw==",
        "carrier": {
          "uid": "dXBzLTE=",
          "label": "United Parcel Service"
        },
        "tracking_number": "1Z9876543"
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "addReturnTracking": {
      "return_shipping_tracking": {
        "uid": "Mw==",
        "carrier": {
          "uid": "dXBzLTE=",
          "label": "United Parcel Service"
        },
        "tracking_number": "1Z9876543"
      }
    }
  }
}

Related topics

• requestReturn mutation
• addReturnComment mutation
• removeReturnTracking mutation

Last updated 9/7/2023

Was this helpful?

Yes

No