Open Buy APIリファレンス
Open Buy APIは、すべてのサプライヤーのアイテムをリアルタイムで検索および購入するための、より高速で標準的で安全なインターフェースを提供するように設計されています。
概要
Open Buy APIは、すべてのサプライヤーがリアルタイムでアイテムを検索および購入するための、より高速で標準的なURLと安全なインターフェースを提供するように設計されています。 シンプルに設計されており、ほとんどのeコマースAPIが提供する一般的なパターンに従っています。
Open Buy APIの4つのコアコンセプトは次のとおりです。
- 認証
- 検索
- 詳細
- チェックアウト
ページの内容には、サプライヤー向けのOpen Buy APIに関する情報が含まれています。
詳細は、バイヤーは Open Buy API for Buyers をご参照ください（Coupa Enterpriseアカウントでのログインが必要です）。
Postmanまたはその他の OpenAPI 3.0 互換ツールで使用するために Open Buyスキーマファイル をダウンロードするか、ReDocなどのオンラインビューアで スキーマファイルを直接表示 してください。
APIの操作については、Open Buyサポートチーム（ openbuy-support@coupa.com ）にお問い合わせください。
API開発が完了したら、次の手順に従ってください。
ドキュメントを openbuy-support@coupa.com までメールアドレスでお送りください。お客様が開始する際に役立てるために共有させていただきます。または、
次の情報を記載したメールを openbuy-support@coupa.com に送信してください。お客様向けの簡単なドキュメントを作成いたします。
担当者のメールアドレス。
APIに関する質問や技術サポートの場合に備えて、このメールアドレスが特定の個人ではなくメールグループであることが望ましいです(例: IT@xxx.com)。
API認証情報の形式。
追加メモ(存在する場合)。
認証方法
Open Buy APIは、次の方法で認証できます。
-
ユーザー名とパスワード（ cXML ID/シークレットペアに似ています）
-
OAuth
アクション
Open Buy APIを使用すると、次のことができます。
| API | 動詞 | パス | アクション | 説明 |
|---|---|---|---|---|
| 認証 | POST | /authentication/v1.0.0 | authenticate | サプライヤーサイトでの認証。 |
| 検索 | POST | /search/v1.0.0 | search | 検索クエリに基づいてアイテムデータを取得します。 |
| 詳細 | POST | /detail/v1.0.0 | 詳細 | 詳細な確認のために特定のアイテムのアイテムデータを取得します。 |
| チェックアウト | POST | /checkout/v1.0.0 | チェックアウト | 購入のためのアイテムデータの取得。 |
認証
| API | 動詞 | パス | アクション | 説明 |
|---|---|---|---|---|
| 認証 | POST | /authentication/v1.0.0 | authenticate | サプライヤーサイトでの認証。 |
認証要求の例
{" credentials ":" 423 j 23 j 2 j 334 l 4 s 04 "," email ":" email@coupa.com "}レスポンス
| コード | 説明 |
|---|---|
| 200 |
トークンの取得に成功しました。 例: |
| 400 |
無効なリクエストパラメータです。取得を試みることができませんでした。 |
| 401 |
権限がありません. |
| 500 |
リクエスト中にサービスエラーが発生しました。 しばらくしてから再試行してください。 |
検索
| API | 動詞 | パス | アクション | 説明 |
|---|---|---|---|---|
| 検索 | POST | /search/v1.0.0 | search | 検索クエリに基づいてアイテムデータを取得します。 |
パラメーター
| 要素 | 説明 | 必須フィールド？ | 一意？ | 許容値 | データタイプ |
|---|---|---|---|---|---|
| query | 検索クエリ | yes | no | any | 文字列 |
| page_number | 結果のページ番号 | no | no | any | 数字 |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
検索結果が正常に取得されました。 例: |
| 400 |
無効なリクエストパラメータです。取得を試みることができませんでした。 |
| 401 |
権限がありません. |
| 500 |
リクエスト中にサービスエラーが発生しました。 しばらくしてから再試行してください。 |
詳細
| API | 動詞 | パス | アクション | 説明 |
|---|---|---|---|---|
| 詳細 | POST | /detail/v1.0.0 | 詳細 | 詳細な確認のために特定のアイテムのアイテムデータを取得します。 |
パラメーター
| 要素 | 説明 | 必須フィールド？ | 一意？ | 許容値 | データタイプ |
|---|---|---|---|---|---|
| item_id | 一意のアイテムID | yes | no | any | 文字列 |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
アイテムが正常に取得されました |
| 400 |
無効なリクエストパラメータです。取得を試みることができませんでした。 |
| 401 |
権限がありません |
| 500 |
リクエスト中にサービスエラーが発生しました。 しばらくしてから再度お試しください |
チェックアウト
| API | 動詞 | パス | アクション | 説明 |
|---|---|---|---|---|
| チェックアウト | POST | /checkout/v1.0.0 | チェックアウト | 購入のためのアイテムデータの取得。 |
パラメーター
| 要素 | 説明 | 必須フィールド？ | 一意？ | 許容値 | データタイプ |
|---|---|---|---|---|---|
| item_id | 一意のアイテムID | yes | yes | any | 文字列 |
| quantity | Quantity | no | no | any | 文字列 |
レスポンス
| コード | 説明 |
|---|---|
| 200 |
アイテムが正常に取得されました |
| 400 |
無効なリクエストパラメータです。取得を試みることができませんでした。 |
| 401 |
権限がありません |
| 500 |
リクエスト中にサービスエラーが発生しました。 しばらくしてから再度お試しください |
Open Buy APIスキーマ
認証要求
アクセストークンを取得するための資格情報とメールアドレス。
| 要素 | 説明 | 必須フィールド？ | データタイプ |
|---|---|---|---|
| 資格情報 |
セッションを承認するサプライヤー固有の文字列。 例には、リフレッシュトークン、ユーザーとパスワード、または認証キーが含まれます。 | no | 文字列 |
|
ユーザーのメールアドレス | no | 文字列 |
認証結果
認証リクエストの結果
| 要素 | 説明 | 必須フィールド？ | データタイプ |
|---|---|---|---|
| トークン |
ベアラートークン | no | 文字列 |
追加アイテムの詳細
値のペアに名前を付ける
| 要素 | 説明 | 必須フィールド？ | データタイプ |
|---|---|---|---|
| 名前 | Name | no | 文字列 |
| 値 | 価値 | no | 文字列 |
検索結果
検索要求の結果
| 要素 | 説明 | 必須フィールド？ | データタイプ |
|---|---|---|---|
| カウント |
検索回数 | yes | 整数 |
| total_count | カタログ内のおおよその総数 | no | 整数 |
| 結果 | 結果 | no |
アイテムの結果（下の表を参照） |
商品の結果
アイテムデータのリクエストの結果
| 要素 | 説明 | 必須フィールド？ | データタイプ |
|---|---|---|---|
| item_id |
一意のアイテムID | no | 文字列 |
| source_part_num |
サプライヤー部品番号 | no | 文字列 |
| title | 文字列 アイテムのタイトル | no | 文字列 |
| type | 文字列 アイテムタイプ（アイテム、グループ）。 グループは、購入可能なアイテムの親を表します。 | no | 文字列 |
| image |
商品画像のURL | no | 文字列 |
| サムネイル |
商品のサムネイル | no | 文字列 |
| 価格 |
Price | no | 数字 |
| currency |
Currency | no | 文字列 |
| listPrice |
定価 | no | 数字 |
| uom |
Price | no | 文字列 |
| summary |
商品の詳細な説明 | no | 文字列 |
| manufacturer_name |
製造業者名 | no | 文字列 |
| manufacturer_part_num |
製造業者品番 | no | 文字列 |
| source_part_auxiliary_id |
サプライヤーAUX部品番号 | no | 文字列 |
| unspsc |
UNSPSC | no | 文字列 |
| リードタイム |
リードタイム | no | 文字列 |
| min_order_quantity |
最小注文数量 | no | 数字 |
| max_order_quantity | 最大注文数量 | no | 数字 |
| order_increment_quantity |
注文インクリメント番号 | no | 数字 |
| quantity |
チェックアウトの数量 | no | 数字 |
| tableDetails | テーブルに表示されている場合に表示する列 | no | 文字列 |
| 詳細 | 詳細 | no | 追加アイテムの詳細（上の表を参照） |
| detaillinks | 詳細リンク | no | 追加アイテムの詳細（上の表を参照） |
| detailimages | 画像の詳細 | no | 追加アイテムの詳細（上の表を参照） |