Skip to main content
POST
/
vendor
/
return-request
/
{id}
Update return request by id
curl --request POST \
  --url https://api.example.com/vendor/return-request/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vendor_reviewer_note": "<string>",
  "status": "refunded"
}
'
{
  "orderReturnRequest": {
    "id": "<string>",
    "customer_id": "<string>",
    "customer_note": "<string>",
    "vendor_reviewer_id": "<string>",
    "vendor_reviewer_note": "<string>",
    "vendor_reviewer_date": "2023-11-07T05:31:56Z",
    "admin_reviewer_id": "<string>",
    "admin_reviewer_note": "<string>",
    "admin_reviewer_date": "2023-11-07T05:31:56Z",
    "status": "pending",
    "order": {
      "id": "<string>"
    },
    "line_items": [
      {
        "id": "<string>",
        "line_item_id": "<string>",
        "quantity": 123
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The ID of the Request.

Body

application/json

A schema for the update of order return request.

​
vendor_reviewer_note
string

Reviewer note.

​
status
enum<string>

A status of the request

Available options:
refunded,
withdrawn,
escalated

Response

200 - application/json

OK

​
orderReturnRequest
Order return request · object

A return request object with its properties