Update Additional References.

This endpoint will override the additional reference provide in the existing return request.

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

Returns 400 when:

  • Tenant Id in the header is missing.
  • Return Request Id provided in the request path is missing.
  • Return Reference Edit Request is not provided in the request.
404

Returns 404 when:

  • Didn't find existing return request with the provided return request id and tenant id.
patch/returns/requests/{return_request_id}/additional-references
Request samples
application/json
{
  • "additional_references": [
    ]
}
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": [
    ]
}