Interface AddressInput

Base interface for addresses entered into the API

interface AddressInput {
    city: string;
    residential?: null | boolean;
    street: GraphqlList<string>;
    [field_name: string]: undefined | JsonValue;
}

Hierarchy (View Summary)

Indexable

Properties

city residential? street

Properties

city

city: string

The city the address is in.

Optionalresidential

residential?: null | boolean

Whether the address is residential or commercial

street

street: GraphqlList<string>

The street address. Note that most carriers will only accept the first two lines.

Settings

Member Visibility

On This Page

Properties