エンドポイント
GET /api/status/item
リクエストパラメータ
| No | パラメータ名 | 項目名 | 任意/必須 | 設定値(例) | 形式 | 説明 |
|---|---|---|---|---|---|---|
| 1 | client_key | クライアントキー | 必須 | abcdefghij0123456789 | 20桁の英数字 |
ninowユーザーに割り当てられた認証キー。 通知書に記載の値を使用してください。 |
| 2 | s_key | 荷主キー | 必須 | abcde0123456789 | 15桁の英数字 |
荷主を識別するキー。 通知書に記載の値を使用してください。 |
| 3 | is_history | 全ての履歴を返すかどうか | 任意 | 0 or 1 | 数字 |
省略時は0として扱います。 0 = 最新の配送状況のみ返す 1 = 履歴をすべて返す |
| 4 | tracking_no | 問合番号 | 任意 | KIT26000000001 | 20桁以内の英数字 | 荷札に印字されているバーコードの文字列と同じ番号。 |
| 5 | order_no | 注文番号 | 任意 | A260522000001 | 20桁以内の英数字 | 問合番号と対になる注文番号(荷主側の管理番号)。 |
| 6 | from_datetime | ステータス報告日時(FROM) | 任意 | 2023/03/01 00:00:00 |
yyyy/MM/dd HH:mm:ss (Asia/Tokyo) |
is_history=0 のときのみ有効。
この日時以降のステータス報告を取得します。 |
| 7 | to_datetime | ステータス報告日時(TO) | 任意 | 2023/03/01 00:00:00 |
yyyy/MM/dd HH:mm:ss (Asia/Tokyo) |
is_history=0 のときのみ有効。
省略時は現在日時までを取得します。 この日時以前のステータス報告を取得します。 |
| 8 | type | 履歴種別 | 任意 | 1 or 2 | 数字 |
is_history=1 のときのみ有効。
省略時は1として扱います。 1 = 簡易モード(標準ステータス) 2 = 詳細モード(運送会社用の詳細ステータス) |
レスポンスパラメータ
| No | パラメータ名 | 項目名 | 設定値 / 形式 | 説明 |
|---|---|---|---|---|
| 1 | result | 成否 | "true" or "false" |
true=正常 false=エラー |
| 2 | list | 配送履歴 | 配列形式(時系列順) ※正常時のみ設定 | |
| 2-1 | └ tracking_no | 問合番号 | A1234567 | 送り状番号 |
| 2-2 | └ order_no | 荷物番号 | 1234567 | 荷主側の注文番号等 |
| 2-3 | └ carrier | 配送会社 | xxxxxxxx | 配送会社名(システムに登録された名称) |
| 2-4 | └ code | 配送ステータスID | 40 | 配送ステータスのID |
| 2-5 | └ status | 配送ステータス | 配送中 | 配送ステータス |
| 2-6 | └ report_time | 報告時刻 | Y-m-d H:i:s | TimeZone:Asia/Tokyo |
| 2-7 | └ instruct_no | コース番号 | Dxxxx260409001 | WEBxxxxxxxxxx, Pxxxxxxxxのパターンもある |
| 2-8 | └ latitude | 緯度 | 0.00000 | |
| 2-9 | └ longitude | 経度 | 0.00000 |
レスポンスパラメータ(エラー) ※HTTPステータスコードが400等の場合
| No | パラメータ名 | 項目名 | 設定値 / 形式 | 説明 |
|---|---|---|---|---|
| 1 | result | 成否 | "false" | |
| 2 | error | エラーメッセージ | 認証エラーやパラメータエラー等 |
リクエスト例(テスト環境)
GET https://demo02.exchanger.ninow.jp/api/status/item?
client_key=(通知されたクライアントキー)
&s_key=(通知された荷主キー)
&is_history=1
&tracking_no=A1234567
&order_no=1234567
GET https://demo02.exchanger.ninow.jp/api/status/item?
client_key=(通知されたクライアントキー)
&s_key=(通知された荷主キー)
&is_history=0
&from_datetime=2026-04-20T00:00:00
&to_datetime=2026-04-20T23:59:59
レスポンス例
✅ 成功時
{
"result": "true",
"list": [
{
"tracking_no": "A1234567",
"order_no": "1234567",
"carrier":"xxxxxxxx"
"code": "40",
"status": "配送中",
"report_time": "2026-04-09 13:05:14",
"instruct_no": "D12340409001",
"latitude": "0.00000",
"longitude": "0.00000"
},
{ ... }
]
}
❌ 失敗時
{"result": "false", "error": "エラーメッセージ"}
注意事項
- ① tracking_no と order_no の両方を指定した場合は、両方の条件に合致するデータのみ返します(AND条件)。
- ② tracking_no または order_no のいずれか一方のみ指定した場合は、その条件に該当するデータを返します(OR条件)。
- ③ 取得できるデータの期間は、運送事業者が定める保持期間内に限ります(ninow 標準サービスでは 100日以内)。
サンプルコード
cURL(コマンドライン)
curl -G https://demo02.exchanger.ninow.jp/api/status/item \
--data-urlencode "client_key=YOUR_CLIENT_KEY" \
--data-urlencode "s_key=YOUR_S_KEY" \
--data-urlencode "tracking_no=A1234567" \
--data-urlencode "is_history=0" \
--data-urlencode "from_datetime=2026/04/10 00:00:00" \
--data-urlencode "to_datetime=2026/04/10 23:59:59"
PHP(cURL関数使用)
<?php
$base_url = 'https://demo02.exchanger.ninow.jp/api/status/item';
$client_key = 'YOUR_CLIENT_KEY';
$s_key = 'YOUR_S_KEY';
$params = http_build_query( [
'client_key' => $client_key,
's_key' => $s_key,
'tracking_no' => 'A1234567', // tracking_no または order_no のいずれかを指定
'is_history' => 0, // 0=最新のみ, 1=履歴全件
'from_datetime' => '2026/04/10 00:00:00',
'to_datetime' => '2026/04/10 23:59:59',
] );
$url = $base_url . '?' . $params;
$ch = curl_init( $url );
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' ) {
foreach ( $result['list'] as $item ) {
echo $item['tracking_no'] . ' : ' . $item['status'] . PHP_EOL;
}
} else {
echo 'エラー: ' . $result['error'];
}