エンドポイント
POST /api/order/import
リクエストデータ形式
Content-type:application/x-www-form-urlencoded
リクエストパラメータ
| No | パラメータ名 | 項目名 | 任意/必須 | 設定値(例) | 形式 | 説明 |
|---|---|---|---|---|---|---|
| 1 | client_key | クライアントキー | 必須 | abcdefghij0123456789 | 20桁の英数字 |
ninowユーザーに割り当てられた認証キー。 通知書に記載の値を使用してください。 |
| 2 | s_key | 荷主キー | 必須 | abcde0123456789 | 15桁の英数字 |
荷主を識別するキー。 通知書に記載の値を使用してください。 |
| 3 | conversion_id | データ変換ID | 必須 | 1 | 数字 | データ変換ツール(exchanger)の「取込・変換設定」画面で確認できるIDを指定してください。 |
| 4 | list | 登録対象データ | 必須 | [ { "tracking_no": "987654321000", "shipping_date": "2026/4/20", "wh_code": "若洲", "cargo_out": "2026/4/20 15:34:56", "shipping_club": "AZProject", "consignee_zip": "3320021", "consignee_name": "安須太郎", "consignee_address": "埼玉県川口市西川口6丁目1番8号 第三荻島ビル", "consignee_tel": "09012345678", "s_size": "60", "s_weight": "1.01", "pcs": 1, "create_time": "2026/4/20 15:34:56", "update_time": "2026/4/20 15:34:56" } ] | JSON文字列形式 | 配送依頼の内容をJSON配列で指定してください。(詳細は、注意事項を参照) |
| 5 | is_issue | 問合番号の発番フラグ | 任意 | 0 or 1 | 数字 |
1を指定すると問合番号を自動発番します。 省略時は0として扱います。 発番ルール:荷主伝票プリフィックス+13桁 1~2桁目:年(西暦下2桁) 3~5桁目:通算日(3桁):000~365(1/1を0) 6~11桁目:連番(6桁) 例)2026年2月1日 → 26031000001〜 ※ Exchangerの画面から配送依頼ファイルを取込む場合は、1に設定しても荷主側に問合番号を返却できないため発番されません。 |
レスポンスパラメータ(正常)
| No | パラメータ名 | 項目名 | 設定値 / 形式 | 説明 |
|---|---|---|---|---|
| 1 | status | 成否 | "OK" | |
| 2 | body | 結果 | ||
| 2-1 | └ tracking_no | 問合番号 | A1234567 | 送り状番号 |
| 2-2 | └ order_no | 荷物番号 | 1234567 | 荷主側の注文番号等 |
レスポンスパラメータ(エラー) ※HTTPステータスコードが400等の場合
| No | パラメータ名 | 項目名 | 設定値 / 形式 | 説明 |
|---|---|---|---|---|
| 1 | result | 成否 | "false" | |
| 2 | error | エラーメッセージ | 認証エラーやパラメータエラー等 |
レスポンスパラメータ(エラー) ※取込できないデータが送信された場合(必須項目が未設定の場合等)
| No | パラメータ名 | 項目名 | 設定値 / 形式 | 説明 |
|---|---|---|---|---|
| 1 | status | 成否 | "NG" | |
| 2 | error | エラーメッセージ | エラー内容 | |
| 3 | list | エラーデータ | エラーデータ(CSV形式) |
リクエスト例(テスト環境)
POST https://demo02.exchanger.ninow.jp/api/orders/import
client_key = (通知されたクライアントキー) s_key = (通知された荷主キー) conversion_id = (exchanger 取込・変換設定管理画面のID) list = [ { "tracking_no": "987654321000", "shipping_date": "2026/4/20", "wh_code": "若洲", "cargo_out": "2026/4/20 15:34:56", "shipping_club": "AZProject", "consignee_zip": "3320021", "consignee_name": "安須太郎", "consignee_address": "埼玉県川口市西川口6丁目1番8号 第三荻島ビル", "consignee_tel": "09012345678", "s_size": "60", "s_weight": "1.01", "pcs": 1, "create_time": "2026/4/20 15:34:56", "update_time": "2026/4/20 15:34:56" }
]
client_key = (通知されたクライアントキー) s_key = (通知された荷主キー) conversion_id = (exchanger 取込・変換設定管理画面のID) list = [ { "tracking_no": "987654321000", "shipping_date": "2026/4/20", "wh_code": "若洲", "cargo_out": "2026/4/20 15:34:56", "shipping_club": "AZProject", "consignee_zip": "3320021", "consignee_name": "安須太郎", "consignee_address": "埼玉県川口市西川口6丁目1番8号 第三荻島ビル", "consignee_tel": "09012345678", "s_size": "60", "s_weight": "1.01", "pcs": 1, "create_time": "2026/4/20 15:34:56", "update_time": "2026/4/20 15:34:56" }
]
レスポンス例
✅ 成功時
{"status":"OK","body":{"tracking_no":"問合番号","order_no":"注文(荷物)番号"}}
❌ 失敗時
{"result": "false", "error": "エラーメッセージ"}
{"status":"NG","error":"エラーメッセージ", "list":"エラーデータ"}
注意事項
- ① listパラメータに配送情報をJSON形式で設定してください。
listパラメータに設定する配送情報の中身は下記の形式に従っていれば自由に設定できますが、事前に取込設定を行う必要があるため、送信できる情報を運営会社にご連絡してください。
※コマンドを作成して共通認識としてご連絡頂くという形でも問題はありません。
リクエストサンプルでは下記のような値を設定していますが、項目の増減も柔軟に対応できます。
※例えば、上記以外に対面配送、置き配等の指定や代引設定等を設定したい場合は、項目に含めることが可能です。項目名 意味 説明 tracking_no 送り状番号 配送中に読み取るバーコードやQRコード(荷札に印刷されている番号)
項目名がtracking_noがorder_noやitem_noという名称でも問題ありませんshipping_date 出荷日 類似項目として出荷日時がある場合や出荷日不明の段階でデータを送信する場合は項目がなくても問題ありません wh_code 出荷センター名 cargo_out 出荷日時 shipping_club 集荷運送業者名 consignee_zip 配送先郵便番号 ハイフンなし(取込時にハイフンは自動削除します) consignee_name 配送先名 consignee_address 配送先住所 consignee_tel 配送先電話番号 ハイフンなし(取込時にハイフンは自動削除します) s_size 荷物サイズ 60サイズ, 80サイズ等 s_weight 荷物重量 単位が必要な場合は別項目で単位を指定してください。単位はkgです。 pcs 個数 個数が1固定の場合は省略できます create_time 作成日時 荷主側でのデータの作成日時 update_time 更新日時 荷主側でのデータの更新日時 - ② is_issueパラメータを1に設定している場合のみ問合番号を発行します。荷札に印字する問合番号を発行したい場合にご指定ください。
-
③ list内の項目は、荷主で送信できる情報(項目名等は自由)を設定し、送信データのJSON情報をサンプルとしてご提示ください。
ニナウのデータ連携設定にて送信情報のどの項目をニナウのどの項目に割り当てるか設定します。 - ④ 日付の形式は、2026-04-20の形式(YYYY-mm-dd)が望ましい。2026/4/1のような形式でも対応は可。
-
⑤ 問合番号に既存と同じ番号を指定した場合、規定日数(100日)以内の場合は、登録データを上書きします。規定日数を超えていた場合は、新規データとして登録します。
同一番号のデータを上書きされたくない場合は、別の番号で登録するようにしてください。(例:注文番号:00001の口割れ時は、問合番号を000011、000012とする等)
is_issueパラメータに1を設定している状態(注文番号から問合番号を作成)で同じ注文番号を指定した場合の動作も同様です。
サンプルコード
cURL(コマンドライン)
curl -X POST https://demo02.exchanger.ninow.jp/api/order/import \
-F "client_key=YOUR_CLIENT_KEY" \
-F "s_key=YOUR_S_KEY" \
-F "conversion_id=YOUR_CONVERSION_ID" \
-F 'list=[{"tracking_no":"987654321000","shipping_date":"2026/4/20","wh_code":"若洲","cargo_out":"2026/4/20 15:34:56","arr_code":"211199","sub_code":"","shipping_club":"AZProject","consignee_zip":"3320021","consignee_name":"安須太郎","consignee_address":"埼玉県川口市西川口6丁目1番8号 第三荻島ビル","consignee_tel":"09012345678","s_size":"60","s_weight":"1.01","pcs":1,"create_time":"2026/4/20 15:34:56","update_time":"2026/4/20 15:34:56"}]'
PHP(cURL関数使用)
<?php
$url = 'https://demo02.exchanger.ninow.jp/api/order/import';
$client_key = 'YOUR_CLIENT_KEY';
$s_key = 'YOUR_S_KEY';
$conversion_id = 'YOUR_CONVERSION_ID';
$list = [
[
'tracking_no' => '987654321000',
'shipping_date' => '2026/4/20',
'wh_code' => '若洲',
'cargo_out' => '2026/4/20 15:34:56',
'shipping_club' => 'AZProject',
'consignee_zip' => '3320021',
'consignee_name' => '安須太郎',
'consignee_address' => '埼玉県川口市西川口6丁目1番8号 第三荻島ビル',
'consignee_tel' => '09012345678',
's_size' => '60',
's_weight' => '1.01',
'pcs' => 1,
'create_time' => '2026/4/20 15:34:56',
'update_time' => '2026/4/20 15:34:56',
],
];
$post_data = [
'client_key' => $client_key,
's_key' => $s_key,
'conversion_id' => $conversion_id,
'list' => json_encode( $list, JSON_UNESCAPED_UNICODE ),
'is_issue' => 0, // 1 にすると問合番号を自動発番
];
$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_POST, true );
curl_setopt( $ch, CURLOPT_POSTFIELDS, $post_data );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
$response = curl_exec( $ch );
$http_code = curl_getinfo( $ch, CURLINFO_HTTP_CODE );
curl_close( $ch );
$result = json_decode( $response, true );
if ( $result['result'] === 'true' ) { // 登録成功
echo '登録成功';
} else { // 登録失敗
echo 'エラー: ' . $result['error'];
}