送り状仕様詳細

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秒)。

StepURL処理
0bmypage/index.htmlGET → Cookie 確立
1bmypageapi/loginPOST → form submit(7フィールド)
1.5HMPLGI0010JspServlet302追跡(最大5ホップ)
2bmypage/ME0002.jsonPOST form-urlencoded → serviceUrl 取得
3{serviceUrl}GET → OAuth コード受渡
4{baseUrl}/tmp/template.datGET → msgpack テンプレート(460行)