updateReturnTracking

Requires at least one of the permissions purchase:debit_note:update or sales:credit_note:update.

Sets the courier service and tracking number on a return and moves it to IN_TRANSIT. Needs the update permission of the return's direction.

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 UpdateReturnTracking($courierService: String!, $returnId: String!, $trackingNumber: String!) {
  updateReturnTracking(
    courierService: $courierService
    returnId: $returnId
    trackingNumber: $trackingNumber
  ) {
    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 UpdateReturnTracking($courierService: String!, $returnId: String!, $trackingNumber: String!) {\n  updateReturnTracking(\n    courierService: $courierService\n    returnId: $returnId\n    trackingNumber: $trackingNumber\n  ) {\n    id\n    returnNumber\n    rmaNumber\n    status\n  }\n}",
  "variables": {
    "courierService": "string",
    "returnId": "string",
    "trackingNumber": "string"
  }
}
EOF

Variables:

{
  "courierService": "string",
  "returnId": "string",
  "trackingNumber": "string"
}

Response:

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

updateReturnTracking(
  courierService: String!
  returnId: String!
  trackingNumber: String!
): ReturnResponse!

Arguments

updateReturnTracking.courierService ● String! non-null scalar

The name of the courier.

updateReturnTracking.returnId ● String! non-null scalar

The ID of the return.

updateReturnTracking.trackingNumber ● String! non-null scalar

The courier tracking number.

Type

ReturnResponse object

A return created through the RMA flow.