Picking List

The picking list resource.

Basehttps://rest.carbon.ms/pickingList

GET/pickingList

List picking lists

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

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

Response

[
  {
    "id": "abc123def456",
    "pickingListId": "xyz789",
    "status": "string",
    "locationId": "xyz789",
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "assignee": "string"
  }
]

GET/pickingList

Retrieve a picking list

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/pickingList

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

Response

{
  "id": "abc123def456",
  "pickingListId": "xyz789",
  "status": "string",
  "locationId": "xyz789",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "assignee": "string"
}

POST/pickingList

Create a picking list

Create a new picking list.

Body parameters

pickingListIdstringrequired

statuspickingListStatusrequired

locationIdstringrequired

References location.id

assigneestring

References user.id

dueDatedate

notesobject

companyIdstringrequired

References company.id

customFieldsobject

POSThttps://rest.carbon.ms/pickingList

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

Response

{
  "id": "abc123def456",
  "pickingListId": "xyz789",
  "status": "string",
  "locationId": "xyz789",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "assignee": "string"
}

PATCH/pickingList

Update a picking list

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

Body parameters

pickingListIdstringrequired

statuspickingListStatusrequired

locationIdstringrequired

References location.id

assigneestring

References user.id

dueDatedate

notesobject

companyIdstringrequired

References company.id

customFieldsobject

PATCHhttps://rest.carbon.ms/pickingList

curl --request PATCH \
  --url 'https://rest.carbon.ms/pickingList?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",
  "status": "string",
  "locationId": "xyz789",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "assignee": "string"
}

DELETE/pickingList

Delete a picking list

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/pickingList

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

204 No Content