TRANXACT.AI Help

Supply Chain · Services and actions

Assets

The assets service of Supply Chain: 5 operation(s).

Type REST5 operationsBase path /api/scm/assets

Download specification (OpenAPI 3.1)

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 › Assets 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.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/scm/assets/handheldHandheld

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/assets/handheld" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/assets/lookup/{code}Lookup

Path parameters

NameTypeDescription
codestring (uuid)The record's code, as a list returns it.

Response

200 with the data as JSON.

Sample request

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

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):

condition*, countedOn, quantity, barcode, remarks; condition one of working|non_working|missing

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/assets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/count" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"condition":"value","countedOn":"value","quantity":"value","barcode":"value","remarks;":"value"}'
GET/api/scm/assets/labelsLabels

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/assets/labels" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/assets/labelsLabels

Request body

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

assetIds, copies

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/assets/labels" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"assetIds":"value","copies":"value"}'

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 › Assets 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.