Tracked Entity

The tracked entity resource.

Basehttps://rest.carbon.ms/trackedEntity

GET/trackedEntity

List tracked entitys

Retrieve a paginated list of tracked entitys. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/trackedEntity

curl --request GET \
  --url 'https://rest.carbon.ms/trackedEntity?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "quantity": 10,
    "status": "string",
    "sourceDocument": "string",
    "sourceDocumentId": "xyz789",
    "attributes": "string",
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/trackedEntity

Retrieve a tracked entity

Fetch a single tracked entity by filtering on `id`.

Query parameters

idstring

Match on the tracked entity's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/trackedEntity

curl --request GET \
  --url 'https://rest.carbon.ms/trackedEntity?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "quantity": 10,
  "status": "string",
  "sourceDocument": "string",
  "sourceDocumentId": "xyz789",
  "attributes": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/trackedEntity

Create a tracked entity

Create a new tracked entity.

Body parameters

quantitynumberrequired

statustrackedEntityStatusrequired

sourceDocumentstringrequired

sourceDocumentIdstringrequired

sourceDocumentReadableIdstring

attributesobjectrequired

companyIdstringrequired

References company.id

readableIdstring

itemIdstring

References item.id

expirationDatedate

POSThttps://rest.carbon.ms/trackedEntity

curl --request POST \
  --url https://rest.carbon.ms/trackedEntity \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"quantity":10,"status":"string","sourceDocument":"string","sourceDocumentId":"xyz789","attributes":"string","companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "quantity": 10,
  "status": "string",
  "sourceDocument": "string",
  "sourceDocumentId": "xyz789",
  "attributes": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/trackedEntity

Update a tracked entity

Update an existing tracked entity, matched on `id`.

Body parameters

quantitynumberrequired

statustrackedEntityStatusrequired

sourceDocumentstringrequired

sourceDocumentIdstringrequired

sourceDocumentReadableIdstring

attributesobjectrequired

companyIdstringrequired

References company.id

readableIdstring

itemIdstring

References item.id

expirationDatedate

PATCHhttps://rest.carbon.ms/trackedEntity

curl --request PATCH \
  --url 'https://rest.carbon.ms/trackedEntity?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"quantity":10}'

Response

{
  "id": "abc123def456",
  "quantity": 10,
  "status": "string",
  "sourceDocument": "string",
  "sourceDocumentId": "xyz789",
  "attributes": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/trackedEntity

Delete a tracked entity

Delete a tracked entity, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the tracked entity to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/trackedEntity

curl --request DELETE \
  --url 'https://rest.carbon.ms/trackedEntity?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content