Interface PartialShippingAddress

Partial shipping address of the customer. This enables the merchant to evaluate the shipping options and whether they are available to the customer. The full shipping address is provided under the stateContext.shipping object after the customer approves the purchase.

interface PartialShippingAddress {
    city: string;
    country: string;
    postalCode?: string;
    region?: string;
}

Properties

city country postalCode? region?

Properties

city

city: string

City/town, more precise than region.

Example

Columbus

country

country: string

2-letter ISO 3166 country code

Example

US

OptionalpostalCode

postalCode?: string

Postal code formatted to the specification of the country specified in the country field.

Example

43215

Optionalregion

region?: string

Region formatted to the specification of the country specified by the country field.

The region should be set to the state (ex. US), county, borough, or municipality depending on the addressing standards of the country.

Example

OH

Settings

Member Visibility

On This Page

Properties