Skip to content

katana_public_api_client.api.purchase_order.update_purchase_order

katana_public_api_client.api.purchase_order.update_purchase_order

Classes

Functions

asyncio(id, *, client, body) async

Update a purchase order

Updates the specified purchase order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Parameters:

  • id (int) –
  • body (UpdatePurchaseOrderRequest) –

    Request payload for updating an existing purchase order's details, status, and line items Example: {'order_no': 'PO-2024-0156-REVISED', 'expected_arrival_date': '2024-02-20T00:00:00Z', 'status': 'PARTIALLY_RECEIVED', 'additional_info': 'Delivery delayed due to weather - updated schedule'}.

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/purchase_order/update_purchase_order.py 
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
262
263
264
265
266
267
268
269
270
271
272
273
274
async def asyncio(
    id: int,
    *,
    client: AuthenticatedClient | Client,
    body: UpdatePurchaseOrderRequest,
) -> (
    DetailedErrorResponse
    | ErrorResponse
    | Union["OutsourcedPurchaseOrder", "RegularPurchaseOrder"]
    | None
):
    """Update a purchase order

     Updates the specified purchase order by setting the values of the parameters passed.
        Any parameters not provided will be left unchanged.

    Args:
        id (int):
        body (UpdatePurchaseOrderRequest): Request payload for updating an existing purchase
            order's details, status, and line items Example: {'order_no': 'PO-2024-0156-REVISED',
            'expected_arrival_date': '2024-02-20T00:00:00Z', 'status': 'PARTIALLY_RECEIVED',
            'additional_info': 'Delivery delayed due to weather - updated schedule'}.

    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[DetailedErrorResponse, ErrorResponse, Union['OutsourcedPurchaseOrder', 'RegularPurchaseOrder']]
    """

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

asyncio_detailed(id, *, client, body) async

Update a purchase order

Updates the specified purchase order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Parameters:

  • id (int) –
  • body (UpdatePurchaseOrderRequest) –

    Request payload for updating an existing purchase order's details, status, and line items Example: {'order_no': 'PO-2024-0156-REVISED', 'expected_arrival_date': '2024-02-20T00:00:00Z', 'status': 'PARTIALLY_RECEIVED', 'additional_info': 'Delivery delayed due to weather - updated schedule'}.

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/purchase_order/update_purchase_order.py 
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
async def asyncio_detailed(
    id: int,
    *,
    client: AuthenticatedClient | Client,
    body: UpdatePurchaseOrderRequest,
) -> Response[
    DetailedErrorResponse
    | ErrorResponse
    | Union["OutsourcedPurchaseOrder", "RegularPurchaseOrder"]
]:
    """Update a purchase order

     Updates the specified purchase order by setting the values of the parameters passed.
        Any parameters not provided will be left unchanged.

    Args:
        id (int):
        body (UpdatePurchaseOrderRequest): Request payload for updating an existing purchase
            order's details, status, and line items Example: {'order_no': 'PO-2024-0156-REVISED',
            'expected_arrival_date': '2024-02-20T00:00:00Z', 'status': 'PARTIALLY_RECEIVED',
            'additional_info': 'Delivery delayed due to weather - updated schedule'}.

    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[DetailedErrorResponse, ErrorResponse, Union['OutsourcedPurchaseOrder', 'RegularPurchaseOrder']]]
    """

    kwargs = _get_kwargs(
        id=id,
        body=body,
    )

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

    return _build_response(client=client, response=response)

sync(id, *, client, body)

Update a purchase order

Updates the specified purchase order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Parameters:

  • id (int) –
  • body (UpdatePurchaseOrderRequest) –

    Request payload for updating an existing purchase order's details, status, and line items Example: {'order_no': 'PO-2024-0156-REVISED', 'expected_arrival_date': '2024-02-20T00:00:00Z', 'status': 'PARTIALLY_RECEIVED', 'additional_info': 'Delivery delayed due to weather - updated schedule'}.

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/purchase_order/update_purchase_order.py 
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
185
186
187
188
189
190
191
192
def sync(
    id: int,
    *,
    client: AuthenticatedClient | Client,
    body: UpdatePurchaseOrderRequest,
) -> (
    DetailedErrorResponse
    | ErrorResponse
    | Union["OutsourcedPurchaseOrder", "RegularPurchaseOrder"]
    | None
):
    """Update a purchase order

     Updates the specified purchase order by setting the values of the parameters passed.
        Any parameters not provided will be left unchanged.

    Args:
        id (int):
        body (UpdatePurchaseOrderRequest): Request payload for updating an existing purchase
            order's details, status, and line items Example: {'order_no': 'PO-2024-0156-REVISED',
            'expected_arrival_date': '2024-02-20T00:00:00Z', 'status': 'PARTIALLY_RECEIVED',
            'additional_info': 'Delivery delayed due to weather - updated schedule'}.

    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[DetailedErrorResponse, ErrorResponse, Union['OutsourcedPurchaseOrder', 'RegularPurchaseOrder']]
    """

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

sync_detailed(id, *, client, body)

Update a purchase order

Updates the specified purchase order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Parameters:

  • id (int) –
  • body (UpdatePurchaseOrderRequest) –

    Request payload for updating an existing purchase order's details, status, and line items Example: {'order_no': 'PO-2024-0156-REVISED', 'expected_arrival_date': '2024-02-20T00:00:00Z', 'status': 'PARTIALLY_RECEIVED', 'additional_info': 'Delivery delayed due to weather - updated schedule'}.

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/purchase_order/update_purchase_order.py 
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
def sync_detailed(
    id: int,
    *,
    client: AuthenticatedClient | Client,
    body: UpdatePurchaseOrderRequest,
) -> Response[
    DetailedErrorResponse
    | ErrorResponse
    | Union["OutsourcedPurchaseOrder", "RegularPurchaseOrder"]
]:
    """Update a purchase order

     Updates the specified purchase order by setting the values of the parameters passed.
        Any parameters not provided will be left unchanged.

    Args:
        id (int):
        body (UpdatePurchaseOrderRequest): Request payload for updating an existing purchase
            order's details, status, and line items Example: {'order_no': 'PO-2024-0156-REVISED',
            'expected_arrival_date': '2024-02-20T00:00:00Z', 'status': 'PARTIALLY_RECEIVED',
            'additional_info': 'Delivery delayed due to weather - updated schedule'}.

    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[DetailedErrorResponse, ErrorResponse, Union['OutsourcedPurchaseOrder', 'RegularPurchaseOrder']]]
    """

    kwargs = _get_kwargs(
        id=id,
        body=body,
    )

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

    return _build_response(client=client, response=response)