Kanban

The kanban resource.

Basehttps://rest.carbon.ms/kanban

GET/kanban

List kanbans

Retrieve a paginated list of kanbans. 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/kanban

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "itemId": "xyz789",
    "replenishmentSystem": "string",
    "quantity": 10,
    "locationId": "xyz789",
    "conversionFactor": 0,
    "autoRelease": true
  }
]

GET/kanban

Retrieve a kanban

Fetch a single kanban by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/kanban

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "itemId": "xyz789",
  "replenishmentSystem": "string",
  "quantity": 10,
  "locationId": "xyz789",
  "conversionFactor": 0,
  "autoRelease": true
}

POST/kanban

Create a kanban

Create a new kanban.

Body parameters

itemIdstringrequired

References item.id

replenishmentSystemitemReplenishmentSystemrequired

quantitynumberrequired

locationIdstringrequired

References location.id

storageUnitIdstring

References storageUnit.id

supplierIdstring

References supplier.id

purchaseUnitOfMeasureCodestring

conversionFactornumberrequired

autoReleasebooleanrequired

autoStartJobbooleanrequired

completedBarcodeOverridestring

jobIdstring

References job.id

POSThttps://rest.carbon.ms/kanban

curl --request POST \
  --url https://rest.carbon.ms/kanban \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"itemId":"xyz789","replenishmentSystem":"string","quantity":10,"locationId":"xyz789","conversionFactor":0,"autoRelease":true,"autoStartJob":true}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "itemId": "xyz789",
  "replenishmentSystem": "string",
  "quantity": 10,
  "locationId": "xyz789",
  "conversionFactor": 0,
  "autoRelease": true
}

PATCH/kanban

Update a kanban

Update an existing kanban, matched on `id`.

Body parameters

itemIdstringrequired

References item.id

replenishmentSystemitemReplenishmentSystemrequired

quantitynumberrequired

locationIdstringrequired

References location.id

storageUnitIdstring

References storageUnit.id

supplierIdstring

References supplier.id

purchaseUnitOfMeasureCodestring

conversionFactornumberrequired

autoReleasebooleanrequired

autoStartJobbooleanrequired

completedBarcodeOverridestring

jobIdstring

References job.id

PATCHhttps://rest.carbon.ms/kanban

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "itemId": "xyz789",
  "replenishmentSystem": "string",
  "quantity": 10,
  "locationId": "xyz789",
  "conversionFactor": 0,
  "autoRelease": true
}

DELETE/kanban

Delete a kanban

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/kanban

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

204 No Content