Summary

The address b2b provides an interface for creating and managing an organizations address.


Get address

GET /v2/b2b/organization/{id}/address

Retrieves the addresses owned by the organization

Input

id:  the owner organization id

Response: 

A Paginated List of AddressVo objects


Get Primary address

 GET /v2/b2b/organization/{id}/address/primary

Retrieves the primary address of the organization

Input

id:  the owner organization id

Response: 

A AddressVo object if successful

 

Get Single address

 GET /v2/b2b/organization/{id}/address/{addressId}

Retrieves a single address of the organization

Input

id:  the owner organization id

Response: 

A AddressVo object if successful


Create address

POST /v2/b2b/organization/{id}/address

Creates a new addres for the organization

Input

id:  the owner organization id

Body:

A AddressVo object

Response: 

A AddressVo object if successful 


Update address

PUT /v2/b2b/organization/{id}/address

Input

id:  the owner organization id

Body:

A AddressVo object

Response: 

A addressVo object if successful 


Delete Single address

 DELETE /v2/b2b/organization/{id}/address/{addressId}

Deletes a single address of the organization

Input

id:  the owner organization id

addressId: the requested address Id

Response: 

A addressVo object if successful


Objects

AddressVo Object

Field
Description
Note
idaddress Id 
streetAddress1The street address of the address. 
streetAddress2The second part of the street address for the address. 
cityThe city that the address is in. 
stateThe state that the address is in. 
zipCodeZip code for the address. 
countryCountry for the address. 
suburbSuburb for the address 
typeType of the Address 
isPrimaryBoolean flag for primary addresses 
AddressVo
{
    "id" : 888,
    "streetAddress1" "",
    "streetAddress2" "",
    "city" "",
    "state" "",
    "suburb" "",
    "zipCode" "",
    "country" "",
    "isPrimary" true,