Providing address information

Search…
Learn how to provide ship from and ship to information for products in your cart.
The Cart resource contains attributes that allow you to set billing and shipping addresses. Digital River then uses the values to determine the correct business entity and process your order.
Basic address information
The following table describes each parameter in a billingAddress, and shippingAddress :
Parameter
Description
nickName
The name the customer prefers.
firstName
The customer's first name.
lastName
The customer's last name.
companyName
The company's name.
line1
The first line of the address.
line2
The second line of the address.
line3
The third line of the address.
city
The city of the address.
countrySubdivision
The state, county, province, or region.
postalCode
The postal code. 

For United States addresses, Digital River supports ZIP+4 codes. They consist of the last four digits of a full nine-digit ZIP code. A nine-digit ZIP Code has two parts: the initial five digits of the zip code indicating the destination post office or delivery area and the last four digits representing a specific delivery route within that overall delivery area.
​
country
A two-letter Alpha-2 country code as described in the ISO 3166 international standard.
countryName
The country's name.
phoneNumber
The customer's phone number.
countyName
The name of the county.
emailAddress
The customer's email address.
phoneticFirstName
The phonetic spelling of the customer's first name in Katakana. 
phoneticLastName
The phonetic spelling of the customer's last name in Katakana.
division
The name of the division within the organization within a Japanese company. 
Billing address example
1
 {
2
  "cart": {
3
        "billingAddress": {
4
            "uri": "http://dispatch-test.digitalriver.com/v1/shoppers/me/carts/active/billing-address",
5
            "id": "billingAddress",
6
            "firstName": "e2000699-72a7-4f39-ba6d-2e5a1c913b5d",
7
            "lastName": "DR",
8
            "companyName": null,
9
            "line1": "8251 Flying Cloud Drive",
10
            "line2": "Suite 100",
11
            "line3": null,
12
            "city": "London",
13
            "countrySubdivision": "AL",
14
            "postalCode": "SE5 9JH",
15
            "country": "GB",
16
            "countryName": "Great Britain",
17
            "phoneNumber": "+44 20 7274 9987",
18
            "countyName": null,
19
            "emailAddress": "[email protected]",
20
            "phoneticFirstName": null,
21
            "phoneticLastName": null,
22
            "division": null,
23
            "suggestions": {
24
                "uri": "http://dispatch-test.digitalriver.com/v1/shoppers/me/carts/active/billing-address/suggestions",
25
                "address": [
26
                    {
27
                        "uri": "http://dispatch-test.digitalriver.com/v1/shoppers/me/carts/active/billing-address/suggestions/1",
28
                        "applyAddress": {
29
                            "uri": "http://dispatch-test.digitalriver.com/v1/shoppers/me/carts/active/apply-billing-address?suggestionid=1"
30
                        },
31
                        "id": 1,
32
                        "firstName": "null",
33
                        "lastName": "null",
34
                        "line1": "8251 Flying Cloud Drive Suite 100",
35
                        "line2": "Suite 100",
36
                        "city": "Al",
37
                        "countrySubdivision": null,
38
                        "postalCode": "SE5 9JH",
39
                        "country": "GB",
40
                        "phoneNumber": "null"
41
                    }
42
                ]
43
            }
44
        },
45
    }
Copied!
Japanese phonetics and divisions
For Japanese addresses, customers can provide their division within their organization (for example, sales department). Additionally, customers can enter their name in two scripting styles: Hiragana and Katakana. Hiragana is the traditional script, while Katakana is the phonetic spelling. Customer and courier services often want phonetic spelling so they can correctly pronounce the customer's name when making a delivery. Katakana is also used by foreigners living in the country who don't have a Japanese name.
Digital River provides the ability to enter a phonetic name for a Japanese customer and a division in the billingAddress and shippingAddress objects.
Phonetic names stored in the required billing address will appear on the Order Summary page.
Add phonetics and divisions
To add phonetics to your billing and shipping addresses, add the following attributes:
"phoneticFirstName": "タロ",
"phoneticLastName": "ヤマダ",
"division": "営業部"
To the following resources:
​POST /shoppers/me/carts/active – Update billing address and shipping address in cart.
​PUT /shoppers/me/carts/active/billing-address – Update billing address independently.
​PUT /shoppers/me/carts/active/shipping-address – Update shipping address independently.
After you implement phonetic names, you will see the new fields under the billing or shipping address in the response. For example:
​GET /shoppers/me/carts/active/billing-address – Get the billing address for a cart.
​GET /shoppers/me/carts/active/shipping-address – Get the shipping address for a cart.
Submit cart response
Phonetics and division example
1
 {
2
  "cart": {
3
    "billingAddress": {
4
                             "nickname": "Home",
5
                              "firstName": "太郎",
6
                              "lastName":"山田",
7
                              "line1":"新宿区新宿1-1-1",
8
                              "line2":"新宿ビル203",
9
                              "line3":"line3",
10
                              "countrySubdivision":"愛知県",
11
                              "country":"JP",
12
                              "countryName":"Japan",
13
                              "phoneNumber":"03-1234-1234",
14
                              "city":"田原市",
15
                              "postalCode": "123-1234",
16
                              "companyName":"Digitalriver",
17
                              "emailAddress": "[email protected]",
18
                              "phoneticFirstName": "タロ",
19
                              "phoneticLastName":"ヤマダ",
20
                              "division": "営業部"
21
                                
22
    },
23
    "shippingAddress": {
24
                             "nickname": "Home",
25
                              "firstName": "太郎",
26
                              "lastName":"山田",
27
                              "line1":"新宿区新宿1-1-1",
28
                              "line2":"新宿ビル203",
29
                              "line3":"line3",
30
                              "countrySubdivision":"愛知県",
31
                              "country":"JP",
32
                              "countryName":"Japan",
33
                              "phoneNumber":"03-1234-1234",
34
                              "city":"田原市",
35
                              "postalCode": "123-1234",
36
                              "companyName":"Digitalriver",
37
                              "emailAddress": "[email protected]",
38
                              "phoneticFirstName": "タロ",
39
                              "phoneticLastName":"ヤマダ",
40
                              "division": "営業部"   
41
    }
42
  }
43
}
Copied!
US states and territories
The following lists the enumerated two-letter state values that Digital River uses to represent states, territories, APO/FPO military addresses, and the District of Columbia. When you specify one of these state enumerations in a request, you must also provide US as the country parameter.
Two-letter Abbreviation
State Name
AK
Alaska
AL
Alabama
AR
Arkansas
AZ
Arizona
CA
California
CO
Colorado
CT
Connecticut
DE
Delaware
FL
Florida
GA
Georgia
HI
Hawaii
IA
Iowa
ID
Idaho
IL
Illinois
IN
Indiana
KS
Kansas
KY
Kentucky
LA
Louisiana
MA
Massachusetts
Two-letter Abbreviation
Federal District
DC
District of Columbia
Two-letter Abbreviation
Territories
AS
American Samoa
GU
Guam
MP
Northern Mariana Islands
PR
Puerto Rico
VI
U.S. Virgin Islands
Two-letter Abbreviation
APO/FPO Military Addresses
AE
Armed Forces
AP
Armed Forces Pacific
AA
Armed Forces America
Configuring taxes
Providing a shipping discount
Last modified 1yr ago
Copy link
Contents
Basic address information
Japanese phonetics and divisions
US states and territories