LogoLogo
System Status
  • Commerce API
    • Test and use cases
    • Roles and permissions
    • Sending API calls
  • Shopper APIs
    • Shopper basics
      • Common use cases
        • Creating a customer
        • Applying store credit
        • Private store workflow
        • Guest checkout
    • OAuth
      • Authentication
      • OAuth 2.0 APIs
      • Token
      • Access tokens
      • Session-aware access tokens
      • Authorizing a shopper
    • Shoppers
      • Managing shoppers
        • User management
        • Single sign-on (SSO)
        • Data validation
        • Bulk user management
        • Bulk user account export
      • Managing a shopper's account
      • Managing a shopper's address
      • Managing payment options
    • Product discovery
      • Categories
      • Products
      • Product variations
      • Pricing
      • Inventory status
      • Financing
      • Offers
        • Understanding offers
        • How to use point of promotions (POPs)
          • Retrieving all point of promotion offers for a specific product
          • Retrieving all offers for a specific point of promotion
        • How to use offers
      • Private stores
        • Managing private stores
        • Submitting an order for a private store
        • Useful APIs
      • Fulfillment
        • Electronic Fulfillment Service (OFI)
        • Digital rights
        • Digital rights revocation
        • Physical fulfillment
          • EDI X12 832 definition data elements
          • EDI X12 846 definition data elements
          • EDI X12 850 definition data elements
          • EDI X12 855 definition data elements
          • EDI X12 856 definition data elements
          • EDI X12 180-1 definition data elements
          • EDI X12 180-2 definition of data elements
          • EDI X12 180-3 definition of data elements
    • Cart
      • Applying a shopper to a cart
      • Getting the current cart
      • Creating or updating a cart
        • Adding a product to a cart
          • Gifting
        • Capturing the customer's IP address
        • Providing address information
        • Managing the shipping or billing address
        • Providing subscription information
        • Managing payment methods
        • Capturing the Terms of Sale (TOS) acceptance
      • Managing offers in a cart
        • Applying an offer
        • Applying a coupon or promo code
        • Getting all applied offers
        • Removing an applied offer
        • Removing eligible offers
        • Reconciling conflicting offers
        • Dynamic offers/personalization
          • Skipping Global Commerce merchandising offer arbitration
          • Triggering a promotional URL offer
          • Overriding a promotional URL offer discount
      • Pricing
        • Landed cost
          • Mixed cart support
          • Tax-included pretty price
      • Redirecting to a Digital River-hosted cart
      • Configuring taxes
        • Managing tax identifiers
      • Managing shipping options
        • Getting shipping options
        • Providing a shipping discount
      • Managing line items
      • Applying a price override
      • Managing payment sessions
      • Managing web checkout
      • Submitting a cart
        • Initiating a charge
        • Authorization declines
      • Resuming cart submission
      • HGOP2
    • Orders
      • Getting orders
      • Selling entities
      • Retrieving addresses from an order
      • Retrieving line items from an order
      • Order lookup
      • Returns
        • Initiate an authenticated session
        • Setting up returns in Global Commerce
        • Managing returns
    • Subscriptions
      • Retrieve the subscription
        • Getting all orders for a subscription
        • Getting a subscription's pending actions
        • Getting all subscriptions for a shopper
        • Getting a subscription by identifier
      • Update subscription at the next renewal
        • Changing the subscription renewal type
        • Changing the subscription renewal quantity
        • Adding or updating a perpetual unit price
        • Changing the subscription's payment option
        • Changing the subscription's payment source
      • Immediately change the subscription
        • Updating the subscription's shipping address
        • Updating a subscription's billing and shipping email address
        • Cancelling a subscription
      • Immediately apply a midterm subscription change
        • Reducing the subscription renewal quantity
  • Admin APIs
    • Admin basics
      • Available Admin API calls
    • Order management
      • Getting the order's details
      • Downloading the invoice
    • Offer management
    • Refund management
      • Authorization
      • Refund reason codes
      • Creating a satisfaction refund
      • Getting the available refunds for a specific order
      • Getting refunds for a specific order
      • Getting refunds available for a shopper's order
      • Getting the JSON schema for an order refund
      • Managing a refund for a delayed payment method
      • Refund error scenarios
    • Subscription management
      • Retrieve the subscription
        • Getting all orders for a subscription
        • Getting a subscription's pending actions
        • Getting all subscriptions for a shopper
        • Getting a subscription by identifier
      • Update the subscription at the next renewal
        • Changing the subscription renewal type
        • Changing the subscription renewal product
        • Changing the subscription renewal price
        • Changing the subscription renewal quantity
        • Adding or updating a perpetual unit price
        • Changing the subscription's payment option
        • Changing the subscription's payment source
      • Immediately change the subscription
        • Activating a subscription
        • Changing the subscription's external reference identifier
        • Updating a subscription's billing and shipping email address
        • Cancelling a subscription
        • Updating the subscription's expiration date
      • Immediately apply a midterm subscription change
        • Applying a midterm change with price override
        • Reducing the subscription renewal quantity
      • Subscription notifications
        • Updating the subscriber's email address
        • Card Account Updater
        • Sending a payment information change notification
        • Sending an expired credit card notification
        • Sending an invalid payment account notification
        • Sending a payment failure notification
        • Sending a subscription renewal reminder notification
        • Setting up subscription renewal reminders
        • Setting up trial subscription renewal reminders
        • Setting up marketing reminders
      • Using the Expired Card Optimizer
    • Customer management
      • Retrieving customer details
      • Requesting PII removal for a customer
    • Site management
      • Configuring authorized shipping and billing countries
      • Getting a site's authorized billing countries
      • Getting a site's authorized shipping countries
    • Product management
      • Getting started
      • Manage products (asynchronous API)
        • Creating or updating a product
        • Adding or updating a product variation
        • Deploying a product
        • Applying live changes
        • Retiring a product
        • Deleting a product variation
        • Deleting a base or individual product's locale
      • Retrieve products (synchronous API)
        • Getting a product by locale
        • Getting a product variation
        • Getting a product variation by locale
      • Get the task status for a product (synchronous API)
        • Getting the latest information on a product task
        • Retrieving the tasks for a specific product
        • Retrieving the tasks for products
      • Bulk operation
        • Asynchronous bulk operations
          • Creating products in bulk
          • Updating products in bulk
          • Deploying products in bulk
          • Deleting product variations in bulk
        • Bulk product upload (BPU)
        • Bulk Product Export (BPE)
          • Line-item level satisfaction refund
          • Order-level satisfaction refund
          • Auto-created line-item level return product
          • Line-item level return product
    • File management
      • Downloading a file
  • Payments
    • Payments solutions
      • Drop-in payments
        • How Drop-in payments work
        • Drop-in payments integration guide
      • DigitalRiver.js with Elements
        • Elements integration guide
        • Configuring payment methods
          • Configuring Afterpay
          • Configuring Alipay+ (cross-border)
          • Configuring Alipay (domestic)
          • Configuring Amazon Pay
          • Configuring Apple Pay
          • Configuring Bancontact
          • Configuring BLIK
          • Configuring Boleto
          • Configuring CCAvenue
          • Configuring Clearpay
          • Configuring Credit Cards
          • Configuring FPX Online Banking
          • Configuring Google Pay
          • Configuring iDEAL
          • Configuring Klarna
          • Configuring Konbini
          • Configuring Online Banking (IBP)
          • Configuring Online Banking (Korea Bank Transfer)
          • Configuring PayCo
          • Configuring PayPal
          • Configuring SEPA Direct Debit
          • Configuring Trustly
          • Configuring Wire Transfer
          • Common payment sources
          • Common payment objects
    • Supported payment methods
      • Afterpay
      • Alipay (domestic)
      • Alipay+ (cross-border)
      • Amazon Pay
      • Apple Pay
      • Bancontact
      • BLIK
      • Boleto
      • CCAvenue
      • Clearpay
      • Credit Cards
      • FPX Online Banking
      • Google Pay
      • iDEAL
      • Klarna
      • Konbini
      • Korea Bank Transfer (Online Banking)
      • Online Banking (IBP)
      • PayCo
      • PayPal
      • PayPal Billing Agreement
      • PayPal Credit
      • PayPal Pay in 3
      • PayPal Pay in 4
      • PayPal RatenZahlung (Installment Payment)
      • SEPA Direct Debit
      • Trustly
      • Wire Transfer
    • Source basics
      • Managing sources
      • Handling credit card sources
      • Retrieving sources
    • Building payment workflows
      • Flows by payment type
      • Handling redirect payment methods
    • PSD2 and SCA
    • Payment testing scenarios
      • Testing standard payment methods
      • Testing redirect payment methods
      • Testing receiver payment methods
      • Testing the CCAvenue payment method
  • Events
    • Events overview
    • Responding to events
    • Event types
      • Delayed payment event types
        • Delayed payment expired event
          • Boleto
          • Konbini
          • Wire Transfer
        • Delayed payment reminder event
          • Boleto
          • Konbini
          • Wire Transfer
      • Subscription event types
        • Subscription created event
        • Subscription updated event
        • Subscription action processed event
        • Subscription cancelled event
        • Subscription credit card expired event
        • Subscription payment information changed event
        • Subscription renewal reminder event
        • Subscription renewed event
        • Subscription trial converted event
        • Subscription trial renewal reminder event
        • Subscription payment failed event
      • Post-order event types
        • Invoice created event
        • Refund credit memo event
      • Inventory event types
        • Inventory out of stock event
        • Inventory source and management
        • Inventory self-managed updated event
        • Inventory fulfiller-managed updated event
      • Post-order Notification Integration Guide
    • Webhooks
      • Commerce API safelist
      • Searching for a webhook
      • Creating a webhook
      • Using webhooks
      • Editing a webhook
      • Turning webhooks on or off
      • Revealing a webhook's secret
      • Rotating a webhook's secret
      • Viewing the webhook details
      • Deleting a webhook
  • Developer Resources
    • Postman collection
    • Commerce API references
    • Shopper APIs reference
    • Admin APIs reference
    • DigitalRiver.js reference
      • Including DigitalRiver.js
      • Initializing DigitalRiver.js
      • DigitalRiver object
      • Elements
        • Amazon Pay element
        • Apple Pay elements
        • Google Pay elements
        • IBAN element
        • iDEAL element
        • Konbini elements
        • Compliance element
        • Offline refund element
        • Online Banking elements
        • Tax Identifier element
        • Delayed payment instructions element
        • PayPal elements
      • Guidelines for capturing payment details
      • Security
      • Digital River payment objects
      • Error types, codes, and objects
  • General resources
    • Global Commerce
    • Global Commerce
      • Company hierarchy
      • Categories
        • Getting a list of categories
      • Products
        • Product scenarios
        • Individual products
          • Creating an individual product
        • Base product with variants
          • Creating a base product with variants
        • Bundle offers
          • Creating a prorated bundle offer with a subscription
        • Product combination
          • Creating a product combination
        • Gifting
        • Inventory status
      • Customer service
        • Log a shopper's request to remove PII
      • Customers
        • Creating a customer
        • Digital River-maintained customer login
        • Client-maintained customer login
      • Transparent Commerce purchase flow
    • eCompass
    • eCompass documentation
    • Release notes
      • 2024
      • 2024 latest
      • 2023
      • 2022
      • 2021
      • 2020
Powered by GitBook
On this page
  • Basic address information
  • Japanese phonetics and divisions
  • Understanding Japanese scripting styles
  • Using the phonetic names and division attributes
  • US states and territories
  • US states
  • US federal district
  • US territories
  • US APO/FPO military addresses
  • Postal codes
  • US ZIP Code and geocode

Was this helpful?

  1. Shopper APIs
  2. Cart
  3. Creating or updating a cart

Providing address information

Learn how to provide ship from and ship to information for products in your cart.

PreviousCapturing the customer's IP addressNextManaging the shipping or billing address

Last updated 4 months ago

Was this helpful?

The resource contains attributes that allow you to set the shopper's billing and shipping addresses. Digital River then uses the values to determine the correct business entity and process your order.

Basic address information

Basic address information includes the customer's name, company, street address, city, and contact information. This data is required to determine accurate billing and shipping processes and to ensure successful delivery. Key parameters include firstName, lastName, line1, city, postalCode, country, and phoneNumber. In the case of Japanese addresses, additional fields for phonetic names and organizational divisions are available for better delivery accuracy.

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

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

 {
  "cart": {
        "billingAddress": {
            "uri": "http://api.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": "shopxTest@digitalriver.com",
            "phoneticFirstName": null,
            "phoneticLastName": null,
            "division": null,
            "suggestions": {
                "uri": "http://api.digitalriver.com/v1/shoppers/me/carts/active/billing-address/suggestions",
                "address": [
                    {
                        "uri": "http://api.digitalriver.com/v1/shoppers/me/carts/active/billing-address/suggestions/1",
                        "applyAddress": {
                            "uri": "http://api.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"
                    }
                ]
            }
        },
    }

Japanese phonetics and divisions

When handling customer addresses in Japan, it is essential to account for unique features such as phonetic spellings and organizational divisions. Phonetic spellings aid in correctly pronouncing names during deliveries, improving the overall customer experience. Meanwhile, organizational divisions within Japanese companies ensure precise internal routing and accurate billing. These elements are crucial for seamless delivery services and data accuracy in billing and shipping processes. Understanding and properly using these fields can significantly enhance service efficiency and customer satisfaction.

Understanding Japanese scripting styles

In Japanese, customer names can be written in two primary script styles:

  • Hiragana: The traditional and cursive script primarily used in native Japanese words.

  • Katakana: This is a phonetic script used when the customer and courier services want to use phonetic spelling. Katakana is also used by foreigners living in the country who don't have a Japanese name.

These scripting styles are crucial for accurate name representation and pronunciation, particularly for delivery and courier services. Katakana is often preferred for its phonetic clarity, making it easier for couriers to pronounce names correctly during delivery.

To ensure accurate and efficient delivery services, customers should:

  • Use Katakana for phonetic clarity, especially if they have foreign names or names that are difficult to pronounce.

  • Enter their names in Hiragana and Katakana to provide traditional and phonetic representations.

Using the phonetic names and division attributes

Digital River provides the ability to enter a phonetic name for a Japanese customer and a division in the billingAddress and shippingAddress objects. This ensures accurate name representation and pronunciation, facilitating effective communication and delivery services.

Add the following attributes to your billing and shipping addresses to ensure accurate pronunciation and proper subdivision handling.

  • phoneticFirstName: The phonetic representation of the first name to ensure correct pronunciation.

  • phoneticLastName: The phonetic representation of the last name, aiding in accurate pronunciation.

  • division: Specifies the subdivision or department within an organization.

Example JSON:

{
  "phoneticFirstName": "タロ",
  "phoneticLastName": "ヤマダ",
  "division": "営業部"
}

Include these attributes when making requests to the following resources:

These attributes enhance the accuracy and efficiency of deliveries by ensuring that phonetic names and divisions appear correctly on the Order Summary page.

Digital River ensures that phonetic names and divisions appear on the Order Summary page, enhancing delivery accuracy and efficiency. They will also appear under the billingAddress and shippingAddress objects when you issue one of the following calls:

 {
  "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": "shopxTest@digitalriver.com",
                              "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": "shopxTest@digitalriver.com",
                              "phoneticFirstName": "タロ",
                              "phoneticLastName":"ヤマダ",
                              "division": "営業部"   
    }
  }
}

US states and territories

US states

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

US federal district

Two-letter Abbreviation
Federal District

DC

District of Columbia

US territories

Two-letter Abbreviation
Territories

AS

American Samoa

GU

Guam

MP

Northern Mariana Islands

PR

Puerto Rico

VI

U.S. Virgin Islands

US APO/FPO military addresses

Two-letter Abbreviation
APO/FPO Military Addresses

AE

Armed Forces

AP

Armed Forces Pacific

AA

Armed Forces America

Postal codes

Postal codes are essential in mailing systems worldwide, facilitating the efficient sorting and delivery of mail. They consist of letters, digits, or both, sometimes including spaces or punctuation that identify specific regions, cities, or delivery routes within a country. Varying in format from one nation to another, postal codes help ensure that mail reaches its intended destination accurately and promptly. Understanding postal codes and their formats is crucial for businesses and individuals alike to ensure smooth and reliable communication and transactions across the globe.

US ZIP Code and geocode

In the United States, a ZIP Code is used to identify specific postal delivery areas, facilitating the efficient sorting and distribution of mail. Typically, a ZIP Code consists of five digits, but it can extend to nine full digits, known as ZIP+4. The additional four digits called the geocode, pinpoint a more precise delivery location within the original five-digit area. This system enhances mail delivery accuracy and plays a crucial role in various applications, such as tax calculations, by providing detailed regional information. Understanding and using both ZIP Codes and geocodes ensure more effective and accurate delivery and processing of mail and related services.

How it works

"billingAddress": {
  "postalCode": “12345-6789”,
  "country": "US"
}

"shippingAddress": {
  "postalCode": “12345-6789”,
  "country": "US"
}

A US shopper can provide just their five-digit ZIP Code without impact. However, we recommend providing the ZIP Code and geocode to ensure the correct tax calculation.

Validation for US locales

For example, the following cases will trigger an error:

  • Entering nine digits without a dash: 123456789

  • Misplaced dash: 1-23456789

Validation for non-US locales

No specific format validation is required for non-US locales. The update ensures no interruption or change in behavior for users operating outside of the US.

The , county, province, or region.

The country's .

A two-letter as described in the international standard.

The in Katakana.

The in Katakana.

The name of the within a Japanese company.

– Updates both billing and shipping addresses in the cart.

– Updates the billing address independently.

– Updates the shipping address independently.

In shipping and billing addresses within the United States, using the correct two-letter , , , and the abbreviations are important. The table below provides a comprehensive list of these abbreviations essential for ensuring accurate and efficient order processing. When specifying a US state or territory in any request, always include "US" as the country parameter.

To enable the postalCode feature, enter the in the following format: "xxxxx-yyyy," where the first five digits represent the ZIP Code and the last four digits represent the geocode. Digital River uses this format when calculating taxes, resulting in more precise results.

When a shopper inputs their ZIP Code and geocode, Digital River performs strict validation to ensure they follow the required format ("xxxxx-yyyy"). If the format is incorrect, a response returns an error with instructions on the proper format. This validation helps achieve accurate tax calculations for US addresses.

Cart
ZIP Code and geocode
states
territories
APO/FPO military addresses
District of Columbia
Alpha-2 country code
ISO 3166
state
postal code
phonetic spelling of the customer's first name
phonetic spelling of the customer's last name
division within the organization
POST /shoppers/me/carts/active
PUT /shoppers/me/carts/active/billing-address
PUT /shoppers/me/carts/active/shipping-address
GET /shoppers/me/carts/active/billing-address
GET /shoppers/me/carts/active/shipping-address
POST/v1/shoppers/me/carts/active/submit-cart
409 Conflict
invalid-postal-code