B2クラウド APIデータ交換規約（簡易版）

版数 1.0
ヤマト運輸株式会社

1.はじめに•B２クラウドAPIは、B２クラウドの機能をお客様システムから利用するための公開APIです。
お客様システムで入力された情報を元に、出荷データの登録確認や送り状の発行が可能となります。

貴社システムインターネット

出荷データ登録
出荷データ
修正・更新

B2クラウド送り状発行依頼

送り状印刷データ

送り状番号付データ

リクエスト
レスポンス

Copyright 2024 YamatoTransport Co., Ltd. All rights Reserved

12.ご利用パターン（画面APIを利用する）
お客様システムで入力された情報を、B2クラウドの画面で表示し、送り状の修正～送り状発行が行えます。

B2クラウド システム

利用者画面操作の流れ
貴社システム画面

仮データ登録・データチェック

登録・
B2クラウド画面へ

B2クラウド画面

データチェック後の出荷データ（エラー情報含む）
貴社システム上からB2クラウドの画面を呼び出す
仮データ更新・データチェック

更新・複数行変更
データチェック後の出荷データ（エラー情報含む）
送り状発行依頼
送り状発行画面

送り状発行

発行開始

発行ステータス（成功/失敗）
印刷状態確認印刷ステータス（成功/失敗）
印刷データ取得

印刷(プリンタダイアログ)
送り状発行処理がOKの場合、貴社システムに通知する
貴社システム画面
出荷データ確認PDFデータ

出荷データ取得
出荷データ（送り状番号採番済）

Copyright 2024 YamatoTransport Co., Ltd. All rights Reserved

23.ご利用パターン（画面APIを利用しない）
お客様のシステムとB2クラウド間で出荷データのやり取りを行い、送り状の修正～送り状発行が行えます。
お客様システム画面で編集や発行を行いたい場合にご利用ください。
※ブラウザ連携・サーバ間連携が可能です

貴社システムB2クラウド システム

利用者画面操作の流れ
貴社システム画面

仮データ登録・データチェック

登録・更新

データチェック後の出荷データ（エラー情報含む）
出荷データ登録
送り状発行依頼

発行ステータス（成功/失敗）
印刷状態確認
印刷状態確認印刷ステータス（成功/失敗）
印刷データチェック・PDFダウンロード

印刷データ取得
PDFデータ
出荷データ取得

送り状番号取得
出荷データ（送り状番号採番済）Copyright 2024 YamatoTransport Co., Ltd. All rights Reserved

34.API一覧
1. 画面APIを利用する場合
API

説明

仮データ登録・データチェック

今回発行する出荷データを一時的に登録し、出荷データのチェックを行う。

取込み結果表示画面

B2クラウド画面の画面を表示する。取込み結果表示画面から、出荷データの編集や、送り状の発行ができる。

印刷データ登録

印刷実行した出荷データを登録し、送り状PDFデータの存在チェックを行う。

伝票番号取得印刷発行済みの出荷データを取得する。

2. 画面APIを利用しない場合
API

説明

仮データ登録・データチェック

今回発行する出荷データを一時的に登録し、出荷データのチェックを行う。

仮データ取得

B2に登録した今回発行用の未印刷の出荷データを取得する。

仮データ更新・データチェック

伝票番号を採番し、発行済みの出荷データとし、印刷データの作成を開始する。

送り状発行

印刷データの作成が完了しているかどうか確認を行う。

印刷状態確認

印刷データの作成が完了しているかどうか確認を行う。

印刷データ登録

印刷実行した出荷データを登録し、送り状PDFデータの存在チェックを行う。

PDFダウンロード

印刷実行した送り状をPDFの形式で取得する。

伝票番号取得印刷発行済みの出荷データを取得する。

緊急時出荷登録B2クラウドで帳票出力ができない場合に、出荷データを発行済みとして登録する。

Copyright 2024 YamatoTransport Co., Ltd. All rights Reserved

45.通信、推奨環境•

B2クラウドでは、Accesstoken（時間制限無しの認証トークン）を使用して、認証を行います。
以下の値をHTTPリクエストヘッダに付与することで、B2クラウドで認証が実行されます。
Accesstokenには個々のユーザーのトークンを設定します。

•

B2クラウドで取り扱うデータはATOM(RFC4287)によって表現されます。
文字コードは、UTF-8です。
JSON、または、MessagePack形式に変換してください。

•B2クラウドは、REST(Representational State Transfer)の概念に基づき設計されており、リソースを一意に特定するURLに対してCRUD操作をします。
当インターフェースの通信プロトコルはHTTPSで、利用できる操作はGET、POST、PUTになります。

•推奨環境
日本語版オペレーティングシステム＜Windowsをご利用の場合＞
OS：Windows10・11
ブラウザ：Edge、Google Chrome＜Macintoshをご利用の場合＞
OS：macOS 13.2
ブラウザ：Google Chrome

Copyright 2024 YamatoTransport Co., Ltd. All rights Reserved

56.免責事項
1. 当社のインターフェースのご利用について
このデータ交換規約は当社の提供するインターフェースに関しての規約です。
なお、お客様がこのインターフェースを利用して自ら開発したシステムについてはお客様が一切の責任を負うことになります。
2. 利用上の制約について
当社は、お客様への通知を行うことなく、自己の裁量に基づいていつでもソフトウエアや特定の機能に関して利用の制約（たとえば、ソフトウエアを介して当社のサービスへのアクセス回数、アクセス時間などについて制限することなど）を行うことができるものとします。
また、ソフトウエアに関するサポートや修正版（アップデート版を含みます）の提供は、当社の裁量に基づいて行い、またあらかじめお客様へ通知を行うことなく、それらを終了する場合があります。
3. 禁止行為について
本サービスのご利用に際し、次に掲げる行為を禁止します。
①インターフェースを販売するなど営利目的で利用する行為②不正にアクセスする行為③不正なデータを送受信する行為④管理及び運営を妨害する行為⑤改変、改造、再配布する行為⑥公序良俗に反するサイトで利用する行為⑦その他当社が不適切と判断する行為
4. 保証について
当社は提供するインターフェースについて、エラーやバグ、論理的誤り、不具合、中断その他の瑕疵（かし）がないこと、信頼性、正確性、完全性、有効性について一切保証しておりません。
インターフェースは明示または黙示の有無にかかわらず、当社がその提供時において保有する状態で提供するものであり、特定の目的への適合性、有用性（有益性）、セキュリティ、権原および非侵害性について一切保証しておりません。
本ソフトウェアをご使用になりますと、お客様は上記事項に同意されたものとみなされます。

Copyright 2024 YamatoTransport Co., Ltd. All rights Reserved

6