receiveSerial

POST

/serials

curl --request POST \
  --url https://app.dev.buildtrace.eu/api/serials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "partRevisionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "serialNumber": "example", "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "supplierId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Required scope: inventory:write.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

partRevisionId

required

string format: uuid

serialNumber

required

string

locationId

string format: uuid

supplierId

string format: uuid

Example ^generated

{
  "partRevisionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "serialNumber": "example",
  "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "supplierId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

201

Created

Media typeapplication/json

object

id

required

string format: uuid

partRevisionId

required

string format: uuid

serialNumber

required

string

status

required

string

currentLocationId

string format: uuid

lotNumber

string

consumedIntoSerialId

string format: uuid

reservedForOrderId

string format: uuid

partCode

Code of the serial’s part (read-only; populated by build-order unit reads).

string

partName

Name of the serial’s part (read-only; populated by build-order unit reads).

string

revisionLabel

Label of the serial’s part revision (read-only; populated by build-order unit reads).

string

finalTestResult

The unit’s final-test outcome (read-only; populated by a build order’s units list): its latest FINAL inspection — the one recorded when it was built, or a retest since, which may be CONDITIONAL — else NOT_TESTED when it was built with no final test. Absent when unknown. The as-built record keeps the result at build time.

string

Allowed values: PASS FAIL CONDITIONAL NOT_TESTED

ecoState

Derived ECO status (read-only; populated by list reads). NEEDS_WORK when an ECO targets this serial with no retrofit recorded yet; APPLIED when it has ECO history and nothing outstanding; NONE when no ECO has ever touched it.

string

Allowed values: NEEDS_WORK APPLIED NONE

createdAt

required

string format: date-time

Example

{
  "finalTestResult": "PASS",
  "ecoState": "NEEDS_WORK"
}

400

Bad request

Media typeapplication/json

object

error

required

string

Example ^generated

{
  "error": "example"
}

401

Unauthorized

404

Not found

409

The serial number is already used by another unit, or the organization’s serials limit is reached

Media typeapplication/json

object

error

required

string

Example ^generated

{
  "error": "example"
}