API V3 - 部分請求書、支払い、フルフィルメント

August 21, 2025

この度、Brandboom API V3をリリースいたしました。本アップデートにより、注文後のワークフローをプログラムでより詳細に制御できるようになります。請求書発行からフルフィルメントまで、販売サイクル全体をAPI経由で直接管理することが可能です。

V3の主な新機能は以下の通りです:
‍

1. 高度な請求書管理

請求書の作成、更新、送信をプログラムで実行できるようになりました。注文確定直後の請求書発行や、条件変更に伴う修正など、新しいエンドポイントによりBrandboomと社内ERP間のシームレスな同期が実現します。

  • 一部数量の請求: APIを使用して一部数量の請求書をバックエンドからBrandboomへ送信できます。分割出荷やバックオーダーなど、現在利用可能な分のみを請求する場合に最適です。
  • 一方向同期(信頼できる唯一の情報源): データの整合性を保つため、API経由で作成された請求書はBrandboom UI上では編集不可となります。すべての更新はバックエンドシステムから同期する必要があり、ERPが常にマスターデータとして機能します。
  • APIによるメール送信: 新しいinvoices/sendエンドポイントを使用すると、請求書確定後、システムから直接Brandboomの公式請求書メールをバイヤーに送信できます。
  • 支払い回収: 請求書詳細はAPIで管理されますが、Brandboomを通じて請求書を顧客に送信し、当社の安全な決済ツールを使用して支払いを受け取ることも可能です。
  • 修正ツール: 新しいinvoices/deleteエンドポイントにより、誤った請求書をプログラムで無効化または削除できます。

‍

2. 支払いと返金

財務管理がより簡単になりました。API V3では以下の操作が可能です:

  • 支払いの追加: システムで支払いが完了した際、特定の請求書に対して自動的に支払いを記録します。
  • 返金処理: API(payments/refund)を通じて直接返金処理と記録を行い、Brandboomの記録を銀行口座の状況と常に一致させます。
  • エラー修正: 新しいpayments/deleteエンドポイントにより、返金イベントを発生させることなく、誤った支払いエントリ(金額や日付の誤りなど)を削除し、台帳を正確に保つことができます。

‍

3. フルフィルメントと出荷追跡

APIを使用して請求書に出荷情報を追加することで、フルフィルメント業務を効率化できます。

  • Flexible Linking: Tie a shipment to an invoice using either the Brandboom invoiceID or your system's externalInvoiceID.
  • Tracking Integration: Push tracking numbers and carrier details directly to the invoice (shipments/create), automatically populating tracking links for your buyers.
  • Status Updates: Use the shipments/updateStatus endpoint to keep shipment statuses (e.g., "In Transit", "Delivered") in sync without re-uploading the entire shipment object.
  • Corrections: If a shipment is created in error, use shipments/delete to remove it instantly.

‍

4. 注文エンドポイントの強化

ordersリソースを大幅にアップグレードし、ステータスの直接操作とワークフロー管理が可能になりました:

  • 注文の拒否: 新しいorders/rejectエンドポイントにより、在庫不足や承認フローの結果に基づき、プログラムで注文を拒否できます。
  • 詳細なステータス制御: orders/updateを使用して、倉庫業務に合わせたステータス文字列を設定できます:
  • 注文ステータス:open、processing、complete‍
  • 支払いステータス:not_paid、partially_paid、paid‍
  • 出荷ステータス:not_shipped、pick_and_pack、partially_pick_and_pack、shipped、partially_shipped‍
  • エクスポートステータス:not_exported、export_ready、exporting、exported
    ‍

導入の準備はよろしいですか?

‍‍詳細なドキュメントと統合ガイドは、Brandboom開発者ポータルでご確認ください。

実装に関するサポートが必要ですか?新しいAPI V3の統合について、サポートチームまでお気軽にお問い合わせください。