JA 地球アイコン
ユーザーアイコン
このページ
  • 最終編集日時: 18 December 2021
何かお探しですか？ 製品 Coupa製品ドキュメント サプライヤー向けリソース サプライヤーの統合に関するリソース Open Buy APIリファレンス

Open Buy APIリファレンス

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

はじめに

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

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

Open Buy APIが顧客と購入者に与える影響については、「購入者向けOpen Buy API 」を参照してください。

認証方法

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

  • ユーザー名とパスワード（cXML ID/シークレットのペアと同様）

  • 認証

アクション

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

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

認証

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

認証申請の例

{
	"credentials": "423j23j2j334l4s04",
	"email": "email@coupa.com"
}

回答

コード 説明
200

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


{
"token": "ABC12345"
}

 
400

無効な要求パラメーターです。取得を試みることができませんでした。
401

権限なし
500

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

検索

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

パラメーター

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

回答

コード 説明
200

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


{
	"count": 0,
	"total_count": 0,
	"results": [
		{
			"source_part_num": 12345,
			"title": "Leather Gloves - XL",
			"url": "https://localhost/image",
			"price": 100,
			"currency": "USD",
			"uom": "EA"
		}
	]
}
400

無効な要求パラメーターです。取得を試みることができませんでした。
401

権限なし
500

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

詳細

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

パラメーター

要素 説明 必須フィールドですか？ 一意ですか？ 許容値 データタイプ
アイテムID 一意のアイテムID はい no 任意 文字列

回答

コード 説明
200

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


{
	"source_part_num": 12345,
	"title": "Leather Gloves - XL",
	"url": "https://localhost/image",
	"price": 100,
	"currency": "USD",
	"uom": "EA"
}
400

無効な要求パラメーターです。取得を試みることができませんでした。
401

権限なし
500

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

チェックアウト

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

パラメーター

要素 説明 必須フィールドですか？ 一意ですか？ 許容値 データタイプ
アイテムID 一意のアイテムID はい はい 任意 文字列
数量 数量 no no 任意 文字列

回答

コード 説明
200

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


{
	"source_part_num": 12345,
	"title": "Leather Gloves - XL",
	"url": "https://localhost/image",
	"price": 100,
	"currency": "USD",
	"uom": "EA"
}
400

無効な要求パラメーターです。取得を試みることができませんでした。
401

権限なし
500

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

Open Buy APIスキーマ

認証申請

アクセストークンを取得するための資格情報とメール。

要素 説明 必須フィールドですか？ データタイプ
認証情報

セッションを承認するためのサプライヤー固有の文字列。たとえば、更新トークン、ユーザーとパスワード、承認キーなどがあります。

 no 文字列
メール

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

 no 文字列

認証結果

認証リクエストの結果

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

ベアラートークン

 no 文字列

追加アイテムの詳細

名前と値のペア

要素 説明 必須フィールドですか？ データタイプ
名前 名前 no 文字列
値 値 no 文字列

検索結果

検索要求の結果

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

検索数

 はい 整数
合計カウント カタログのおおよその合計数 no 整数
結果 結果 no アイテム結果

アイテム結果

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

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

一意のアイテムID

 no 文字列
ソース品番

サプライヤーの品番

 no 文字列
タイトル 文字列

アイテムのタイトル

 no 文字列
type 文字列

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

 no 文字列
画像

アイテム画像へのURL

 no 文字列
サムネイル

製品のサムネイル

 no 文字列
価格

価格

 no 番号
通貨

通貨

 no 文字列
定価

定価

 no 番号
数量単位

価格

 no 文字列
概要

アイテムに関する詳細な説明

 no 文字列
製造業者名

製造業者名

 no 文字列
製造業者品番

製造業者品番

 no 文字列
source_part_auxiliary_id

サプライヤー予備品番

 no 文字列
不特定

未指定商品

 no 文字列
リードタイム

リードタイム

 no 文字列
min_order_quantity

最小注文数量

 no 番号
max_order_quantity 最大注文数量 no 番号
注文単位の数量

注文単位の番号

 no 番号
数量

チェックアウトの数量

 no 番号
テーブル詳細 テーブルに表示する場合に表示する列 no 文字列
詳細 詳細 no 追加アイテムの詳細
詳細リンク 詳細リンク no 追加アイテムの詳細
詳細画像 詳細画像 no 追加アイテムの詳細

 

このページに表示されている一部、または全ての内容は、機械翻訳によるものです。ご了承ください。