Skip to main content
PATCH
/
order
cURL
curl --request PATCH \
  --url https://dev.api.r4technology.io/order \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "items": [
    {
      "id": "<string>",
      "sku": "<string>",
      "title": "<string>",
      "price": "<string>",
      "variant_id": "<string>",
      "description": "<string>",
      "return_reason": "<string>",
      "dry_clean_service": true
    }
  ],
  "email": "[email protected]",
  "name": "<string>",
  "destination_id": 123,
  "seller_id": 123
}
'
{
  "code": "Success",
  "message": "Order received successfully.",
  "return_order_id": "TRNZABCDEFGHIJKLMNOP",
  "qr_code_url": "https://the-return-public-assets.s3.amazonaws.com/qr-codes/TRNZABCDEFGHIJKLMNOP.png"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Order details including customer information and items to return

​
id
string
required

Unique order identifier

​
items
object[]
required

Array of line items to return

​
email
string<email>

Customer email address

​
name
string

Customer name

​
destination_id
integer

Destination identifier where the package will ultimately be transfered to from our consolidation hub

​
seller_id
integer

Seller identifier that identifies the original seller of the item

Response

Order received successfully

​
code
string

Response status code

​
message
string

Response message