Providing address information
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.
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 | |
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 | |
countryName | The country's name. |
phoneNumber | The customer's phone number. |
countyName | The name of the county. |
emailAddress | The customer's email address. |
phoneticFirstName | |
phoneticLastName | |
division |
Billing address example
{
"cart": {
"billingAddress": {
"uri": "http://dispatch-test.digitalriver.com/v1/shoppers/me/carts/active/billing-address",
"id": "billingAddress",
"firstName": "e2000699-72a7-4f39-ba6d-2e5a1c913b5d",
"lastName": "DR",
"companyName": null,
"line1": "8251 Flying Cloud Drive",
"line2": "Suite 100",
"line3": null,
"city": "London",
"countrySubdivision": "AL",
"postalCode": "SE5 9JH",
"country": "GB",
"countryName": "Great Britain",
"phoneNumber": "+44 20 7274 9987",
"countyName": null,
"emailAddress": "[email protected]",
"phoneticFirstName": null,
"phoneticLastName": null,
"division": null,
"suggestions": {
"uri": "http://dispatch-test.digitalriver.com/v1/shoppers/me/carts/active/billing-address/suggestions",
"address": [
{
"uri": "http://dispatch-test.digitalriver.com/v1/shoppers/me/carts/active/billing-address/suggestions/1",
"applyAddress": {
"uri": "http://dispatch-test.digitalriver.com/v1/shoppers/me/carts/active/apply-billing-address?suggestionid=1"
},
"id": 1,
"firstName": "null",
"lastName": "null",
"line1": "8251 Flying Cloud Drive Suite 100",
"line2": "Suite 100",
"city": "Al",
"countrySubdivision": null,
"postalCode": "SE5 9JH",
"country": "GB",
"phoneNumber": "null"
}
]
}
},
}
For Japanese addresses, customers can provide their division within their organization (for example, the sales department). Additionally, a customer 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.
To add phonetics to your billing and shipping addresses, add the following attributes:
"phoneticFirstName": "タロ",
"phoneticLastName": "ヤマダ",
"division": "営業部"To the following resources:
After you implement phonetic names, you will see the new fields under the billing or shipping address in the response. For example:
- Submit cart response
Phonetics and division example
{
"cart": {
"billingAddress": {
"nickname": "Home",
"firstName": "太郎",
"lastName":"山田",
"line1":"新宿区新宿1-1-1",
"line2":"新宿ビル203",
"line3":"line3",
"countrySubdivision":"愛知県",
"country":"JP",
"countryName":"Japan",
"phoneNumber":"03-1234-1234",
"city":"田原市",
"postalCode": "123-1234",
"companyName":"Digitalriver",
"emailAddress": "[email protected]",
"phoneticFirstName": "タロ",
"phoneticLastName":"ヤマダ",
"division": "営業部"
},
"shippingAddress": {
"nickname": "Home",
"firstName": "太郎",
"lastName":"山田",
"line1":"新宿区新宿1-1-1",
"line2":"新宿ビル203",
"line3":"line3",
"countrySubdivision":"愛知県",
"country":"JP",
"countryName":"Japan",
"phoneNumber":"03-1234-1234",
"city":"田原市",
"postalCode": "123-1234",
"companyName":"Digitalriver",
"emailAddress": "[email protected]",
"phoneticFirstName": "タロ",
"phoneticLastName":"ヤマダ",
"division": "営業部"
}
}
}
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 |
MD | Maryland |
ME | Maine |
MI | Michigan |
MN | Minnesota |
MO | Missouri |
MS | Mississippi |
MT | Montana |
NC | North Carolina |
ND | North Dakota |
NE | Nebraska |
NH | New Hampshire |
NJ | New Jersey |
NM | New Mexico |
NV | Nevada |
NY | New York |
OH | Ohio |
OK | Oklahoma |
OR | Oregon |
PA | Pennsylvania |
RI | Rhode Island |
SC | South Carolina |
TN | Tennessee |
TX | Texas |
UT | Utah |
VT | Vermont |
WA | Washington |
WV | West Virginia |
WY | Wyoming |
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 |