Skip to content

katana_public_api_client.api.serial_number.create_serial_numbers

katana_public_api_client.api.serial_number.create_serial_numbers

Classes

Functions

asyncio(*, client, body) async

Create serial numbers

Mints new or transfers existing serial numbers to a resource.

Write semantics differ by resource_type (see CreateSerialNumberResourceType):

  • Mint (ManufacturingOrder, PurchaseOrderRow) — the serial-number string doesn't need to pre-exist. The API creates a new record and links it to the target resource.
  • Transfer (SalesOrderRow, StockTransferRow, StockAdjustmentRow) — the serial-number string MUST already exist (typically attached to a ManufacturingOrder output). The API moves the linkage from its current resource to the target. If the string isn't anywhere yet, the entry lands in failed with reason: MISSING — the call still returns 200.

Partial failure is the norm, not the exception. The response carries successful AND failed arrays; consumers must handle both. A 200 status does NOT mean every input was applied — check failed to learn which strings the API rejected.

422 cases: non-existent resource_id returns 422 UnprocessableEntityError with detail No entity found (not 404). Invalid resource_type (e.g. Production) returns 422 with an Ajv-style validation detail.

Transfer response quirks: on a successful transfer the moved record's transaction_id may be the literal string undefined and resource_id may be null — re-fetch via GET /serial_numbers to confirm the landing state.

Parameters:

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/serial_number/create_serial_numbers.py 
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
308
309
310
311
312
313
314
315
async def asyncio(
    *,
    client: AuthenticatedClient | Client,
    body: CreateSerialNumbersRequest,
) -> CreateSerialNumbersResponse | DetailedErrorResponse | ErrorResponse | None:
    """Create serial numbers

     Mints new or transfers existing serial numbers to a resource.

    **Write semantics differ by ``resource_type``** (see
    ``CreateSerialNumberResourceType``):

    - **Mint** (``ManufacturingOrder``, ``PurchaseOrderRow``) — the
      serial-number string doesn't need to pre-exist. The API creates a
      new record and links it to the target resource.
    - **Transfer** (``SalesOrderRow``, ``StockTransferRow``,
      ``StockAdjustmentRow``) — the serial-number string MUST already
      exist (typically attached to a ManufacturingOrder output). The
      API moves the linkage from its current resource to the target.
      If the string isn't anywhere yet, the entry lands in ``failed``
      with ``reason: MISSING`` — the call still returns 200.

    **Partial failure is the norm, not the exception.** The response
    carries ``successful`` AND ``failed`` arrays; consumers must
    handle both. A 200 status does NOT mean every input was applied —
    check ``failed`` to learn which strings the API rejected.

    **422 cases:** non-existent ``resource_id`` returns
    ``422 UnprocessableEntityError`` with detail ``No entity found``
    (not 404). Invalid ``resource_type`` (e.g. ``Production``)
    returns 422 with an Ajv-style validation detail.

    **Transfer response quirks:** on a successful transfer the moved
    record's ``transaction_id`` may be the literal string
    ``undefined`` and ``resource_id`` may be ``null`` — re-fetch via
    ``GET /serial_numbers`` to confirm the landing state.

    Args:
        body (CreateSerialNumbersRequest): Request payload for creating serial numbers for a
            resource

    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:
        CreateSerialNumbersResponse | DetailedErrorResponse | ErrorResponse
    """

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

asyncio_detailed(*, client, body) async

Create serial numbers

Mints new or transfers existing serial numbers to a resource.

Write semantics differ by resource_type (see CreateSerialNumberResourceType):

  • Mint (ManufacturingOrder, PurchaseOrderRow) — the serial-number string doesn't need to pre-exist. The API creates a new record and links it to the target resource.
  • Transfer (SalesOrderRow, StockTransferRow, StockAdjustmentRow) — the serial-number string MUST already exist (typically attached to a ManufacturingOrder output). The API moves the linkage from its current resource to the target. If the string isn't anywhere yet, the entry lands in failed with reason: MISSING — the call still returns 200.

Partial failure is the norm, not the exception. The response carries successful AND failed arrays; consumers must handle both. A 200 status does NOT mean every input was applied — check failed to learn which strings the API rejected.

422 cases: non-existent resource_id returns 422 UnprocessableEntityError with detail No entity found (not 404). Invalid resource_type (e.g. Production) returns 422 with an Ajv-style validation detail.

Transfer response quirks: on a successful transfer the moved record's transaction_id may be the literal string undefined and resource_id may be null — re-fetch via GET /serial_numbers to confirm the landing state.

Parameters:

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/serial_number/create_serial_numbers.py 
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
245
246
247
248
249
250
251
252
253
254
255
256
257
async def asyncio_detailed(
    *,
    client: AuthenticatedClient | Client,
    body: CreateSerialNumbersRequest,
) -> Response[CreateSerialNumbersResponse | DetailedErrorResponse | ErrorResponse]:
    """Create serial numbers

     Mints new or transfers existing serial numbers to a resource.

    **Write semantics differ by ``resource_type``** (see
    ``CreateSerialNumberResourceType``):

    - **Mint** (``ManufacturingOrder``, ``PurchaseOrderRow``) — the
      serial-number string doesn't need to pre-exist. The API creates a
      new record and links it to the target resource.
    - **Transfer** (``SalesOrderRow``, ``StockTransferRow``,
      ``StockAdjustmentRow``) — the serial-number string MUST already
      exist (typically attached to a ManufacturingOrder output). The
      API moves the linkage from its current resource to the target.
      If the string isn't anywhere yet, the entry lands in ``failed``
      with ``reason: MISSING`` — the call still returns 200.

    **Partial failure is the norm, not the exception.** The response
    carries ``successful`` AND ``failed`` arrays; consumers must
    handle both. A 200 status does NOT mean every input was applied —
    check ``failed`` to learn which strings the API rejected.

    **422 cases:** non-existent ``resource_id`` returns
    ``422 UnprocessableEntityError`` with detail ``No entity found``
    (not 404). Invalid ``resource_type`` (e.g. ``Production``)
    returns 422 with an Ajv-style validation detail.

    **Transfer response quirks:** on a successful transfer the moved
    record's ``transaction_id`` may be the literal string
    ``undefined`` and ``resource_id`` may be ``null`` — re-fetch via
    ``GET /serial_numbers`` to confirm the landing state.

    Args:
        body (CreateSerialNumbersRequest): Request payload for creating serial numbers for a
            resource

    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[CreateSerialNumbersResponse | 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)

Create serial numbers

Mints new or transfers existing serial numbers to a resource.

Write semantics differ by resource_type (see CreateSerialNumberResourceType):

  • Mint (ManufacturingOrder, PurchaseOrderRow) — the serial-number string doesn't need to pre-exist. The API creates a new record and links it to the target resource.
  • Transfer (SalesOrderRow, StockTransferRow, StockAdjustmentRow) — the serial-number string MUST already exist (typically attached to a ManufacturingOrder output). The API moves the linkage from its current resource to the target. If the string isn't anywhere yet, the entry lands in failed with reason: MISSING — the call still returns 200.

Partial failure is the norm, not the exception. The response carries successful AND failed arrays; consumers must handle both. A 200 status does NOT mean every input was applied — check failed to learn which strings the API rejected.

422 cases: non-existent resource_id returns 422 UnprocessableEntityError with detail No entity found (not 404). Invalid resource_type (e.g. Production) returns 422 with an Ajv-style validation detail.

Transfer response quirks: on a successful transfer the moved record's transaction_id may be the literal string undefined and resource_id may be null — re-fetch via GET /serial_numbers to confirm the landing state.

Parameters:

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/serial_number/create_serial_numbers.py 
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
def sync(
    *,
    client: AuthenticatedClient | Client,
    body: CreateSerialNumbersRequest,
) -> CreateSerialNumbersResponse | DetailedErrorResponse | ErrorResponse | None:
    """Create serial numbers

     Mints new or transfers existing serial numbers to a resource.

    **Write semantics differ by ``resource_type``** (see
    ``CreateSerialNumberResourceType``):

    - **Mint** (``ManufacturingOrder``, ``PurchaseOrderRow``) — the
      serial-number string doesn't need to pre-exist. The API creates a
      new record and links it to the target resource.
    - **Transfer** (``SalesOrderRow``, ``StockTransferRow``,
      ``StockAdjustmentRow``) — the serial-number string MUST already
      exist (typically attached to a ManufacturingOrder output). The
      API moves the linkage from its current resource to the target.
      If the string isn't anywhere yet, the entry lands in ``failed``
      with ``reason: MISSING`` — the call still returns 200.

    **Partial failure is the norm, not the exception.** The response
    carries ``successful`` AND ``failed`` arrays; consumers must
    handle both. A 200 status does NOT mean every input was applied —
    check ``failed`` to learn which strings the API rejected.

    **422 cases:** non-existent ``resource_id`` returns
    ``422 UnprocessableEntityError`` with detail ``No entity found``
    (not 404). Invalid ``resource_type`` (e.g. ``Production``)
    returns 422 with an Ajv-style validation detail.

    **Transfer response quirks:** on a successful transfer the moved
    record's ``transaction_id`` may be the literal string
    ``undefined`` and ``resource_id`` may be ``null`` — re-fetch via
    ``GET /serial_numbers`` to confirm the landing state.

    Args:
        body (CreateSerialNumbersRequest): Request payload for creating serial numbers for a
            resource

    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:
        CreateSerialNumbersResponse | DetailedErrorResponse | ErrorResponse
    """

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

sync_detailed(*, client, body)

Create serial numbers

Mints new or transfers existing serial numbers to a resource.

Write semantics differ by resource_type (see CreateSerialNumberResourceType):

  • Mint (ManufacturingOrder, PurchaseOrderRow) — the serial-number string doesn't need to pre-exist. The API creates a new record and links it to the target resource.
  • Transfer (SalesOrderRow, StockTransferRow, StockAdjustmentRow) — the serial-number string MUST already exist (typically attached to a ManufacturingOrder output). The API moves the linkage from its current resource to the target. If the string isn't anywhere yet, the entry lands in failed with reason: MISSING — the call still returns 200.

Partial failure is the norm, not the exception. The response carries successful AND failed arrays; consumers must handle both. A 200 status does NOT mean every input was applied — check failed to learn which strings the API rejected.

422 cases: non-existent resource_id returns 422 UnprocessableEntityError with detail No entity found (not 404). Invalid resource_type (e.g. Production) returns 422 with an Ajv-style validation detail.

Transfer response quirks: on a successful transfer the moved record's transaction_id may be the literal string undefined and resource_id may be null — re-fetch via GET /serial_numbers to confirm the landing state.

Parameters:

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/serial_number/create_serial_numbers.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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
def sync_detailed(
    *,
    client: AuthenticatedClient | Client,
    body: CreateSerialNumbersRequest,
) -> Response[CreateSerialNumbersResponse | DetailedErrorResponse | ErrorResponse]:
    """Create serial numbers

     Mints new or transfers existing serial numbers to a resource.

    **Write semantics differ by ``resource_type``** (see
    ``CreateSerialNumberResourceType``):

    - **Mint** (``ManufacturingOrder``, ``PurchaseOrderRow``) — the
      serial-number string doesn't need to pre-exist. The API creates a
      new record and links it to the target resource.
    - **Transfer** (``SalesOrderRow``, ``StockTransferRow``,
      ``StockAdjustmentRow``) — the serial-number string MUST already
      exist (typically attached to a ManufacturingOrder output). The
      API moves the linkage from its current resource to the target.
      If the string isn't anywhere yet, the entry lands in ``failed``
      with ``reason: MISSING`` — the call still returns 200.

    **Partial failure is the norm, not the exception.** The response
    carries ``successful`` AND ``failed`` arrays; consumers must
    handle both. A 200 status does NOT mean every input was applied —
    check ``failed`` to learn which strings the API rejected.

    **422 cases:** non-existent ``resource_id`` returns
    ``422 UnprocessableEntityError`` with detail ``No entity found``
    (not 404). Invalid ``resource_type`` (e.g. ``Production``)
    returns 422 with an Ajv-style validation detail.

    **Transfer response quirks:** on a successful transfer the moved
    record's ``transaction_id`` may be the literal string
    ``undefined`` and ``resource_id`` may be ``null`` — re-fetch via
    ``GET /serial_numbers`` to confirm the landing state.

    Args:
        body (CreateSerialNumbersRequest): Request payload for creating serial numbers for a
            resource

    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[CreateSerialNumbersResponse | DetailedErrorResponse | ErrorResponse]
    """

    kwargs = _get_kwargs(
        body=body,
    )

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

    return _build_response(client=client, response=response)