Skip to content

katana_public_api_client.api.stocktake.get_all_stocktakes

katana_public_api_client.api.stocktake.get_all_stocktakes

Classes

Functions

asyncio(*, client, limit=50, page=1, ids=UNSET, location_id=UNSET, status=UNSET, stocktake_number=UNSET, stock_adjustment_id=UNSET, created_at_min=UNSET, created_at_max=UNSET, updated_at_min=UNSET, updated_at_max=UNSET, include_deleted=UNSET) async

List stocktakes

Returns a list of stocktakes.

Parameters:

  • limit (Union[Unset, int], default: 50 ) –

    Default: 50.

  • page (Union[Unset, int], default: 1 ) –

    Default: 1.

  • ids (Union[Unset, list[int]], default: UNSET ) –
  • location_id (Union[Unset, int], default: UNSET ) –
  • status (Union[Unset, str], default: UNSET ) –
  • stocktake_number (Union[Unset, str], default: UNSET ) –
  • stock_adjustment_id (Union[Unset, float], default: UNSET ) –
  • created_at_min (Union[Unset, datetime], default: UNSET ) –
  • created_at_max (Union[Unset, datetime], default: UNSET ) –
  • updated_at_min (Union[Unset, datetime], default: UNSET ) –
  • updated_at_max (Union[Unset, datetime], default: UNSET ) –
  • include_deleted (Union[Unset, bool], default: UNSET ) –

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/stocktake/get_all_stocktakes.py 
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
async def asyncio(
    *,
    client: AuthenticatedClient | Client,
    limit: Unset | int = 50,
    page: Unset | int = 1,
    ids: Unset | list[int] = UNSET,
    location_id: Unset | int = UNSET,
    status: Unset | str = UNSET,
    stocktake_number: Unset | str = UNSET,
    stock_adjustment_id: Unset | float = UNSET,
    created_at_min: Unset | datetime.datetime = UNSET,
    created_at_max: Unset | datetime.datetime = UNSET,
    updated_at_min: Unset | datetime.datetime = UNSET,
    updated_at_max: Unset | datetime.datetime = UNSET,
    include_deleted: Unset | bool = UNSET,
) -> ErrorResponse | StocktakeListResponse | None:
    """List stocktakes

     Returns a list of stocktakes.

    Args:
        limit (Union[Unset, int]):  Default: 50.
        page (Union[Unset, int]):  Default: 1.
        ids (Union[Unset, list[int]]):
        location_id (Union[Unset, int]):
        status (Union[Unset, str]):
        stocktake_number (Union[Unset, str]):
        stock_adjustment_id (Union[Unset, float]):
        created_at_min (Union[Unset, datetime.datetime]):
        created_at_max (Union[Unset, datetime.datetime]):
        updated_at_min (Union[Unset, datetime.datetime]):
        updated_at_max (Union[Unset, datetime.datetime]):
        include_deleted (Union[Unset, bool]):

    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:
        Union[ErrorResponse, StocktakeListResponse]
    """

    return (
        await asyncio_detailed(
            client=client,
            limit=limit,
            page=page,
            ids=ids,
            location_id=location_id,
            status=status,
            stocktake_number=stocktake_number,
            stock_adjustment_id=stock_adjustment_id,
            created_at_min=created_at_min,
            created_at_max=created_at_max,
            updated_at_min=updated_at_min,
            updated_at_max=updated_at_max,
            include_deleted=include_deleted,
        )
    ).parsed

asyncio_detailed(*, client, limit=50, page=1, ids=UNSET, location_id=UNSET, status=UNSET, stocktake_number=UNSET, stock_adjustment_id=UNSET, created_at_min=UNSET, created_at_max=UNSET, updated_at_min=UNSET, updated_at_max=UNSET, include_deleted=UNSET) async

List stocktakes

Returns a list of stocktakes.

Parameters:

  • limit (Union[Unset, int], default: 50 ) –

    Default: 50.

  • page (Union[Unset, int], default: 1 ) –

    Default: 1.

  • ids (Union[Unset, list[int]], default: UNSET ) –
  • location_id (Union[Unset, int], default: UNSET ) –
  • status (Union[Unset, str], default: UNSET ) –
  • stocktake_number (Union[Unset, str], default: UNSET ) –
  • stock_adjustment_id (Union[Unset, float], default: UNSET ) –
  • created_at_min (Union[Unset, datetime], default: UNSET ) –
  • created_at_max (Union[Unset, datetime], default: UNSET ) –
  • updated_at_min (Union[Unset, datetime], default: UNSET ) –
  • updated_at_max (Union[Unset, datetime], default: UNSET ) –
  • include_deleted (Union[Unset, bool], default: UNSET ) –

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/stocktake/get_all_stocktakes.py 
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
async def asyncio_detailed(
    *,
    client: AuthenticatedClient | Client,
    limit: Unset | int = 50,
    page: Unset | int = 1,
    ids: Unset | list[int] = UNSET,
    location_id: Unset | int = UNSET,
    status: Unset | str = UNSET,
    stocktake_number: Unset | str = UNSET,
    stock_adjustment_id: Unset | float = UNSET,
    created_at_min: Unset | datetime.datetime = UNSET,
    created_at_max: Unset | datetime.datetime = UNSET,
    updated_at_min: Unset | datetime.datetime = UNSET,
    updated_at_max: Unset | datetime.datetime = UNSET,
    include_deleted: Unset | bool = UNSET,
) -> Response[ErrorResponse | StocktakeListResponse]:
    """List stocktakes

     Returns a list of stocktakes.

    Args:
        limit (Union[Unset, int]):  Default: 50.
        page (Union[Unset, int]):  Default: 1.
        ids (Union[Unset, list[int]]):
        location_id (Union[Unset, int]):
        status (Union[Unset, str]):
        stocktake_number (Union[Unset, str]):
        stock_adjustment_id (Union[Unset, float]):
        created_at_min (Union[Unset, datetime.datetime]):
        created_at_max (Union[Unset, datetime.datetime]):
        updated_at_min (Union[Unset, datetime.datetime]):
        updated_at_max (Union[Unset, datetime.datetime]):
        include_deleted (Union[Unset, bool]):

    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[Union[ErrorResponse, StocktakeListResponse]]
    """

    kwargs = _get_kwargs(
        limit=limit,
        page=page,
        ids=ids,
        location_id=location_id,
        status=status,
        stocktake_number=stocktake_number,
        stock_adjustment_id=stock_adjustment_id,
        created_at_min=created_at_min,
        created_at_max=created_at_max,
        updated_at_min=updated_at_min,
        updated_at_max=updated_at_max,
        include_deleted=include_deleted,
    )

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

    return _build_response(client=client, response=response)

sync(*, client, limit=50, page=1, ids=UNSET, location_id=UNSET, status=UNSET, stocktake_number=UNSET, stock_adjustment_id=UNSET, created_at_min=UNSET, created_at_max=UNSET, updated_at_min=UNSET, updated_at_max=UNSET, include_deleted=UNSET)

List stocktakes

Returns a list of stocktakes.

Parameters:

  • limit (Union[Unset, int], default: 50 ) –

    Default: 50.

  • page (Union[Unset, int], default: 1 ) –

    Default: 1.

  • ids (Union[Unset, list[int]], default: UNSET ) –
  • location_id (Union[Unset, int], default: UNSET ) –
  • status (Union[Unset, str], default: UNSET ) –
  • stocktake_number (Union[Unset, str], default: UNSET ) –
  • stock_adjustment_id (Union[Unset, float], default: UNSET ) –
  • created_at_min (Union[Unset, datetime], default: UNSET ) –
  • created_at_max (Union[Unset, datetime], default: UNSET ) –
  • updated_at_min (Union[Unset, datetime], default: UNSET ) –
  • updated_at_max (Union[Unset, datetime], default: UNSET ) –
  • include_deleted (Union[Unset, bool], default: UNSET ) –

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/stocktake/get_all_stocktakes.py 
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
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
244
def sync(
    *,
    client: AuthenticatedClient | Client,
    limit: Unset | int = 50,
    page: Unset | int = 1,
    ids: Unset | list[int] = UNSET,
    location_id: Unset | int = UNSET,
    status: Unset | str = UNSET,
    stocktake_number: Unset | str = UNSET,
    stock_adjustment_id: Unset | float = UNSET,
    created_at_min: Unset | datetime.datetime = UNSET,
    created_at_max: Unset | datetime.datetime = UNSET,
    updated_at_min: Unset | datetime.datetime = UNSET,
    updated_at_max: Unset | datetime.datetime = UNSET,
    include_deleted: Unset | bool = UNSET,
) -> ErrorResponse | StocktakeListResponse | None:
    """List stocktakes

     Returns a list of stocktakes.

    Args:
        limit (Union[Unset, int]):  Default: 50.
        page (Union[Unset, int]):  Default: 1.
        ids (Union[Unset, list[int]]):
        location_id (Union[Unset, int]):
        status (Union[Unset, str]):
        stocktake_number (Union[Unset, str]):
        stock_adjustment_id (Union[Unset, float]):
        created_at_min (Union[Unset, datetime.datetime]):
        created_at_max (Union[Unset, datetime.datetime]):
        updated_at_min (Union[Unset, datetime.datetime]):
        updated_at_max (Union[Unset, datetime.datetime]):
        include_deleted (Union[Unset, bool]):

    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:
        Union[ErrorResponse, StocktakeListResponse]
    """

    return sync_detailed(
        client=client,
        limit=limit,
        page=page,
        ids=ids,
        location_id=location_id,
        status=status,
        stocktake_number=stocktake_number,
        stock_adjustment_id=stock_adjustment_id,
        created_at_min=created_at_min,
        created_at_max=created_at_max,
        updated_at_min=updated_at_min,
        updated_at_max=updated_at_max,
        include_deleted=include_deleted,
    ).parsed

sync_detailed(*, client, limit=50, page=1, ids=UNSET, location_id=UNSET, status=UNSET, stocktake_number=UNSET, stock_adjustment_id=UNSET, created_at_min=UNSET, created_at_max=UNSET, updated_at_min=UNSET, updated_at_max=UNSET, include_deleted=UNSET)

List stocktakes

Returns a list of stocktakes.

Parameters:

  • limit (Union[Unset, int], default: 50 ) –

    Default: 50.

  • page (Union[Unset, int], default: 1 ) –

    Default: 1.

  • ids (Union[Unset, list[int]], default: UNSET ) –
  • location_id (Union[Unset, int], default: UNSET ) –
  • status (Union[Unset, str], default: UNSET ) –
  • stocktake_number (Union[Unset, str], default: UNSET ) –
  • stock_adjustment_id (Union[Unset, float], default: UNSET ) –
  • created_at_min (Union[Unset, datetime], default: UNSET ) –
  • created_at_max (Union[Unset, datetime], default: UNSET ) –
  • updated_at_min (Union[Unset, datetime], default: UNSET ) –
  • updated_at_max (Union[Unset, datetime], default: UNSET ) –
  • include_deleted (Union[Unset, bool], default: UNSET ) –

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/stocktake/get_all_stocktakes.py 
122
123
124
125
126
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
def sync_detailed(
    *,
    client: AuthenticatedClient | Client,
    limit: Unset | int = 50,
    page: Unset | int = 1,
    ids: Unset | list[int] = UNSET,
    location_id: Unset | int = UNSET,
    status: Unset | str = UNSET,
    stocktake_number: Unset | str = UNSET,
    stock_adjustment_id: Unset | float = UNSET,
    created_at_min: Unset | datetime.datetime = UNSET,
    created_at_max: Unset | datetime.datetime = UNSET,
    updated_at_min: Unset | datetime.datetime = UNSET,
    updated_at_max: Unset | datetime.datetime = UNSET,
    include_deleted: Unset | bool = UNSET,
) -> Response[ErrorResponse | StocktakeListResponse]:
    """List stocktakes

     Returns a list of stocktakes.

    Args:
        limit (Union[Unset, int]):  Default: 50.
        page (Union[Unset, int]):  Default: 1.
        ids (Union[Unset, list[int]]):
        location_id (Union[Unset, int]):
        status (Union[Unset, str]):
        stocktake_number (Union[Unset, str]):
        stock_adjustment_id (Union[Unset, float]):
        created_at_min (Union[Unset, datetime.datetime]):
        created_at_max (Union[Unset, datetime.datetime]):
        updated_at_min (Union[Unset, datetime.datetime]):
        updated_at_max (Union[Unset, datetime.datetime]):
        include_deleted (Union[Unset, bool]):

    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[Union[ErrorResponse, StocktakeListResponse]]
    """

    kwargs = _get_kwargs(
        limit=limit,
        page=page,
        ids=ids,
        location_id=location_id,
        status=status,
        stocktake_number=stocktake_number,
        stock_adjustment_id=stock_adjustment_id,
        created_at_min=created_at_min,
        created_at_max=created_at_max,
        updated_at_min=updated_at_min,
        updated_at_max=updated_at_max,
        include_deleted=include_deleted,
    )

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

    return _build_response(client=client, response=response)