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: 

An 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: 

An AddressVo object if successful


Create address

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

Creates a new address for the organization

Input

id:  the owner organization id

Body:

An AddressVo object

Response: 

An AddressVo object if successful 


Update address

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

Input

id:  the owner organization id

Body:

An AddressVo object

Response: 

An 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: 

An addressVo object if successful


Objects

AddressVo Object

Field
Description
idaddress Id
streetAddress1The first line of the street address
streetAddress2The second line of the street address
cityAddress City
stateAddress State/Province
zipCodeAddress Zip/Postal Code
countryAddress Country
suburbAddress Suburb
typeType of the Address
isPrimaryBoolean flag for primary address


AddressVo
{
    "id" : 888,
    "streetAddress1" : "4914 Gateway Avenue",
    "streetAddress2" : "Apt 2B",
    "city" : "Newhall",
    "state" : "CA",
    "suburb" : "",
    "zipCode" : "91321",
    "country" : "United States",
    "isPrimary" : true,
}