refundRequestReturn

refundRequestReturn is used as part of the standard refunds workflow to mark the goods as having been returned.

  2 minute read  

Key Information

Use-Case

When operating the standard refund workflow, you need to mark the refund requests as having been returned. This is true with both post-dispatch (return) and pre-dispatch (cancellation) use-cases.

Further Points of Note
  • The cancellation workflow (products have not yet been dispatched) still requires the use of this mutation, for more information on the supported workflows, refer to this article.
Availability
  • Operator API: Yes
  • Seller API: Yes - scoped to seller owned refund request

Example

mutation markRefundRequestItemAsReturned{
  refundRequestReturn(
    input: {
      refundRequestId: "UmVmdW5kUmVxdWVzdC01Mjk="
      notes: [{ note: "refundRequestReturn via API" }]
    }
  ) {
    refundRequest {
      id
      status
    }
    errors {
      field
      messages
    }
  }
}

Arguments

NameType
inputRefundRequestReturnMutationInput

Response

Returns RefundRequestReturnMutationPayload

Error Responses

HTTP ErrorError MessageMeaning
401UnauthorizedYou don’t have access to the endpoint, likely Basic Authentication credentials are missing
401API Token has expiredYou don’t have access to the endpoint, likely that you are either not supplying an API Key, or the key you are supplying is invalid
200No object found for refundRequestId: <refundRequestId>The ID of the supplied refund request does not exist
200Can only mark an awaiting RefundRequest as returnedYou have attempted to mark a refund request as returned, when it was not in the AWAITING state

Further Reading