Return Shipment を作成

Create return shipment

curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/ReturnShipment/createReturnShipment \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "serviceTypeCode": "fedex_ground",
  "orderTitle": "Return Label Title",
  "orderNumber": "123123",
  "totalValueCurrency": "usd",
  "shipment": {
    "shipToWarehouseId": 2,
    "boxType": "cus",
    "shipFrom": {
      "country": "usa",
      "contactName": "Your name",
      "street1": "Some address line 1",
      "state": "tx",
      "city": "Houston",
      "postalCode": "77235",
      "phone": "15622708183",
      "email": "user@example.com",
      "fax": "<string>",
      "street2": "Some address line 2",
      "street3": "<string>"
    },
    "parcel": {
      "weight": 10.5,
      "weightUnit": "g",
      "length": 10,
      "width": 10,
      "height": 10,
      "dimensionUnit": "cm",
      "items": [
        {
          "description": "Test item",
          "weight": 10.5,
          "value": 100,
          "weightUom": "g",
          "valueCurrencyCode": "usd"
        }
      ]
    },
    "sellerReferenceNumber": "<string>",
    "customFieldMap": {}
  },
  "totalValue": 100,
  "sellerReferenceNumber": "<string>",
  "remarks": "<string>"
}
'

{
  "data": {
    "returnRequestId": 123,
    "returnRequestNumber": "<string>",
    "shipmentId": 123,
    "referenceNumber": "<string>",
    "labelId": 123,
    "labelRequestStatusCode": "<string>",
    "cost": 123,
    "costCurrencyCode": "<string>"
  }
}

POST

api

ReturnShipment

createReturnShipment

Create return shipment

curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/ReturnShipment/createReturnShipment \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "serviceTypeCode": "fedex_ground",
  "orderTitle": "Return Label Title",
  "orderNumber": "123123",
  "totalValueCurrency": "usd",
  "shipment": {
    "shipToWarehouseId": 2,
    "boxType": "cus",
    "shipFrom": {
      "country": "usa",
      "contactName": "Your name",
      "street1": "Some address line 1",
      "state": "tx",
      "city": "Houston",
      "postalCode": "77235",
      "phone": "15622708183",
      "email": "user@example.com",
      "fax": "<string>",
      "street2": "Some address line 2",
      "street3": "<string>"
    },
    "parcel": {
      "weight": 10.5,
      "weightUnit": "g",
      "length": 10,
      "width": 10,
      "height": 10,
      "dimensionUnit": "cm",
      "items": [
        {
          "description": "Test item",
          "weight": 10.5,
          "value": 100,
          "weightUom": "g",
          "valueCurrencyCode": "usd"
        }
      ]
    },
    "sellerReferenceNumber": "<string>",
    "customFieldMap": {}
  },
  "totalValue": 100,
  "sellerReferenceNumber": "<string>",
  "remarks": "<string>"
}
'

{
  "data": {
    "returnRequestId": 123,
    "returnRequestNumber": "<string>",
    "shipmentId": 123,
    "referenceNumber": "<string>",
    "labelId": 123,
    "labelRequestStatusCode": "<string>",
    "cost": 123,
    "costCurrencyCode": "<string>"
  }
}

このページはAIによって自動翻訳されています。API技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。

ラベルリクエストを伴う返品シップメントを作成します——ほぼすべての Return Helper 統合の入口です。シップメントは 1 つまたは複数のパーセルを、商品・連絡先・寸法とまとめて表します。ラベル生成は非同期キューで処理され、即時レスポンスでシップメント ID と labelRequestStatusCode（通常は queued）が返り、実際のラベル URL は後ほど webhook で配信されます。

前提条件

呼び出し前に以下を準備してください：

serviceTypeCode — 以下のいずれかから利用可能な返品サービスを取得してください：
- すべての返品サービスタイプを取得
- 発地国と倉庫でサービスタイプを取得
発地・宛先国コード — すべての発地国を取得とすべての国を取得で取得します。コードは ISO3（usa、gbr、chn）です。
パーセル寸法と重量 — 必須かつ > 0 であること。単位はすべての寸法単位を取得およびすべての重量単位を取得で確認できます。
冪等キー — 強く推奨。x-returnhelper-idempotency-key に新しい UUID を送って、リトライによる重複シップメントを防いでください。詳細は冪等性セクションを参照してください。

重要なフィールド

totalValue と totalValueCurrency — totalValue は parcel.items[].value の合計と厳密に等しい必要があります。通貨は ISO 4217（例：USD、GBP、EUR）。コードがサポートされているかはすべての取引タイプを取得で確認してください。
parcel.items — 複数明細のサポートはアカウント設定に依存します。単一明細のみ許可されているアカウントが複数明細を送ると、バリデーションのソフトエラーになります。設定変更が必要な場合はサポートにご連絡ください。
寸法 — dimension1 が最長辺、dimension2 が次に長い辺、dimension3 が最短辺です。
sellerReferenceNumber — 出品者側の識別子で、3 つの独立したレイヤー（トップレベル、shipment、parcel.items[] 内の各アイテム）で受け付けます。そのまま保存され、Webhook イベントで返却されるため自社の注文システムとの突合に利用できます。レイヤーの意味、省略時のフォールバック挙動、推奨される突合ワークフローについては Seller Reference Number を参照してください。

ラベル生成は非同期

即時レスポンスには labelRequestStatusCode: queued が含まれます。最終的なラベル URL と追跡番号は labelGenerated webhook イベント（失敗時は labelFailed）で配信されます。倉庫到着は markShipmentArrive イベント、その後 inventoryCreated イベントが続きます。Webhooks を購読してください——webhook はシップメントライフサイクルの真実のソースであり、ポーリングの代替手段ではありません。

前提条件

重要なフィールド

ラベル生成は非同期

関連

承認

ボディ

レスポンス

​前提条件

​重要なフィールド

​ラベル生成は非同期

​関連

承認

ボディ

レスポンス

前提条件

重要なフィールド

ラベル生成は非同期

関連