GetAddressParameters
Format of parameters that can be passed to getCustomerAddress endpoint method.
interface GetAddressParameters {
"company:in"?: string[];
"customer_id:in"?: number[];
"id:in"?: number[];
"name:in"?: string[];
include?: CustomersIncludeEnum;
limit?: number;
page?: number;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
"company:in" | Optional | string[] | Filter items by company. |
"customer_id:in" | Optional | number[] | Filter items by customer ID. |
"id:in" | Optional | number[] | Filter items by ID. |
"name:in" | Optional | string[] | Filter items by first_name and last_name. |
include | Optional | CustomersIncludeEnum | Indicates whether to include customer address sub-resources. |
limit | Optional | number | Items count per page. limit=50 |
page | Optional | number | Page number |