Home > @vsf-enterprise/bigcommerce-api > CreateAddressParameters

# CreateAddressParameters interface

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

Signature:

export interface CreateAddressParameters

# Properties

Property Type Description
address_type? string (Optional) The address type.
address1 string The address 1 line.
address2? string (Optional) The address 2 line.
city string The city of the customer address.
company string The company of the customer address.
country_code string The country code of the customer address.
customer_id number The customer ID.
first_name string The first name of the customer address.
last_name string The last name of the customer address.
phone? string (Optional) The phone number of the customer address.
postal_code string The postal code of the customer address.
state_or_province string The state or province name spelled out in full. State or province codes not accepted.
Test your knowledge →