Connect REST API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Commerce Webstore Account Address
- Resource
-
/commerce/webstores/webstoreId/accounts/accountId/addresses/addressId - Available version
- 54.0
- HTTP methods
- DELETE, PATCH
- Request body for PATCH
-
- Root XML tag
- <address>
- JSON example
-
{ "addressId":"81Wxx0000000001EAA", "city":"Boston", "country":"US", "isDefault":true, "name":"Home Address", "postalCode":"01234", "region":"MA", "street":"1 Milk Street", “addressType”: “Billing”, "commerceAddressFieldInputList": { "fields" : [ { "dataName" : "options__c", "text" : "alpha" } ] } } - Properties
-
Name Type Description Required or Optional Available Version addressType String Type of address, for example, Shipping or Billing. Optional 54.0 city String The address city. Optional 54.0 commerceAddressFieldInputList Commerce Address Field Input[] A list of custom address fields, if any. Optional 54.0 companyName String The address company name. Optional 57.0 country String The address country. Optional 54.0 countryCode String Two-character country code. Optional 54.0–58.0 firstName String The address first name. Optional 57.0 isDefault Boolean Indicates whether a contact’s address is the preferred method of communication (true) or not (false). The default value is false. Optional 54.0 lastName String The address last name. Optional 57.0 middleName String The address middle name. Optional 57.0 name String Name of the contact. Required 54.0 phoneNumber String The phone number associated with the address, including a valid country code. For example, +1xxxxxxxxxx (for a US number). Optional 57.0 postalCode String Zip code or postal code for the address. Optional 54.0 region String The address state. Optional 54.0 regionCode String The address state code. Optional 54.0–58.0 street String The address street. Optional 54.0
- Response body for PATCH
- Commerce Address