このページはAIによって自動翻訳されています。不明点や相違がある場合は、英語版を正式版として参照してください。
Return Helper API
Return Helper は、返品リクエストの作成から、配送追跡、ラベル生成、倉庫処理まで、Eコマースの商品返品をエンドツーエンドで管理するAPIスイートを提供しています。
このAPIはサーバー間連携専用です。クライアントサイドのコードからこれらのエンドポイントを直接呼び出さないでください。
利用可能なAPI
User API — 返品リクエスト、配送、ラベル、在庫、アカウント設定を管理するための、マーチャントおよびパートナー向け認証済みエンドポイントです。
Public API — サービスタイプ、倉庫一覧、ステータスコード、対応国などのルックアップ値を公開する参照データエンドポイントです。
すべてのAPIリクエストには、リクエストヘッダーとしてAPIキーとトークンが必要です：
x-rr-apikey: YOUR_API_KEY
x-rr-apitoken: YOUR_API_TOKEN
Content-Type: application/json
- Return Helper ユーザーポータルにログインします。
- 設定 → 署名キーとAPIトークン に移動します。
- 既存のキーとトークンのペアが一覧表示されます。新しいペアを生成することもできます。
APIトークンは秘密情報です。他者と共有したり、クライアントサイドのコードに公開しないでください。
ベースURL
サンドボックス
| エンドポイント | ベースURL |
|---|
| User API | https://api.returnshelper.com/uat/user/api |
| Public API | https://api.returnshelper.com/uat/public/api |
本番環境
| エンドポイント | ベースURL |
|---|
| User API | https://api.returnhelpercentre.com/v1/user/api |
| User API（中国） | https://api.returnhelperchina.com/user/ |
| Public API | https://api.returnhelpercentre.com/v1/public/api |
冪等性(Idempotency)
状態変更リクエスト（返品配送(Return Shipment)や在庫の作成など）では、ネットワーク再試行時に重複操作が発生しないよう、冪等性キー(Idempotency Key)を含めてください。
x-returnhelper-idempotency-key: YOUR_UNIQUE_KEY
User-Agentヘッダー
問題を調査する際にReturn Helperサポートがあなたの連携を識別できるよう、User-Agentヘッダーを含めてください：
User-Agent: {app name}/{app version} (Platform={os version}; Runtime={runtime version}; Language={language})
User-Agent: CompanyABCApi/2024.16.0 (Platform=Unix/13.4.0; Runtime=8.0.2; Language=CSharp12)
x-rr-apikey: YOUR_API_KEY
x-rr-apitoken: YOUR_API_TOKEN
Content-Type: application/json
x-returnhelper-idempotency-key: YOUR_UNIQUE_KEY
User-Agent: YourApp/1.0.0 (Platform=Linux/5.15; Runtime=8.0.2; Language=CSharp12)
OpenAPI仕様
完全なAPI仕様はOpenAPI 3.1ドキュメントとして提供されています。PostmanやInsomniaなどのAPIクライアントに直接インポートしたり、OpenAPI Generatorなどのツールを使用してクライアントSDKを生成したりするために使用できます。
OpenAPI仕様をダウンロード
openapi.json — OpenAPI 3.1
一般的な注意事項
- すべての
dateTimeパラメーターはISO 8601形式でなければなりません。そうでない場合、APIはパースできません。
- 日付文字列パラメーター（例：
createToStr、createFromStr）もISO 8601形式である必要があります；時刻部分は無視されます。
- APIから返されるすべてのタイムスタンプはUTCです。
Webhook
ラベル結果および倉庫イベント（配送到着、在庫作成、画像アップロードなど）は、Webhook通知を通じて非同期で配信されます。これらのイベントを受信するには、通知エンドポイントを登録する必要があります。
通知イベントタイプとそのペイロードの完全な一覧については、Webhookセクションを参照してください。
