Skip to main content
GET
/
returns
/
{return_request_id}
Get Return Request
curl --request GET \
  --url https://api.zinc.com/returns/{return_request_id} \
  --header 'Authorization: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "open",
  "reason": "return.request_label",
  "notes": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
Retrieve detailed information about a specific return request using its unique identifier.

Path Parameters

  • return_request_id (required) - The UUID of the return request to retrieve

Response

Returns a return request object with:
  • id - Return request UUID
  • order_id - The associated order ID
  • status - Current return request status
  • reason - The reason for the return
  • notes - Any additional notes
  • created_at - Request creation timestamp
  • updated_at - Last update timestamp

Error Responses

  • 404 Not Found - Return request ID does not exist or you don’t have access to it
  • 401 Unauthorized - Invalid or missing authentication

Authorizations

Authorization
string
header
required

Zinc API key (Bearer zn_...)

Headers

authorization
string | null

Path Parameters

return_request_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required
order_id
string<uuid>
required
status
enum<string>
required
Available options:
open,
in_progress,
approved,
denied,
completed
reason
enum<string>
required
Available options:
return.request_label,
nondelivery.not_delivered,
nondelivery.damaged,
nondelivery.empty_box,
tracking.request_update,
cancel.forced_cancellation,
other
notes
string | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required