Type Alias ShippingRatesAddress

ShippingRatesAddress: {
    address1?: string;
    address2?: string | null;
    city?: string;
    country_code: string;
    state_code?: string | null;
    zip?: string | null;
}

Information about the address.

Required fields:

  • country_code: Always required

Conditionally required fields:

  • state_code: Required for United States (US), Australia (AU), and Canada (CA)

Optional fields:

  • All other fields are optional but providing more information may produce more precise results and more shipping options.

Type declaration

  • Optionaladdress1?: string

    Address line 1

  • Optionaladdress2?: string | null

    Address line 2

  • Optionalcity?: string

    City

  • country_code: string

    Country code

  • Optionalstate_code?: string | null

    State/province code. Required for United States (US), Australia (AU), and Canada (CA). For other countries, this field is optional.

  • Optionalzip?: string | null

    ZIP/Postal code