Retrieve an order's address

Get the order's billing address

To obtain the billing address for an order, provide the order ID in the {orderId} URI path parameter.

GEThttps://api.digitalriver.com/v1/shoppers/me/orders/{orderId}/billing-address

Path parameters

orderId*string

Provide the order's identifier.

Query parameters

Response

200401

Successful response.

Body

application/json

uristring

Example: "https://api.digitalriver.com/v1/shoppers/me/address/47278020023"

relationstring

Example: "https://developers.digitalriver.com/v1/shoppers/AddressesResource"

idstring

Unique identifier of the address.

Example: "billingAddress"

firstNamestring

The shopper's first name.

Example: "Automation"

lastNamestring

The shopper's last name.

Example: "Tester"

companyNamestring

Company Name

Example: "Digital River"

line1string

The first line of the address.

Example: "PO BOX 6930"

line2string

The second line of the address.

Example: "123"

line3string

The third line of the address. (Optional)

Example: "Suite Line 3"

citystring

City or town.

Example: "Waconia"

countrySubdivisionstring

State/County/Province/Region.

Example: "MN"

postalCodestring

ZIP or postal code.

Example: "5387.0"

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.

Example: "US"

countryNamestring

Country.

Example: "United States"

phoneNumberstring

The shopper's phone number.

Example: "099-222-44454"

emailAddressstring

The shopper's email address.

Example: "[e-mail]"

countyNamestring

County.

Example: "Hennepin"

phoneticFirstNamestring

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

Example: "クリス"

phoneticLastNamestring

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

Example: "ミラー"

divisionstring

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

Example: "製品開発"

titlestring

The shopper's title. (Optional, usually for France locale.)

Example: "M"

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/orders/{orderId}/billing-address', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "uri": "https://api.digitalriver.com/v1/shoppers/me/address/47278020023",
  "relation": "https://developers.digitalriver.com/v1/shoppers/AddressesResource",
  "id": "billingAddress",
  "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",
  "emailAddress": "[e-mail]",
  "countyName": "Hennepin",
  "phoneticFirstName": "クリス",
  "phoneticLastName": "ミラー",
  "division": "製品開発",
  "title": "M"
}

Get the order's shipping address

Get the shipping address for an order. You must specify the ID of the order in the {orderId} URI path parameter.

GEThttps://api.digitalriver.com/v1/shoppers/me/orders/{orderId}/shipping-address

Path parameters

orderId*string

Provide the order's identifier.

Query parameters

Response

200401

Successful response.

Body

application/json

uristring

Example: "https://api.digitalriver.com/v1/shoppers/me/address/47278020023"

relationstring

Example: "https://developers.digitalriver.com/v1/shoppers/AddressesResource"

idstring

Unique identifier of the address.

Example: "shippingAddress"

firstNamestring

The shopper's first name.

Example: "Automation"

lastNamestring

The shopper's last name.

Example: "Tester"

companyNamestring

Company Name

Example: "Digital River"

line1string

The first line of the address.

Example: "PO BOX 6930"

line2string

The second line of the address.

Example: "123"

line3string

The third line of the address. (Optional)

Example: "Suite Line 3"

citystring

City or town.

Example: "Waconia"

countrySubdivisionstring

State/County/Province/Region.

Example: "MN"

postalCodestring

ZIP or postal code.

Example: "5387.0"

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.

Example: "US"

countryNamestring

Country.

Example: "United States"

phoneNumberstring

The shopper's phone number.

Example: "099-222-44454"

countyNamestring

County.

Example: "Hennepin"

emailAddressstring

The shopper's email address.

Example: "[e-mail]"

phoneticFirstNamestring

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

Example: "クリス"

phoneticLastNamestring

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

Example: "ミラー"

divisionstring

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

Example: "製品開発"

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/orders/{orderId}/shipping-address', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "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": "[e-mail]",
  "phoneticFirstName": "クリス",
  "phoneticLastName": "ミラー",
  "division": "製品開発"
}