ユーザーマニュアル
ヘルプセンター/ユーザーマニュアル/Brightpearl 接続:注文を取り込み、在庫を確認

Brightpearl 接続:注文を取り込み、在庫を確認

最終更新 2026-11-01

まず Brightpearl 開発者ポータルであなたのアプリから app_ref と dev_ref を取得し、次にアカウントの OAuth 認証を実行して access token と、datacenter 用の api_domain を取得し、5 項目すべてを Integration に入力して、テスト・マッピング・有効化を行います。販売注文が取り込まれ、在庫を確認できます。

Brightpearl コネクタは Brightpearl の販売注文をこのシステムに取り込み、Brightpearl にある製品の在庫可用性を確認できます。Brightpearl から読み取る接続です:Brightpearl から顧客は取り込まず、在庫やその他の変更を Brightpearl に返送しません。ここでは順序が重要です。datacenter の値はリストから選ぶものではなく、OAuth トークンの応答で api_domain として返されます。そのため、先に認証を完了し、その後に接続を入力します。

Brightpearl 接続手順:アプリ参照、OAuth でトークンと api_domain、入力、テスト、Mapping、有効化。

前提条件#

  • Brightpearl アカウントと、そのアカウントコード。アカウントコードは Brightpearl アドレスのサブドメイン部分です。例えば acme.brightpearl.com のアカウントコードは acme です。
  • developer.brightpearl.com の Brightpearl 開発者ポータルへのアクセスと、この統合用のアプリ。アプリ参照と開発者参照が必要です。
  • その Brightpearl アカウントについて、認証情報の手順で示す認証アドレスから OAuth2 Authorization Code フローを完了できること。
  • datacenter の逆向きの順序を理解していること:認証後に、トークン応答の api_domain として取得します。推測したり、アカウントのサブドメインを入力したりしないでください。

認証情報の取得#

  1. まずアカウントコードを控えます:Brightpearl アドレスのサブドメイン部分です。例えば acme.brightpearl.com の acme です。
  2. developer.brightpearl.com の Brightpearl 開発者ポータルを開き、アプリを開いて、そのアプリ参照を控えます。これが app_ref の値です。同じアプリ参照は OAuth フローで client_id としても使われます。
  3. 同時に開発者参照も控えます。これが dev_ref の値です。各リクエストで brightpearl-dev-ref ヘッダーとして送信され、app_ref は brightpearl-app-ref ヘッダーとして送信されます。
  4. https://oauth.brightpearl.com/authorize/{account} からアカウントの OAuth 認証を開始し、{account} には自分のアカウントコードを入れ、Authorization Code Grant フローを完了して access token を取得します。
  5. 同じトークン応答から 2 つの値を控えます:access_token 自体と、api_domain の値です。api_domain(例:use1.brightpearlconnect.com)がそのまま datacenter フィールドに入る内容です。応答からコピーし、自分で組み立てないでください。
5 つの値は 3 つの異なる場所から来ます:アカウントコードは Brightpearl アドレスから、app_ref と dev_ref は開発者ポータルから、access_token と datacenter は OAuth トークン応答からです。認証を実行する前に 5 項目すべてを入力しようとしても、最後の 2 つは正しくなりません。

Integration への入力#

  1. Integration → コネクタマーケットプレイス → Brightpearl → 新規接続 を開きます。以下の 5 フィールドはすべて必須です。
  2. account、必須、Brightpearl アカウントコード:Brightpearl アドレスのサブドメイン部分(例:acme)です。
  3. datacenter、必須、API データセンターのドメイン:OAuth トークン応答で返された api_domain(例:use1.brightpearlconnect.com)を入力します。ここにアカウントのサブドメインを入力しないでください。
  4. app_ref、必須、アプリ参照:developer.brightpearl.com の Brightpearl 開発者ポータルにあるあなたのアプリのアプリ参照です。
  5. dev_ref、必須、開発者参照:あなたの Brightpearl 開発者参照です。各リクエストで brightpearl-dev-ref ヘッダーとして送信されます。
  6. access_token、必須、OAuth2 アクセストークン:Authorization Code Grant フローで取得した access token を貼り付けます。パスワード型のフィールドで、秘密情報として保存されます。

接続テスト#

接続テストをクリックします。テストはまず 5 フィールド(account、datacenter、app_ref、dev_ref、access_token)をすべて確認し、いずれかが未入力であれば、リクエストを送る前に止まり、未入力フィールドを報告します。それ以外の場合、3 つのヘッダー(トークン付きの Authorization: Bearer、brightpearl-dev-ref、brightpearl-app-ref)を付けて、注文ステータスの参照データを読むリクエストを送信します:GET https://{datacenter}/public-api/{account}/order-service/order-status。アドレスの {datacenter} と {account} には自分の値が入ります。Brightpearl で最も軽い読み取り専用の確認です。200 が返れば接続は機能しています。401 はトークンに、403 は権限に問題があることを示します。テストは 12 秒でタイムアウトします。

Mapping / テンプレート選択#

Brightpearl 標準の Mapping を選択します。販売注文は Brightpearl の注文サービスの検索で見つけ、その後に全体を読み取ります。在庫確認は倉庫サービスから製品の可用性を読みます。テスト合格後、1 回取得を実行し、実注文を並べて確認してください(注文番号、注文に表示される顧客名、明細、数量)。さらに 1 製品の可用性を Brightpearl の表示と照合してから有効化します。注文の項目が異なる場合は、Brightpearl のレコードを変更せず、Mapping でその項目を調整してください。

Brightpearl のデータフロー:販売注文を取り込み、在庫の可用性は Brightpearl から読み取ります。

有効化#

有効化後、接続は設定した頻度で Brightpearl の販売注文をこのシステムに取り込み、在庫確認では Brightpearl の現在の製品可用性を読み取ります。最初は Runs / Logs で取得を確認し、Brightpearl と照合してから無人運用に移してください。access token が機能しなくなったら、同じアカウントで OAuth 認証を再実行し、新しいトークン応答から access_token と datacenter を一緒に更新してください。

この接続が行わないこと:Brightpearl から顧客を取り込まず、在庫、注文ステータス、履行実績を Brightpearl に返送しません。これらは引き続き Brightpearl 自体で、または実際の作業を行うシステムで処理してください。

よくある質問#

テストが 401 で失敗する — トークンに問題がある

Brightpearl がテストで送信された access token を受け入れませんでした。access_token フィールドのトークンが誤っている、不完全である、またはこのアカウントについて Authorization Code Grant フローで取得されたものではありません。テストは Bearer トークンの確認として注文ステータスの参照データを読み、Brightpearl が受け入れられないトークンはまずここで失敗します。

https://oauth.brightpearl.com/authorize/{account} から自分のアカウントコードで認証を再実行し、Authorization Code Grant フローを完了し、新しい access token を全文貼り付け、同じトークン応答から api_domain として datacenter を再コピーしてください。保存して再テストしてください。

テストが 403 で失敗する — 権限の問題

これは 401 とは異なります。トークンは受け入れられましたが、その背後にあるアプリまたはアカウントに、テストで使う注文ステータスの参照データを読む許可がありません。同じアプリと同じアクセスで認証を再実行しても 403 が返り続けます。

Brightpearl で app_ref で特定されるアプリがこのアカウントについて何にアクセスできるかを確認し、dev_ref と app_ref がトークンと組みで使う正確なペアであるか確認してください。アプリに接続が必要な読み取りアクセスを与えるか、すでにそれを持つアプリを使い、再認証して新しいトークン応答でフィールドを更新し、再テストしてください。

テストがリクエストを送る前に止まり、未入力フィールドを報告する

必須 5 フィールド(account、datacenter、app_ref、dev_ref、access_token)のいずれかが空です。テストがまず 5 つすべてを確認するのは、リクエストアドレスに account と datacenter が、リクエストヘッダーに app_ref、dev_ref、トークンが必要だからです。

不足しているフィールドをそれぞれの取得元から入力してください:account は Brightpearl アドレスから、app_ref と dev_ref は開発者ポータルから、access_token と datacenter は OAuth トークン応答からです。保存して再テストしてください。

アカウントのサブドメインを datacenter に入力し、テストが失敗する

account と datacenter は形の異なる別の値です。account は Brightpearl アドレスのサブドメイン(例:acme)です。datacenter は OAuth トークン応答で返される api_domain で、use1.brightpearlconnect.com のような形です。datacenter フィールドに account の値を入れると、テストリクエストが誤ったアドレスに送信されます。

OAuth 認証のトークン応答に戻り、api_domain の値を datacenter フィールドにそのままコピーし、account はサブドメインだけにし、保存して再テストしてください。

接続済みだが販売注文が取り込まれない

接続は機能しています(テストで注文ステータスの参照データを正常に読みました)が、新しく取り込むものがありません。取得範囲内にこのアカウントの新しい販売注文が Brightpearl にないか、それらの注文が接続のアカウントコードとは別のアカウントにあります。

接続と同じアカウントコードで Brightpearl に販売注文を 1 件作成または確認し、手動取得を実行して、プレビューまたは Runs / Logs に注文が表示されるか確認してください。

在庫確認で、ある製品の可用性が返らない

接続は Brightpearl の製品可用性を読めますが、その製品に対応する可用性レコードがないか、Mapping の製品コードが Brightpearl の製品と一致していません。テストが合格しても、特定の製品だけ何も返らないことがあります。

まず Brightpearl でその製品と可用性を確認し、次に Mapping のその品目の製品コードを確認して Brightpearl と一致するよう修正してください。その製品だけ在庫確認を再実行してください。