OrderAddress

interface OrderAddress { country: string; first_name: string; last_name: string; line1: string; line2?: string; line3?: string; line4: string; notes?: string; phone_number?: string; postcode?: string; state?: string; }

Source: api.ts:446

A postal address on a placed Order — where it ships, or where the card is billed.

The line1line4 shape comes from the API: line4 is the city, and state and postcode are optional because not every country has them. An absent field means the country does not use it or the shopper left it blank, so print the lines that are present rather than assuming a fixed layout.


Properties

country: string

Two-letter country code, e.g. "US".

first_name: string

Recipient's first name.

last_name: string

Recipient's last name.

line1: string

Street address.

line2: string

Apartment, suite, or unit.

line3: string

Third address line, for addresses that need one.

line4: string

City.

notes: string

Delivery notes the shopper left for the courier.

phone_number: string

Contact phone for the delivery.

postcode: string

Postal or ZIP code. Absent for countries that do not use one.

state: string

State, province, or region. Absent for countries that do not use one.