TRANXACT.AI Help

Supply Chain · Traceability

Serial Numbers

Read and maintain serials records (scm.serial_numbers).

Type REST10 operationsBase path /api/scm/serialsPublished as /api/v1/serials

Download specification (OpenAPI 3.1) Screen: Serial Numbers

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Supply Chain › Serial Numbers on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablescm.serial_numbers · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

10 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/scm/serialsList serial numbers

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "serial_no": "SER-000001",
      "lot_no": "LOT-000001",
      "status": "draft",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "received_receipt_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "manufactured_at": "2026-10-30"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/serials?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/serials/{id}Read one serials

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "serial_no": "SER-000001",
  "lot_no": "LOT-000001",
  "status": "draft",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "received_receipt_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "manufactured_at": "2026-10-30"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/serials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/serialsPost serial numbers

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/serials" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/serials/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/serials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/scm/serials/{id}Put serial numbers

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/serials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/serials/{id}Delete serial numbers

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/scm/serials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/serials/{id}/historyHistory

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/serials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/history" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/serials/lookup/{serialNo}Lookup

Path parameters

NameTypeDescription
serialNostring (uuid)The record's serialNo, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/serials/lookup/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/serials/registerRegister

Request body

The keys this action reads (* = required; "one of" lists the only values):

itemId*, binId, lotNo, serials, count, notes

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/serials/register" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"itemId":"value","binId":"value","lotNo":"value","serials":"value","count":"value","notes":"value"}'
POST/api/scm/serials/{id}/moveMove

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

toBinId, status, notes, referenceNo; status one of scrapped

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/serials/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/move" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"toBinId":"value","status":"value","notes":"value","referenceNo;":"value"}'

Data model

Every field of a serials, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
item_iduuidread onlyItem id
serial_notextread onlySerial no
lot_notextread onlyLot no
statustextread onlyStatus
location_iduuidread onlyLocation id
warehouse_iduuidread onlyWarehouse id
bin_iduuidread onlyBin id
supplier_iduuidread onlySupplier id
received_receipt_iduuidread onlyReceived receipt id
production_order_iduuidread onlyProduction order id
account_iduuidread onlyAccount id
manufactured_atdateread onlyManufactured at
received_attimestamp with time zoneread onlyReceived at
expiry_datedateread onlyExpiry date
warranty_untildateread onlyWarranty until
notestextread onlyNotes
created_attimestamp with time zoneread onlyCreated at
receipt_line_iduuidread onlyReceipt line id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Serial Numbers for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.