会社のAPI
会社のAPIを使用して、会社のデータを作成、更新、またはクエリします。
会社のAPIを使用して、会社データを作成、更新、またはクエリします。
APIにアクセスするためのURLは次のとおりです。https<instance> ://.cso.coupahost.com/api/companies
詳細については、統合のベストプラクティスを参照してください。
アクション
| 動詞 | パス | アクション | 説明 |
|---|---|---|---|
| 取得 | /api/companies |
index | すべての企業を取得するための取得アクションを実行します |
| 投稿 | /api/companies |
作成 | 1つ以上のCompaniesオブジェクトを作成します。 |
| プット | /api/companies |
更新 | 1つ以上の会社を更新します。大量のアップデートを実行できます。 |
| 取得 | /api/companies /: id |
表示 | 会社データを1つ表示します。 |
| プット | /api/companies /: id |
update | IDを使用して一度に1つの会社を更新する |
要素
これらは会社APIで使用可能な要素です
| フィールド名 | フィールドの説明 | 申請書 | 一意ですか？ | 許容値 | In | アウト* | タイプ |
|---|---|---|---|---|---|---|---|
| iD | 会社のID | はい | はい | 整数 | |||
| 都道府県 | 会社の状況 | アクティブ、削除済み（大文字と小文字を区別） | はい | はい | string | ||
| 名前 | 会社の名前 | はい | はい | はい | string | ||
| phone - number | 会社の電話番号 | はい | はい | string | |||
| メール | 会社のメールアドレス | はい | はい | string | |||
| street | 会社住所の所番地 | はい | はい | string | |||
| 郵便番号 | 会社住所の郵便番号 | はい | はい | string | |||
| 市区町村 | 会社住所の市区町村部分 | はい | はい | string | |||
| 国 | 会社住所の国部分 | はい | はい | string | |||
| duns - scac | 会社のDUNS SCACコード。 | はい | はい | string | |||
| keywords | 会社に関連付けられているキーワード | はい | はい | string |
メモ
応答ペイロードにNULL値は表示されません。
例
この例では、会社のAPIを照会しました。URLへのアクセスを行いました。
https<instance> ://.cso.coupahost.com/api/companies
会社GET回答
{
"TOTAL ":7,
"compannies ": [
{
"ID ":"9219592888303484960 ",
"state ":"アクティブ",
"name ": "!新規サプライヤー（スペイン語）"
},
{
"ID ":"9219594398656586067 ",
"state ":"アクティブ",
"name ": "!サイモンテスト組織",
"email ":" simon@kepgames.com "
},
{
"ID ":"9219592919623127484 ",
"state ":"アクティブ",
"name ": "!SKF （テスト入札者）」
},
{
"ID ":"9219592881350550871 ",
"state ":"アクティブ",
"name ": "!スペインの入札業者",
"email ":" heloisa.spanish@tradeext.com "
},
{
"ID ":"9219592230193035378 ",
"state ":"有効",
"name ": "!TE ",
"email ":" lorena@te.se ",
"duns - scac ":" testing 123456789 ",
"KEYWORDS ":"テスト"
},
{
"ID ":"9219596145584379778 ",
"state ":"有効",
"name ": "!TE Test Company」
},
{
"ID ":"9219592639285418804 ",
"state ":"アクティブ",
"name ": "!TE Test Company 2 ",
"phone - number ":"123 -234 -3456 ",
"email ":" testcompany2+upg@coupa.com ",
"street ":"番地1 ",
"郵便番号":"12345 ",
"city ":" valahalla ",
"COUNTRY ":「合衆国領有小離島」、
"keywords ":「運送人」
}
]
}作成/更新
以下では、Coupa APIを使用して会社に対してアクションを実行する方法について説明します。
作成
/api/companies
以下のペイロードは2つの会社を作成します
ペイロード：
{
"companies ": [
{
"state ":"アクティブ",
"name ":"はい、Heloisa ",
"duns - scac ":"更新します"
},
{
"name ":"TEテストカンパニー2 ",
"phone - number ":"123 -234 -3456 ",
"email ":" testcompany2+upg@coupa.com "
}
]
}
回答:201
{
"result ": [
{
"type ":" api.post.added ",
"description ":"2件のオブジェクトが作成されました。"
}
],
"ADDED ":2,
"companies ": [
{
"ID ":"9220538753256092391"
},
{
"ID ":"9220538753250662192"
}
]
} 更新
/api/companies
以下のペイロードは、会社を更新します。
一度に1つまたは複数の会社を更新するには：
ペイロード：
{
"companies ": [
{
"ID ":"9219594319065198091 ",
"state ":"アクティブ",
"name ": "!(TE) Heloisa ",
"duns - scac ":「更新します」
},
{
"ID ":"9219596218212801426 ",
"state ":"アクティブ",
"name ": "!(TE)入札者のみの組織(イタリア語)",
"duns - scac ":"更新します",
"email ":" testbidders_itl@coupa.com "
},
{
"ID ":"9219596218212801429 ",
"state ":"アクティブ",
"name ": "!(TE)入札者のみの組織",
"duns - scac ":"更新します",
"keywords ":「入札者」
}
]
}
回答:200 OK
{
"result ": [
{
"type ":" api.put.updated ",
"DESCRIPTION ":"3件のオブジェクトが更新されました。"
}
],
"更新済み":3
}
メモ
更新は寛大な方法で行われます。つまり、1つのリソースの更新に失敗した場合、他のリソースの更新は成功する可能性があります。更新には会社IDが必要です。
要求が成功すると、HTTP 200応答が返されます。レスポンスの本文には、作成された申請書が含まれます。要求が失敗すると、HTTP 400 Bad Requestが返されます。応答の本文には、XML形式の検証エラーが含まれます。