エンドポイント
GET /api/pod/image
リクエストパラメータ
| No | パラメータ名 | 項目名 | 任意/必須 | 設定値(例) | 形式 | 説明 |
|---|---|---|---|---|---|---|
| 1 | client_key | クライアントキー | 必須 | abcdefghij0123456789 | 20桁の英数字 |
ninowユーザーに割り当てられた認証キー。 通知書に記載の値を使用してください。 |
| 2 | s_key | 荷主キー | 必須 | abcde0123456789 | 15桁の英数字 |
荷主を識別するキー。 通知書に記載の値を使用してください。 |
| 3 | tracking_no | 問合番号 | 任意 | KIT26000000001 | 20桁以内の英数字 | 荷札に印字されているバーコードの文字列と同じ番号。 |
| 4 | order_no | 注文番号 | 任意 | A260522000001 | 20桁以内の英数字 | 問合番号と対になる注文番号(荷主側の管理番号)。 |
| 5 | type | 区分 | 任意 | 3 | 数字 |
取得する画像の種別を指定する。 1=写真のみ 2=電子サインのみ 3=両方(写真・電子サイン) ※省略時は3として扱います。 |
レスポンスパラメータ
| No | パラメータ名 | 項目名 | 設定値 / 形式 | 説明 |
|---|---|---|---|---|
| 1 | status | 成否 | "OK" | 正常時は "OK" を返します。 |
| 2 | body.list | 画像リスト | 配列 | 該当する画像の配列(画像順)。該当が無い場合は空配列を返します。 |
| 3 | body.list[].image | 画像データ | Base64文字列 | 画像をBase64エンコードした文字列。 |
| 4 | body.list[].report_time | 撮影日時 | Y-m-d H:i:s | 画像を取得(登録)した日時。 |
レスポンスパラメータ(エラー) ※HTTPステータスコードが400・401等の場合
| No | パラメータ名 | 項目名 | 設定値 / 形式 | 説明 |
|---|---|---|---|---|
| 1 | status | 成否 | "NG" | エラー時は "NG" を返します。 |
| 2 | body.result | 成否 | false | |
| 3 | body.error | エラーメッセージ | 文字列 | 認証エラーやパラメータエラー等の内容。 |
リクエスト例(テスト環境)
GET https://demo02.exchanger.ninow.jp/api/pod/image?
client_key=(通知されたクライアントキー)
&s_key=(通知された荷主キー)
&tracking_no=A1234567
&order_no=1234567
&type=3
レスポンス例
✅ 成功時
{
"status": "OK",
"body": {
"list": [
{ "image": "画像のBase64文字列", "report_time": "2026-06-03 16:30:29" },
{ "image": "画像のBase64文字列", "report_time": "2026-06-03 16:30:29" }
]
}
}
❌ 失敗時
{
"status": "NG",
"body": { "result": false, "error": "エラーメッセージ" }
}
注意事項
- ① tracking_no と order_no の両方を指定した場合は、両方の条件に合致するデータのみ返します(AND条件)。
- ② tracking_no または order_no のいずれか一方のみ指定した場合は、その条件に該当するデータを返します(OR条件)。
- ③ 取得できるデータの期間は、運送事業者が定める保持期間内に限ります(ninow 標準サービスでは 100日以内)。
- ④ body.list[].image は、画像をBase64形式の文字列にしたものです。
- ⑤ 該当する画像が無い場合、status は "OK"、body.list は空配列([])を返します。
サンプルコード
cURL(コマンドライン)
curl -G https://demo02.exchanger.ninow.jp/api/pod/image \
--data-urlencode "client_key=YOUR_CLIENT_KEY" \
--data-urlencode "s_key=YOUR_S_KEY" \
--data-urlencode "tracking_no=A1234567" \
--data-urlencode "order_no=1234567" \
--data-urlencode "type=3"
PHP(cURL関数使用)
<?php
$base_url = 'https://demo02.exchanger.ninow.jp/api/pod/image';
$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 のいずれかを指定
'order_no' => '1234567',
'type' => 3, // 1=写真, 2=電子サイン, 3=両方
] );
$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 ( isset( $result['status'] ) && $result['status'] === 'OK' ) { // 画像を1枚ずつBase64デコードして保存
$no = 1;
foreach ( $result['body']['list'] as $item ) {
$image_data = base64_decode( $item['image'] );
file_put_contents( 'pod_' . $no . '.jpg', $image_data );
$no++;
}
echo '画像保存完了: ' . ( $no - 1 ) . '件';
} else {
echo 'エラー: ' . $result['body']['error'];
}