AddressRequest

@Serializable
data class AddressRequest(val externalId: String?, val label: String, val line1: String, val line2: String? = null, val postalCode: String, val city: String, val state: String? = null, val country: CountryModel) : Address

Model that holds the address data to be added.

Constructors

Link copied to clipboard
constructor(externalId: String?, label: String, line1: String, line2: String? = null, postalCode: String, city: String, state: String? = null, country: CountryModel)

Properties

Link copied to clipboard
@SerialName(value = "city")
open override val city: String

Address City, district, suburb, town, or village

Link copied to clipboard
@SerialName(value = "country")
open override val country: CountryModel

Address country. 3-letter country code (ISO 3166-1 alpha-3)

Link copied to clipboard
@SerialName(value = "external_id")
val externalId: String?

External ID of this address in your platform

Link copied to clipboard
@SerialName(value = "label")
val label: String

Address label

Link copied to clipboard
@SerialName(value = "line_1")
open override val line1: String

Address Line One

Link copied to clipboard
@SerialName(value = "line_2")
open override val line2: String? = null

Address Line Two

Link copied to clipboard
@SerialName(value = "postal_code")
open override val postalCode: String

Address ZIP or postal code

Link copied to clipboard
@SerialName(value = "state")
open override val state: String? = null

Address State, county, province, or region