Addresses

The Addresses resource family provides access to selected billing and shipping addresses on cart orders and purchases. With this resource, you can retrieve, edit, create and set selected billing and shipping addresses.

Select Order Billing Address

The billing address info resource provides the shopper with a selector to choose the billing address to use for the purchase. If the shopper is transacting on behalf of an account, the selector returns the addresses stored on the account. If not, the selector returns the addresses stored on the shopper profile.

Workflow

1. Start with order
2. GET the link with rel: billingaddressinfo
3. GET the link with rel: selector
4. GET the link with rel: choice
5. POST the choice using the link with rel: selectaction

Read Order Billing Address Choice

Use the order billing address selector to read an available address choice.

Workflow

1. Start with order
2. GET the link with rel: billingaddressinfo
3. GET the link with rel: selector
4. GET the link with rel: chosen
5. GET the link with rel: description
6. Render the response

Response Fields

Type: addresses.address

Name	Description	Type
name	The customer name.	object
given-name	The person’s given name.	string
family-name	The person’s family name.	string
address	The customer address. Address field names are based on the v.card specification. For more information on this specification, see v.card.	object
street-address	Street address line 1.	string
street-address-2	Street address line 2. This field is optional.	string
street-address-3	Street address line 3. This field is optional.	string
locality	The city name.	string
region	The region name. A region typically corresponds to a province or a state of a country.	string
postal-code	The postal code or zip code.	string
country-name	The country name.	string
phone-number	The phone number.	string
organization	The organization.	string

Read Selected Order Billing Address

Use the order billing address selector to read the chosen billing address.

Workflow

1. Start with order
2. GET the link with rel: billingaddressinfo
3. GET the link with rel: billingaddress
4. Render the response

Response Fields

Type: addresses.address

Name	Description	Type
name	The customer name.	object
given-name	The person’s given name.	string
family-name	The person’s family name.	string
address	The customer address. Address field names are based on the v.card specification. For more information on this specification, see v.card.	object
street-address	Street address line 1.	string
street-address-2	Street address line 2. This field is optional.	string
street-address-3	Street address line 3. This field is optional.	string
locality	The city name.	string
region	The region name. A region typically corresponds to a province or a state of a country.	string
postal-code	The postal code or zip code.	string
country-name	The country name.	string
phone-number	The phone number.	string
organization	The organization.	string

Add Billing Address from Order

Create a billing address from the order.

Workflow

1. Start with order
2. GET the link with rel: billingaddressinfo
3. GET the link with rel: addressform
4. Fill out the form
5. POST the form using the link with rel: createaddressaction

Request Fields

Type: addresses.address

Name	Description	Type
name	The customer name.	object
given-name	The person’s given name.	string
family-name	The person’s family name.	string
address	The customer address. Address field names are based on the v.card specification. For more information on this specification, see v.card.	object
street-address	Street address line 1.	string
street-address-2	Street address line 2. This field is optional.	string
street-address-3	Street address line 3. This field is optional.	string
locality	The city name.	string
region	The region name. A region typically corresponds to a province or a state of a country.	string
postal-code	The postal code or zip code.	string
country-name	The country name.	string
phone-number	The phone number.	string
organization	The organization.	string

Select Delivery Shipping Address

The destination info resource provides the shopper with a selector to choose the shipping address to use for the purchase. If the shopper is transacting on behalf of an account, the selector returns the addresses stored on the account. If not, the selector returns the addresses stored on the shopper profile.

Workflow

1. Start with destination info
2. GET the link with rel: selector
3. GET the link with rel: choice
4. POST the choice using the link with rel: selectaction

Read Delivery Shipping Address Choice

Use the delivery shipping address selector to read an available address choice.

Workflow

1. Start with destination info
2. GET the link with rel: selector
3. GET the link with rel: choice
4. GET the link with rel: description
5. Render the response

Response Fields

Type: addresses.address

Name	Description	Type
name	The customer name.	object
given-name	The person’s given name.	string
family-name	The person’s family name.	string
address	The customer address. Address field names are based on the v.card specification. For more information on this specification, see v.card.	object
street-address	Street address line 1.	string
street-address-2	Street address line 2. This field is optional.	string
street-address-3	Street address line 3. This field is optional.	string
locality	The city name.	string
region	The region name. A region typically corresponds to a province or a state of a country.	string
postal-code	The postal code or zip code.	string
country-name	The country name.	string
phone-number	The phone number.	string
organization	The organization.	string

Read Selected Order Shipping Address

Use the delivery shipping address selector to read the chosen shipping address.

Workflow

1. Start with destination-info
2. GET the link with rel: destination
3. Render the response

Response Fields

Type: addresses.address

Name	Description	Type
name	The customer name.	object
given-name	The person’s given name.	string
family-name	The person’s family name.	string
address	The customer address. Address field names are based on the v.card specification. For more information on this specification, see v.card.	object
street-address	Street address line 1.	string
street-address-2	Street address line 2. This field is optional.	string
street-address-3	Street address line 3. This field is optional.	string
locality	The city name.	string
region	The region name. A region typically corresponds to a province or a state of a country.	string
postal-code	The postal code or zip code.	string
country-name	The country name.	string
phone-number	The phone number.	string
organization	The organization.	string

Add Shipping Address from Delivery

Create a shipping address from the delivery.

Workflow

1. Start with delivery
2. GET the link with rel: destinationinfo
3. GET the link with rel: addressform
4. Fill out the form
5. POST the form using the link with rel: createaddressaction

Request Fields

Type: addresses.address

Name	Description	Type
name	The customer name.	object
given-name	The person’s given name.	string
family-name	The person’s family name.	string
address	The customer address. Address field names are based on the v.card specification. For more information on this specification, see v.card.	object
street-address	Street address line 1.	string
street-address-2	Street address line 2. This field is optional.	string
street-address-3	Street address line 3. This field is optional.	string
locality	The city name.	string
region	The region name. A region typically corresponds to a province or a state of a country.	string
postal-code	The postal code or zip code.	string
country-name	The country name.	string
phone-number	The phone number.	string
organization	The organization.	string