Including address information

Learn how to provide the customer address information.

The shipping object contains the customer address information. This is the default address provided by the customer in the customers object, and it is an affordance. If you don't specify a shipTo object in the checkout, the checkout inherits the shipping object.

When you define your shipping, you must provide the country. If you are going to use the shipping address, the required fields vary based on the country where you ship the physical product.

Parameter

Description

address

The customer shipping address.

line1

The first line of the address

line2

The second line of the address.

city

City or town.

postalCode

ZIP or postal code.

State

State/County/Province/Region.

Country

Two-letter country code.

name

The customer's name.

phone

The customer's phone number.

email

The customer's email.

organization

The customer's organization.

additionalAddressInfo

Used for Brazilian barrios. See Additional address information for an example.

The Customers resource uses the shipping object.

cURL
cURL
curl https://api.digtalriver.com/customers
-u sk_test_db9682a2-b04a-4e94-8e11-35fe8ec0b324: \
-d shipping[name]="John Smith" \
-d shipping[phone]="555-111-1111" \
-d shipping[email]="jsmith@digitalriver.com" \
-d shipping[organization]="Digital River" \
-d shipping[address][line1]="10380 Bren Rd W" \
-d shipping[address][line1]="string" \
-d shipping[address][city]="Minnetonka" \
-d shipping[address][postalCode]="55129" \
-d shipping[address][state]="MN" \
-d shipping[address][country]="US"