建立 Resend Order

Create resend order

curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/Resend/createResend \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "returnInventoryIdList": [
    123
  ],
  "resendShipment": {
    "warehouseId": 123,
    "shipmentCountryCode": "<string>",
    "shipmentName": "<string>",
    "shipmentPhone": "<string>",
    "shipmentStreet1": "<string>",
    "shipmentStreet2": "<string>",
    "shipmentState": "<string>",
    "shipmentCity": "<string>",
    "shipmentPostalCode": "<string>",
    "shipmentServiceType": "<string>",
    "shipmentFax": "<string>",
    "shipmentEmail": "<string>",
    "shipmentStreet3": "<string>"
  },
  "description": "<string>",
  "remarks": "<string>"
}
'

import requests

url = "https://api.returnshelper.com/uat/user/api/Resend/createResend"

payload = {
    "returnInventoryIdList": [123],
    "resendShipment": {
        "warehouseId": 123,
        "shipmentCountryCode": "<string>",
        "shipmentName": "<string>",
        "shipmentPhone": "<string>",
        "shipmentStreet1": "<string>",
        "shipmentStreet2": "<string>",
        "shipmentState": "<string>",
        "shipmentCity": "<string>",
        "shipmentPostalCode": "<string>",
        "shipmentServiceType": "<string>",
        "shipmentFax": "<string>",
        "shipmentEmail": "<string>",
        "shipmentStreet3": "<string>"
    },
    "description": "<string>",
    "remarks": "<string>"
}
headers = {
    "x-rr-apikey": "<api-key>",
    "x-rr-apitoken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-rr-apikey': '<api-key>',
    'x-rr-apitoken': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    returnInventoryIdList: [123],
    resendShipment: {
      warehouseId: 123,
      shipmentCountryCode: '<string>',
      shipmentName: '<string>',
      shipmentPhone: '<string>',
      shipmentStreet1: '<string>',
      shipmentStreet2: '<string>',
      shipmentState: '<string>',
      shipmentCity: '<string>',
      shipmentPostalCode: '<string>',
      shipmentServiceType: '<string>',
      shipmentFax: '<string>',
      shipmentEmail: '<string>',
      shipmentStreet3: '<string>'
    },
    description: '<string>',
    remarks: '<string>'
  })
};

fetch('https://api.returnshelper.com/uat/user/api/Resend/createResend', 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/Resend/createResend",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'returnInventoryIdList' => [
        123
    ],
    'resendShipment' => [
        'warehouseId' => 123,
        'shipmentCountryCode' => '<string>',
        'shipmentName' => '<string>',
        'shipmentPhone' => '<string>',
        'shipmentStreet1' => '<string>',
        'shipmentStreet2' => '<string>',
        'shipmentState' => '<string>',
        'shipmentCity' => '<string>',
        'shipmentPostalCode' => '<string>',
        'shipmentServiceType' => '<string>',
        'shipmentFax' => '<string>',
        'shipmentEmail' => '<string>',
        'shipmentStreet3' => '<string>'
    ],
    'description' => '<string>',
    'remarks' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.returnshelper.com/uat/user/api/Resend/createResend"

	payload := strings.NewReader("{\n  \"returnInventoryIdList\": [\n    123\n  ],\n  \"resendShipment\": {\n    \"warehouseId\": 123,\n    \"shipmentCountryCode\": \"<string>\",\n    \"shipmentName\": \"<string>\",\n    \"shipmentPhone\": \"<string>\",\n    \"shipmentStreet1\": \"<string>\",\n    \"shipmentStreet2\": \"<string>\",\n    \"shipmentState\": \"<string>\",\n    \"shipmentCity\": \"<string>\",\n    \"shipmentPostalCode\": \"<string>\",\n    \"shipmentServiceType\": \"<string>\",\n    \"shipmentFax\": \"<string>\",\n    \"shipmentEmail\": \"<string>\",\n    \"shipmentStreet3\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"remarks\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-rr-apikey", "<api-key>")
	req.Header.Add("x-rr-apitoken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.returnshelper.com/uat/user/api/Resend/createResend")
  .header("x-rr-apikey", "<api-key>")
  .header("x-rr-apitoken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"returnInventoryIdList\": [\n    123\n  ],\n  \"resendShipment\": {\n    \"warehouseId\": 123,\n    \"shipmentCountryCode\": \"<string>\",\n    \"shipmentName\": \"<string>\",\n    \"shipmentPhone\": \"<string>\",\n    \"shipmentStreet1\": \"<string>\",\n    \"shipmentStreet2\": \"<string>\",\n    \"shipmentState\": \"<string>\",\n    \"shipmentCity\": \"<string>\",\n    \"shipmentPostalCode\": \"<string>\",\n    \"shipmentServiceType\": \"<string>\",\n    \"shipmentFax\": \"<string>\",\n    \"shipmentEmail\": \"<string>\",\n    \"shipmentStreet3\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"remarks\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.returnshelper.com/uat/user/api/Resend/createResend")

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

request = Net::HTTP::Post.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"returnInventoryIdList\": [\n    123\n  ],\n  \"resendShipment\": {\n    \"warehouseId\": 123,\n    \"shipmentCountryCode\": \"<string>\",\n    \"shipmentName\": \"<string>\",\n    \"shipmentPhone\": \"<string>\",\n    \"shipmentStreet1\": \"<string>\",\n    \"shipmentStreet2\": \"<string>\",\n    \"shipmentState\": \"<string>\",\n    \"shipmentCity\": \"<string>\",\n    \"shipmentPostalCode\": \"<string>\",\n    \"shipmentServiceType\": \"<string>\",\n    \"shipmentFax\": \"<string>\",\n    \"shipmentEmail\": \"<string>\",\n    \"shipmentStreet3\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"remarks\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "resendId": 123
}

{
  "correlationId": "<string>",
  "meta": {
    "status": 123,
    "data": {},
    "errorCode": "<string>",
    "error": {}
  }
}

POST

api

Resend

createResend

Create resend order

curl --request POST \
  --url https://api.returnshelper.com/uat/user/api/Resend/createResend \
  --header 'Content-Type: application/json' \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>' \
  --data '
{
  "returnInventoryIdList": [
    123
  ],
  "resendShipment": {
    "warehouseId": 123,
    "shipmentCountryCode": "<string>",
    "shipmentName": "<string>",
    "shipmentPhone": "<string>",
    "shipmentStreet1": "<string>",
    "shipmentStreet2": "<string>",
    "shipmentState": "<string>",
    "shipmentCity": "<string>",
    "shipmentPostalCode": "<string>",
    "shipmentServiceType": "<string>",
    "shipmentFax": "<string>",
    "shipmentEmail": "<string>",
    "shipmentStreet3": "<string>"
  },
  "description": "<string>",
  "remarks": "<string>"
}
'

import requests

url = "https://api.returnshelper.com/uat/user/api/Resend/createResend"

payload = {
    "returnInventoryIdList": [123],
    "resendShipment": {
        "warehouseId": 123,
        "shipmentCountryCode": "<string>",
        "shipmentName": "<string>",
        "shipmentPhone": "<string>",
        "shipmentStreet1": "<string>",
        "shipmentStreet2": "<string>",
        "shipmentState": "<string>",
        "shipmentCity": "<string>",
        "shipmentPostalCode": "<string>",
        "shipmentServiceType": "<string>",
        "shipmentFax": "<string>",
        "shipmentEmail": "<string>",
        "shipmentStreet3": "<string>"
    },
    "description": "<string>",
    "remarks": "<string>"
}
headers = {
    "x-rr-apikey": "<api-key>",
    "x-rr-apitoken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-rr-apikey': '<api-key>',
    'x-rr-apitoken': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    returnInventoryIdList: [123],
    resendShipment: {
      warehouseId: 123,
      shipmentCountryCode: '<string>',
      shipmentName: '<string>',
      shipmentPhone: '<string>',
      shipmentStreet1: '<string>',
      shipmentStreet2: '<string>',
      shipmentState: '<string>',
      shipmentCity: '<string>',
      shipmentPostalCode: '<string>',
      shipmentServiceType: '<string>',
      shipmentFax: '<string>',
      shipmentEmail: '<string>',
      shipmentStreet3: '<string>'
    },
    description: '<string>',
    remarks: '<string>'
  })
};

fetch('https://api.returnshelper.com/uat/user/api/Resend/createResend', 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/Resend/createResend",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'returnInventoryIdList' => [
        123
    ],
    'resendShipment' => [
        'warehouseId' => 123,
        'shipmentCountryCode' => '<string>',
        'shipmentName' => '<string>',
        'shipmentPhone' => '<string>',
        'shipmentStreet1' => '<string>',
        'shipmentStreet2' => '<string>',
        'shipmentState' => '<string>',
        'shipmentCity' => '<string>',
        'shipmentPostalCode' => '<string>',
        'shipmentServiceType' => '<string>',
        'shipmentFax' => '<string>',
        'shipmentEmail' => '<string>',
        'shipmentStreet3' => '<string>'
    ],
    'description' => '<string>',
    'remarks' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.returnshelper.com/uat/user/api/Resend/createResend"

	payload := strings.NewReader("{\n  \"returnInventoryIdList\": [\n    123\n  ],\n  \"resendShipment\": {\n    \"warehouseId\": 123,\n    \"shipmentCountryCode\": \"<string>\",\n    \"shipmentName\": \"<string>\",\n    \"shipmentPhone\": \"<string>\",\n    \"shipmentStreet1\": \"<string>\",\n    \"shipmentStreet2\": \"<string>\",\n    \"shipmentState\": \"<string>\",\n    \"shipmentCity\": \"<string>\",\n    \"shipmentPostalCode\": \"<string>\",\n    \"shipmentServiceType\": \"<string>\",\n    \"shipmentFax\": \"<string>\",\n    \"shipmentEmail\": \"<string>\",\n    \"shipmentStreet3\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"remarks\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-rr-apikey", "<api-key>")
	req.Header.Add("x-rr-apitoken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.returnshelper.com/uat/user/api/Resend/createResend")
  .header("x-rr-apikey", "<api-key>")
  .header("x-rr-apitoken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"returnInventoryIdList\": [\n    123\n  ],\n  \"resendShipment\": {\n    \"warehouseId\": 123,\n    \"shipmentCountryCode\": \"<string>\",\n    \"shipmentName\": \"<string>\",\n    \"shipmentPhone\": \"<string>\",\n    \"shipmentStreet1\": \"<string>\",\n    \"shipmentStreet2\": \"<string>\",\n    \"shipmentState\": \"<string>\",\n    \"shipmentCity\": \"<string>\",\n    \"shipmentPostalCode\": \"<string>\",\n    \"shipmentServiceType\": \"<string>\",\n    \"shipmentFax\": \"<string>\",\n    \"shipmentEmail\": \"<string>\",\n    \"shipmentStreet3\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"remarks\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.returnshelper.com/uat/user/api/Resend/createResend")

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

request = Net::HTTP::Post.new(url)
request["x-rr-apikey"] = '<api-key>'
request["x-rr-apitoken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"returnInventoryIdList\": [\n    123\n  ],\n  \"resendShipment\": {\n    \"warehouseId\": 123,\n    \"shipmentCountryCode\": \"<string>\",\n    \"shipmentName\": \"<string>\",\n    \"shipmentPhone\": \"<string>\",\n    \"shipmentStreet1\": \"<string>\",\n    \"shipmentStreet2\": \"<string>\",\n    \"shipmentState\": \"<string>\",\n    \"shipmentCity\": \"<string>\",\n    \"shipmentPostalCode\": \"<string>\",\n    \"shipmentServiceType\": \"<string>\",\n    \"shipmentFax\": \"<string>\",\n    \"shipmentEmail\": \"<string>\",\n    \"shipmentStreet3\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"remarks\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "resendId": 123
}

{
  "correlationId": "<string>",
  "meta": {
    "status": 123,
    "data": {},
    "errorCode": "<string>",
    "error": {}
  }
}

此頁面由 AI 自動翻譯。API 技術規格以英文呈現為標準。如有任何疑問，請參閱英文版本。

建立補寄訂單——將一個或多個已收到的退件庫存項打包，再寄到客戶地址。會觸發非同步面單產生；面單 URL 透過 webhook 推送。

前置條件

目標庫存項已在您的帳戶中。returnInventoryId 由 newInventoryCreated webhook 事件推送——請在自有端快取。
同一次補寄的所有庫存必須位於同一倉庫。
每筆庫存目前的 handlingStatusCode 必須可推進至 rsd（補寄）——通常需為 ohd（暫存）。
任何項所屬行項目不可存在待處理 VAS。
每筆庫存必須實際在庫（非運輸中，亦未處於其他活躍流程）。
備妥目的地地址。

必填欄位

resendShipment — 完整 Shipment payload（目的地址、聯絡人、尺寸、重量、服務類型）。國家代碼為 ISO3。
- warehouseId 為必填，且必須與 returnInventoryIdList 中各項目所屬的倉庫相同（同一次補寄的所有項目共用同一倉庫）。省略將導致驗證失敗。
- payload 內的 shipmentServiceType 是 Shipment Service Type（不是 Return Service Type）— 有效代碼請見取得 Warehouse 可用的 Shipment Service Types。傳入 Return Service Type 代碼會在驗證階段失敗。
returnInventoryIdList — 非空 List<long>。上限為 ResendConfig.groupResendMaxRmaCount（通常為個位數；如需打包更多請聯絡客服）。

選填欄位

description — 補寄訂單的自由文字描述（上限 255 字元）。會保存至訂單，並由取得補寄訂單詳情回傳。
remarks — 補寄訂單的商家備註（上限 5000 字元）。會保存至訂單，並由取得補寄訂單詳情回傳。

兩者對應 Portal 上 Create Resend 表單的 Description 與 Remarks 欄位。皆為選填——省略即代表該訂單不設描述或備註。

副作用

每筆庫存的 handlingCode 會被設為 rsd。
待面單就緒後，倉庫將出貨。

標籤產生：自動 vs 手動服務類型

補寄是否自動產生運單標籤，取決於您在 resendShipment.shipmentServiceType 中傳入的 shipment service type。每個 shipment service type 都帶有 isEnableAutoCreateLabel 旗標——請從取得 Warehouse 可用的 Shipment Service Types 取得，並讀取您打算使用的代碼的 isEnableAutoCreateLabel。

自動標籤（`isEnableAutoCreateLabel: true`）

標籤在建立後非同步產生。補寄狀態流轉為： queued → label-success → completed（若標籤產生失敗則 queued → failed）僅當補寄處於 label-success 且在截止時間之前，才能透過取消補寄訂單取消。處於 queued 時無法取消，因為標籤仍在產生中。

手動標籤（`isEnableAutoCreateLabel: false`）

不會自動產生標籤；由倉庫處理該補寄。補寄狀態流轉為： pending → in-progress → completed 當補寄處於 pending 且在截止時間之前，可透過取消補寄訂單取消。

取消截止時間

每個補寄都有取消截止時間，即工作日的 08:00 UTC，於補寄建立時設定。只要補寄處於其可取消狀態（自動標籤為 label-success，手動標籤為 pending），您可在該截止時間之前取消。一旦超過截止時間，便無法再透過 API 取消。

若已超過截止時間但您仍需取消補寄，請聯絡我們的客服團隊協助。截止時間過後無法保證能取消——包裹可能已經寄出。

概覽

API

FBA

合併運貨單

通知

回收

重寄

退貨庫存

退件運貨單（建立）

服務類型

退件運貨單

退件運貨單服務類型

增值服務

倉庫

前置條件

必填欄位

選填欄位

副作用

標籤產生：自動 vs 手動服務類型

自動標籤（`isEnableAutoCreateLabel: true`）

手動標籤（`isEnableAutoCreateLabel: false`）

取消截止時間

相關

授權

主體

回應

​前置條件

​必填欄位

​選填欄位

​副作用

​標籤產生：自動 vs 手動服務類型

​自動標籤（isEnableAutoCreateLabel: true）

​手動標籤（isEnableAutoCreateLabel: false）

​取消截止時間

​相關

授權

主體

回應

前置條件

必填欄位

選填欄位

副作用

標籤產生：自動 vs 手動服務類型

自動標籤（`isEnableAutoCreateLabel: true`）

手動標籤（`isEnableAutoCreateLabel: false`）

取消截止時間

相關