Interface CustomerListParams

Parameters for listing customers

interface CustomerListParams {
    code?: string;
    company?: string;
    created_on_max?: string;
    created_on_min?: string;
    email?: string;
    fields?: string[];
    limit?: number;
    order_by?: "created_on" | "updated_on" | "orders_count" | "total_spent";
    page?: number;
    phone?: string;
    query?: string;
    sort?: "asc" | "desc";
    updated_on_max?: string;
    updated_on_min?: string;
}

Hierarchy (view full)

Properties

code?: string

Filter by customer code

company?: string

Filter by company

created_on_max?: string

Filter by creation date range end

created_on_min?: string

Filter by creation date range start

email?: string

Filter by email

fields?: string[]

Fields to include in the response. Use comma-separated values: 'id,name,created_on'

limit?: number

Number of items per page. Maximum value varies by endpoint.

order_by?: "created_on" | "updated_on" | "orders_count" | "total_spent"

Order results by field

page?: number

Page number (1-based).

phone?: string

Filter by phone

query?: string

Search query

sort?: "asc" | "desc"

Sort order (asc/desc)

updated_on_max?: string

Filter by update date range end

updated_on_min?: string

Filter by update date range start