Server: https://[app key here]-[site_ID here]-apps.worldsecuresystems.com. Take a look at the Authorize your API calls document for more info on how this URL is formed.

Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.

Path: /webresources/api/v3/sites/current/addresses

Alternatively, use siteID instead of 'current'

Authorization header: This should contain the authorization token. Here is how to obtain the token.

Response

The details for the specified customer ID in JSON format.

id - the name of the address resource (string)

siteid (boolean)

addressType -the ID of the address type (integer)

1 - Home address

2 - Work address

3 - PO box

5 - DeliveryAddress

8 - Billing address

objectId (number)

objectType(number)

1001 - Individual

2008 - Orders

createDate (dateTime)

lastUpdateDate (dateTime)

default (boolean)

address1 (string)

address2 (string)

zipCode (string)

city (string)

countryCode (string)

state (string)

The response is paginated, you can return only a few of the customer's fields. Take a look at the API V3: sorting and filtering for additional switches you can use.

You can output additional fields to those listed above as default, see the API v3 Discovery APP for additional details.

Create a new address resource

Request

Method: POST

Version: v3

Server: https://[app key here]-[site_ID here]-apps.worldsecuresystems.com. Take a look at the Authorize your API calls document for more info on how this URL is formed.

Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.

Path: /webresources/api/v3/sites/current/addresses

Alternatively, use siteID instead of 'current'

Authorization header: This should contain the authorization token. Here is how to obtain the token.

Edit an address resource

Request

Method: PUT

Version: v3

Server: https://[app key here]-[site_ID here]-apps.worldsecuresystems.com. Take a look at the Authorize your API calls document for more info on how this URL is formed.

Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.

Path: /webresources/api/v3/sites/current/addresses/[address_ID]

Alternatively, use siteID instead of 'current'

Authorization header: This should contain the authorization token. Here is how to obtain the token.

Delete an address entity

Request

Method: DELETE

Version: v3

Server: https://[app key here]-[site_ID here]-apps.worldsecuresystems.com. Take a look at the Authorize your API calls document for more info on how this URL is formed.

Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.

Path: /webresources/api/v3/sites/current/addresses/[address_ID]

Alternatively, use siteID instead of 'current'

Authorization header: This should contain the authorization token. Here is how to obtain the token.