エンドポイント
GET /api/label/pdf
リクエストパラメータ
| No | パラメータ名 | 項目名 | 任意/必須 | 設定値（例） | 形式 | 説明 |
|---|---|---|---|---|---|---|
| 1 | client_key | クライアントキー | 必須 | abcdefghij0123456789 | 20桁の英数字 |
ninowユーザーに割り当てられた認証キー。 通知書に記載の値を使用してください。 |
| 2 | s_key | 荷主キー | 必須 | abcde0123456789 | 15桁の英数字 |
荷主を識別するキー。 通知書に記載の値を使用してください。 |
| 3 | tracking_no | 問合番号 | 任意 | KIT26000000001 | 20桁以内の英数字 | 荷札に印字されているバーコードの文字列と同じ番号。 |
| 4 | order_no | 注文番号 | 任意 | A260522000001 | 20桁以内の英数字 | 問合番号と対になる注文番号（荷主側の管理番号）。 |
| 5 | security_mode | セキュリティモード | 任意 | 1 | 数字 |
お届け先情報のマスクモードを指定する。 1=マスクなし 2=電話番号のみマスク(*を表示) 3=匿名配送モード(お届け先情報を全て*にする) ※省略時は1として扱います。 |
レスポンスパラメータ
| No | パラメータ名 | 項目名 | 設定値 / 形式 | 説明 |
|---|---|---|---|---|
| 1 | 成否 | PDFのBase64文字列 |
レスポンスパラメータ（エラー） ※HTTPステータスコードが400等の場合
| No | パラメータ名 | 項目名 | 設定値 / 形式 | 説明 |
|---|---|---|---|---|
| 1 | result | 成否 | "false" | |
| 2 | error | エラーメッセージ | 認証エラーやパラメータエラー等 |
リクエスト例（テスト環境）
GET https://demo02.exchanger.ninow.jp/api/label/pdf?
client_key=（通知されたクライアントキー）
&s_key=（通知された荷主キー）
&tracking_no=A1234567
&order_no=1234567
&security_mode=2
レスポンス例
✅ 成功時
{"pdf":"PDFのBase64文字列"}
❌ 失敗時
{"result": "false", "error": "エラーメッセージ"}
注意事項
- ① tracking_no と order_no の両方を指定した場合は、両方の条件に合致するデータのみ返します（AND条件）。
- ② tracking_no または order_no のいずれか一方のみ指定した場合は、その条件に該当するデータを返します（OR条件）。
- ③ 取得できるデータの期間は、運送事業者が定める保持期間内に限ります（ninow 標準サービスでは 100日以内）。
- ④ bodyの内容は、PDFをBase64形式の文字列にしたものです。
サンプルコード
cURL（コマンドライン）
curl -G https://demo02.exchanger.ninow.jp/api/label/pdf \
--data-urlencode "client_key=YOUR_CLIENT_KEY" \
--data-urlencode "s_key=YOUR_S_KEY" \
--data-urlencode "tracking_no=A1234567" \
--data-urlencode "order_no=1234567"
PHP（cURL関数使用）
<?php
$base_url = 'https://demo02.exchanger.ninow.jp/api/label/pdf';
$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',
] );
$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['pdf'] ) ) { // Base64デコードしてPDFとして保存
$pdf_data = base64_decode( $result['pdf'] );
file_put_contents( 'label.pdf', $pdf_data );
echo 'PDF保存完了: label.pdf';
} else {
echo 'エラー: ' . $result['error'];
}
荷札PDFサンプル
APIで取得できる荷札PDFの出力例です。