Approve Return Request

Sets Return Request to APPROVED status and creates reverse shipment according to Return Request properties. At this point Return Request is required to have pickup and dropoff details. Payment, if not specified, is calculated based on the shipment items present in request.

SecurityOauth2.0
Request
path Parameters
return_request_id
required
string
header Parameters
tenant-id
string
Request Body schema: application/json
Array of objects
Responses
200
400

Returns 400 when:

  • dropoff location is missing in the resulted RMA object.
  • RMA is not in PENDING status.
patch/returns/requests/{return_request_id}/approve
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "return_request_id": "RMA_843X7O267D7T",
  • "shipments": [
    ],
  • "partner_order_reference": "string",
  • "additional_references": [
    ],
  • "merchant": "string",
  • "status": "string",
  • "pickup": {
    },
  • "customer_comment": "string",
  • "channel": "string",
  • "notes": [
    ],
  • "items": [
    ],
  • "refund_method": "string",
  • "refund_info": {
    },
  • "creation_date": "string",
  • "update_date": "string",
  • "approval_date": "string",
  • "cancellation_date": "string",
  • "rejection_date": "string",
  • "completion_date": "string",
  • "return_items_updates": [
    ]
}