開発ドキュメント

各リクエストでは、client_key パラメーターと token パラメーターの両方を必ず送信してください。
値の渡し方:
  • client_key は URL パラメーターとして渡してください。
    例: https://webapi.umtec.jp/miandan/api/put_sagawa?client_key={client_key}

  • token は HTTP ヘッダーで渡してください。
    例:Authorization: Bearer {token}
    ※新規に生成されたトークンの有効期間は 1 年間です。
  • 機能:指定した URL に結果を送信します。成功した場合は追跡番号が返されます。失敗した場合はエラー理由が返されます。
  • URL:ユーザーが定義します。
  • リクエスト方式:POST
  • データ形式:JSONテキスト
  • リクエストデータ構造:
  • {
      "result":1,(1:成功;0:失敗)
      "data":{
               "client_key":"○○○○",       
               "channel_id":"○○○○",
               "customer_number":"○○○○",
               "tracking_number":"○○○○"(成功)
               "error_message":"○○○○"(失敗)
            }
    }

  • 機能:1件または複数の送り状データを取得します。1回のリクエストで送信できる最大件数は500件です。500件を超えると送信に失敗します。
  • URL:https://webapi.umtec.jp/miandan/api/get_status?client_key={client_key}&t={t}
  • client_key:認証キーについては「認証キーのセクション」をご参照ください。
  • t:配送タイプ(佐川の場合:sagawa ヤマトの場合:yamato)
  • headers:Authorization: Bearer {token}'
  • リクエスト方式:POST
  • データ形式:JSONテキスト
  • リクエスト制限: 1秒あたり最大2リクエスト。制限を超えるリクエストは拒否され、HTTP 429 エラーが返されます。
  • リクエストデータ構造:
  • [
      "customer_number1",
      "customer_number2",
      "customer_number3",
      ...
    ]
  • レスポンスデータ構造:
  • {
      "result":1,(1:成功;0:失敗)
      "message":"some message",
      "data":
      [
          {"customer_number":"〇","tracking_number":"〇","status":"〇","error_message":"〇"},
          {"customer_number":"〇","tracking_number":"〇","status":"〇","error_message":"〇"},
          {"customer_number":"〇","tracking_number":"〇","status":"〇","error_message":"〇"},
          ...
      ]
    }
    
    status:
      1: 新規 
      2: 作成中 
      3: 完成 
      4: 失敗 
      5: 再作成                                            

    以下のURLから直接PDFを取得できます。
    https://shippsys-files.umtec.jp/{client_key}/{service_type}/pdfs4print/{customer_number}.pdf

  • client_key:認証キーについては「認証キーのセクション」をご参照ください。
  • service_type:配送タイプ(佐川の場合:sagawa ヤマトの場合:yamato)
  • customer_number:お客様管理番号
  • 機能:運賃情報を取得します。一度に送信できるエントリーの最大数は500件です。
  • URL:https://webapi.umtec.jp/miandan/api/get_billing_info?client_key={client_key}
  • client_key:認証キーについては「認証キーのセクション」をご参照ください。
  • headers:Authorization: Bearer {token}
  • リクエスト方式:POST
  • データ形式:JSONテキスト
  • リクエスト制限: 1秒あたり最大2リクエスト。制限を超えるリクエストは拒否され、HTTP 429 エラーが返されます。
  • リクエストデータ構造:
  • [
      "customer_number",
      "customer_number",
      "customer_number",
      ...
    ]
  • レスポンスデータ構造:
  • {
      "result":1,(1:成功;0:失敗)
      "message":"some message",
      "data":
      [
          {"customer_number":"〇","tracking_number":"〇","billing_fee_total":"〇"},
          {"customer_number":"〇","tracking_number":"〇","billing_fee_total":"〇"},
          {"customer_number":"〇","tracking_number":"〇","billing_fee_total":"〇"},
          ...
      ]
    }                                            

  • 機能:輸送状況を取得します。
  • URL:https://webapi.umtec.jp/miandan/api/get_delivery_status?client_key={client_key}
  • client_key:認証キーについては「認証キーのセクション」をご参照ください。
  • headers:Authorization: Bearer {token}
  • リクエスト方式:POST
  • データ形式:JSONテキスト
  • リクエスト制限: 1秒あたり最大2リクエスト。制限を超えるリクエストは拒否され、HTTP 429 エラーが返されます。
  • リクエストデータ構造:
  • {"no":"〇〇〇〇〇〇", "t":"〇〇〇〇"}
  • no:追跡番号
  • t:配送タイプ(佐川の場合:sagawa ヤマトの場合:yamato)
  • レスポンスデータ構造:
  • {"status":"〇〇〇〇〇"}

    開発ドキュメント

  • 機能:複数のデータをアップロードできます。1回のリクエストで送信できるエントリーの最大数は200件です。
  • URL:https://webapi.umtec.jp/miandan/api/put_sagawa?client_key={client_key}
  • client_key:認証キーについては「認証キーのセクション」をご参照ください。
  • headers:Authorization: Bearer {token}
  • リクエスト方式:POST
  • データ形式:JSONテキスト
  • リクエスト制限: 1秒あたり最大2リクエスト。制限を超えるリクエストは拒否され、HTTP 429 エラーが返されます。
  • リクエストデータ構造:
  • [
        {"deli_code_type":"〇","deli_code":"〇","deli_phone":"〇","deli_postcode":"〇","deli_address1":"〇",...},
        {"deli_code_type":"〇","deli_code":"〇","deli_phone":"〇","deli_postcode":"〇","deli_address1":"〇",...},
        ...
    ]
    
    ※空欄のフィールドは設定不要です。
  • データフィールド参照:
  • システムフィールド (必須)
  • フィールド1:channel_id 説明:チャンネルID 参考設定ページ
  • フィールド2:warehouse_id 説明:倉庫ID 参考設定ページ

  • フィールド一覧
  • フィールド1:deli_code_type 説明:お届け先コード取得区分
  • フィールド2:deli_code 説明:お届け先コード
  • フィールド3:deli_phone 説明:お届け先電話番号
  • 半角数字
    "-"ハイフン
  • フィールド4:deli_postcode 説明:お届け先郵便番号
  • 半角数字
    "-"ハイフン
  • フィールド5:deli_address1 説明:お届け先住所1
  • ※特記事項:
    実際の運用では、すべての住所情報をこのフィールドにまとめることができます。この場合、deli_address2 と deli_address3 は空でも構いません。
    
  • フィールド6:deli_address2 説明:お届け先住所2
  • フィールド7:deli_address3 説明:お届け先住所3
  • フィールド8:deli_name1 説明:お届け先名称1
  • フィールド9:deli_name2 説明:お届け先名称2
  • フィールド10:customer_number 説明:お客様管理番号
  • ※特記事項:
    このフィールドはユニックである必要があります。このフィールドはクエリ時に使用されます。
    このフィールドの最大長は 16 文字で、数字、大文字と小文字、-、_のみをサポートします。
    ※※ 
    この項目を送り状に直接表示させる必要がない場合は、システムIDを佐川の送り状の「customer_number」として設定することも可能です。その場合、この項目には最大32文字まで設定できます。
  • フィールド11:customer_code 説明:お客様コード
  • フィールド12:dept_code_type 説明:部署ご担当者コード取得区分
  • フィールド13:dept_code 説明:部署ご担当者コード
  • フィールド14:dept_name 説明:部署ご担当者名称
  • フィールド15:sender_phone 説明:荷送人電話番号
  • 半角数字
    "-"ハイフン
  • フィールド16:requester_code_type 説明:ご依頼主コード取得区分
  • フィールド17:requester_code 説明:ご依頼主コード
  • フィールド18:requester_phone 説明:ご依頼主電話番号
  • 半角数字
    "-"ハイフン
  • フィールド19:requester_postcode 説明:ご依頼主郵便番号
  • 半角数字
    "-"ハイフン
  • フィールド20:requester_address1 説明:ご依頼主住所1
  • フィールド21:requester_address2 説明:ご依頼主住所2
  • フィールド22:requester_name1 説明:ご依頼主名称1
  • フィールド23:requester_name2 説明:ご依頼主名称2
  • フィールド24:package_type 説明:荷姿
  • 001 :箱類
    002 :バッグ類
    003 :スーツケース
    004 :封筒類
    005 :ゴルフバッグ
    006 :スキー
    007 :スノーボード
    008 :その他
  • フィールド25:product_name1 説明:品名1
  • フィールド26:product_name2 説明:品名2
  • フィールド27:product_name3 説明:品名3
  • フィールド28:product_name4 説明:品名4
  • フィールド29:product_name5 説明:品名5
  • フィールド30:label_package_type 説明:荷札荷姿
  • 001 :箱類
    002 :バッグ類
    003 :スーツケース
    004 :封筒類
    005 :ゴルフバッグ
    006 :スキー
    007 :スノーボード
    008 :その他
  • フィールド31:label_name1 説明:荷札品名1
  • フィールド32:label_name2 説明:荷札品名2
  • フィールド33:label_name3 説明:荷札品名3
  • フィールド34:label_name4 説明:荷札品名4
  • フィールド35:label_name5 説明:荷札品名5
  • フィールド36:label_name6 説明:荷札品名6
  • フィールド37:label_name7 説明:荷札品名7
  • フィールド38:label_name8 説明:荷札品名8
  • フィールド39:label_name9 説明:荷札品名9
  • フィールド40:label_name10 説明:荷札品名10
  • フィールド41:label_name11 説明:荷札品名11
  • フィールド42:shipping_qty 説明:出荷個数
  • フィールド43:delivery_speed 説明:スピード指定
  • 000 :飛脚宅配便
    003 :飛脚航空便(翌日中配達)
    004 :飛脚航空便(翌日午前中配達)
    005 :飛脚ジャストタイム便
  • フィールド44:cool_service_type 説明:クール便指定
  • 001:指定なし 
    002:飛脚クール便(冷蔵) 
    003:飛脚クール便(冷凍)
  • フィールド45:delivery_date 説明:配達日
  • YYYYMMDDフォーマットに変換
  • フィールド46:delivery_time_slot 説明:配達指定時間帯
  • 01 : 午前中
    12 : 12:00~14:00
    14 : 14:00~16:00
    16 : 16:00~18:00
    18 : 18:00~20:00
    04 : 18:00~21:00
    19 : 19:00~21:00
  • フィールド47:delivery_time_hour_minute 説明:配達指定時間(時分
  • フィールド48:cod_amount 説明:代引金額
  • フィールド49:tax_amount 説明:消費税
  • フィールド50:payment_type 説明:決済種別
  • フィールド51:insurance_amount 説明:保険金額
  • フィールド52:sticker1 説明:指定シール1
  • 001 :飛脚クール便(冷蔵)
    002 :飛脚クール便(冷凍)
    004 :営業所受取サービス
    005 :指定日配達サービス
    008 :eコレクト(現金)
    009 :eコレクト(デビット/クレジット)
    010 :eコレクト(全て可能)
    011 :取扱注意
    012 :貴重品
    013 :天地無用
    017 :飛脚航空便
    018 :飛脚ジャストタイム便
    020 :時間帯指定サービス(午前中) 021 :時間帯指定サービス(18時~21時)
    022 :時間帯指定サービス(12時~14時)
    023 :時間帯指定サービス(14時~16時)
    024 :時間帯指定サービス(16時~18時)
    025 :時間帯指定サービス(18時~20時)
    026 :時間帯指定サービス(19時~21時)
  • フィールド53:sticker2 説明:指定シール2
  • フィールド54:sticker3 説明:指定シール3
  • フィールド55:store_pickup 説明:営業店受取
  • 0 :通常出荷
    1 :営業所受取
  • フィールド56:src_type 説明:SRC区分
  • フィールド57:pickup_store_code 説明:営業所受取営業所コード
  • フィールド58:origin_dest_type 説明:元着区分
  • 1 :元払
    2 :着払
  • フィールド59:email 説明:メールアドレス
  • フィールド60:unavailable_contact 説明:ご不在時連絡先
  • フィールド61:shipping_date 説明:出荷日
  • フィールド62:inquiry_number 説明:お問い合せ送り状No.
  • フィールド63:print_place_type 説明:出荷場印字区分
  • フィールド64:unbundle_specification 説明:集約解除指定
  • フィールド65:edit1 説明:編集1
  • フィールド66:edit2 説明:編集2
  • フィールド67:edit3 説明:編集3
  • フィールド68:edit4 説明:編集4
  • フィールド69:edit5 説明:編集5
  • フィールド70:edit6 説明:編集6
  • フィールド71:edit7 説明:編集7
  • フィールド72:edit8 説明:編集8
  • フィールド73:edit9 説明:編集9
  • フィールド74:edit10 説明:編集10

  • ※詳細については、下記の公式ドキュメントもご参照ください。
    佐川の公式ドキュメント
  • レスポンスデータ構造:
  • {
        "result":1,(1:成功;0:失敗;2:一部分失敗)
        "message":"some message",
    }

    Webhook機能を使用することを強くお勧めします。
  • 機能:送り状データを更新できます。一度に送信できるエントリーの最大数は200件です。
  • URL:https://webapi.umtec.jp/miandan/api/update_sagawa?client_key={client_key}
  • client_key:認証キーについては「認証キーのセクション」をご参照ください。
  • headers:Authorization: Bearer {token}
  • リクエスト方式:POST
  • データ形式:JSONテキスト
  • リクエスト制限: 1秒あたり最大2リクエスト。制限を超えるリクエストは拒否され、HTTP 429 エラーが返されます。
  • リクエストデータ構造:
  • [
      {"deli_code_type":"〇","deli_code":"〇","deli_phone":"〇","deli_postcode":"〇","deli_address1":"〇",...},
      {"deli_code_type":"〇","deli_code":"〇","deli_phone":"〇","deli_postcode":"〇","deli_address1":"〇",...},
      ...
    ]
    ※空欄のフィールドは設定不要です。
  • データフィールド参照:
  • システムフィールド (必須)
  • フィールド1:channel_id 説明:チャンネルID 参考設定ページ
  • フィールド2:warehouse_id 説明:倉庫ID 参考設定ページ

  • フィールド一覧
  • フィールド1:deli_code_type 説明:お届け先コード取得区分
  • フィールド2:deli_code 説明:お届け先コード
  • フィールド3:deli_phone 説明:お届け先電話番号
  • 半角数字 "-"ハイフン
  • フィールド4:deli_postcode 説明:お届け先郵便番号
  • 半角数字 "-"ハイフン
  • フィールド5:deli_address1 説明:お届け先住所1
  • ※特記事項:
    実際の運用では、すべての住所情報をこのフィールドにまとめることができます。この場合、deli_address2 と deli_address3 は空でも構いません。
    
  • フィールド6:deli_address2 説明:お届け先住所2
  • フィールド7:deli_address3 説明:お届け先住所3
  • フィールド8:deli_name1 説明:お届け先名称1
  • フィールド9:deli_name2 説明:お届け先名称2
  • フィールド10:customer_number 説明:お客様管理番号
  • システムは、このフィールドの値をもとに対応する既存のレコードを検索し、該当レコードが存在する場合に更新を実行します。該当レコードが見つからない場合は、エラーを返します。
  • フィールド11:customer_code 説明:お客様コード
  • フィールド12:dept_code_type 説明:部署ご担当者コード取得区分
  • フィールド13:dept_code 説明:部署ご担当者コード
  • フィールド14:dept_name 説明:部署ご担当者名称
  • フィールド15:sender_phone 説明:荷送人電話番号
  • 半角数字 "-"ハイフン
  • フィールド16:requester_code_type 説明:ご依頼主コード取得区分
  • フィールド17:requester_code 説明:ご依頼主コード
  • フィールド18:requester_phone 説明:ご依頼主電話番号
  • 半角数字 "-"ハイフン
  • フィールド19:requester_postcode 説明:ご依頼主郵便番号
  • 半角数字 "-"ハイフン
  • フィールド20:requester_address1 説明:ご依頼主住所1
  • フィールド21:requester_address2 説明:ご依頼主住所2
  • フィールド22:requester_name1 説明:ご依頼主名称1
  • フィールド23:requester_name2 説明:ご依頼主名称2
  • フィールド24:package_type 説明:荷姿
  • 001 :箱類 
    002 :バッグ類 
    003 :スーツケース 
    004 :封筒類 
    005 :ゴルフバッグ 
    006 :スキー 
    007 :スノーボード 
    008 :その他
  • フィールド25:product_name1 説明:品名1
  • フィールド26:product_name2 説明:品名2
  • フィールド27:product_name3 説明:品名3
  • フィールド28:product_name4 説明:品名4
  • フィールド29:product_name5 説明:品名5
  • フィールド30:label_package_type 説明:荷札荷姿
  • 001 :箱類 
    002 :バッグ類 
    003 :スーツケース 
    004 :封筒類 
    005 :ゴルフバッグ 
    006 :スキー 
    007 :スノーボード 
    008 :その他
  • フィールド31:label_name1 説明:荷札品名1
  • フィールド32:label_name2 説明:荷札品名2
  • フィールド33:label_name3 説明:荷札品名3
  • フィールド34:label_name4 説明:荷札品名4
  • フィールド35:label_name5 説明:荷札品名5
  • フィールド36:label_name6 説明:荷札品名6
  • フィールド37:label_name7 説明:荷札品名7
  • フィールド38:label_name8 説明:荷札品名8
  • フィールド39:label_name9 説明:荷札品名9
  • フィールド40:label_name10 説明:荷札品名10
  • フィールド41:label_name11 説明:荷札品名11
  • フィールド42:shipping_qty 説明:出荷個数
  • フィールド43:delivery_speed 説明:スピード指定
  • 000 :飛脚宅配便 
    003 :飛脚航空便(翌日中配達) 
    004 :飛脚航空便(翌日午前中配達) 
    005 :飛脚ジャストタイム便
  • フィールド44:cool_service_type 説明:クール便指定
  • フィールド45:delivery_date 説明:配達日
  • YYYYMMDDフォーマットに変換
  • フィールド46:delivery_time_slot 説明:配達指定時間帯
  • 01 : 午前中 
    12 : 12:00~14:00 
    14 : 14:00~16:00 
    16 : 16:00~18:00 
    18 : 18:00~20:00 
    04 : 18:00~21:00 
    19 : 19:00~21:00
  • フィールド47:delivery_time_hour_minute 説明:配達指定時間(時分)
  • フィールド48:cod_amount 説明:代引金額
  • フィールド49:tax_amount 説明:消費税
  • フィールド50:payment_type 説明:決済種別
  • フィールド51:insurance_amount 説明:保険金額
  • フィールド52:sticker1 説明:指定シール1
  • 001 :飛脚クール便(冷蔵) 
    002 :飛脚クール便(冷凍) 
    004 :営業所受取サービス 
    005 :指定日配達サービス 
    008 :eコレクト(現金) 
    009 :eコレクト(デビット/クレジット) 
    010 :eコレクト(全て可能) 
    011 :取扱注意 
    012 :貴重品 
    013 :天地無用 
    017 :飛脚航空便 
    018 :飛脚ジャストタイム便 
    020 :時間帯指定サービス(午前中) 
    021 :時間帯指定サービス(18時~21時) 
    022 :時間帯指定サービス(12時~14時) 
    023 :時間帯指定サービス(14時~16時) 
    24 :時間帯指定サービス(16時~18時) 
    025 :時間帯指定サービス(18時~20時) 
    026 :時間帯指定サービス(19時~21時)
  • フィールド53:sticker2 説明:指定シール2
  • フィールド54:sticker3 説明:指定シール3
  • フィールド55:store_pickup 説明:営業店受取
  • 0 :通常出荷 1 :営業所受取
  • フィールド56:src_type 説明:SRC区分
  • フィールド57:pickup_store_code 説明:営業所受取営業所コード
  • フィールド58:origin_dest_type 説明:元着区分
  • 1 :元払 2 :着払
  • フィールド59:email 説明:メールアドレス
  • フィールド60:unavailable_contact 説明:ご不在時連絡先
  • フィールド61:shipping_date 説明:出荷日
  • フィールド62:inquiry_number 説明:お問い合せ送り状No.
  • フィールド63:print_place_type 説明:出荷場印字区分
  • フィールド64:unbundle_specification 説明:集約解除指定
  • フィールド65:edit1 説明:編集1
  • フィールド66:edit2 説明:編集2
  • フィールド67:edit3 説明:編集3
  • フィールド68:edit4 説明:編集4
  • フィールド69:edit5 説明:編集5
  • フィールド70:edit6 説明:編集6
  • フィールド71:edit7 説明:編集7
  • フィールド72:edit8 説明:編集8
  • フィールド73:edit9 説明:編集9
  • フィールド74:edit10 説明:編集10

  • ※詳細については、下記の公式ドキュメントもご参照ください。佐川の公式ドキュメント
  • レスポンスデータ構造:
  • {
      "result":1,(1:成功;0:失敗;2:一部分失敗)
      "message":"some message",
    }

    送り状データをアップ(PHP)

    
    <?php
    $token = '************';
    $client_key = '*******************';
    $data = [
        [
            "channel_id " => 1,
            "warehouse_id" => 1,
            "deli_phone" => "0123456789",
            "deli_postcode" => "123-4567",
            "deli_address1" => "千葉県○○市○○○○",
            "deli_name1" => "○○○株式会社",
            "customer_number" => "AA000001"
            //...
        ],
        [
            "channel_id " => 1,
            "warehouse_id" => 2,
            "deli_phone" => "9876543210",
            "deli_postcode" => "765-4321",
            "deli_address1" => "大阪市中央区",
            "deli_name1" => "○○○株式会社",
            "customer_number" => "AA000002"
            //....
        ]
    ];
    
    $jsonData = json_encode($data);
    
    $url = 'https://webapi.umtec.jp/miandan/api/put_sagawa?client_key='.$client_key;
    
    $headers = [
        'Content-Type: application/json',
        "Authorization: Bearer {$token}"
    ];
    
    $ch = curl_init($url);
    
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
    
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    
    $response = curl_exec($ch);
    
    if (curl_errno($ch)) {
        echo 'cURL Error: ' . curl_error($ch);
    } else {
        echo 'Response: ' . $response;
    
        $info = curl_getinfo($ch);
        echo 'HTTP Code: ' . $info['http_code'];
        echo 'Total Time: ' . $info['total_time'];
    }
    
    curl_close($ch);
    ?>
          

    追跡番号を取得(PHP)

    
    <?php
    $token = '************';
    $client_key = '*******************';
    $data = [
        "10000001",
        "10000002",
        "10000003",
    ];
    
    $jsonData = json_encode($data);
    
    $url = 'https://webapi.umtec.jp/miandan/api/get_sagawa?client_key='.$client_key;
    
    $headers = [
        'Content-Type: application/json',
        "Authorization: Bearer {$token}"
    ];
    
    $ch = curl_init($url);
    
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
    
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    
    $response = curl_exec($ch);
    
    if (curl_errno($ch)) {
        echo 'cURL Error: ' . curl_error($ch);
    } else {
        echo 'Response: ' . $response;
    
        $info = curl_getinfo($ch);
        echo 'HTTP Code: ' . $info['http_code'];
        echo 'Total Time: ' . $info['total_time'];
    }
    
    curl_close($ch);
    ?>
    

    送り状データをアップ(Java)

    
    import java.io.OutputStream;
    import java.net.HttpURLConnection;
    import java.net.URL;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.HashMap;
    import com.fasterxml.jackson.databind.ObjectMapper;
    
    public class HttpRequestExample {
    
        public static void main(String[] args) {
            try {
                String token = "************";
                String clientKey = "*******************";
    
                List<HashMap<String, Object>> data = new ArrayList<>();
                HashMap<String, Object> entry1 = new HashMap<>();
                entry1.put("channel_id", 1);
                entry1.put("warehouse_id", 1);
                entry1.put("deli_phone", "0123456789");
                entry1.put("deli_postcode", "123-4567");
                entry1.put("deli_address1", "千葉県○○市○○○○");
                entry1.put("deli_name1", "○○○株式会社");
                entry1.put("customer_number", "AA000001");
    
                HashMap<String, Object> entry2 = new HashMap<>();
                entry2.put("channel_id", 1);
                entry2.put("warehouse_id", 2);
                entry2.put("deli_phone", "9876543210");
                entry2.put("deli_postcode", "765-4321");
                entry2.put("deli_address1", "大阪市中央区");
                entry2.put("deli_name1", "○○○株式会社");
                entry2.put("customer_number", "AA000002");
    
                data.add(entry1);
                data.add(entry2);
    
                ObjectMapper objectMapper = new ObjectMapper();
                String jsonData = objectMapper.writeValueAsString(data);
    
                String urlString = "https://webapi.umtec.jp/miandan/api/put_sagawa?client_key=" + clientKey;
                URL url = new URL(urlString);
    
                // 初始化 HttpURLConnection
                HttpURLConnection conn = (HttpURLConnection) url.openConnection();
                conn.setRequestMethod("POST");
                conn.setRequestProperty("Content-Type", "application/json");
                conn.setRequestProperty("Authorization", "Bearer " + token);
                conn.setDoOutput(true);
    
                OutputStream os = conn.getOutputStream();
                os.write(jsonData.getBytes());
                os.flush();
                os.close();
    
                int responseCode = conn.getResponseCode();
                System.out.println("HTTP Code: " + responseCode);
                if (responseCode == HttpURLConnection.HTTP_OK) {
                    System.out.println("Response: " + conn.getResponseMessage());
                } else {
                    System.out.println("Error: " + conn.getResponseMessage());
                }
    
                conn.disconnect();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
    

    送り状データをアップ(Python)

    
    import requests
    import json
    
    token = '************'
    client_key = '*******************'
    data = [
        {
            "channel_id": 1,
            "warehouse_id": 1,
            "deli_phone": "0123456789",
            "deli_postcode": "123-4567",
            "deli_address1": "千葉県○○市○○○○",
            "deli_name1": "○○○株式会社",
            "customer_number": "AA000001"
            # ...
        },
        {
            "channel_id": 1,
            "warehouse_id": 2,
            "deli_phone": "9876543210",
            "deli_postcode": "765-4321",
            "deli_address1": "大阪市中央区",
            "deli_name1": "○○○株式会社",
            "customer_number": "AA000002"
            # ...
        }
        # ...
    ]
    
    json_data = json.dumps(data)
    
    url = f'https://webapi.umtec.jp/miandan/api/put_sagawa?client_key={client_key}'
    
    headers = {
        'Content-Type': 'application/json',
        f'Authorization': f'Bearer {token}'
    }
    
    response = requests.post(url, headers=headers, data=json_data)
    
    if response.status_code == 200:
        print('Response:', response.text)
    else:
        print(f'Error: {response.status_code}, {response.text}')
    
    

    送り状データをアップ(Node.js)

    
    const axios = require('axios');
    
    const token = '************';
    const clientKey = '*******************';
    
    const data = [
      {
        channel_id: 1,
        warehouse_id: 1,
        deli_phone: '0123456789',
        deli_postcode: '123-4567',
        deli_address1: '千葉県○○市○○○○',
        deli_name1: '○○○株式会社',
        customer_number: 'AA000001'
      },
      {
        channel_id: 1,
        warehouse_id: 2,
        deli_phone: '9876543210',
        deli_postcode: '765-4321',
        deli_address1: '大阪市中央区',
        deli_name1: '○○○株式会社',
        customer_number: 'AA000002'
      }
    ];
    
    const urlString = `https://webapi.umtec.jp/miandan/api/put_sagawa?client_key=${clientKey}`;
    
    axios.post(urlString, data, {
      headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${token}`
      }
    })
    .then(response => {
      console.log(`HTTP Code: ${response.status}`);
      console.log('Response:', response.data);
    })
    .catch(error => {
      console.error('Error:', error.response ? error.response.data : error.message);
    });
    
    
    

    開発ドキュメント

  • 機能:複数のデータをアップロードできます。1回のリクエストで送信できるエントリーの最大数は200件です。
  • URL:https://webapi.umtec.jp/miandan/api/put_yamato?client_key={client_key}
  • client_key:認証キーについては「認証キーのセクション」をご参照ください。
  • headers:Authorization: Bearer {token}
  • リクエスト方式:POST
  • データ形式:JSONテキスト
  • リクエスト制限: 1秒あたり最大2リクエスト。制限を超えるリクエストは拒否され、HTTP 429 エラーが返されます。
  • リクエストデータ構造:
  • [
        {"channel_id":"〇","warehouse_id":"〇","customer_number":"〇","deli_postcode":"〇",...},
        {"channel_id":"〇","warehouse_id":"〇","customer_number":"〇","deli_postcode":"〇",...},
        ...
    ]
    
    ※空欄のフィールドは設定不要です。
  • データフィールド参照:
  • システムフィールド (必須)
  • フィールド1:channel_id 説明:チャンネルID 参考設定ページ
  • フィールド2:warehouse_id 説明:倉庫ID 参考設定ページ

  • フィールド一覧
  • フィールド1:customer_number
  • お客様管理番号
    必須
    半角英数字-_計22文字
    ※特記事項:
    このフィールドはユニックである必要があります。このフィールドはクエリ時に使用されます。
    ※※ 
    この項目を送り状に直接表示させる必要がない場合は、システムIDを佐川の送り状の「customer_number」として設定することも可能です。その場合、この項目には最大32文字まで設定できます。
    
  • フィールド2:invoice_type
  • 送り状種類
    必須                                                    
    半角数字1文字
    0 : 発払い
    2 : コレクト
    3 : クロネコゆうメール
    4 : タイム
    5 : 着払い
    6 : 発払い(複数口)
    7 : ネコポス・クロネコゆうパケット
    8 : 宅急便コンパクト
    9 : 宅急便コンパクトコレクト
    A : ネコポス(1月末にてサービス終了)
    
    (※宅急便_必須項目)
    (※クロネコゆうメール_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド3:cool_classification
  • クール区分
    半角数字1文字
    0または空白 : 通常
    1 : クール冷凍
    2 : クール冷蔵
    ※「0:発払い」、「2:コレクト」、「5:着払い」のみ、ご利用頂けます。
    上記以外の送り状の場合、空白扱いで取り込みます。
  • フィールド4:invoice_number
  • 伝票番号
    半角数字12文字
    ※B2クラウドにて付与
  • フィールド5:shipment_scheduled_date
  • 出荷予定日
    設定されていない場合は当日になる。 
    半角10文字
    「YYYY/MM/DD」で入力してください。
    (※宅急便_必須項目)
    (※クロネコゆうメール_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド6:deli_scheduled_date
  • お届け予定日
    半角10文字
    「YYYY/MM/DD」で入力してください。
    ※入力なしの場合、印字されません。
    ※「最短日」と入力可
  • フィールド7:deli_time_zone
  • 配達時間帯
    半角4文字
    発払・コレクト・着払・宅急便コンパクト・宅急便コンパクトコレクト・発払(複数口) の場合
     空白 : 指定なし
     0812 : 午前中
     1416 : 14~16時
     1618 : 16~18時
     1820 : 18~20時
     1921 : 19~21時
    タイム
     0010 : 午前10時まで
     0017 : 午後5時まで
  • フィールド8:deli_code
  • お届け先コード
    半角英数字20文字
  • フィールド9:deli_phone_number
  • お届け先電話番号
    必須
    半角数字15文字ハイフン含む
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド10:deli_phone_number_branch
  • お届け先電話番号枝番
    半角数字2文字
  • フィールド11:deli_postal_code 説明:お届け先郵便番号
  • お届け先郵便番号
    必須
    半角数字8文字
    ハイフンなし7文字も可
    (※宅急便_必須項目)
    (※クロネコゆうメール_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド12:deli_address
  • お届け先住所
    必須
    全角/半角
    都道府県(4文字)
    市区郡町村(12文字)
    町・番地(16文字)
    (※宅急便_必須項目)
    (※クロネコゆうメール_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド13:deli_apartment_name
  • お届け先アパートマンション名
    全角/半角 
    16文字/32文字 
  • フィールド14:deli_company_department1
  • お届け先会社・部門1
    全角/半角
    25文字/50文字 
  • フィールド15:deli_company_department2
  • お届け先会社・部門2
    全角/半角 
    25文字/50文字 
  • フィールド16:deli_name
  • お届け先名
    必須
    全角/半角
    16文字/32文字 
    (※宅急便_必須項目)
    (※クロネコゆうメール_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド17:deli_name_kana
  • お届け先名(カナ)
    半角カタカナ 50文字 
  • フィールド18:honorifics
  • 敬称
    全角/半角 2文字/4文字
    クロネコゆうメールの場合に指定可能
    【入力例】
    様・御中・殿・行・係・宛・先生・なし
  • フィールド19:requester_code
  • ご依頼主コード
    半角英数字 20文字 
  • フィールド20:requester_phone_number
  • ご依頼主電話番号
    必須
    半角数字15文字ハイフン含む
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド21:requester_phone_number_branch
  • ご依頼主電話番号枝番
    半角数字 2文字 
  • フィールド22:requester_postal_code
  • ご依頼主郵便番号
    必須
    半角数字8文字
    ハイフンなし半角7文字も可 
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド23:requester_address
  • ご依頼主住所
    必須
    全角/半角32文字/64文字
    都道府県(4文字)
    市区郡町村(12文字)
    町・番地(16文字)
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド24:requester_apartment
  • ご依頼主アパートマンション
    全角/半角 16文字/32文字 
  • フィールド25:requester_name 説明:ご依頼主名
  • ご依頼主名
    必須
    全角/半角 16文字/32文字 
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド26:requester_name_kana
  • ご依頼主名(カナ)
    半角カタカナ 50文字
  • フィールド27:product_code1
  • 品名コード1
    半角英数字 30文字 
  • フィールド28:product_name1
  • 品名1
    必須
    全角/半角 25文字/50文字 
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド29:product_code2
  • 品名コード2
    半角英数字 30文字
  • フィールド30:product_name2
  •  品名2
  • フィールド31:handling1
  • 荷扱い1
    全角/半角 10文字/20文字 
  • フィールド32:handling2
  • 荷扱い2
    全角/半角 10文字/20文字  
  • フィールド33:article
  • 記事
    このフィールドはシステムによってすでに占有されているため、使用しないでください。
    全角/半角 22文字/44文字 
  • フィールド34:collect_amount_incl_tax
  • コレクト代金引換額(税込)
    半角数字 7文字
    ※コレクトの場合は必須
    300,000円以下 1円以上
    ※但し、宅急便コンパクトコレクトの場合は
    30,000円以下  1円以上
  • フィールド35:internal_tax_amount
  • 内消費税額等
    半角数字 7文字
    ※コレクトの場合は必須 
    ※コレクト代金引換額(税込)以下
  • フィールド36:detention
  • 止置き
    半角数字 1文字
    0 : 利用しない
    1 : 利用する 
  • フィールド37:office_code
  • 営業所コード
    半角数字 6文字
    ※止置きを利用する場合は必須 
  • フィールド38:number_of_issues
  • 発行枚数
    半角数字 2文字
    ※発払い・タイム・着払い、ネコポス・クロネコゆうパケット・発払い(複数口)のみ指定可能
  • フィールド39:count_flag
  • 個数口表示フラグ
    默认为1
    半角数字 1文字
    1 : 印字する
    2 : 印字しない 
    3 : 枠と口数を印字する
    ※宅急便コンパクト、宅急便コンパクトコレクトは対象外
    ※複数口の場合、本項目の指定に関係なく、3 : 枠と口数を印字する扱いとする
  • フィールド40:customer_code_billing
  • 請求先顧客コード
    設定がない場合はシステム設定の値が自動取得されます。
    半角数字10~12文字
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド41:billing_classification_code
  • 請求先分類コード
    設定がない場合はシステム設定の値が自動取得されます。
    空白または半角数字3文字
    
  • フィールド42:fare_management_number
  • 運賃管理番号
    設定がない場合はシステム設定の値が自動取得されます。
    半角数字2文字
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド43:yamato_web_collect_data_registration
  • クロネコwebコレクトデータ登録
    半角数字 1文字
    0 : 無し
    1 : 有り 
  • フィールド44:yamato_web_collect_store_number
  • クロネコwebコレクト加盟店番号
    半角英数字 9文字 
    ※クロネコwebコレクトデータ有りの場合は必須 
  • フィールド45:yamato_web_collect_application_number1
  • クロネコwebコレクト申込受付番号1
    半角英数字 23文字
    ※クロネコwebコレクトデータ有りの場合は必須 
  • フィールド46:yamato_web_collect_application_number2
  • クロネコwebコレクト申込受付番号2
    半角英数字 23文字
    ※発払い(複数口)の場合は、設定不可
  • フィールド47:yamato_web_collect_application_number3
  • クロネコwebコレクト申込受付番号3
    半角英数字 23文字
    ※発払い(複数口)の場合は、設定不可
  • フィールド48:scheduled_deli_email_usage_type
  • お届け予定eメール利用区分
    半角数字 1文字
    0 : 利用しない
    1 : 利用する 
  • フィールド49:scheduled_deli_email_address
  • お届け予定eメールe-mailアドレス
    半角英数字&記号 60文字
    ※お届け予定eメールを利用する場合は必須 
  • フィールド50:scheduled_deli_email_message
  • お届け予定eメールメッセージ
    全角 74文字
    ※お届け予定eメールを利用する場合は必須
  • フィールド51:completed_deli_email_usage_type
  • お届け完了eメール利用区分
    半角数字 1文字
    0 : 利用しない
    1 : 利用する 
  • フィールド52:completed_deli_email_address
  • お届け完了eメールe-mailアドレス
    半角英数字 60文字
    ※お届け完了eメールを利用する場合は必須 
  • フィールド53:completed_deli_email_message
  • お届け完了eメールメッセージ
    全角 159文字 
    ※お届け完了eメールを利用する場合は必須 
  • フィールド54:yamato_collection_agency_usage_type
  • クロネコ収納代行利用区分
    半角数字1文字
    0 : 利用しない
    1 : 利用する 
  • フィールド55:spare1
  • 予備
    半角数字1文字
  • フィールド56:collection_agency_billing_amount
  • 収納代行請求金額(税込)
    半角数字7文字
  • フィールド57:collection_agency_internal_tax_amount
  • 収納代行内消費税額等
    半角数字7文字
  • フィールド58:collection_agency_billing_postal_code
  • 収納代行請求先郵便番号
    半角数字&ハイフン8文字
    ハイフンなし半角7文字も可 
  • フィールド59:collection_agency_billing_address
  • 収納代行請求先住所
    全角/半角 32文字/64文字
    都道府県(4文字)
    市区郡町村(12文字)
    町・番地(16文字)"
  • フィールド60:collection_agency_billing_apartment_name
  • 収納代行請求先住所(アパートマンション名)
    全角/半角 16文字/32文字
  • フィールド61:collection_agency_billing_company_department1
  • 収納代行請求先会社・部門名1
    全角/半角 25文字/50文字
  • フィールド62:collection_agency_billing_company_department2
  • 収納代行請求先会社・部門名2
    全角/半角 25文字/50文字
  • フィールド63:collection_agency_billing_name_kanji
  • 収納代行請求先名(漢字)
    全角/半角 16文字/32文字
  • フィールド64:collection_agency_billing_name_kana
  • 収納代行請求先名(カナ)
    半角カタカナ50文字
  • フィールド65:collection_agency_inquiry_name_kanji
  • 収納代行問合せ先名(漢字)
    全角/半角 16文字/32文字
  • フィールド66:collection_agency_inquiry_postal_code
  • 収納代行問合せ先郵便番号
    半角数字&ハイフン8文字
    ハイフンなし半角7文字も可 
  • フィールド67:collection_agency_inquiry_address
  • 収納代行問合せ先住所
    全角/半角 32文字/64文字
    都道府県(4文字)
    市区郡町村(12文字)
    町・番地(16文字)
  • フィールド68:collection_agency_inquiry_apartment_name
  • 収納代行問合せ先住所(アパートマンション名)
    全角/半角 16文字/32文字
  • フィールド69:collection_agency_inquiry_phone_number
  • 収納代行問合せ先電話番号
    半角数字&ハイフン15文字
  • フィールド70:collection_agency_management_number
  • 収納代行管理番号
    半角英数字20文字
  • フィールド71:collection_agency_product_name
  • 収納代行品名
    全角/半角 25文字/50文字
  • フィールド72:collection_agency_remarks
  • 収納代行備考
    全角/半角 14文字/28文字

    ※詳細については、下記の公式ドキュメントもご参照ください。
    ヤマトの公式ドキュメント
  • レスポンスデータ構造:
  • {
        "result":1,(1:成功;0:失敗;2:一部分失敗)
        "message":"some message",
    }

    Webhook機能を使用することを強くお勧めします。
  • 機能:複数のデータをアップロードできます。1回のリクエストで送信できるエントリーの最大数は200件です。
  • URL:https://webapi.umtec.jp/miandan/api/update_yamato?client_key={client_key}
  • client_key:認証キーについては「認証キーのセクション」をご参照ください。
  • headers:Authorization: Bearer {token}
  • リクエスト方式:POST
  • データ形式:JSONテキスト
  • リクエスト制限: 1秒あたり最大2リクエスト。制限を超えるリクエストは拒否され、HTTP 429 エラーが返されます。
  • リクエストデータ構造:
  • [
        {"channel_id":"〇","warehouse_id":"〇","customer_number":"〇","deli_postcode":"〇",...},
        {"channel_id":"〇","warehouse_id":"〇","customer_number":"〇","deli_postcode":"〇",...},
        ...
    ]
    
    ※空欄のフィールドは設定不要です。
  • データフィールド参照:
  • システムフィールド (必須)
  • フィールド1:channel_id 説明:チャンネルID 参考設定ページ
  • フィールド2:warehouse_id 説明:倉庫ID 参考設定ページ

  • フィールド一覧
  • フィールド1:customer_number
  • お客様管理番号
    必須
    
    システムは、このフィールドの値をもとに対応する既存のレコードを検索し、該当レコードが存在する場合に更新を実行します。該当レコードが見つからない場合は、エラーを返します。
    
  • フィールド2:invoice_type
  • 送り状種類
    必須                                                    
    半角数字1文字
    0 : 発払い
    2 : コレクト
    3 : クロネコゆうメール
    4 : タイム
    5 : 着払い
    6 : 発払い(複数口)
    7 : ネコポス・クロネコゆうパケット
    8 : 宅急便コンパクト
    9 : 宅急便コンパクトコレクト
    
    (※宅急便_必須項目)
    (※クロネコゆうメール_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド3:cool_classification
  • クール区分
    半角数字1文字
    0または空白 : 通常
    1 : クール冷凍
    2 : クール冷蔵
    ※「0:発払い」、「2:コレクト」、「5:着払い」のみ、ご利用頂けます。
    上記以外の送り状の場合、空白扱いで取り込みます。
  • フィールド4:invoice_number
  • 伝票番号
    半角数字12文字
    ※B2クラウドにて付与
  • フィールド5:shipment_scheduled_date
  • 出荷予定日
    設定されていない場合は当日になる。 
    半角10文字
    「YYYY/MM/DD」で入力してください。
    (※宅急便_必須項目)
    (※クロネコゆうメール_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド6:deli_scheduled_date
  • お届け予定日
    半角10文字
    「YYYY/MM/DD」で入力してください。
    ※入力なしの場合、印字されません。
    ※「最短日」と入力可
  • フィールド7:deli_time_zone
  • 配達時間帯
    半角4文字
    発払・コレクト・着払・宅急便コンパクト・宅急便コンパクトコレクト・発払(複数口) の場合
     空白 : 指定なし
     0812 : 午前中
     1416 : 14~16時
     1618 : 16~18時
     1820 : 18~20時
     1921 : 19~21時
    タイム
     0010 : 午前10時まで
     0017 : 午後5時まで
  • フィールド8:deli_code
  • お届け先コード
    半角英数字20文字
  • フィールド9:deli_phone_number
  • お届け先電話番号
    必須
    半角数字15文字ハイフン含む
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド10:deli_phone_number_branch
  • お届け先電話番号枝番
    半角数字2文字
  • フィールド11:deli_postal_code 説明:お届け先郵便番号
  • お届け先郵便番号
    必須
    半角数字8文字
    ハイフンなし7文字も可
    (※宅急便_必須項目)
    (※クロネコゆうメール_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド12:deli_address
  • お届け先住所
    必須
    全角/半角
    都道府県(4文字)
    市区郡町村(12文字)
    町・番地(16文字)
    (※宅急便_必須項目)
    (※クロネコゆうメール_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド13:deli_apartment_name
  • お届け先アパートマンション名
    全角/半角 
    16文字/32文字 
  • フィールド14:deli_company_department1
  • お届け先会社・部門1
    全角/半角
    25文字/50文字 
  • フィールド15:deli_company_department2
  • お届け先会社・部門2
    全角/半角 
    25文字/50文字 
  • フィールド16:deli_name
  • お届け先名
    必須
    全角/半角
    16文字/32文字 
    (※宅急便_必須項目)
    (※クロネコゆうメール_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド17:deli_name_kana
  • お届け先名(カナ)
    半角カタカナ 50文字 
  • フィールド18:honorifics
  • 敬称
    全角/半角 2文字/4文字
    クロネコゆうメールの場合に指定可能
    【入力例】
    様・御中・殿・行・係・宛・先生・なし
  • フィールド19:requester_code
  • ご依頼主コード
    半角英数字 20文字 
  • フィールド20:requester_phone_number
  • ご依頼主電話番号
    必須
    半角数字15文字ハイフン含む
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド21:requester_phone_number_branch
  • ご依頼主電話番号枝番
    半角数字 2文字 
  • フィールド22:requester_postal_code
  • ご依頼主郵便番号
    必須
    半角数字8文字
    ハイフンなし半角7文字も可 
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド23:requester_address
  • ご依頼主住所
    必須
    全角/半角32文字/64文字
    都道府県(4文字)
    市区郡町村(12文字)
    町・番地(16文字)
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド24:requester_apartment
  • ご依頼主アパートマンション
    全角/半角 16文字/32文字 
  • フィールド25:requester_name 説明:ご依頼主名
  • ご依頼主名
    必須
    全角/半角 16文字/32文字 
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド26:requester_name_kana
  • ご依頼主名(カナ)
    半角カタカナ 50文字
  • フィールド27:product_code1
  • 品名コード1
    半角英数字 30文字 
  • フィールド28:product_name1
  • 品名1
    必須
    全角/半角 25文字/50文字 
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド29:product_code2
  • 品名コード2
    半角英数字 30文字
  • フィールド30:product_name2
  •  品名2
  • フィールド31:handling1
  • 荷扱い1
    全角/半角 10文字/20文字 
  • フィールド32:handling2
  • 荷扱い2
    全角/半角 10文字/20文字  
  • フィールド33:article
  • 記事
    このフィールドはシステムによってすでに占有されているため、使用しないでください。
    全角/半角 22文字/44文字 
  • フィールド34:collect_amount_incl_tax
  • コレクト代金引換額(税込)
    半角数字 7文字
    ※コレクトの場合は必須
    300,000円以下 1円以上
    ※但し、宅急便コンパクトコレクトの場合は
    30,000円以下  1円以上
  • フィールド35:internal_tax_amount
  • 内消費税額等
    半角数字 7文字
    ※コレクトの場合は必須 
    ※コレクト代金引換額(税込)以下
  • フィールド36:detention
  • 止置き
    半角数字 1文字
    0 : 利用しない
    1 : 利用する 
  • フィールド37:office_code
  • 営業所コード
    半角数字 6文字
    ※止置きを利用する場合は必須 
  • フィールド38:number_of_issues
  • 発行枚数
    半角数字 2文字
    ※発払い・タイム・着払い、ネコポス・クロネコゆうパケット・発払い(複数口)のみ指定可能
  • フィールド39:count_flag
  • 個数口表示フラグ
    默认为1
    半角数字 1文字
    1 : 印字する
    2 : 印字しない 
    3 : 枠と口数を印字する
    ※宅急便コンパクト、宅急便コンパクトコレクトは対象外
    ※複数口の場合、本項目の指定に関係なく、3 : 枠と口数を印字する扱いとする
  • フィールド40:customer_code_billing
  • 請求先顧客コード
    設定がない場合はシステム設定の値が自動取得されます。
    半角数字10~12文字
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド41:billing_classification_code
  • 請求先分類コード
    設定がない場合はシステム設定の値が自動取得されます。
    空白または半角数字3文字
    
  • フィールド42:fare_management_number
  • 運賃管理番号
    設定がない場合はシステム設定の値が自動取得されます。
    半角数字2文字
    (※宅急便_必須項目)
    (※ネコポス・クロネコゆうパケット_必須項目)
  • フィールド43:yamato_web_collect_data_registration
  • クロネコwebコレクトデータ登録
    半角数字 1文字
    0 : 無し
    1 : 有り 
  • フィールド44:yamato_web_collect_store_number
  • クロネコwebコレクト加盟店番号
    半角英数字 9文字 
    ※クロネコwebコレクトデータ有りの場合は必須 
  • フィールド45:yamato_web_collect_application_number1
  • クロネコwebコレクト申込受付番号1
    半角英数字 23文字
    ※クロネコwebコレクトデータ有りの場合は必須 
  • フィールド46:yamato_web_collect_application_number2
  • クロネコwebコレクト申込受付番号2
    半角英数字 23文字
    ※発払い(複数口)の場合は、設定不可
  • フィールド47:yamato_web_collect_application_number3
  • クロネコwebコレクト申込受付番号3
    半角英数字 23文字
    ※発払い(複数口)の場合は、設定不可
  • フィールド48:scheduled_deli_email_usage_type
  • お届け予定eメール利用区分
    半角数字 1文字
    0 : 利用しない
    1 : 利用する 
  • フィールド49:scheduled_deli_email_address
  • お届け予定eメールe-mailアドレス
    半角英数字&記号 60文字
    ※お届け予定eメールを利用する場合は必須 
  • フィールド50:scheduled_deli_email_message
  • お届け予定eメールメッセージ
    全角 74文字
    ※お届け予定eメールを利用する場合は必須
  • フィールド51:completed_deli_email_usage_type
  • お届け完了eメール利用区分
    半角数字 1文字
    0 : 利用しない
    1 : 利用する 
  • フィールド52:completed_deli_email_address
  • お届け完了eメールe-mailアドレス
    半角英数字 60文字
    ※お届け完了eメールを利用する場合は必須 
  • フィールド53:completed_deli_email_message
  • お届け完了eメールメッセージ
    全角 159文字 
    ※お届け完了eメールを利用する場合は必須 
  • フィールド54:yamato_collection_agency_usage_type
  • クロネコ収納代行利用区分
    半角数字1文字
    0 : 利用しない
    1 : 利用する 
  • フィールド55:spare1
  • 予備
    半角数字1文字
  • フィールド56:collection_agency_billing_amount
  • 収納代行請求金額(税込)
    半角数字7文字
  • フィールド57:collection_agency_internal_tax_amount
  • 収納代行内消費税額等
    半角数字7文字
  • フィールド58:collection_agency_billing_postal_code
  • 収納代行請求先郵便番号
    半角数字&ハイフン8文字
    ハイフンなし半角7文字も可 
  • フィールド59:collection_agency_billing_address
  • 収納代行請求先住所
    全角/半角 32文字/64文字
    都道府県(4文字)
    市区郡町村(12文字)
    町・番地(16文字)"
  • フィールド60:collection_agency_billing_apartment_name
  • 収納代行請求先住所(アパートマンション名)
    全角/半角 16文字/32文字
  • フィールド61:collection_agency_billing_company_department1
  • 収納代行請求先会社・部門名1
    全角/半角 25文字/50文字
  • フィールド62:collection_agency_billing_company_department2
  • 収納代行請求先会社・部門名2
    全角/半角 25文字/50文字
  • フィールド63:collection_agency_billing_name_kanji
  • 収納代行請求先名(漢字)
    全角/半角 16文字/32文字
  • フィールド64:collection_agency_billing_name_kana
  • 収納代行請求先名(カナ)
    半角カタカナ50文字
  • フィールド65:collection_agency_inquiry_name_kanji
  • 収納代行問合せ先名(漢字)
    全角/半角 16文字/32文字
  • フィールド66:collection_agency_inquiry_postal_code
  • 収納代行問合せ先郵便番号
    半角数字&ハイフン8文字
    ハイフンなし半角7文字も可 
  • フィールド67:collection_agency_inquiry_address
  • 収納代行問合せ先住所
    全角/半角 32文字/64文字
    都道府県(4文字)
    市区郡町村(12文字)
    町・番地(16文字)
  • フィールド68:collection_agency_inquiry_apartment_name
  • 収納代行問合せ先住所(アパートマンション名)
    全角/半角 16文字/32文字
  • フィールド69:collection_agency_inquiry_phone_number
  • 収納代行問合せ先電話番号
    半角数字&ハイフン15文字
  • フィールド70:collection_agency_management_number
  • 収納代行管理番号
    半角英数字20文字
  • フィールド71:collection_agency_product_name
  • 収納代行品名
    全角/半角 25文字/50文字
  • フィールド72:collection_agency_remarks
  • 収納代行備考
    全角/半角 14文字/28文字

    ※詳細については、下記の公式ドキュメントもご参照ください。
    ヤマトの公式ドキュメント
  • レスポンスデータ構造:
  • {
        "result":1,(1:成功;0:失敗;2:一部分失敗)
        "message":"some message",
    }

    送り状データをアップ(PHP)

    
    <?php
    $token = '************';
    $client_key = '*******************';
    $data = [
        [
            "channel_id" => 1,
            "warehouse_id" => 1,
            "deli_phone_number" => "0123456789",
            "deli_postal_code" => "123-4567",
            "deli_address" => "千葉県○○市○○○○",
            "deli_name" => "○○○株式会社",
            "customer_number" => "AA000001"
            //...
        ],
        [
            "channel_id" => 1,
            "warehouse_id" => 2,
            "deli_phone_number" => "9876543210",
            "deli_postal_code" => "765-4321",
            "deli_address" => "大阪市中央区",
            "deli_name" => "○○○株式会社",
            "customer_number" => "AA000002"
            //...
        ]
        // ...
    ];
    
    $jsonData = json_encode($data);
    
    $url = 'https://webapi.umtec.jp/miandan/api/put_yamato?client_key='.$client_key;
    
    $headers = [
        'Content-Type: application/json',
        "Authorization: Bearer {$token}"
    ];
    
    $ch = curl_init($url);
    
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
    
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    
    $response = curl_exec($ch);
    
    if (curl_errno($ch)) {
        echo 'cURL Error: ' . curl_error($ch);
    } else {
        echo 'Response: ' . $response;
    
        $info = curl_getinfo($ch);
        echo 'HTTP Code: ' . $info['http_code'];
        echo 'Total Time: ' . $info['total_time'];
    }
    
    curl_close($ch);
    ?>
          

    追跡番号を取得(PHP)

    
    <?php
    $token = '************';
    $client_key = '*******************';
    $data = [
        "10000001",
        "10000002",
        "10000003",
        // ...
    ];
    
    $jsonData = json_encode($data);
    
    $url = 'https://webapi.umtec.jp/miandan/api/get_yamato?client_key='.$client_key;
    
    $headers = [
        'Content-Type: application/json',
        "Authorization: Bearer {$token}"
    ];
    
    $ch = curl_init($url);
    
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
    
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    
    $response = curl_exec($ch);
    
    if (curl_errno($ch)) {
        echo 'cURL Error: ' . curl_error($ch);
    } else {
        echo 'Response: ' . $response;
    
        $info = curl_getinfo($ch);
        echo 'HTTP Code: ' . $info['http_code'];
        echo 'Total Time: ' . $info['total_time'];
    }
    
    curl_close($ch);
    ?>
    

    開発ドキュメント
    開発ドキュメント

  • 機能:複数のデータをアップロードできます。1回のリクエストで送信できるエントリーの最大数は200件です。
  • URL:https://webapi.umtec.jp/miandan/api/put_seino_km2?client_key={client_key}
  • client_key:認証キーについては「認証キーのセクション」をご参照ください。
  • headers:Authorization: Bearer {token}
  • リクエスト方式:POST
  • データ形式:JSONテキスト
  • リクエスト制限: 1秒あたり最大2リクエスト。制限を超えるリクエストは拒否され、HTTP 429 エラーが返されます。
  • リクエストデータ構造:
  • [
        {"channel_id":"〇","warehouse_id":"〇","customer_number":"〇","deli_postal_code":"〇",...},
        {"channel_id":"〇","warehouse_id":"〇","customer_number":"〇","deli_postal_code":"〇",...},
        ...
    ]
    
    ※空欄のフィールドは設定不要です。
  • データフィールド参照:
  • システムフィールド (必須)
  • フィールド1:channel_id 説明:チャンネルID 参考設定ページ
  • フィールド2:warehouse_id 説明:倉庫ID 参考設定ページ

  • フィールド一覧
  • フィールド1:customer_number
  • お客様管理番号
    必須
    半角英数字18文字
    ※特記事項:
    このフィールドはユニックである必要があります。このフィールドはクエリ時に使用されます。
    このフィールドの最大長は 40 文字で、数字、大文字と小文字、-、_のみをサポートします。
    
  • フィールド2:sender_code
  • 荷送人コード    
    半角英数大文字  11文字                                           
    
  • フィールド3:seino_code
  • 西濃発店コード
    半角英数    4文字                                                   
    
  • フィールド4:shipment_date
  • 出荷予定日
    半角英数8文字    西暦年月日(年4桁)
    値がセットされていない場合、省略時設定   
  • フィールド5:payment_type
  • 元着区分
    半角数字
    元払:1 着払:3
    ※値がセットされていない場合、省略時設定
    
  • フィールド6:original_ticket_type
  • 原票区分
    半角数字1文字
    出荷先によって正しい区分を指定してください。
     [企業宛] 一般:0、 ミニ:3、 ビジネス便:9
     [個人宛] 宅配:1、 通販便:8
    
    「ミニ」指定時、個数が2以上または重量がミニ便上限重量を超えている場合、強制的に一般便に変更されます。
    ※値がセットされていない場合、省略時設定
  • フィールド7:quantity
  • 個数
    必須
    半角数字4文字
    輸送個口数(3桁以内)
    ※出荷登録に可能な桁数は3桁ですが、固定長の場合は5バイト(後ろ2桁はスペース)で設定してください
    
  • フィールド8:weight_type
  • 重量区分
    使用しない
  • フィールド9:weight_kg
  • 重量(kg)
    半角数字5文字
    ※重量(kg)と重量(才)の両方に値をセットした場合は、1才を8kgとして計算し、重量の多い値の項目を重量として使用します。
    
  • フィールド10:weight_cubic
  • 重量(才)
    半角数字5文字
  • フィールド11:sender_name
  • 荷送人名称
    全角文字20文字
  • フィールド12:sender_address1
  • 荷送人住所1
    全角文字20文字
  • フィールド13:sender_address2
  • 荷送人住所2
    全角文字20文字 
  • フィールド14:sender_phone
  • 荷送人電話番号
    半角数字13文字 
  • フィールド15:department_code
  • 部署コード
    半角英数大文字2文字 
  • フィールド16:department_name
  • 部署名
    全角文字15文字
  • フィールド17:weight_contract_type
  • 重量契約区分
    使用しない 
  • フィールド18:deli_postal_code
  • お届け先郵便番号
    必須
    半角数字7文字
  • フィールド19:deli_name1
  • お届け先名称1
    必須
    全角文字30文字 
  • フィールド20:deli_name2
  • お届け先名称2
    全角文字30文字
  • フィールド21:deli_address1
  • お届け先住所1
    必須
    全角文字30文字 
  • フィールド22:deli_address2
  • お届け先住所2
    全角文字30文字
  • フィールド23:deli_phone
  • お届け先電話番号
    必須
    半角数字13文字
  • フィールド24:deli_code
  • お届け先コード
    半角カナ英数大文字30文字 
  • フィールド25:deli_jis_code
  • お届け先JIS市町村コード
    半角数字5文字 
  • フィールド26:arrival_code
  • 着店コード付け区分
    使用しない
  • フィールド27:arrival_station_code
  • 着地コード
    使用しない
  • フィールド28:insurance_amount
  • 保険金額
    半角数字5文字 
  • フィールド29:transport_instruction1
  • 輸送指示1
    使用しない
  • フィールド30:transport_instruction2
  •  輸送指示2
    使用しない 
  • フィールド31:article1
  • 記事1
    全角/半角15文字 
  • フィールド32:article2
  • 記事2
    全角/半角15文字 
  • フィールド33:article3
  • 記事3
    全角/半角15文字 
  • フィールド34:article4
  • 記事4
    全角/半角15文字 
  • フィールド35:delivery_date_code
  • 輸送指示(配達指定日付)
    半角数字5文字
    輸送指示コード1・2のいずれかに、【02:配達指定】を指定した場合に使用。
    『月日(MMDD)+区分』で計5バイトです。
    但し、区分のみのご指定もできます。その場合は、『月日(0000)+区分』でご指定ください。
    
    【一般・ミニ・宅配の場合】
    区分・・・0:希望無、1:午前、2:午後、8:まで
    【通販便の場合】
    区分・・・0:希望無、5:9:00~12:00、6:12:00~17:00、7:17:00~20:00、8:まで
    
    「出荷情報一括登録」画面にて、「配達指定日にお届け可能かチェック」を選択した場合、 
    『月日(0000)+区分』(区分(時間帯)のみのご指定)はエラーとなります。
    
     通販便でご出荷時は、「原票区分」に"8"(通販便)を必ず指定してください。
    
  • フィールド36:delivery_instruction_code1
  • 輸送指示コード1
    輸送指示コード表を参照してください。
    【01:止商品】と【02:配達指定】を同時に使用することはできません 
  • フィールド37:delivery_instruction_code2
  • 輸送指示コード2
    輸送指示コード表を参照してください。
    【01:止商品】と【02:配達指定】を同時に使用することはできません 
  • フィールド38:stop_location_name
  • 輸送指示(止め店所名)
    全角文字4文字
    輸送指示コード1・2のいずれかに、【01:止商品】を指定した場合に使用。
    名称は、営業所案内を参照して下さい
  • フィールド39:reserve
  • 予備
    使用しない
  • フィールド40:cod_amount
  • 品代金
    半角数字9文字
    代引の場合、商品代金と消費税等の合計値を入力して下さい。
    西濃運輸と代引契約をされている荷主様のみご利用いただけます。代引でない出荷の場合は、当項目は不要です。
    
     代引配達について
    (代引サービス取扱不可能エリア一覧表)
    大きな建物などの館内、および下記地域がお届け先に設定されていた場合、代引配達できませんので予めご了承下さい。(出荷登録は可能です)
    
    [代引配達不可能地域]
    ・岡山県瀬戸内市牛窓町牛窓5000-6000番地
    ・広島県広島市南区宇品町金輪島
    ・広島県竹原市小梨町
  • フィールド41:tax_amount
  • 消費税等
    半角数字9文字
    代引の場合、商品代金に対する消費税等を入力して下さい。
    未入力の場合、品代金から計算された消費税等額が自動的にセットされます。
    西濃運輸と代引契約をされている荷主様のみご利用いただけます。代引でない出荷の場合は、当項目は不要です。
    
  • フィールド42:delivery_email
  • 配達時間メール 送信先(メールアドレス)
    半角数字100文字
    荷受人様へ配達前にお届け予定時間をメールでご案内します。

    ※詳細については、下記の公式ドキュメントもご参照ください。
    西濃の公式ドキュメント
  • レスポンスデータ構造:
  • {
        "result":1,(1:成功;0:失敗;2:一部分失敗)
        "message":"some message",
    }

    Webhook機能を使用することを強くお勧めします。
  • 機能:複数のデータをアップロードできます。1回のリクエストで送信できるエントリーの最大数は200件です。
  • URL:https://webapi.umtec.jp/miandan/api/update_seino_km2?client_key={client_key}
  • client_key:認証キーについては「認証キーのセクション」をご参照ください。
  • headers:Authorization: Bearer {token}
  • リクエスト方式:POST
  • データ形式:JSONテキスト
  • リクエスト制限: 1秒あたり最大2リクエスト。制限を超えるリクエストは拒否され、HTTP 429 エラーが返されます。
  • リクエストデータ構造:
  • [
        {"channel_id":"〇","warehouse_id":"〇","customer_number":"〇","deli_postal_code":"〇",...},
        {"channel_id":"〇","warehouse_id":"〇","customer_number":"〇","deli_postal_code":"〇",...},
        ...
    ]
    
    ※空欄のフィールドは設定不要です。
  • データフィールド参照:
  • システムフィールド (必須)
  • フィールド1:channel_id 説明:チャンネルID 参考設定ページ
  • フィールド2:warehouse_id 説明:倉庫ID 参考設定ページ

  • フィールド一覧
  • フィールド1:customer_number
  • お客様管理番号
    必須
    半角英数字50文字
    
    システムは、このフィールドの値をもとに対応する既存のレコードを検索し、該当レコードが存在する場合に更新を実行します。該当レコードが見つからない場合は、エラーを返します。
    
  • フィールド2:sender_code
  • 荷送人コード    
    半角英数大文字  11文字                                           
    
  • フィールド3:seino_code
  • 西濃発店コード
    半角英数    4文字                                                   
    
  • フィールド4:shipment_date
  • 出荷予定日
    半角英数8文字    西暦年月日(年4桁)
    値がセットされていない場合、省略時設定   
  • フィールド5:payment_type
  • 元着区分
    半角数字
    元払:1 着払:3
    ※値がセットされていない場合、省略時設定
    
  • フィールド6:original_ticket_type
  • 原票区分
    半角数字1文字
    出荷先によって正しい区分を指定してください。
     [企業宛] 一般:0、 ミニ:3、 ビジネス便:9
     [個人宛] 宅配:1、 通販便:8
    
    「ミニ」指定時、個数が2以上または重量がミニ便上限重量を超えている場合、強制的に一般便に変更されます。
    ※値がセットされていない場合、省略時設定
  • フィールド7:quantity
  • 個数
    必須
    半角数字4文字
    輸送個口数(3桁以内)
    ※出荷登録に可能な桁数は3桁ですが、固定長の場合は5バイト(後ろ2桁はスペース)で設定してください
    
  • フィールド8:weight_type
  • 重量区分
    使用しない
  • フィールド9:weight_kg
  • 重量(kg)
    半角数字5文字
    ※重量(kg)と重量(才)の両方に値をセットした場合は、1才を8kgとして計算し、重量の多い値の項目を重量として使用します。
    
  • フィールド10:weight_cubic
  • 重量(才)
    半角数字5文字
  • フィールド11:sender_name
  • 荷送人名称
    全角文字20文字
  • フィールド12:sender_address1
  • 荷送人住所1
    全角文字20文字
  • フィールド13:sender_address2
  • 荷送人住所2
    全角文字20文字 
  • フィールド14:sender_phone
  • 荷送人電話番号
    半角数字13文字 
  • フィールド15:department_code
  • 部署コード
    半角英数大文字2文字 
  • フィールド16:department_name
  • 部署名
    全角文字15文字
  • フィールド17:weight_contract_type
  • 重量契約区分
    使用しない 
  • フィールド18:deli_postal_code
  • お届け先郵便番号
    必須
    半角数字7文字
  • フィールド19:deli_name1
  • お届け先名称1
    必須
    全角文字30文字 
  • フィールド20:deli_name2
  • お届け先名称2
    全角文字30文字
  • フィールド21:deli_address1
  • お届け先住所1
    必須
    全角文字30文字 
  • フィールド22:deli_address2
  • お届け先住所2
    全角文字30文字
  • フィールド23:deli_phone
  • お届け先電話番号
    必須
    半角数字13文字
  • フィールド24:deli_code
  • お届け先コード
    半角カナ英数大文字30文字 
  • フィールド25:deli_jis_code
  • お届け先JIS市町村コード
    半角数字5文字 
  • フィールド26:arrival_code
  • 着店コード付け区分
    使用しない
  • フィールド27:arrival_station_code
  • 着地コード
    使用しない
  • フィールド28:insurance_amount
  • 保険金額
    半角数字5文字 
  • フィールド29:transport_instruction1
  • 輸送指示1
    使用しない
  • フィールド30:transport_instruction2
  •  輸送指示2
    使用しない 
  • フィールド31:article1
  • 記事1
    全角/半角15文字 
  • フィールド32:article2
  • 記事2
    全角/半角15文字 
  • フィールド33:article3
  • 記事3
    全角/半角15文字 
  • フィールド34:article4
  • 記事4
    全角/半角15文字 
  • フィールド35:delivery_date_code
  • 輸送指示(配達指定日付)
    半角数字5文字
    輸送指示コード1・2のいずれかに、【02:配達指定】を指定した場合に使用。
    『月日(MMDD)+区分』で計5バイトです。
    但し、区分のみのご指定もできます。その場合は、『月日(0000)+区分』でご指定ください。
    
    【一般・ミニ・宅配の場合】
    区分・・・0:希望無、1:午前、2:午後、8:まで
    【通販便の場合】
    区分・・・0:希望無、5:9:00~12:00、6:12:00~17:00、7:17:00~20:00、8:まで
    
    「出荷情報一括登録」画面にて、「配達指定日にお届け可能かチェック」を選択した場合、 
    『月日(0000)+区分』(区分(時間帯)のみのご指定)はエラーとなります。
    
     通販便でご出荷時は、「原票区分」に"8"(通販便)を必ず指定してください。
    
  • フィールド36:delivery_instruction_code1
  • 輸送指示コード1
    輸送指示コード表を参照してください。
    【01:止商品】と【02:配達指定】を同時に使用することはできません 
  • フィールド37:delivery_instruction_code2
  • 輸送指示コード2
    輸送指示コード表を参照してください。
    【01:止商品】と【02:配達指定】を同時に使用することはできません 
  • フィールド38:stop_location_name
  • 輸送指示(止め店所名)
    全角文字4文字
    輸送指示コード1・2のいずれかに、【01:止商品】を指定した場合に使用。
    名称は、営業所案内を参照して下さい
  • フィールド39:reserve
  • 予備
    使用しない
  • フィールド40:cod_amount
  • 品代金
    半角数字9文字
    代引の場合、商品代金と消費税等の合計値を入力して下さい。
    西濃運輸と代引契約をされている荷主様のみご利用いただけます。代引でない出荷の場合は、当項目は不要です。
    
     代引配達について
    (代引サービス取扱不可能エリア一覧表)
    大きな建物などの館内、および下記地域がお届け先に設定されていた場合、代引配達できませんので予めご了承下さい。(出荷登録は可能です)
    
    [代引配達不可能地域]
    ・岡山県瀬戸内市牛窓町牛窓5000-6000番地
    ・広島県広島市南区宇品町金輪島
    ・広島県竹原市小梨町
  • フィールド41:tax_amount
  • 消費税等
    半角数字9文字
    代引の場合、商品代金に対する消費税等を入力して下さい。
    未入力の場合、品代金から計算された消費税等額が自動的にセットされます。
    西濃運輸と代引契約をされている荷主様のみご利用いただけます。代引でない出荷の場合は、当項目は不要です。
    
  • フィールド42:delivery_email
  • 配達時間メール 送信先(メールアドレス)
    半角数字100文字
    荷受人様へ配達前にお届け予定時間をメールでご案内します。

    ※詳細については、下記の公式ドキュメントもご参照ください。
    西濃の公式ドキュメント
  • レスポンスデータ構造:
  • {
        "result":1,(1:成功;0:失敗;2:一部分失敗)
        "message":"some message",
    }

    送り状データをアップ(PHP)

    
    <?php
    $token = '************';
    $client_key = '*******************';
    $data = [
        [
            "channel_id" => 1,
            "warehouse_id" => 1,
            "deli_phone" => "0123456789",
            "deli_postal_code" => "1234567",
            "deli_address1" => "千葉県○○市○○○○",
            "deli_name1" => "○○○株式会社",
            "customer_number" => "AA000001"
            //...
        ],
        [
            "channel_id" => 1,
            "warehouse_id" => 2,
            "deli_phone" => "9876543210",
            "deli_postal_code" => "7654321",
            "deli_address1" => "大阪市中央区",
            "deli_name1" => "○○○株式会社",
            "customer_number" => "AA000002"
            //...
        ]
        // ...
    ];
    
    $jsonData = json_encode($data);
    
    $url = 'https://webapi.umtec.jp/miandan/api/put_seino_km2?client_key='.$client_key;
    
    $headers = [
        'Content-Type: application/json',
        "Authorization: Bearer {$token}"
    ];
    
    $ch = curl_init($url);
    
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
    
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    
    $response = curl_exec($ch);
    
    if (curl_errno($ch)) {
        echo 'cURL Error: ' . curl_error($ch);
    } else {
        echo 'Response: ' . $response;
    
        $info = curl_getinfo($ch);
        echo 'HTTP Code: ' . $info['http_code'];
        echo 'Total Time: ' . $info['total_time'];
    }
    
    curl_close($ch);
    ?>
          

    追跡番号を取得(PHP)

    
    <?php
    $token = '************';
    $client_key = '*******************';
    $data = [
        "10000001",
        "10000002",
        "10000003",
        // ...
    ];
    
    $jsonData = json_encode($data);
    
    $url = 'https://webapi.umtec.jp/miandan/api/get_seino_km2?client_key='.$client_key;
    
    $headers = [
        'Content-Type: application/json',
        "Authorization: Bearer {$token}"
    ];
    
    $ch = curl_init($url);
    
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
    
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    
    $response = curl_exec($ch);
    
    if (curl_errno($ch)) {
        echo 'cURL Error: ' . curl_error($ch);
    } else {
        echo 'Response: ' . $response;
    
        $info = curl_getinfo($ch);
        echo 'HTTP Code: ' . $info['http_code'];
        echo 'Total Time: ' . $info['total_time'];
    }
    
    curl_close($ch);
    ?>
    

    開発ドキュメント

  • 機能:複数のデータをアップロードできます。1回のリクエストで送信できるエントリーの最大数は200件です。
  • URL:https://webapi.umtec.jp/miandan/api/put_seino_rsmile?client_key={client_key}
  • client_key:認証キーについては「認証キーのセクション」をご参照ください。
  • headers:Authorization: Bearer {token}
  • リクエスト方式:POST
  • データ形式:JSONテキスト
  • リクエスト制限: 1秒あたり最大2リクエスト。制限を超えるリクエストは拒否され、HTTP 429 エラーが返されます。
  • リクエストデータ構造:
  • [
        {"channel_id":"〇","warehouse_id":"〇","customer_number":"〇","deli_postal_code":"〇",...},
        {"channel_id":"〇","warehouse_id":"〇","customer_number":"〇","deli_postal_code":"〇",...},
        ...
    ]
    
    ※空欄のフィールドは設定不要です。
  • データフィールド参照:
  • システムフィールド (必須)
  • フィールド1:channel_id 説明:チャンネルID 参考設定ページ
  • フィールド2:warehouse_id 説明:倉庫ID 参考設定ページ

  • フィールド一覧
  • フィールド1:customer_number
  • お客様管理番号
    必須
    半角英数字18文字
    ※特記事項:
    このフィールドはユニックである必要があります。このフィールドはクエリ時に使用されます。
    このフィールドの最大長は 40 文字で、数字、大文字と小文字、-、_のみをサポートします。
    
  • フィールド2:deli_phone
  • 電話番号
    必須
    半角数字、ハイフン  15文字
    
  • フィールド3:deli_postal_code
  • 郵便番号
    必須
    半角数字  7文字
    
  • フィールド4:deli_prefecture
  • 都道府県
    必須
    全角半角   20文字
    
  • フィールド5:deli_city
  • 市区町村
    必須
    全角半角   40文字
    
  • フィールド6:deli_town
  • 町域
    必須
    全角半角   60文字
    
  • フィールド7:deli_address
  • 番地・ビル名
    必須
    全角半角   60文字
    
  • フィールド8:deli_name1
  • お届先名称1
    必須
    全角半角   60文字
    
  • フィールド9:deli_name2
  • お届先名称2
    全角半角   60文字
    
  • フィールド10:shipping_qty
  • 個数
    半角数字   4文字
    
  • フィールド11:weight
  • 重量
    半角数字、小数点   7文字
    
  • フィールド12:sender_code
  • 荷送人コード
    半角英数   6文字
    
  • フィールド13:sender_name2
  • 荷送人名称2
    全角半角   60文字
    
  • フィールド14:payment_type
  • 元着区分
    全角文字   4文字
    元払:"元払"、着払:"着払"、代引:"代引" と入力
    
  • フィールド15:transport_type
  • 輸送区分
    全角文字   6文字
    輸送区分が航空の時のみ有効 急便:空白、AIR:"AIR"
    
  • フィールド16:delivery_date
  • 配達指定日
    半角数字   8文字 (yyyyMMdd)
    
  • フィールド17:note1
  • 記事1
    全角半角   60文字
    
  • フィールド18:note2
  • 記事2
    全角半角   60文字
    
  • フィールド19:note3
  • 記事3
    全角半角   60文字
    
  • フィールド20:note4
  • 記事4
    全角半角   60文字
    
  • フィールド21:shipment_date
  • 出荷日
    半角数字   8文字 (yyyyMMdd)
    
  • フィールド22:dangerous_goods
  • 航空輸送制限貨物(危険物)有無
    全角文字   2文字 (有/無)
    
  • フィールド23:billing_unit
  • 請求単位
    半角英数   20文字
    
  • フィールド24:notification_email1
  • 出荷通知メールアドレス1
    半角英数   50文字
    
  • フィールド25:notification_email2
  • 出荷通知メールアドレス2
    半角英数   50文字
    
  • フィールド26:notification_email3
  • 出荷通知メールアドレス3
    半角英数   50文字
    
  • フィールド27:notification_email4
  • 出荷通知メールアドレス4
    半角英数   50文字
    
  • フィールド28:notification_email5
  • 出荷通知メールアドレス5
    半角英数   50文字
    
  • フィールド29:cod_amount
  • 代引金額(消費税等含む)
    半角数字、小数点   7文字
    
  • フィールド30:tax
  • 消費税等
    半角数字、小数点   7文字
    
  • フィールド31:shipping_option
  • 配送オプション
    半角数字   2文字
    
  • フィールド32:declared_item
  • 申告商品
    半角数字   2文字
    
  • フィールド33:declared_price
  • 申告価格
    半角数字、小数点   6文字
    
  • フィールド34:insurance_price
  • 保険価格
    半角数字、小数点   6文字
    
  • フィールド35:insurance_display
  • 保険額印字
    全角文字   6文字
    

    ※詳細については、下記の公式ドキュメントもご参照ください。
    公式ドキュメント
  • レスポンスデータ構造:
  • {
        "result":1,(1:成功;0:失敗;2:一部分失敗)
        "message":"some message",
    }

    Webhook機能を使用することを強くお勧めします。
  • 機能:複数のデータをアップロードできます。1回のリクエストで送信できるエントリーの最大数は200件です。
  • URL:https://webapi.umtec.jp/miandan/api/update_seino_rsmile?client_key={client_key}
  • client_key:認証キーについては「認証キーのセクション」をご参照ください。
  • headers:Authorization: Bearer {token}
  • リクエスト方式:POST
  • データ形式:JSONテキスト
  • リクエスト制限: 1秒あたり最大2リクエスト。制限を超えるリクエストは拒否され、HTTP 429 エラーが返されます。
  • リクエストデータ構造:
  • [
        {"channel_id":"〇","warehouse_id":"〇","customer_number":"〇","deli_postal_code":"〇",...},
        {"channel_id":"〇","warehouse_id":"〇","customer_number":"〇","deli_postal_code":"〇",...},
        ...
    ]
    
    ※空欄のフィールドは設定不要です。
  • データフィールド参照:
  • システムフィールド (必須)
  • フィールド1:channel_id 説明:チャンネルID 参考設定ページ
  • フィールド2:warehouse_id 説明:倉庫ID 参考設定ページ

  • フィールド一覧
  • フィールド1:customer_number
  • お客様管理番号
    必須
    半角英数字50文字
    
    システムは、このフィールドの値をもとに対応する既存のレコードを検索し、該当レコードが存在する場合に更新を実行します。該当レコードが見つからない場合は、エラーを返します。
    
  • フィールド2:deli_phone
  • 電話番号
    必須
    半角数字、ハイフン  15文字
    
  • フィールド3:deli_postal_code
  • 郵便番号
    必須
    半角数字  7文字
    
  • フィールド4:deli_prefecture
  • 都道府県
    必須
    全角半角   20文字
    
  • フィールド5:deli_city
  • 市区町村
    必須
    全角半角   40文字
    
  • フィールド6:deli_town
  • 町域
    必須
    全角半角   60文字
    
  • フィールド7:deli_address
  • 番地・ビル名
    必須
    全角半角   60文字
    
  • フィールド8:deli_name1
  • お届先名称1
    必須
    全角半角   60文字
    
  • フィールド9:deli_name2
  • お届先名称2
    全角半角   60文字
    
  • フィールド10:shipping_qty
  • 個数
    半角数字   4文字
    
  • フィールド11:weight
  • 重量
    半角数字、小数点   7文字
    
  • フィールド12:sender_code
  • 荷送人コード
    半角英数   6文字
    
  • フィールド13:sender_name2
  • 荷送人名称2
    全角半角   60文字
    
  • フィールド14:payment_type
  • 元着区分
    全角文字   4文字
    元払:"元払"、着払:"着払"、代引:"代引" と入力
    
  • フィールド15:transport_type
  • 輸送区分
    全角文字   6文字
    輸送区分が航空の時のみ有効 急便:空白、AIR:"AIR"
    
  • フィールド16:delivery_date
  • 配達指定日
    半角数字   8文字 (yyyyMMdd)
    
  • フィールド17:note1
  • 記事1
    全角半角   60文字
    
  • フィールド18:note2
  • 記事2
    全角半角   60文字
    
  • フィールド19:note3
  • 記事3
    全角半角   60文字
    
  • フィールド20:note4
  • 記事4
    全角半角   60文字
    
  • フィールド21:shipment_date
  • 出荷日
    半角数字   8文字 (yyyyMMdd)
    
  • フィールド22:dangerous_goods
  • 航空輸送制限貨物(危険物)有無
    全角文字   2文字 (有/無)
    
  • フィールド23:billing_unit
  • 請求単位
    半角英数   20文字
    
  • フィールド24:notification_email1
  • 出荷通知メールアドレス1
    半角英数   50文字
    
  • フィールド25:notification_email2
  • 出荷通知メールアドレス2
    半角英数   50文字
    
  • フィールド26:notification_email3
  • 出荷通知メールアドレス3
    半角英数   50文字
    
  • フィールド27:notification_email4
  • 出荷通知メールアドレス4
    半角英数   50文字
    
  • フィールド28:notification_email5
  • 出荷通知メールアドレス5
    半角英数   50文字
    
  • フィールド29:cod_amount
  • 代引金額(消費税等含む)
    半角数字、小数点   7文字
    
  • フィールド30:tax
  • 消費税等
    半角数字、小数点   7文字
    
  • フィールド31:shipping_option
  • 配送オプション
    半角数字   2文字
    
  • フィールド32:declared_item
  • 申告商品
    半角数字   2文字
    
  • フィールド33:declared_price
  • 申告価格
    半角数字、小数点   6文字
    
  • フィールド34:insurance_price
  • 保険価格
    半角数字、小数点   6文字
    
  • フィールド35:insurance_display
  • 保険額印字
    全角文字   6文字
    

    ※詳細については、下記の公式ドキュメントもご参照ください。
    公式ドキュメント
  • レスポンスデータ構造:
  • {
        "result":1,(1:成功;0:失敗;2:一部分失敗)
        "message":"some message",
    }

    送り状データをアップ(PHP)

    
    <?php
    $token = '************';
    $client_key = '*******************';
    $data = [
        [
            "channel_id" => 1,
            "warehouse_id" => 1,
            "deli_phone" => "090-1234-5678",
            "deli_postal_code" => "0010001",
            "deli_prefecture" => "千葉県",
            "deli_city" => "○○市",
            "deli_town" => "○○○○○○5-1",
            "deli_address" => "777",
            "deli_name1" => "○○○株式会社",
            "shipping_qty" => 1,
            "warehouse_id" => 11,
            "payment_type" => '元払',
            "weight" => 2.8,
            "note1" => "note1dd",
            "customer_number" => "AA000001"
            //...
        ],
        [
            "channel_id" => 1,
            "warehouse_id" => 2,
            "deli_phone" => "090-1234-5678",
            "deli_postal_code" => "0010001",
            "deli_prefecture" => "千葉県",
            "deli_city" => "○○市",
            "deli_town" => "○○○○○○5-1",
            "deli_address" => "777",
            "deli_name1" => "○○○株式会社",
            "shipping_qty" => 1,
            "warehouse_id" => 11,
            "payment_type" => '元払',
            "weight" => 2.8,
            "note1" => "note1dd",
            "customer_number" => "AA000002"
            //...
        ]
        // ...
    ];
    
    $jsonData = json_encode($data);
    
    $url = 'https://webapi.umtec.jp/miandan/api/put_seino_rsmile?client_key='.$client_key;
    
    $headers = [
        'Content-Type: application/json',
        "Authorization: Bearer {$token}"
    ];
    
    $ch = curl_init($url);
    
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
    
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    
    $response = curl_exec($ch);
    
    if (curl_errno($ch)) {
        echo 'cURL Error: ' . curl_error($ch);
    } else {
        echo 'Response: ' . $response;
    
        $info = curl_getinfo($ch);
        echo 'HTTP Code: ' . $info['http_code'];
        echo 'Total Time: ' . $info['total_time'];
    }
    
    curl_close($ch);
    ?>
          

    追跡番号を取得(PHP)

    
    <?php
    $token = '************';
    $client_key = '*******************';
    $data = [
        "10000001",
        "10000002",
        "10000003",
        // ...
    ];
    
    $jsonData = json_encode($data);
    
    $url = 'https://webapi.umtec.jp/miandan/api/get_seino_rsmile?client_key='.$client_key;
    
    $headers = [
        'Content-Type: application/json',
        "Authorization: Bearer {$token}"
    ];
    
    $ch = curl_init($url);
    
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
    
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    
    $response = curl_exec($ch);
    
    if (curl_errno($ch)) {
        echo 'cURL Error: ' . curl_error($ch);
    } else {
        echo 'Response: ' . $response;
    
        $info = curl_getinfo($ch);
        echo 'HTTP Code: ' . $info['http_code'];
        echo 'Total Time: ' . $info['total_time'];
    }
    
    curl_close($ch);
    ?>
    

    開発ドキュメント
    プリンタサーバー接続方法

    プリンタサーバーは WebSocket を通じて接続します。
  • 接続先:ws://localhost:3333
  • 
    // WebSocketサーバーへの接続   
    const ws = new WebSocket("ws://localhost:3333");                         
                            

    指令
  • 印刷指令:印刷対象のファイル名(管理番号)をプリンタサーバーに送信します。プリンタサーバーは指令を受信すると、あらかじめ設定されたプリンターで送り状を出力します。
  • 
    const message = {
        type: "print",
        filename: pdfFileName,
    };  
    ws.send(JSON.stringify(message));                          
                            
  • 印刷結果の返却:プリンタサーバーは印刷結果をクライアントに返送します。クライアントは返されたデータを用いて、必要な後処理を実施できます。
  • 
     ws.onmessage = (event) => {
        console.log("Receive message:", event.data);
        try {
            const jsonData = JSON.parse(event.data);
            if (jsonData.type === "print") {
                if (jsonData.result == 1) {
                    //印刷が成功しました。ここで印刷後の処理を追加できます。
                    const fileName = jsonData.fileName;//印刷されたファイル名を返されます。
                    const message = jsonData.message;//印刷結果を返されます。
                } else if (jsonData.result == 0) {
                    //印刷失敗しました。ここで印刷失敗後の処理を追加できます
                    const message = jsonData.message;//印刷結果を返されます。
                }
            }
        } catch (e) {
            console.error("Failed to parse JSON:", e);
        }
    };                        
                            
    完全なコードのサンプル(javascript)
    
    const ws = new WebSocket("ws://localhost:3333");
    ws.onopen = () => {
        console.log("WebSocket is opened.");
    };
    
    ws.onmessage = (event) => {
        console.log("Receive message:", event.data);
        try {
            const jsonData = JSON.parse(event.data);
            if (jsonData.type === "print") {
                if (jsonData.result == 1) {
                    //印刷が成功しました。ここで印刷後の処理を追加できます。
                    const fileName = jsonData.fileName;//印刷されたファイル名を返されます。
                    const message = jsonData.message;//印刷結果を返されます。
                } else if (jsonData.result == 0) {
                    //印刷失敗しました。ここで印刷失敗後の処理を追加できます
                    const message = jsonData.message;//印刷結果を返されます。
                }
            }
        } catch (e) {
            console.error("Failed to parse JSON:", e);
        }
    };
    
    ws.onerror = (error) => {
        console.error("WebSocket:", error);
    };
    
    ws.onclose = () => {
        console.log("WebSocket is closed.");
        ws = null;
    };
    
    //PDFファイルを印刷するときに使用する関数
    function shippsysPrint(pdfFileName) {
        const message = {
            type: "print",
            filename: pdfFileName,
        };
        if (ws && ws.readyState === WebSocket.OPEN) {
            ws.send(JSON.stringify(message));
            console.log("message send:", message);
        } else {
            console.error("Failed to connect to the print server, please check the server status.");
        }
    }