Skip to content

katana_public_api_client.api.customer.search_customers

katana_public_api_client.api.customer.search_customers

Classes

Functions

asyncio(*, client, body) async

Search customers

Searches customers using a structured filter body with nested logical operators (and / or) and per-field comparators. Only the fields in the filter schema may appear; unknown fields return 422. Custom field values are addressable via custom_fields.<uuid> nested paths. Returns the same shape as GET /customers — a paginated list of records.

Parameters:

  • body (CustomerSearchRequest) –

    Structured search body for POST /customers/search. Returns the same paginated {"data": [...]} shape as the corresponding list endpoint, plus an X-Pagination header. Example: {'filter': {'and': [{'category': None, 'eq': 'Wholesale'}]}, 'order': ['name ASC'], 'limit': 50, 'page': 1}.

Raises:

  • UnexpectedStatus –

    If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • TimeoutException –

    If the request takes longer than Client.timeout.

Returns:

Source code in katana_public_api_client/api/customer/search_customers.py 
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
async def asyncio(
    *,
    client: AuthenticatedClient | Client,
    body: CustomerSearchRequest,
) -> CustomerListResponse | DetailedErrorResponse | ErrorResponse | None:
    """Search customers

     Searches customers using a structured filter body with nested
    logical operators (``and`` / ``or``) and per-field comparators.
    Only the fields in the filter schema may appear; unknown fields
    return 422. Custom field values are addressable via
    ``custom_fields.<uuid>`` nested paths. Returns the same shape as
    ``GET /customers`` — a paginated list of records.

    Args:
        body (CustomerSearchRequest): Structured search body for ``POST /customers/search``.
            Returns the
            same paginated ``{"data": [...]}`` shape as the corresponding list
            endpoint, plus an ``X-Pagination`` header.
             Example: {'filter': {'and': [{'category': None, 'eq': 'Wholesale'}]}, 'order': ['name
            ASC'], 'limit': 50, 'page': 1}.


    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        CustomerListResponse | DetailedErrorResponse | ErrorResponse
    """

    return (
        await asyncio_detailed(
            client=client,
            body=body,
        )
    ).parsed

asyncio_detailed(*, client, body) async

Search customers

Searches customers using a structured filter body with nested logical operators (and / or) and per-field comparators. Only the fields in the filter schema may appear; unknown fields return 422. Custom field values are addressable via custom_fields.<uuid> nested paths. Returns the same shape as GET /customers — a paginated list of records.

Parameters:

  • body (CustomerSearchRequest) –

    Structured search body for POST /customers/search. Returns the same paginated {"data": [...]} shape as the corresponding list endpoint, plus an X-Pagination header. Example: {'filter': {'and': [{'category': None, 'eq': 'Wholesale'}]}, 'order': ['name ASC'], 'limit': 50, 'page': 1}.

Raises:

  • UnexpectedStatus –

    If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • TimeoutException –

    If the request takes longer than Client.timeout.

Returns:

Source code in katana_public_api_client/api/customer/search_customers.py 
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
async def asyncio_detailed(
    *,
    client: AuthenticatedClient | Client,
    body: CustomerSearchRequest,
) -> Response[CustomerListResponse | DetailedErrorResponse | ErrorResponse]:
    """Search customers

     Searches customers using a structured filter body with nested
    logical operators (``and`` / ``or``) and per-field comparators.
    Only the fields in the filter schema may appear; unknown fields
    return 422. Custom field values are addressable via
    ``custom_fields.<uuid>`` nested paths. Returns the same shape as
    ``GET /customers`` — a paginated list of records.

    Args:
        body (CustomerSearchRequest): Structured search body for ``POST /customers/search``.
            Returns the
            same paginated ``{"data": [...]}`` shape as the corresponding list
            endpoint, plus an ``X-Pagination`` header.
             Example: {'filter': {'and': [{'category': None, 'eq': 'Wholesale'}]}, 'order': ['name
            ASC'], 'limit': 50, 'page': 1}.


    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        Response[CustomerListResponse | DetailedErrorResponse | ErrorResponse]
    """

    kwargs = _get_kwargs(
        body=body,
    )

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

sync(*, client, body)

Search customers

Searches customers using a structured filter body with nested logical operators (and / or) and per-field comparators. Only the fields in the filter schema may appear; unknown fields return 422. Custom field values are addressable via custom_fields.<uuid> nested paths. Returns the same shape as GET /customers — a paginated list of records.

Parameters:

  • body (CustomerSearchRequest) –

    Structured search body for POST /customers/search. Returns the same paginated {"data": [...]} shape as the corresponding list endpoint, plus an X-Pagination header. Example: {'filter': {'and': [{'category': None, 'eq': 'Wholesale'}]}, 'order': ['name ASC'], 'limit': 50, 'page': 1}.

Raises:

  • UnexpectedStatus –

    If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • TimeoutException –

    If the request takes longer than Client.timeout.

Returns:

Source code in katana_public_api_client/api/customer/search_customers.py 
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
def sync(
    *,
    client: AuthenticatedClient | Client,
    body: CustomerSearchRequest,
) -> CustomerListResponse | DetailedErrorResponse | ErrorResponse | None:
    """Search customers

     Searches customers using a structured filter body with nested
    logical operators (``and`` / ``or``) and per-field comparators.
    Only the fields in the filter schema may appear; unknown fields
    return 422. Custom field values are addressable via
    ``custom_fields.<uuid>`` nested paths. Returns the same shape as
    ``GET /customers`` — a paginated list of records.

    Args:
        body (CustomerSearchRequest): Structured search body for ``POST /customers/search``.
            Returns the
            same paginated ``{"data": [...]}`` shape as the corresponding list
            endpoint, plus an ``X-Pagination`` header.
             Example: {'filter': {'and': [{'category': None, 'eq': 'Wholesale'}]}, 'order': ['name
            ASC'], 'limit': 50, 'page': 1}.


    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        CustomerListResponse | DetailedErrorResponse | ErrorResponse
    """

    return sync_detailed(
        client=client,
        body=body,
    ).parsed

sync_detailed(*, client, body)

Search customers

Searches customers using a structured filter body with nested logical operators (and / or) and per-field comparators. Only the fields in the filter schema may appear; unknown fields return 422. Custom field values are addressable via custom_fields.<uuid> nested paths. Returns the same shape as GET /customers — a paginated list of records.

Parameters:

  • body (CustomerSearchRequest) –

    Structured search body for POST /customers/search. Returns the same paginated {"data": [...]} shape as the corresponding list endpoint, plus an X-Pagination header. Example: {'filter': {'and': [{'category': None, 'eq': 'Wholesale'}]}, 'order': ['name ASC'], 'limit': 50, 'page': 1}.

Raises:

  • UnexpectedStatus –

    If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • TimeoutException –

    If the request takes longer than Client.timeout.

Returns:

Source code in katana_public_api_client/api/customer/search_customers.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
def sync_detailed(
    *,
    client: AuthenticatedClient | Client,
    body: CustomerSearchRequest,
) -> Response[CustomerListResponse | DetailedErrorResponse | ErrorResponse]:
    """Search customers

     Searches customers using a structured filter body with nested
    logical operators (``and`` / ``or``) and per-field comparators.
    Only the fields in the filter schema may appear; unknown fields
    return 422. Custom field values are addressable via
    ``custom_fields.<uuid>`` nested paths. Returns the same shape as
    ``GET /customers`` — a paginated list of records.

    Args:
        body (CustomerSearchRequest): Structured search body for ``POST /customers/search``.
            Returns the
            same paginated ``{"data": [...]}`` shape as the corresponding list
            endpoint, plus an ``X-Pagination`` header.
             Example: {'filter': {'and': [{'category': None, 'eq': 'Wholesale'}]}, 'order': ['name
            ASC'], 'limit': 50, 'page': 1}.


    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.


    Returns:
        Response[CustomerListResponse | DetailedErrorResponse | ErrorResponse]
    """

    kwargs = _get_kwargs(
        body=body,
    )

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)