送り状仕様詳細
B2クラウドの送り状フィールドルール、伝票種別、配達時間帯、印刷設定の完全リファレンス。
必須フィールド(8項目)
この 8 フィールドだけで送り状が発行できます。依頼主・請求先はサーバー側で自動設定。
| フィールド | 説明 | 例 | ルール |
service_type | 伝票種別 | "0" | 下記参照 |
consignee_name | お届け先名 | "山田太郎" | 最大全角16文字 |
consignee_telephone_display | お届け先電話 | "03-1234-5678" | ハイフン付き、15文字以内 |
consignee_zip_code | 郵便番号 | "100-0014" | 8文字以内 |
consignee_address1 | 都道府県 | "東京都" | 10文字以内 |
consignee_address2 | 市区町村 | "千代田区" | 24文字以内 |
consignee_address3 | 町・番地 | "永田町1-7-1" | 32文字以内 |
item_name1 | 品名 | "化粧品" | 50文字以内(DM以外必須) |
建物・部屋番号は consignee_address4(最大32文字)に指定。例: "与野ティーズガーデン201"
伝票種別(service_type)
| 値 | 名称 | 追加必須フィールド | ラベル印刷 | 備考 |
"0" | 発払い(元払い) | — | ✅ | 最も一般的。迷ったらこれ。 |
"2" | コレクト(代金引換) | amount | ✅ | 専用ラベル print_type=2 |
"3" | クロネコゆうメール(DM) | — | ❌ | item_name1 不要 |
"4" | タイムサービス | — | ✅ | delivery_time_zone: "0010"/"0017" のみ |
"5" | 着払い | — | ❌ | invoice_code 不要、ラベル印刷不可 |
"6" | 発払い(複数口) | closure_key + package_qty | — | 合計 2〜99 個 |
"7" | クロネコゆうパケット | — | ✅ | 専用ラベル print_type=7 |
"8" | 宅急便コンパクト | — | ❌ | 専用BOX使用、ラベル印刷不可 |
"9" | コンパクトコレクト | amount | ❌ | ラベル印刷不可 |
"A" | ネコポス | — | ✅ | 専用ラベル print_type=A |
ラベル印刷不可の伝票種別(着払い/コンパクト/DM/コンパクトコレクト)は printer_type="1"(レーザー)設定でのみ印刷可能。
よく使うオプション
| フィールド | 説明 | デフォルト | 備考 |
shipment_date | 出荷日 | 本日 | "YYYY/MM/DD" 形式 |
consignee_address4 | 建物・部屋番号 | — | 最大32文字 |
consignee_department1 | 部署名 | — | 最大50文字 |
consignee_title | 敬称 | "様" | "様"/"御中"/"" |
item_name2 | 品名2 | — | |
is_cool | クール便 | "0" | "0"=普通 / "1"=冷凍 / "2"=冷蔵 |
package_qty | 個数 | "1" | 文字列で指定。"1"〜"99" |
note | 記事欄 | — | 最大44文字 |
handling_information1 | 荷扱い情報1 | — | 例: "ワレモノ注意"(最大20文字) |
search_key4 | 管理用検索キー | 自動生成 | 半角英数字16文字以内 |
配達時間帯(delivery_time_zone)
| コード | 時間帯 | 備考 |
"0000" | 指定なし | デフォルト |
"0812" | 午前中 | |
"1416" | 14時〜16時 | |
"1618" | 16時〜18時 | |
"1820" | 18時〜20時 | |
"1921" | 19時〜21時 | |
"0010" | 午前中(タイム専用) | service_type=4 のみ |
"0017" | 午後(タイム専用) | service_type=4 のみ |
印刷設定
print_type: 用紙種別(デフォルト "m5" = A5マルチ)
| 値 | 名称 | サイズ |
"m" | A4マルチ | 210×297mm |
"m5" | A5マルチ(デフォルト) | 210×149mm |
"4" | ラベル発払い | 119.6×236.1mm |
"2" | ラベルコレクト | — |
"7" | ラベルゆうパケット | — |
"A" | ラベルネコポス | — |
output_format を指定すると printer_type を自動切替:
| 値 | 動作 |
"a4_multi" | printer_type=1 に切替 → A4マルチで印刷 |
"a5_multi" | printer_type=1 に切替 → A5マルチで印刷 |
"label" | printer_type=3 に切替 → ラベルで印刷 |
依頼主の上書き
通常は環境変数で自動設定されるため指定不要。ユーザーが明示的に変更を求めた場合のみ使用。
| フィールド | 説明 |
shipper_name | 依頼主名(最大32文字) |
shipper_telephone_display | 依頼主電話(ハイフン付き) |
shipper_zip_code | 依頼主郵便番号 |
shipper_address1/2/3 | 依頼主住所(都道府県/市区町村/町・番地) |
コレクト / コンパクトコレクト専用
| フィールド | 説明 | 対象 |
amount | 代引金額(税込、文字列) | service_type=2 / 9 |
tax_amount | 消費税額(任意) | service_type=2 / 9 |
amount の範囲: "1" 〜 "300000"
認証フロー(5段階)
実ブラウザの認証フローを完全に模倣。ステートレスに各リクエストで新規ログイン(3〜5秒)。
| Step | URL | 処理 |
| 0 | bmypage/index.html | GET → Cookie 確立 |
| 1 | bmypageapi/login | POST → form submit(7フィールド) |
| 1.5 | HMPLGI0010JspServlet | 302追跡(最大5ホップ) |
| 2 | bmypage/ME0002.json | POST form-urlencoded → serviceUrl 取得 |
| 3 | {serviceUrl} | GET → OAuth コード受渡 |
| 4 | {baseUrl}/tmp/template.dat | GET → msgpack テンプレート(460行) |