Skip to content

katana_public_api_client.api.inventory.get_all_inventory_signals

katana_public_api_client.api.inventory.get_all_inventory_signals

Classes

Functions

asyncio(*, client, demand_window=GetAllInventorySignalsDemandWindow.VALUE_30, variant_id=UNSET, stock_risk=UNSET, limit=UNSET, page=UNSET) async

List inventory replenishment signals

Returns a list of inventory replenishment signals, one per variant. Signals are account-wide, summed across all locations.

Only variants with demand in the selected demand window have a row, so a variant_id filter can return fewer rows than ids requested. A missing row means no recent demand, not a missing variant - use /inventory for a full listing.

Parameters:

  • demand_window (GetAllInventorySignalsDemandWindow | Unset, default: VALUE_30 ) –

    Default: GetAllInventorySignalsDemandWindow.VALUE_30.

  • variant_id (list[int] | Unset, default: UNSET ) –
  • stock_risk (GetAllInventorySignalsStockRisk | Unset, default: UNSET ) –
  • limit (int | Unset, default: UNSET ) –

    Default: 50.

  • page (int | Unset, default: UNSET ) –

    Default: 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/inventory/get_all_inventory_signals.py 
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
308
309
310
311
312
async def asyncio(
    *,
    client: AuthenticatedClient | Client,
    demand_window: GetAllInventorySignalsDemandWindow
    | Unset = GetAllInventorySignalsDemandWindow.VALUE_30,
    variant_id: list[int] | Unset = UNSET,
    stock_risk: GetAllInventorySignalsStockRisk | Unset = UNSET,
    limit: int | Unset = UNSET,
    page: int | Unset = UNSET,
) -> ErrorResponse | InventorySignalListResponse | None:
    """List inventory replenishment signals

     Returns a list of inventory replenishment signals, one per variant. Signals are account-wide, summed
      across all locations.

      Only variants with demand in the selected demand window have a row, so a variant_id filter can
    return fewer rows
      than ids requested. A missing row means no recent demand, not a missing variant - use /inventory
    for a
      full listing.

    Args:
        demand_window (GetAllInventorySignalsDemandWindow | Unset):  Default:
            GetAllInventorySignalsDemandWindow.VALUE_30.
        variant_id (list[int] | Unset):
        stock_risk (GetAllInventorySignalsStockRisk | Unset):
        limit (int | Unset):  Default: 50.
        page (int | Unset):  Default: 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:
        ErrorResponse | InventorySignalListResponse
    """

    return (
        await asyncio_detailed(
            client=client,
            demand_window=demand_window,
            variant_id=variant_id,
            stock_risk=stock_risk,
            limit=limit,
            page=page,
        )
    ).parsed

asyncio_detailed(*, client, demand_window=GetAllInventorySignalsDemandWindow.VALUE_30, variant_id=UNSET, stock_risk=UNSET, limit=UNSET, page=UNSET) async

List inventory replenishment signals

Returns a list of inventory replenishment signals, one per variant. Signals are account-wide, summed across all locations.

Only variants with demand in the selected demand window have a row, so a variant_id filter can return fewer rows than ids requested. A missing row means no recent demand, not a missing variant - use /inventory for a full listing.

Parameters:

  • demand_window (GetAllInventorySignalsDemandWindow | Unset, default: VALUE_30 ) –

    Default: GetAllInventorySignalsDemandWindow.VALUE_30.

  • variant_id (list[int] | Unset, default: UNSET ) –
  • stock_risk (GetAllInventorySignalsStockRisk | Unset, default: UNSET ) –
  • limit (int | Unset, default: UNSET ) –

    Default: 50.

  • page (int | Unset, default: UNSET ) –

    Default: 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/inventory/get_all_inventory_signals.py 
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
async def asyncio_detailed(
    *,
    client: AuthenticatedClient | Client,
    demand_window: GetAllInventorySignalsDemandWindow
    | Unset = GetAllInventorySignalsDemandWindow.VALUE_30,
    variant_id: list[int] | Unset = UNSET,
    stock_risk: GetAllInventorySignalsStockRisk | Unset = UNSET,
    limit: int | Unset = UNSET,
    page: int | Unset = UNSET,
) -> Response[ErrorResponse | InventorySignalListResponse]:
    """List inventory replenishment signals

     Returns a list of inventory replenishment signals, one per variant. Signals are account-wide, summed
      across all locations.

      Only variants with demand in the selected demand window have a row, so a variant_id filter can
    return fewer rows
      than ids requested. A missing row means no recent demand, not a missing variant - use /inventory
    for a
      full listing.

    Args:
        demand_window (GetAllInventorySignalsDemandWindow | Unset):  Default:
            GetAllInventorySignalsDemandWindow.VALUE_30.
        variant_id (list[int] | Unset):
        stock_risk (GetAllInventorySignalsStockRisk | Unset):
        limit (int | Unset):  Default: 50.
        page (int | Unset):  Default: 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[ErrorResponse | InventorySignalListResponse]
    """

    kwargs = _get_kwargs(
        demand_window=demand_window,
        variant_id=variant_id,
        stock_risk=stock_risk,
        limit=limit,
        page=page,
    )

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

    return _build_response(client=client, response=response)

sync(*, client, demand_window=GetAllInventorySignalsDemandWindow.VALUE_30, variant_id=UNSET, stock_risk=UNSET, limit=UNSET, page=UNSET)

List inventory replenishment signals

Returns a list of inventory replenishment signals, one per variant. Signals are account-wide, summed across all locations.

Only variants with demand in the selected demand window have a row, so a variant_id filter can return fewer rows than ids requested. A missing row means no recent demand, not a missing variant - use /inventory for a full listing.

Parameters:

  • demand_window (GetAllInventorySignalsDemandWindow | Unset, default: VALUE_30 ) –

    Default: GetAllInventorySignalsDemandWindow.VALUE_30.

  • variant_id (list[int] | Unset, default: UNSET ) –
  • stock_risk (GetAllInventorySignalsStockRisk | Unset, default: UNSET ) –
  • limit (int | Unset, default: UNSET ) –

    Default: 50.

  • page (int | Unset, default: UNSET ) –

    Default: 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/inventory/get_all_inventory_signals.py 
163
164
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
204
205
206
207
208
209
def sync(
    *,
    client: AuthenticatedClient | Client,
    demand_window: GetAllInventorySignalsDemandWindow
    | Unset = GetAllInventorySignalsDemandWindow.VALUE_30,
    variant_id: list[int] | Unset = UNSET,
    stock_risk: GetAllInventorySignalsStockRisk | Unset = UNSET,
    limit: int | Unset = UNSET,
    page: int | Unset = UNSET,
) -> ErrorResponse | InventorySignalListResponse | None:
    """List inventory replenishment signals

     Returns a list of inventory replenishment signals, one per variant. Signals are account-wide, summed
      across all locations.

      Only variants with demand in the selected demand window have a row, so a variant_id filter can
    return fewer rows
      than ids requested. A missing row means no recent demand, not a missing variant - use /inventory
    for a
      full listing.

    Args:
        demand_window (GetAllInventorySignalsDemandWindow | Unset):  Default:
            GetAllInventorySignalsDemandWindow.VALUE_30.
        variant_id (list[int] | Unset):
        stock_risk (GetAllInventorySignalsStockRisk | Unset):
        limit (int | Unset):  Default: 50.
        page (int | Unset):  Default: 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:
        ErrorResponse | InventorySignalListResponse
    """

    return sync_detailed(
        client=client,
        demand_window=demand_window,
        variant_id=variant_id,
        stock_risk=stock_risk,
        limit=limit,
        page=page,
    ).parsed

sync_detailed(*, client, demand_window=GetAllInventorySignalsDemandWindow.VALUE_30, variant_id=UNSET, stock_risk=UNSET, limit=UNSET, page=UNSET)

List inventory replenishment signals

Returns a list of inventory replenishment signals, one per variant. Signals are account-wide, summed across all locations.

Only variants with demand in the selected demand window have a row, so a variant_id filter can return fewer rows than ids requested. A missing row means no recent demand, not a missing variant - use /inventory for a full listing.

Parameters:

  • demand_window (GetAllInventorySignalsDemandWindow | Unset, default: VALUE_30 ) –

    Default: GetAllInventorySignalsDemandWindow.VALUE_30.

  • variant_id (list[int] | Unset, default: UNSET ) –
  • stock_risk (GetAllInventorySignalsStockRisk | Unset, default: UNSET ) –
  • limit (int | Unset, default: UNSET ) –

    Default: 50.

  • page (int | Unset, default: UNSET ) –

    Default: 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/inventory/get_all_inventory_signals.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
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
def sync_detailed(
    *,
    client: AuthenticatedClient | Client,
    demand_window: GetAllInventorySignalsDemandWindow
    | Unset = GetAllInventorySignalsDemandWindow.VALUE_30,
    variant_id: list[int] | Unset = UNSET,
    stock_risk: GetAllInventorySignalsStockRisk | Unset = UNSET,
    limit: int | Unset = UNSET,
    page: int | Unset = UNSET,
) -> Response[ErrorResponse | InventorySignalListResponse]:
    """List inventory replenishment signals

     Returns a list of inventory replenishment signals, one per variant. Signals are account-wide, summed
      across all locations.

      Only variants with demand in the selected demand window have a row, so a variant_id filter can
    return fewer rows
      than ids requested. A missing row means no recent demand, not a missing variant - use /inventory
    for a
      full listing.

    Args:
        demand_window (GetAllInventorySignalsDemandWindow | Unset):  Default:
            GetAllInventorySignalsDemandWindow.VALUE_30.
        variant_id (list[int] | Unset):
        stock_risk (GetAllInventorySignalsStockRisk | Unset):
        limit (int | Unset):  Default: 50.
        page (int | Unset):  Default: 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[ErrorResponse | InventorySignalListResponse]
    """

    kwargs = _get_kwargs(
        demand_window=demand_window,
        variant_id=variant_id,
        stock_risk=stock_risk,
        limit=limit,
        page=page,
    )

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

    return _build_response(client=client, response=response)