Home > @vsf-enterprise/bigcommerce-api > GetAddressParameters
# GetAddressParameters interface
Format of parameters that can be passed to getCustomerAddress endpoint method.
Signature:
export interface GetAddressParameters
# Properties
| Property | Type | Description |
|---|---|---|
| "company:in"? | string[] | (Optional) Filter items by company. |
| "customer_id:in"? | number[] | (Optional) Filter items by customer ID. |
| "id:in"? | number[] | (Optional) Filter items by ID. |
| "name:in"? | string[] | (Optional) Filter items by first_name and last_name. |
| include? | CustomersIncludeEnum | (Optional) Indicates whether to include customer address sub-resources. |
| limit? | number | (Optional) Items count per page. limit=50 |
| page? | number | (Optional) Page number |