Picking List Line Tracked Entity

The picking list line tracked entity resource.

Basehttps://rest.carbon.ms/pickingListLineTrackedEntity

GET/pickingListLineTrackedEntity

List picking list line tracked entities

Retrieve a paginated list of picking list line tracked entities. 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/pickingListLineTrackedEntity

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

Response

[
  {
    "pickingListLineId": "xyz789",
    "trackedEntityId": "xyz789",
    "quantity": 10,
    "quantityPicked": 10,
    "companyId": "xyz789"
  }
]

GET/pickingListLineTrackedEntity

Retrieve a picking list line tracked entity

Fetch a single picking list line tracked entity by filtering on `pickingListLineId`.

Query parameters

pickingListLineIdstring

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

GEThttps://rest.carbon.ms/pickingListLineTrackedEntity

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

Response

{
  "pickingListLineId": "xyz789",
  "trackedEntityId": "xyz789",
  "quantity": 10,
  "quantityPicked": 10,
  "companyId": "xyz789"
}

POST/pickingListLineTrackedEntity

Create a picking list line tracked entity

Create a new picking list line tracked entity.

Body parameters

quantitynumberrequired

quantityPickednumberrequired

companyIdstringrequired

POSThttps://rest.carbon.ms/pickingListLineTrackedEntity

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

Response

{
  "pickingListLineId": "xyz789",
  "trackedEntityId": "xyz789",
  "quantity": 10,
  "quantityPicked": 10,
  "companyId": "xyz789"
}

PATCH/pickingListLineTrackedEntity

Update a picking list line tracked entity

Update an existing picking list line tracked entity, matched on `pickingListLineId`.

Body parameters

quantitynumberrequired

quantityPickednumberrequired

companyIdstringrequired

PATCHhttps://rest.carbon.ms/pickingListLineTrackedEntity

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

Response

{
  "pickingListLineId": "xyz789",
  "trackedEntityId": "xyz789",
  "quantity": 10,
  "quantityPicked": 10,
  "companyId": "xyz789"
}

DELETE/pickingListLineTrackedEntity

Delete a picking list line tracked entity

Delete a picking list line tracked entity, matched on `pickingListLineId`. Returns 204 No Content.

Query parameters

pickingListLineIdstring

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

DELETEhttps://rest.carbon.ms/pickingListLineTrackedEntity

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

204 No Content