Znode

GET addresses

Gets a list of addresses.

Request Information

» Filters

Name Description Usage
accountId This will filter the request by account ID. GET addresses?filter=accountid~{operator}~{value}
city This will filter the request by city. GET addresses?filter=city~{operator}~{value}
companyName This will filter the request by company name. GET addresses?filter=companyname~{operator}~{value}
countryCode This will filter the request by country code. GET addresses?filter=countrycode~{operator}~{value}
lastName This will filter the request by last name. GET addresses?filter=lastname~{operator}~{value}
postalCode This will filter the request by postal code. GET addresses?filter=postalcode~{operator}~{value}
stateCode This will filter the request by state code. GET addresses?filter=statecode~{operator}~{value}

» Sorting

Name Description Usage
addressId This will sort the response by address ID. GET addresses?sort=addressid
countryCode This will sort the response by country code. GET addresses?sort=countrycode
postalCode This will sort the response by portal code. GET addresses?sort=postalcode
stateCode This will sort the response by state code. GET addresses?sort=statecode

» Paging

Name Description Usage
index The index to retrieve when requesting paged results. GET addresses?page=index~{value}
size The size of the page when retrieving paged results. GET addresses?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

Sample:
	{
  "Addresses": [
    {
      "AccountId": 11521,
      "AddressId": 2,
      "City": "Fake City",
      "CompanyName": "Your Company",
      "CountryCode": "US",
      "FirstName": "Site",
      "IsDefaultBilling": true,
      "IsDefaultShipping": true,
      "LastName": "Admin",
      "MiddleName": "",
      "Name": "Default Billing & Shipping",
      "PhoneNumber": "1-888-Your-Store",
      "PostalCode": "12345",
      "StateCode": "SD",
      "StreetAddress1": "123 Fake Street",
      "StreetAddress2": "",
      "ValidAddress": false,
      "Email": null,
      "SetUserBillingAddress": false
    }
  ],
  "AddressListModel": {
    "Addresses": [],
    "PortalId": 0,
    "Email": null,
    "IsSameAsBillingAddress": false,
    "PageIndex": null,
    "PageSize": null,
    "TotalResults": null,
    "TotalPages": null
  },
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false
}