Alokai

CreateAddressParameters

Format of parameters that can be passed to createCustomerAddress endpoint method.

interface CreateAddressParameters {
	address_type?: string;
	address1: string;
	address2?: string;
	city: string;
	company: string;
	country_code: string;
	first_name: string;
	last_name: string;
	phone?: string;
	postal_code: string;
	state_or_province: string;
}

Properties

NameRequiredTypeDescription
address_typeOptionalstringThe address type.
address1RequiredstringThe address 1 line.
address2OptionalstringThe address 2 line.
cityRequiredstringThe city of the customer address.
companyRequiredstringThe company of the customer address.
country_codeRequiredstringThe country code of the customer address.
first_nameRequiredstringThe first name of the customer address.
last_nameRequiredstringThe last name of the customer address.
phoneOptionalstringThe phone number of the customer address.
postal_codeRequiredstringThe postal code of the customer address.
state_or_provinceRequiredstringThe state or province name spelled out in full. State or province codes not accepted.

On this page