何かお探しですか？製品 Coupa製品ドキュメントインテグレーション技術文書 Coupa Core API リソース参照データリソース住所API (/addresses) 住所APIコールの例

住所APIコールの例

住所クエリオプションの取得

address APIを使用して必要な結果セットをクエリして取得する方法の例をいくつか以下に示します。

このクエリは、2010年11月1日以降に作成されたすべての会社の住所を返します。

https://<instance url>/api/addresses?created_at[gt]=2010-11-01T00:00:00

このクエリは、すべての有効な住所と、会社の住所のニックネームに「San Francisco」という文字が含まれる住所を返します。

https://<instance url>/api/addresses?active=true&name[contains]=San+Francisco

このクエリは、米国およびカリフォルニア州のすべての会社の住所を返します

https://<instance url>/api/addresses?country[name]=United+States&state=CA

このクエリは、住所のニックネームに「ホームオフィス」が含まれているすべての個人の住所を返します

https://<instance url>/api/users/85/addresses?name=Home+Office

住所を取得

この例では、IDが6の会社の住所レコードをクエリしました。

URLにGETしました：

https://<instance url>/api/addresses/6
または
https://<instance url>/api/addresses?id=6

検索条件に一致する回答は次のとおりです。

<?xml version="1.0" encoding="UTF-8"?>
<addresses type="array">
	 <address>
			<attention />
			<city>San Francisco</city>
			<id type="integer">14</id>
			<name>San Francisco Office</name>
			<postal-code>94450</postal-code>
			<state>CA</state>
			<street1>150 Main Street</street1>
			<street2 />
			<country>
				 <code>US</code>
				 <id type="integer">223</id>
				 <name>United States</name>
			</country>
	 </address>
</addresses>

この例では、IDが85のユーザーのすべての個人住所レコードについてクエリを実行しました。

URLにGETしました：
https://<instance url>/api/users/85/addresses

検索条件に一致する回答は次のとおりです。

<?xml version="1.0" encoding="UTF-8"?>
<addresses type="array">
	 <address>
			<attention>Margret Patrick</attention>
			<city>San Mateo</city>
			<id type="integer">123</id>
			<name>Home Office</name>
			<postal-code>94402</postal-code>
			<state>CA</state>
			<street1>111 Main Street</street1>
			<street2 />
			<country>
				 <code>US</code>
				 <id type="integer">223</id>
				 <name>United States</name>
			</country>
	 </address>
	 <address>
			<attention>Margret Patrick</attention>
			<city>San Francisco</city>
			<id type="integer">124</id>
			<name>test2</name>
			<postal-code>94103</postal-code>
			<state>CA</state>
			<street1>2600 Polk Street</street1>
			<street2 />
			<country>
				 <code>US</code>
				 <id type="integer">223</id>
				 <name>United States</name>
			</country>
	 </address>
</addresses>

住所の作成

この例では、会社の住所を作成しています。

URLに投稿しました https://<instance url>/api/addresses.

<?xml version="1.0" encoding="UTF-8"?>
<address>
	 <name>Silicon Valley</name>
	 <city>San Mateo</city>
	 <postal-code>94404</postal-code>
	 <state>CA</state>
	 <street1>2 W 5th Ave</street1>
	 <street2>Suite 300</street2>
	 <country>
			<code>US</code>
			<name>United States</name>
	 </country>
</address>

この例では、ユーザーIDが85のユーザーの個人住所を作成しています。

URLに投稿します https://<instance url>/api/users/85/addresses

<?xml version="1.0" encoding="UTF-8"?>
<address>
	 <attention nil="true" />
	 <city>San Mateo</city>
	 <id type="integer">125</id>
	 <name>Silicon Valley</name>
	 <postal-code>94400</postal-code>
	 <state>CA</state>
	 <street1>2 W 5th Ave</street1>
	 <street2 nil="true" />
	 <country>
			<code>US</code>
			<id type="integer">223</id>
			<name>United States</name>
	 </country>
</address>

支払先住所の作成

この例では、特定のサプライヤーの支払先住所を作成しています

URLに投稿しました https://<instance url>/api/suppliers/<supplier id>/addresses

<?xml version="1.0" encoding="UTF-8"?>
<remit-to-address>
	 <remit-to-code>100</remit-to-code>
	 <name>100 Ellsworth</name>
	 <street1>100 Ellsworth Ave.</street1>
	 <city>SAN MATEO</city>
	 <state>CA</state>
	 <postal-code>94404</postal-code>
	 <active type="boolean">true</active>
	 <country>
			<code>US</code>
	 </country>
</remit-to-address>

住所の更新

これらの例では、単一の会社の住所レコードを更新しています。

URLにPUTを行いました： https://<instance url>/api/addresses/<address ID>

たとえば、住所ID 122のニックネームと2行目を使用して住所レコードを更新するには、次の操作を行います。

URL: https://<instance url>/api/addresses/122

<?xml version="1.0" encoding="UTF-8"?>
<address>
	 <name>South Bay Office</name>
	 <street2>Suite 200</street2>
</address>

たとえば、IDが122の会社の住所を無効にするには、次の操作を行います。

URL: https://<instance url>/api/addresses/122

 <?xml version="1.0" encoding="UTF-8"?>
<address>
	 <active>false</active>
</address>

たとえば、ユーザーID 85と住所ID 125の個人住所を無効にするには次を実行します。

URL: https://<instance url>/api/users/85/addresses/125

 <?xml version="1.0" encoding="UTF-8"?>
<address>
	 <active>false</active>
</address>

サプライヤー支払先住所の更新

これらの例では、単一のサプライヤー支払先住所を更新しています。支払先住所を更新する方法は、通常の住所と同じくらい簡単ですが、サプライヤーと支払先IDの両方を知る必要があります

URLにPUTを行いました： https://<instance url>/api/suppliers/<supplier id>/addresses/<remit-to address ID>

たとえば、ID 12のサプライヤーの支払先住所ID 23287の支払先コードを更新して、現在の値が「001」に変更された場合に、支払先住所を修正します

URL: https://<instance url>/api/suppliers/12/remit_to_addresses/23287

<?xml version="1.0" encoding="UTF-8"?>
<remit-to-address>
	 <remit-to-code>001</remit-to-code>
</remit-to-address>

たとえば、ID 232887のサプライヤーのID 12の支払先住所を無効にするには、次の操作を行います。