B2クラウドAPI連携機能

1.概要

B2クラウドAPI連携機能は、ヤマト運輸様が提供する「送り状発行システムB2クラウド」とAPI連携できる機能です。

aishipからB2クラウドへの出荷情報の連携、B2クラウド上での送り状発行、B2クラウドからaishipへ出荷実績（問い合わせ番号、配送会社）の登録をaishipの管理画面上から自動で行うことができます。B2クラウドへの連携処理の流れは以下の図の通りです。

図.aishipからB2クラウドへの出荷情報連携フロー

2.B2クラウドAPI連携の利用にあたり

B2クラウドAPI連携機能を利用する場合、「B2クラウドAPI連携機能」のオプション申込（利用料無料）が必要です。

ご希望の方は、aiship管理画面のオプション申込から「B2クラウドAPI連携」を選択し、お申込みください。

3.機能詳細

ここではB2クラウドAPI連携の各機能について説明します。

3.1.B2クラウドAPI連携を利用する

B2クラウドAPI連携の利用にあたり、B2クラウドのAPIアクセス認証キーが必要になります。APIアクセス認証キーの発行はB2クラウドの管理画面で操作していただく必要があります。詳細は下記リンクをご確認頂くかヤマト運輸様までお問い合わせください。

＞＞　「APIアクセス認証キー」の確認方法を教えてください。

発行したAPIアクセス認証キー、その他各種情報を管理画面（システム管理＞B2クラウドAPI）にて登録していただくと、B2クラウドAPI連携が利用可能になります。詳細は下記リンクをご確認ください。

＞＞「システム管理_B2クラウドAPI」へ

3.2.aishipからB2クラウドへ出荷情報を連携

aishipから連携する注文を選択しB2クラウドへ出荷情報を連携します。

3.2.1.aishipからB2クラウドへ連携操作

aishipからB2クラウドへの出荷情報連携は受注管理＞受注一覧で行います。

3.2.1.1.出荷情報の連携を実行

受注管理＞受注一覧でB2クラウドに連携したい注文を選択して「連携」ボタンを押下します。

一度に連携できる注文数は、受注一覧で表示できる最大表示件数までです。

図.受注一覧でB2クラウドに連携する注文を選択する

3.2.1.2.aishipからB2クラウド画面への連携結果の確認

aishipからB2クラウドへ出荷情報連携結果については、受注管理＞受注一覧画面上の「連携結果確認」モーダル画面から確認することができます。あわせて「システム管理＞B2クラウドAPI」で設定した通知メールアドレス宛への通知メールで確認することもできます。詳細は「3.4.aishipとB2クラウド間の出荷情報連携、出荷実績連携の結果を確認する」をご確認ください。

3.2.1.3.B2クラウド画面で連携した出荷情報を確認

aishipからB2クラウドへ出荷情報を連携すると、B2クラウドの編集画面が別タブで開きます。

連携の際は、各項目を「3.2.3.連携項目」の内容に基づいて連携します。

取り込まれた出荷情報の送り状が印刷可能である場合、選択欄のチェックボックスが選択状態で表示されます。

図.B2クラウド（送り状印刷が可能な状態）

3.2.1.4.B2クラウド画面で連携した出荷情報を修正・編集

取り込まれた出荷情報について修正が必要な場合、枠が赤く表示されます。 必要に応じてB2クラウドの編集画面で出荷情報を修正してください。

図.B2クラウド（修正が必要な状態）

送り状の内容を変更されたい場合も、必要に応じてB2クラウドの編集画面で出荷情報を修正してください。

以下のようなケースが該当します。

【ケース1】配送方法が「メール便」の注文ため、送り状種類を「クロネコゆうメール」「ネコポス」に変更したい。

【対処】B2クラウドの編集画面を開き「送り状の種類」を希望のものに選択してください。

【ケース2】（食品ギフトオーナー以外）配送方法が「クール便」の注文のため、クール便用の送り状を発行したい。

【対処】 B2クラウドの編集画面を開き「クール便」を希望のものに選択してください。

3.2.2.連携条件

以下に該当する出荷情報は連携対象外となります。

※選択された場合、自動的に除外されます。

※複数配送受注内に条件に合致する出荷情報が混在する場合、対象の出荷情報のみが自動連携されます。

・ソーシャルギフト注文かつ、住所情報が「未入力」で出荷先が確定してない

・全ての商品が「キャンセル」「返品」となっている

・問い合わせ番号がすでに登録されている

・削除済された配送先

3.2.3.連携項目

aishipからB2クラウドへ連携する情報について記載します。

表.aishipからB2クラウドへAPI連携する出荷情報の項目

その他の項目（ご依頼主情報、送付先情報等）については、ヤマトB2形式のCSVエクスポートに準じます。

詳細な出力内容や出力条件はマニュアルのCSVレイアウトを確認してください。

＞＞「CSVレイアウト（ヤマトB2形式）」へ

また、システム管理＞B2クラウドAPI連携で「ご依頼主に販売者情報を使用する／しない」で「使用する」に設定した場合、ご依頼主情報にサイトの販売者情報を設定することも可能です。「ご依頼主に販売者情報を使用する」とした場合の依頼主情報に関する詳細な出力内容や出力条件は下記マニュアルのCSVレイアウトを確認してください。

＞＞「CSVレイアウト（ヤマトB2形式(ご依頼主に販売者情報を使用)）」へ

3.2.3.1.配達時間帯指定について

B2クラウドに出荷情報を連携する配達時間帯は、ヤマトが指定するタイムゾーンに合わせる必要があります。

設定は、管理画面のカート管理＞配送希望日時設定から設定してください。

表.指定時間帯コードの設定

3.2.4.B2クラウド上で送り状を発行する

B2クラウドの画面で「発行開始」のボタンを押下すると、aishipから連携した出荷情報に対しB2クラウド上で問い合わせ番号（伝票番号）が採番され、送り状が印刷されます。送り状が印刷されると、aishipへ出荷実績を連携します。詳細は「3.3.B2クラウドからaishipへ出荷実績を登録する」を確認してください。

送り状が印刷されないと、B2クラウド上で出荷情報が保存されず問い合わせ番号も発行されないままとなり、aishipへ出荷実績を連携することができません。aishipへ出荷実績を連携するためには、必ず「発行開始」ボタンを押下していただき、送り状の印刷処理まで完了するようにしてください。

3.3.B2クラウドからaishipへ出荷実績を登録する

3.2.4で送り状を印刷した後、B2からaishipへ印刷完了の通知が送られると同時に、出荷実績が連携されます。

出荷実績が連携されると、aishipは各出荷情報に「問い合わせ番号」と「配送会社（ヤマト運輸）」を登録します。

登録処理が完了すると「システム管理＞B2クラウドAPI」で設定した通知メールアドレス宛へ通知メールが送信されます。

出荷実績の登録結果の確認の詳細は「3.4.aishipとB2クラウド間の出荷情報連携、出荷実績連携の結果を確認する」をご確認ください。

3.4.出荷情報連携および出荷実績連携の結果を確認する

aishipとB2クラウド間の連携結果の確認方法について説明します。

3.4.1 通知メールで確認

aishipからB2クラウドへの出荷情報連携が正常に終了すると、と「システム管理＞B2クラウドAPI」で設定した通知メールアドレス宛に結果の通知メールが送信されます。メールにはB2クラウドへの連携が成功した出荷情報のお客様管理番号の一覧が記載されます。

図.通知メールの例（aishipからB2クラウドへの出荷情報連携結果）

B2クラウドからaishipへ出荷実績が連携された場合も通知メールが送信されます。aiship上で問い合わせ番号、配送会社の登録が正常に完了した後、メールが送信されます。メールには問い合わせ番号・配送会社の登録が成功した出荷情報のお客様管理番号の一覧が記載されます。

図.通知メールの例（B2クラウドからaihsipへの出荷実績連携結果）

何らかの理由でB2クラウドの出荷情報連携が失敗した場合、失敗した旨をメールで通知します。メールの内容をご確認いただき、再度実行していただくか、それでも解決しない場合はお手数ですがaishipサポートセンターまでお問い合わせください。

図.通知メールの例（出荷情報の連携が失敗した場合）

3.4.2.受注管理＞受注一覧の「連携結果確認」モーダル画面で確認

連携結果は受注管理＞受注一覧の「連携結果確認」モーダル画面からも確認できます。

aishipとB2クラウド間の出荷情報連携が完了すると、連携結果が記録されモーダルウィンドウで履歴が確認できるようになります。

連携結果は直近1週間分の履歴を確認することができます。

図.連携結果確認のモーダル画面

表.連携結果確認の表示項目

4.補足事項

・「3.2.4 aishipからB2クラウドへ出荷情報を連携する」時点では、B2クラウドに出荷情報は保存されていない状態です。

この段階でB2クラウドの画面を閉じるとB2クラウド上で出荷情報のデータは消失してしまうため、再度同じ注文を選択しB2クラウドへ連携する必要があります。

・一度に連携できる注文は受注一覧上に表示されている注文のみです。

受注一覧の最大表示件数以上の注文数をB2クラウドに連携したい場合は、お手数ですが分割して

「3.2.3 aishipからB2クラウドへ出荷情報を連携する」〜「3.2.5.B2クラウドからaishipへ出荷実績を登録する」の操作を実施してください。

5.関連記事

・B2クラウドとAPI連携するために必要な設定を行う

＞＞「システム管理_B2クラウドAPI」へ

・aishipからB2クラウドへ出荷情報をAPI連携する

＞＞「受注管理_受注一覧」へ