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

1
2
3
mutation: {
    addReturnTracking(input: AddReturnTrackingInput!): AddReturnTrackingOutput
}

Example usage

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

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
mutation{
  addReturnTracking(input: {
    return_uid: "Mw=="
    carrier_uid: "dXBzLTE="
    tracking_number: "1Z9876543"
  }){
    return_shipping_tracking {
      uid
      carrier {
        uid
        label
      }
      tracking_number
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "data": {
    "addReturnTracking": {
      "return_shipping_tracking": {
        "uid": "Mw==",
        "carrier": {
          "uid": "dXBzLTE=",
          "label": "United Parcel Service"
        },
        "tracking_number": "1Z9876543"
      }
    }
  }
}

Input attributes

The AddReturnTrackingInput object must contain the following attributes:

Output attributes

The AddReturnTrackingOutput object contains the following attributes.

Return object

The Return object can contain the following attributes:

ReturnComment attributes

The ReturnComment object provides details about an individual comment in a refund request. Comments can be added by a customer or the merchant.

ReturnCustomAttribute attributes

ReturnCustomer attributes

The ReturnCustomer object contains information about the person requesting a return.

ReturnItem attributes

The ReturnItem object provides details about an individual item in a return request.

ReturnShipping attributes

The ReturnShipping object can contain the merchant’s shipping address and tracking information.

ReturnShippingAddress attributes

The ReturnShippingAddress object defines the merchant address for receiving returned items.

ReturnShippingCarrier attributes

The ReturnShippingCarrier object contains details about the shipping carrier used to return a product.

ReturnShippingTracking attributes

The ReturnShippingTracking object contains tracking information for an approved return.

ReturnShippingTrackingStatus attributes

The ReturnShippingTrackingStatus object contains tracking status information for an approved return.

Related topics

• requestReturn mutation
• addReturnComment mutation
• removeReturnTracking mutation