Skip to main content
POST
/
store
/
return-request
Create an order return request
curl --request POST \
  --url https://api.example.com/store/return-request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_id": "<string>",
  "customer_note": "<string>",
  "shipping_option_id": "<string>",
  "line_items": [
    {
      "line_item_id": "<string>",
      "quantity": 123,
      "reason_id": "<string>"
    }
  ]
}
'
{
  "order_return_request": {
    "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.

Body

application/json

A schema for the creation of order return request.

order_id
string

ID of the order

customer_note
string

Customer note.

shipping_option_id
string

ID of the shipping option

line_items
object[]

Array of items to return

Response

201 - application/json

Created

order_return_request
Order return request · object

A return request object with its properties