JA globe icon
user icon
このページ
  • 最終編集日時: 09 November 2023
何かお探しですか？ 製品 Coupa製品ドキュメンテーション サプライヤー向けリソース サプライヤー向け 統合リソース Open Buy APIリファレンス

Open Buy APIリファレンス

Open Buy APIは、すべてのサプライヤーがリアルタイムでアイテムを検索および購入するための、より高速で標準的で安全なインターフェースを提供するように設計されています。

はじめに

Open Buy APIは、すべてのサプライヤーがリアルタイムでアイテムを検索および購入するための、より高速で標準的で安全なインターフェースを提供するように設計されています。シンプルに設計されており、ほとんどのeコマースAPIが提供する一般的なパターンに従っています。

Open Buy APIの4つのコアコンセプトは次のとおりです。

Open Buy APIが顧客やバイヤーに与える影響については、「バイヤー向けOpen Buy API」を参照してください。

Postmanまたは別のOpenAPI 3.0互換ツールで使用するOpen Buyスキーマファイルをダウンロードするか、ReDocなどのオンラインビューアでスキーマファイルを直接表示します。

認証方法

Open Buy APIは、次の方法で認証できます。

  • ユーザー名とパスワード（ cXML ID/シークレットペアに似ています）

  • OAuth

アクション

Open Buy APIを使用すると、次のことができます。

API 動詞 パス アクション 説明
認証 投稿 /authentication/v1.0.0 authenticate サプライヤーサイトとの認証
検索 投稿 /search/v1.0.0 検索 検索クエリに基づいてアイテムデータを取得する
詳細 投稿 /detail/v1.0.0 detail 詳細なレビューのために特定のアイテムのアイテムデータを取得する
チェックアウト 投稿 /checkout/v1.0.0 会計 購入のアイテムデータを取得する

    認証

    API 動詞 パス アクション 説明
    認証 投稿 /authentication/v1.0.0 authenticate サプライヤーサイトとの認証

    例の認証要求

    {

	"credentials ":"423 j 23 j 2 j 334 l 4 s 04 ",

	"email ":" email@coupa.com "

}

    回答

    コード 説明
    200

    トークンが正常に取得されました

    

{

"トークン":"ABC 12345"

}

     
    400

    無効なリクエストパラメーターです。取得を試みることができませんでした。
    401

    権限がありません
    500

    申請中にサービスエラーが発生しました。しばらくしてからもう一度お試しください

    検索

    API 動詞 パス アクション 説明
    検索 投稿 /search/v1.0.0 検索 検索クエリに基づいてアイテムデータを取得する

    パラメーター

    要素 説明 必須フィールドですか？ 一意ですか？ 許容値 データタイプ
    query 検索クエリ はい いいえ 任意の string
    page_number 結果のページ番号 no no 任意の number

    回答

    コード 説明
    200

    検索結果が正常に取得されました

    

{

	"count ":0,

	"total_count ":0,

	"results ": [

		{

			"ソース品番":１ ２ ３ ４ ５、

			"タイトル":"レザーグローブ- XL ",

			"url ":" https :// localhost/image ",

			"price ":100,

			"通貨":"USD ",

			"uom ":「EA」

		}

	]

}
    400

    無効なリクエストパラメーターです。取得を試みることができませんでした。
    401

    権限がありません
    500

    申請中にサービスエラーが発生しました。しばらくしてからもう一度お試しください

    詳細

    API 動詞 パス アクション 説明
    詳細 投稿 /detail/v1.0.0 detail 詳細なレビューのために特定のアイテムのアイテムデータを取得する

    パラメーター

    要素 説明 必須フィールドですか？ 一意ですか？ 許容される値 データタイプ
    アイテムID 一意のアイテムID はい いいえ any string

    回答

    コード 説明
    200

    アイテムが正しく取得されました

    

{

	"ソース品番":１ ２ ３ ４ ５、

	"タイトル":"レザーグローブ- XL ",

	"url ":" https :// localhost/image ",

	"price ":100,

	"currency ":"米ドル",

	"uom ":「EA」

}
    400

    無効なリクエストパラメーターです。取得を試みることができませんでした。
    401

    権限がありません
    500

    申請中にサービスエラーが発生しました。しばらくしてからもう一度お試しください

    チェックアウト

    API 動詞 パス アクション 説明
    チェックアウト 投稿 /checkout/v1.0.0 会計 購入用のアイテムデータを取得する

    パラメーター

    要素 説明 必須フィールドですか？ 一意ですか？ 許容される値 データタイプ
    アイテムID 一意のアイテムID はい はい any string
    数量 数量 no いいえ 任意の string

    回答

    ｺｰﾄﾞ 説明
    200

    アイテムが正しく取得されました

    

{

	"ソース品番":１ ２ ３ ４ ５、

	"タイトル":"レザーグローブ- XL ",

	"url ":" https :// localhost/image ",

	"price ":100,

	"通貨":"米ドル",

	"uom ":「EA」

}
    400

    無効なリクエストパラメーターです。取得を試みることができませんでした。
    401

    権限がありません
    500

    申請中にサービスエラーが発生しました。しばらくしてからもう一度お試しください

    Open Buy APIスキーマ

    AUTHENTICATION REQUEST

    アクセストークンを取得するための認証情報とメールアドレス。

    要素 説明 必須フィールドですか？ データタイプ
    資格証明書

    セッションを承認するサプライヤー固有の文字列。例には、リフレッシュトークン、ユーザーとパスワード、または認証鍵が含まれます。

    		 いいえ string
    eメール

    ユーザーのメールアドレス

    		 no string

    認証結果

    認証のリクエストの結果

    要素 説明 必須フィールドですか？ データタイプ
    トークン

    ベアラートークン

    		 いいえ string

    追加アイテムの詳細

    値のペアに名前を付ける

    要素 説明 必須フィールドですか？ データタイプ
    名前 名前 no string
    値 値 いいえ string

    検索結果

    検索リクエストの結果

    要素 説明 必須フィールドですか？ データタイプ
    カウント

    検索のカウント

    		 はい 整数
    total_count カタログのおおよその合計数 いいえ 整数
    件の結果 結果 いいえ 商品の結果

    商品実績

    アイテムデータのリクエストの結果

    要素 説明 必須フィールドですか？ データタイプ
    アイテムID

    一意のアイテムID

    		 いいえ string
    source_part_num

    サプライヤー品番

    		 no string
    タイトル string

    アイテムのタイトル

    		 no string
    タイプ string

    アイテムタイプ（アイテム、グループ）。グループは、購入可能なアイテムの親を表します。

    		 no string
    image

    アイテム画像へのURL

    		 no string
    サムネイル

    製品のサムネイル

    		 no string
    価格

    価格

    		 いいえ 番号
    currency

    通貨

    		 no string
    listPrice

    カタログ記載価格

    		 no number
    uom

    価格

    		 いいえ string
    要約

    アイテムの詳細な説明

    		 いいえ string
    manufacturer_name

    製造業者名

    		 no string
    メーカー品番

    製造業者品番

    		 no string
    source_part_auxiliary_id

    サプライヤー予備品番

    		 no string
    不特定

    UNSPSC

    		 いいえ string
    リードタイム

    リードタイム

    		 いいえ string
    min_order_quantity

    最小注文数量

    		 no 番号
    max_order_quantity 最大注文数量 いいえ number
    order_increment_quantity

    注文単位番号

    		 いいえ 番号
    数量

    チェックアウトのための数量

    		 いいえ number
    tableDetails テーブルに表示されている場合に表示する列 no string
    詳細 詳細 いいえ 追加アイテムの詳細
    detaillinks 詳細リンク no 追加アイテムの詳細
    detailimages 詳細画像 いいえ 追加アイテムの詳細