会社API
会社APIを使用して、会社データの作成、更新、照会を行います。
APIにアクセスするためのURL: https://<instance>.cso.coupahost.com/api/companies
詳細については、統合のベストプラクティスを参照してください。
アクション
動詞 | パス | アクション | 説明 |
|---|---|---|---|
GET |
| インデックス | GETアクションを実行し、すべての会社を取得 |
POST |
| 作成 | 1つまたは複数の会社オブジェクトを作成。 |
PUT |
| 更新 | 1つまたは複数の会社を更新。 一括更新も可能です。 |
GET |
| 表示 | 1つの会社データを表示。 |
PUT |
| 更新 | IDを使用して1社ずつ会社を更新 |
Elements
会社APIで使用できる要素は次のとおりです。
フィールド名 | フィールドの説明 | 必須 | 一意？ | 許容値 | 入力 | アウト* | Type |
|---|---|---|---|---|---|---|---|
ID | 会社のID | はい | yes | 整数 | |||
state | 会社のステータス | アクティブ、削除済み(大文字と小文字を区別) | yes | yes | 文字列 | ||
名前 | 会社の名前 | はい | yes | yes | 文字列 | ||
phone-number | 会社の電話番号 | yes | yes | 文字列 | |||
会社のメールアドレス | yes | yes | 文字列 | ||||
street | 会社住所の番地情報 | yes | yes | 文字列 | |||
zipcode | 会社住所の郵便番号 | yes | yes | 文字列 | |||
市 | 会社住所の市区町村 | yes | yes | 文字列 | |||
国 | 会社住所の国情報 | yes | yes | 文字列 | |||
duns-scac | 会社のDUNS SCACコード。 | yes | yes | 文字列 | |||
keywords | 会社に関連付けられたキーワード | yes | yes | 文字列 |
レスポンスのペイロードにはnull値は含まれません。
例
この例では、会社APIに対してクエリを実行しました。 以下のURLに対してGETリクエストを実行しました。
https ://<instance>.cso.coupahost.com/api/companies
会社GETレスポンス
{" total ": 7 ," compannies ":[{" id ":" 9219592888303484960 "," state ":" Active "," name ":"! 新規サプライヤー（スペイン語）"}、{" id ":" 9219594398656586067 "," state ":" Active "," name ":"! Simon Test Organization "," email ":" simon@kepgames.com "},{" id ":" 9219592919623127484 "," state ":" Active "," name ":"! SKF (test bidders )"}, {" id ":" 9219592881350550871 "," state ":" Active "," name ":"! スペイン語の入札者"," email ":" heloisa.spanish@tradeext.com "},{" id ":" 9219592230193035378 "," state ":" Active "," name ":"! TE "," email ":" lorena@te.se "," duns - scac ":" testing 123456789 "," keywords ":" test "},{" id ":" 9219596145584379778 "," state ":" Active "," name ":"! TE Test Company "}, {" id ":" 9219592639285418804 "," state ":" Active "," name ":"! TE Test Company 2 ", "phone - number ":" 123 -234 -3456 ", "email ":" testcompany2+upg@coupa.com ", "street ":" street address 1 ", "zip - code ":" 12345 ", "city ":" valahalla ", "country ":" United States Minor Outlying Islands ", "keywords ":" Carrier "}]}作成/更新
以下はCoupa APIを使って会社に対してアクションを実行する方法の説明です。
Create
/api/companies
以下のペイロードは、2つの会社を作成します。
ペイロード：{" companies ":[{" state ":" Active "," name ":" Yes Heloisa "," duns - scac ":" Shall be updated "},{" name ":" TE Test Company 2 "," phone - number ":" 123 -234 -3456 "," email ":" testcompany2+upg@coupa.com "}]}応答： 201 {" result ":[{" type ":" api.post.added "," description ":" 2 objects created ." }]," ADDED ": 2 ," COMPANIES ":[{" id ":" 9220538753256092391 "},{" id ":" 9220538753250662192 "}]}Update
/api/companies
以下のペイロードは、会社を更新します。
一度に1つ以上の会社を更新するには：ペイロード：{" companies ":[{" id ":" 9219594319065198091 "," state ":" Active "," name ":"! (TE) Heloisa "," duns - scac ":" Shall be updated "},{" id ":" 9219596218212801426 "," state ":" Active "," name ":"! (TE) Org only with bidders (Italian )", "duns - scac ":" Shall be updated ", "email ":" testbidders_itl@coupa.com "}, {"id ":" 9219596218212801429 ", "state ":" Active ", "name ": "! (TE) Org with only bidders ", "duns - scac ":" Shall be updated ", "keywords ":" Bidders "}]} Response: 200 OK {" result ": [{" type ": "api.put.updated "," description ": "3 objects updated ." }], "updated": 3}更新は寛容に処理されます。つまり、1つのリソースの更新に失敗しても、他のリソースは成功する場合があります。 更新には会社IDが必須です。
成功した要求は HTTP 200応答を返します。 レスポンスの本文には作成された申請書が含まれます。 リクエストが失敗すると、次が返されます:
HTTP 400不正な要求. レスポンスの本文にはXML形式の検証エラーが含まれます。