Commerce Webstore Account Addresses

Create a Commerce account address for a webstore, or retrieve a collection of addresses for a webstore account.

Resource

1/commerce/webstores/webstoreId/accounts/accountId/addresses

Available version

54.0

Requires Chatter

HTTP methods

GET, POST

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`addressType`	String[]	List of address types (for example, “Shipping” or “Billing”).	Optional	54.0
`defaultOnly`	Boolean	Indicate if you only want the default address (`true`) or all addresses for the account (`false`). The default value is `false`.	Optional	54.0
`fields`	String[]	A list of custom fields for the address.	Optional	54.0
`pageSize`	Integer	Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25.	Optional	54.0
`pageToken`	String	Specifies the page token to use to view a page of information. Page tokens are returned as part of the response, such as `currentPageToken` or `nextPageToken`. If you don’t specify a value, the first page is returned.	Optional	54.0
`sortOrder`	String	Sort order for Commerce addresses. `CreatedDateAsc`—Sort in ascending order of created date. `CreatedDateDesc`—Sort in descending order of created date. `NameAsc`—Sort in ascending order of name. `NameDesc`—Sort in descending order of name.	Optional	54.0

Response body for GET

Commerce Address Collection

Request body for POST

Root XML tag

<address>

JSON example

1{
2  "addressId":"81Wxx0000000001EAA",
3  "city":"Boston",
4  "country":"USA",
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}

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
`country`	String	The address country.	Optional	54.0
`countryCode`	String	Two-character country code.	Optional	54.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
`name`	String	Name of the contact.	Required	54.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
`street`	String	The address street.	Optional	54.0

Response body for POST

Commerce Address

Connect REST API Developer Guide

Commerce Webstore Account Addresses