updateReturnSatisfaction

Requires permission sales:credit_note:update.

Records the customer's satisfaction rating and feedback on a return. A rating of 3 or more counts as satisfied. Needs the credit notes update permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation UpdateReturnSatisfaction($feedback: String!, $rating: Int!, $returnId: String!) {
  updateReturnSatisfaction(
    feedback: $feedback
    rating: $rating
    returnId: $returnId
  ) {
    id
    returnNumber
    rmaNumber
    status
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdateReturnSatisfaction($feedback: String!, $rating: Int!, $returnId: String!) {\n  updateReturnSatisfaction(\n    feedback: $feedback\n    rating: $rating\n    returnId: $returnId\n  ) {\n    id\n    returnNumber\n    rmaNumber\n    status\n  }\n}",
  "variables": {
    "feedback": "string",
    "rating": 0,
    "returnId": "string"
  }
}
EOF

Variables:

{
  "feedback": "string",
  "rating": 0,
  "returnId": "string"
}

Response:

{
  "data": {
    "updateReturnSatisfaction": {
      "id": "string",
      "returnNumber": "string",
      "rmaNumber": "string",
      "status": "string"
    }
  }
}

updateReturnSatisfaction(
  feedback: String!
  rating: Int!
  returnId: String!
): ReturnResponse!

Arguments

updateReturnSatisfaction.feedback ● String! non-null scalar

The customer's written feedback.

updateReturnSatisfaction.rating ● Int! non-null scalar

The customer rating, as a whole number.

updateReturnSatisfaction.returnId ● String! non-null scalar

The ID of the return.

Type

ReturnResponse object

A return created through the RMA flow.