curl --request GET \
--url https://api.returnshelper.com/uat/user/api/ReturnRequest/getReturnRequest \
--header 'x-rr-apikey: <api-key>' \
--header 'x-rr-apitoken: <api-key>'import requests
url = "https://api.returnshelper.com/uat/user/api/ReturnRequest/getReturnRequest"
headers = {
"x-rr-apikey": "<api-key>",
"x-rr-apitoken": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-rr-apikey': '<api-key>', 'x-rr-apitoken': '<api-key>'}
};
fetch('https://api.returnshelper.com/uat/user/api/ReturnRequest/getReturnRequest', 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://api.returnshelper.com/uat/user/api/ReturnRequest/getReturnRequest",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-rr-apikey: <api-key>",
"x-rr-apitoken: <api-key>"
],
]);
$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://api.returnshelper.com/uat/user/api/ReturnRequest/getReturnRequest"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-rr-apikey", "<api-key>")
req.Header.Add("x-rr-apitoken", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.returnshelper.com/uat/user/api/ReturnRequest/getReturnRequest")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/ReturnRequest/getReturnRequest")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"returnRequestId": 123,
"returnRequestNumber": "<string>",
"sellerReferenceNumber": "<string>",
"returnStatusCode": "<string>",
"returnTitle": "<string>",
"totalValue": 123,
"totalValueCurrency": "<string>",
"rma": "<string>",
"remarks": "<string>",
"isArchived": true,
"returnRequestFrom": "<string>",
"shipments": [
{
"shipmentId": 123,
"returnRequestId": 123,
"shipmentNumber": "<string>",
"shipmentStatusCode": "<string>",
"shipmentServiceType": "<string>",
"label": {
"labelId": 123,
"labelRequestStatusCode": "<string>",
"trackingNumber": "<string>",
"labelUrl": "<string>",
"qrcodeUrl": "<string>",
"carrier": "<string>"
}
}
],
"returnRequestLineItems": [
{}
],
"returnInventoryList": [
{}
],
"returnShipmentCustomFieldList": [
{}
]
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}Return Shipment の詳細を取得
curl --request GET \
--url https://api.returnshelper.com/uat/user/api/ReturnRequest/getReturnRequest \
--header 'x-rr-apikey: <api-key>' \
--header 'x-rr-apitoken: <api-key>'import requests
url = "https://api.returnshelper.com/uat/user/api/ReturnRequest/getReturnRequest"
headers = {
"x-rr-apikey": "<api-key>",
"x-rr-apitoken": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-rr-apikey': '<api-key>', 'x-rr-apitoken': '<api-key>'}
};
fetch('https://api.returnshelper.com/uat/user/api/ReturnRequest/getReturnRequest', 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://api.returnshelper.com/uat/user/api/ReturnRequest/getReturnRequest",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-rr-apikey: <api-key>",
"x-rr-apitoken: <api-key>"
],
]);
$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://api.returnshelper.com/uat/user/api/ReturnRequest/getReturnRequest"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-rr-apikey", "<api-key>")
req.Header.Add("x-rr-apitoken", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.returnshelper.com/uat/user/api/ReturnRequest/getReturnRequest")
.header("x-rr-apikey", "<api-key>")
.header("x-rr-apitoken", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.returnshelper.com/uat/user/api/ReturnRequest/getReturnRequest")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"returnRequestId": 123,
"returnRequestNumber": "<string>",
"sellerReferenceNumber": "<string>",
"returnStatusCode": "<string>",
"returnTitle": "<string>",
"totalValue": 123,
"totalValueCurrency": "<string>",
"rma": "<string>",
"remarks": "<string>",
"isArchived": true,
"returnRequestFrom": "<string>",
"shipments": [
{
"shipmentId": 123,
"returnRequestId": 123,
"shipmentNumber": "<string>",
"shipmentStatusCode": "<string>",
"shipmentServiceType": "<string>",
"label": {
"labelId": 123,
"labelRequestStatusCode": "<string>",
"trackingNumber": "<string>",
"labelUrl": "<string>",
"qrcodeUrl": "<string>",
"carrier": "<string>"
}
}
],
"returnRequestLineItems": [
{}
],
"returnInventoryList": [
{}
],
"returnShipmentCustomFieldList": [
{}
]
}{
"correlationId": "<string>",
"meta": {
"status": 123,
"data": {},
"errorCode": "<string>",
"error": {}
}
}returnRequestId を使って、単一の返品シップメントの完全なレコード(シップメント、明細、ラベル、カスタムフィールド)を取得します。
返品シップメントは倉庫到着前のパーセルを表します。倉庫がパーセルを登録すると返品在庫アイテムになります。その段階以降は、入荷後の処理データを持つ 取得 返品在庫 詳細 を使用してください。
見逃したラベルの復旧
ラベルはshipments[].label.labelUrl にあります。このエンドポイントの主な用途はシステム障害後の突合です。受信側がラベル通知を見逃した場合、returnRequestId で呼び出して現在の labelUrl と trackingNumber を直接読み取れます。labelUrl が空の場合は生成が未完了(または失敗)であることを意味します——shipments[].label.labelRequestStatusCode を確認してください。
labelGenerated webhook で配信されます。それが真実のソースです。通常運用でラベルを知るために本エンドポイントをポーリングしないでください——Webhooks を購読し、通知の見逃しや配信失敗後の補完にのみ本エンドポイントを使用してください。承認
Your API key
Your API token — keep this private
クエリパラメータ
Return request identifier, as returned by Create return shipment.
レスポンス
Success
Full record of a return shipment. Successful responses also carry the standard envelope fields (correlationId, meta) alongside the fields below.
Return request identifier
Return request number
Your merchant-supplied reference, echoed back for reconciliation
Current return status code
Return title
Declared total value of the return
ISO 4217 currency code of totalValue (e.g. usd)
Warehouse-assigned RMA reference (uppercased). Populated once the warehouse processes the parcel.
Free-text remarks
Whether the return request is archived
Origin/source of the return request
Shipments belonging to this return request, each with its label.
Show child attributes
Show child attributes
Line items included in the return request.
Return inventory records derived from this request, populated once the warehouse has received the parcel. Empty before receipt — use Get return inventory details for full inventory data at that stage.
Custom fields attached to the return shipment.