Sign in
latestOpenAPI 3.0.02026-08-101013821017.9 KB

4b69392f93b9

Shipping Address

Get shipping address for the cart

Get the shipping address for a cart.

get/v1/shoppers/me/carts/active/shipping-address

Query parameters

tokenstring

Provide the authorized or anonymous token for a shopper.

expandstring

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstring

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

Response

Successful response.

uristring
relationstring
idstring

Unique identifier of the address.

firstNamestring

The shopper's first name.

lastNamestring

The shopper's last name.

companyNamestring

Company Name

line1string

The first line of the address.

line2string

The second line of the address.

line3string

The third line of the address. (Optional)

citystring

City or town.

countrySubdivisionstring

State/County/Province/Region.

postalCodestring

ZIP or postal code.

countrystring

A two-letter (ISO 3166-2) country code. See https://en.wikipedia.org/wiki/ISO_3166-2 for a complete list of country codes.

countryNamestring

Country.

phoneNumberstring

The shopper's phone number.

countyNamestring

County.

emailAddressstring

The shopper's email address.

phoneticFirstNamestring

The shopper's Japanese Katakana first name. (Optional, usually for Japanese locale.)

phoneticLastNamestring

The shopper's Japanese Katakana last name. (Optional, usually for Japanese locale.)

divisionstring

The shopper's company departmant name. (Optional, usually for Japanese locale.)

Example response

{
  "uri": "https://api.digitalriver.com/v1/shoppers/me/address/47278020023",
  "relation": "https://developers.digitalriver.com/v1/shoppers/AddressesResource",
  "id": "shippingAddress",
  "firstName": "Automation",
  "lastName": "Tester",
  "companyName": "Digital River",
  "line1": "PO BOX 6930",
  "line2": "123",
  "line3": "Suite Line 3",
  "city": "Waconia",
  "countrySubdivision": "MN",
  "postalCode": "5387.0",
  "country": "US",
  "countryName": "United States",
  "phoneNumber": "099-222-44454",
  "countyName": "Hennepin",
  "emailAddress": "automatedTester@digitalriver.com",
  "phoneticFirstName": "クリス",
  "phoneticLastName": "ミラー",
  "division": "製品開発"
}