addReturnComment mutation

The addReturnComment mutation adds a comment to an existing return request.

Syntax

1
2
3
mutation: {
    addReturnComment(input: AddReturnCommentInput!): AddReturnCommentOutput
}

Example usage

The following example adds a comment in response to the merchant.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
mutation{
  addReturnComment(input: {
    return_uid: "Mw=="
    comment_text: "I'd like a refund"})
    {
    return {
      uid
      status
      comments {
        uid
        author_name
        text
      }
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "data": {
    "addReturnComment": {
      "return": {
        "uid": "Mw==",
        "status": "PENDING",
        "comments": [
          {
            "uid": "NQ==",
            "author_name": "Customer Service",
            "text": "We placed your Return request."
          },
          {
            "uid": "Ng==",
            "author_name": "Bob Loblaw",
            "text": "I want to return the shirt because I don't like the texture of the fabric"
          },
          {
            "uid": "Nw==",
            "author_name": "Customer Service",
            "text": "OK. Would you like a refund or store credit?"
          },
          {
            "uid": "OA==",
            "author_name": "Bob Loblaw",
            "text": "I'd like a refund"
          }
        ]
      }
    }
  }
}

Input attributes

The AddReturnCommentInput object must contain the following attributes:

Output attributes

The AddReturnCommentOutput object contains the Return object.

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
• addReturnTracking mutation
• removeReturnTracking mutation