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技術仕様は英語が正式です。不明点がある場合は英語版を参照してください。

再送注文を作成します——すでに受領済みの 1 件以上の返品在庫アイテムを、顧客の住所宛にまとめて発送する出庫シップメントです。非同期のラベル生成をトリガーし、ラベル URL は webhook で配信されます。

前提条件

対象在庫アイテムがアカウントに存在していること。returnInventoryId は newInventoryCreated webhook イベントで配信されるため、自社側でキャッシュしてください。
同一の再送内のすべての在庫が 同じ倉庫 にあること。
各在庫の現在の handlingStatusCode が、ハンドリング状態機械上で rsd（再送）に進めるものであること——通常は ohd（保留）状態である必要があります。
いずれのアイテムのラインアイテムにも保留中の VAS が存在しないこと。
各在庫が物理的に在庫されていること（輸送中ではなく、他のアクティブなワークフローにも入っていない）。
宛先住所を準備しておくこと。

必須フィールド

resendShipment — 完全な Shipment ペイロード（宛先住所、連絡先、寸法、重量、サービスタイプ）。国コードは ISO3。
- warehouseId は必須で、returnInventoryIdList に含まれるアイテムの倉庫と一致している必要があります（1 回の再送のすべてのアイテムは同じ倉庫に属します）。省略するとバリデーションに失敗します。
- ペイロード内の shipmentServiceType は Shipment Service Type（Return Service Type ではありません）— 有効なコードは Warehouse で利用可能な Shipment Service Types を取得を参照してください。Return Service Type コードを渡すとバリデーションで失敗します。
returnInventoryIdList — 空でない List<long>。上限は ResendConfig.groupResendMaxRmaCount（通常 1 桁。多数まとめたい場合はサポートにご相談ください）。

任意フィールド

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`）

キャンセル締め切り時刻

関連