Open Buy APIリファレンス
Open Buy APIは、すべてのサプライヤーのアイテムをリアルタイムで検索および購入するための、より高速で標準的で安全なインターフェースを提供するように設計されています。
はじめに
Open Buy APIは、すべてのサプライヤーのアイテムをリアルタイムで検索および購入するための、より高速で標準的なURLと安全なインターフェースを提供するように設計されています。 シンプルに設計されており、ほとんどのeコマースAPIが提供する一般的なパターンに従っています。
Open Buy APIの4つのコアコンセプトは次のとおりです。
- 認証
- 検索
- 詳細
- チェックアウト
Open Buy APIが顧客やバイヤーにどのように影響するかについては、 Open Buy API for Buyersを参照してください。
Postmanまたは別の OpenAPI 3.0 互換ツールで使用するためのOpen Buyスキーマファイルをダウンロードするか、 スキーマファイルをReDocのようなオンラインビューアで直接 表示します。
APIの操作については、Open Buyサポートチーム（ openbuy-support@coupa.com ）にお問い合わせください。
API開発が完了したら、ドキュメント（ openbuy-support@coupa.com）をお気軽に電子メールでお送りください。お客様が始めるのを助けるために、お客様と共有します。 それ以外の場合は、この短いフォームに必要事項を記入し、上記のアドレスにメールでお送りください。お客様向けの簡単なドキュメントを作成します。
認証方法
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 | 文字列 |
認証結果
認証リクエストの結果
| 要素 | 説明 | 必須フィールド？ | データタイプ |
|---|---|---|---|
| トークン | ベアラートークン | なし | 文字列 |
追加アイテムの詳細
値のペアに名前を付ける
| 要素 | 説明 | 必須フィールド？ | データタイプ |
|---|---|---|---|
| 名前 | Name | no | 文字列 |
| 値 | 価値 | なし | 文字列 |
検索結果
検索要求の結果
| 要素 | 説明 | 必須フィールド？ | データタイプ |
|---|---|---|---|
| カウント | 検索回数 | yes | 整数 |
| total_count | カタログ内のおおよその総数 | no | 整数 |
| 結果 | 結果 | なし | アイテムの結果（下の表を参照） |
商品の結果
アイテムデータのリクエストの結果
| 要素 | 説明 | 必須フィールド？ | データタイプ |
|---|---|---|---|
| item_id | 一意のアイテムID | なし | 文字列 |
| source_part_num | サプライヤー部品番号 | no | 文字列 |
| title | 文字列 アイテムのタイトル | なし | 文字列 |
| タイプ | 文字列 アイテムタイプ（アイテム、グループ）。 グループは、購入可能なアイテムの親を表します。 | no | 文字列 |
| image | 商品画像のURL | no | 文字列 |
| サムネイル | 商品のサムネイル | なし | 文字列 |
| 価格 | 価格 | no | 数字 |
| currency | Currency | なし | 文字列 |
| listPrice | 定価 | no | 数字 |
| uom | 価格 | no | 文字列 |
| summary | 商品の詳細な説明 | なし | 文字列 |
| manufacturer_name | 製造業者名 | no | 文字列 |
| manufacturer_part_num | 製造業者品番 | no | 文字列 |
| source_part_auxiliary_id | サプライヤーAUX部品番号 | no | 文字列 |
| unspsc | UNSPSC | no | 文字列 |
| リードタイム | リードタイム | なし | 文字列 |
| min_order_quantity | 最小注文数量 | なし | 数字 |
| max_order_quantity | 最大注文数量 | なし | 数字 |
| order_increment_quantity | 注文インクリメント番号 | なし | 数字 |
| 数量 | チェックアウトの数量 | no | 数字 |
| tableDetails | テーブルに表示されている場合に表示する列 | no | 文字列 |
| 詳細 | 詳細 | no | 追加アイテムの詳細（上の表を参照） |
| detaillinks | 詳細リンク | no | 追加アイテムの詳細（上の表を参照） |
| detailimages | 画像の詳細 | no | 追加アイテムの詳細（上の表を参照） |