Skip to main content
GET
/
v1
/
return_items
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/return_items/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://{defaultHost}/v1/return_items/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{defaultHost}/v1/return_items/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{defaultHost}/v1/return_items/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{defaultHost}/v1/return_items/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{defaultHost}/v1/return_items/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{defaultHost}/v1/return_items/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "c673d076-fd43-4c79-9ff3-c4c73fb1cb19",
  "object": "return_item",
  "note": null,
  "return_reason": "wrong_item",
  "return_reason_description": "Received the wrong item",
  "quantity": 1,
  "return_request": "e94878c4-43b8-4562-9303-7e8ba469c649",
  "line_item": "71c98e1c-a0df-45f2-998f-ca5353f90b95",
  "created_at": 1782485890,
  "updated_at": 1782485890
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
note
string | null

A note to capture extra details about this return item. This is required when the return reason is other.

​
return_reason
string

The reason for returning the item – one of color, defective, not_as_described, other, size_too_large, size_too_small, style, unknown, unwanted, or wrong_item. The list of these reasons can be fetched from the /return_reasons endpoint.

​
quantity
integer

The quantity of products being returned. This must be less than or equal to the fulfilled quantity of the associated line item.

​
return_reason_description
string

The full description of the return reason.

​
return_request

Expandable – The associated return request ID.

​
line_item

Expandable – The associated line item ID.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.