Commerce Webstore Account Addresses
- リソース
-
1/commerce/webstores/webstoreId/accounts/accountId/addresses - 使用可能なバージョン
- 54.0
- HTTP のメソッド
- GET、POST
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン addressId String 取引先の住所の ID。 省略可能 56.0 addressType String[] 住所の種別のリスト (「納入先」や「請求先」など)。 省略可能 54.0 defaultOnly Boolean デフォルトの住所のみが必要か (true)、取引先のすべての住所が必要か (false) を示します。デフォルト値は、false です。 省略可能 54.0 excludeUnsupportedCountries Boolean すべてのアドレスを取得するか (false)、または種別が「納入先」で、ストアの shipToCountries リストに含まれている国のアドレスのみを取得するか (true) を示します。デフォルト値は、false です。 省略可能 57.0 fields String[] 住所のカスタム項目のリスト。 省略可能 54.0 pageSize Integer ページあたりの項目数を指定します。有効な値は 1 ~ 100 です。値を指定しない場合、デフォルトサイズは 25 です。 省略可能 54.0 pageToken String 情報ページの表示に使用するページ���ークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答の一部として返されます。値を指定しないと、最初のページが返されます。 省略可能 54.0 sortOrder String Commerce の住所の並び替え順。値は次のとおりです。 - CreatedDateAsc — 作成日を昇順で並び替えます。
- CreatedDateDesc — 作成日を降順で並び替えます。
- NameAsc — 名前を昇順で並び替えます。
- NameDesc — 名前を降順で並び替えます。
省略可能 54.0 - GET のレスポンスボディ
- Commerce Address Collection
- POST のリクエストボディ
-
- ルート XML タグ
- <address>
- JSON の例
-
1{ 2 "addressId":"81Wxx0000000001EAA", 3 "city":"Boston", 4 "country":"US", 5 "isDefault":true, 6 "name":"Home Address", 7 "postalCode":"01234", 8 "region":"MA", 9 "street":"1 Milk Street", 10 “addressType”: “Billing”, 11 "commerceAddressFieldInputList": { 12 "fields" : [ { 13 "dataName" : "options__c", 14 "text" : "alpha" 15 } ] 16 } 17} - プロパティ
-
名前 型 説明 必須か省略可能 使用可能なバージョン addressType String 住所の種別 (「納入先」や「請求先」など)。 省略可能 54.0 city String 住所の市区郡。 省略可能 54.0 commerceAddressFieldInputList Commerce Address Field Input[] カスタム住所項目のリスト (ある場合)。 省略可能 54.0 companyName String 住所の会社名。 省略可能 57.0 country String 住所の国。 省略可能 54.0 countryCode String 2 文字の国コード。 省略可能 54.0 ~ 58.0 firstName String 住所の名。 省略可能 57.0 isDefault Boolean 取引先責任者の住所が優先連絡方法か (true)、否か (false) を示します。デフォルト値は false です。 省略可能 54.0 lastName String 住所の姓。 省略可能 57.0 middleName String 住所のミドルネーム。 省略可能 57.0 name String 取引先責任者の名前。 必須 54.0 phoneNumber String 住所の電話番号。 省略可能 57.0 postalCode String 住所の郵便番号。 省略可能 54.0 region String 住所の都道府県。 省略可能 54.0 regionCode String 住所の都道府県コード。 省略可能 54.0 ~ 58.0 street String 住所の町名・番地。 省略可能 54.0
- POST のレスポンスボディ
- Commerce Address