Shipping address

Learn more about the shipping address.

Shipping address resource

Order identifier

The orderId is the order's identifier. This path parameter is required when you get the shipping address for the order.

Shipping address query parameters

You can specify one or more query parameters separated by an ampersand (&) to return a filtered list of shipping addresses. The following topics describe the query parameters available for the shipping address. For more information on how to use query parameters, see Fields and query parameters.

Country

The country is a two-digit ISO 3166-2 country code. This query parameter is available when you

Expand

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides additional fields in the response. Expanding resources reduces the number of API calls required to accomplish a task. See Expand query parameter for more information. This query parameter is available when you get the shipping address for the order, get the shipping address for the cart, add or update the cart's shipping address, or apply a shipping address to a cart.

Fields

Use the fields query parameter to specify the fields that appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time. See Fields query parameter for more information. This query parameter is available when you get the shipping address for the order, get the shipping address for the cart, add or update the cart's shipping address, or apply a shipping address to a cart.

Postal code

The postalCode is 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. This query parameter is available when you apply a billing address to a cart.

The suggestionId

The suggestionId is the identifier of the Shipping Address Suggestion resource to apply to the cart's shipping address. This query parameter is available when you apply a shipping address to a cart.

Token

The token is the authorized or anonymous token for the shopper. This query parameter is available when you get the shipping address for the order, get the shipping address for the cart, add or update the cart's shipping address, or apply a shipping address to a cart.