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 '
{
  "return_order_id": "<string>",
  "items": [
    {
      "id": "<string>",
      "sku": "<string>",
      "title": "<string>",
      "price": "<string>",
      "variant_id": "<string>",
      "description": "<string>",
      "return_reason": "<string>",
      "dry_clean_service": true,
      "photo_url": "<string>"
    }
  ],
  "email": "jsmith@example.com",
  "name": "<string>",
  "destination_id": "<string>",
  "seller_id": "<string>",
  "expiration_date": "2023-12-25",
  "delivery_address": {
    "address_line_1": "<string>",
    "address_line_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>"
  }
}
'
{
  "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

​
return_order_id
string
required

R4 return order identifier to update

​
items
object[]
required

Array of line items to return

​
email
string<email>

Customer email address

​
name
string

Customer name

​
destination_id
string

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

​
seller_id
string

Seller identifier that identifies the original seller of the item

​
expiration_date
string<date>

The date after which the order will no longer be accepted at a dropoff location

​
delivery_address
object

Optional delivery address for the order

Response

Order received successfully

​
code
string

Response status code

​
message
string

Response message