Pick Method

The pick method resource.

Basehttps://rest.carbon.ms/pickMethod

GET/pickMethod

List pick methods

Retrieve a paginated list of pick methods. 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/pickMethod

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

Response

[
  {
    "itemId": "xyz789",
    "locationId": "xyz789",
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "defaultStorageUnitId": "xyz789",
    "updatedBy": "string",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

GET/pickMethod

Retrieve a pick method

Fetch a single pick method by filtering on `itemId`.

Query parameters

itemIdstring

Match on the pick method's `itemId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/pickMethod

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

Response

{
  "itemId": "xyz789",
  "locationId": "xyz789",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "defaultStorageUnitId": "xyz789",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

POST/pickMethod

Create a pick method

Create a new pick method.

Body parameters

itemIdstringrequired

References item.id

locationIdstringrequired

References location.id

defaultStorageUnitIdstring

References storageUnit.id

companyIdstringrequired

References company.id

customFieldsobject

POSThttps://rest.carbon.ms/pickMethod

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

Response

{
  "itemId": "xyz789",
  "locationId": "xyz789",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "defaultStorageUnitId": "xyz789",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

PATCH/pickMethod

Update a pick method

Update an existing pick method, matched on `itemId`.

Body parameters

itemIdstringrequired

References item.id

locationIdstringrequired

References location.id

defaultStorageUnitIdstring

References storageUnit.id

companyIdstringrequired

References company.id

customFieldsobject

PATCHhttps://rest.carbon.ms/pickMethod

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

Response

{
  "itemId": "xyz789",
  "locationId": "xyz789",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "defaultStorageUnitId": "xyz789",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

DELETE/pickMethod

Delete a pick method

Delete a pick method, matched on `itemId`. Returns 204 No Content.

Query parameters

itemIdstring

The `itemId` of the pick method to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/pickMethod

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

204 No Content