Picking List Line

The picking list line resource.

Basehttps://rest.carbon.ms/pickingListLine

GET/pickingListLine

List picking list lines

Retrieve a paginated list of picking list lines. 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/pickingListLine

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

Response

[
  {
    "id": "abc123def456",
    "pickingListId": "xyz789",
    "jobId": "xyz789",
    "jobMaterialId": "xyz789",
    "itemId": "xyz789",
    "quantityToPick": 10,
    "quantityPicked": 10,
    "status": "string"
  }
]

GET/pickingListLine

Retrieve a picking list line

Fetch a single picking list line by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/pickingListLine

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

Response

{
  "id": "abc123def456",
  "pickingListId": "xyz789",
  "jobId": "xyz789",
  "jobMaterialId": "xyz789",
  "itemId": "xyz789",
  "quantityToPick": 10,
  "quantityPicked": 10,
  "status": "string"
}

POST/pickingListLine

Create a picking list line

Create a new picking list line.

Body parameters

pickingListIdstringrequired

References pickingList.id

jobIdstringrequired

References job.id

jobMaterialIdstringrequired

References jobMaterial.id

jobOperationIdstring

References jobOperation.id

itemIdstringrequired

References item.id

quantityToPicknumberrequired

quantityPickednumberrequired

outstandingQuantitynumber

storageUnitIdstring

References storageUnit.id

toStorageUnitIdstring

References storageUnit.id

statuspickingListLineStatusrequired

companyIdstringrequired

References company.id

customFieldsobject

POSThttps://rest.carbon.ms/pickingListLine

curl --request POST \
  --url https://rest.carbon.ms/pickingListLine \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"pickingListId":"xyz789","jobId":"xyz789","jobMaterialId":"xyz789","itemId":"xyz789","quantityToPick":10,"quantityPicked":10,"status":"string","companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "pickingListId": "xyz789",
  "jobId": "xyz789",
  "jobMaterialId": "xyz789",
  "itemId": "xyz789",
  "quantityToPick": 10,
  "quantityPicked": 10,
  "status": "string"
}

PATCH/pickingListLine

Update a picking list line

Update an existing picking list line, matched on `id`.

Body parameters

pickingListIdstringrequired

References pickingList.id

jobIdstringrequired

References job.id

jobMaterialIdstringrequired

References jobMaterial.id

jobOperationIdstring

References jobOperation.id

itemIdstringrequired

References item.id

quantityToPicknumberrequired

quantityPickednumberrequired

outstandingQuantitynumber

storageUnitIdstring

References storageUnit.id

toStorageUnitIdstring

References storageUnit.id

statuspickingListLineStatusrequired

companyIdstringrequired

References company.id

customFieldsobject

PATCHhttps://rest.carbon.ms/pickingListLine

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

Response

{
  "id": "abc123def456",
  "pickingListId": "xyz789",
  "jobId": "xyz789",
  "jobMaterialId": "xyz789",
  "itemId": "xyz789",
  "quantityToPick": 10,
  "quantityPicked": 10,
  "status": "string"
}

DELETE/pickingListLine

Delete a picking list line

Delete a picking list line, matched on `id`. Returns 204 No Content.

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/pickingListLine

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

204 No Content