TRANXACT.AI Help

Manufacturing · Kanban

Kanban Loops

The control cycle: what circulates between where and where, in containers of what size, and how many of them exist. The card count is the cap on the stock in the system.

Type REST8 operationsBase path /api/mfg/kanban-loopsPublished as /api/v1/kanban-loops

Download specification (OpenAPI 3.1) Screen: Kanban Loops

Overview

PackageManufacturing
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Manufacturing › Kanban Loops on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablemfg.kanban_loops · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

8 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/mfg/kanban-loopsList kanban loops

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "loop_no": "LOO-000001",
      "name": "Example",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "supply_strategy": "text",
      "supply_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "demand_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "supply_work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "demand_work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "source_warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "container_qty": "12.0000",
      "card_count": 10
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/mfg/kanban-loops?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/mfg/kanban-loops/{id}Read one kanban loop

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "loop_no": "LOO-000001",
  "name": "Example",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supply_strategy": "text",
  "supply_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "demand_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supply_work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "demand_work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "container_qty": "12.0000",
  "card_count": 10
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/mfg/kanban-loops/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/kanban-loopsCreate a kanban loop

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
nametextYesName
item_iduuidYesItem
supply_strategytextNoHow an empty container is refilled
supply_bin_iduuidNoSupply bin
demand_bin_iduuidNoDemand bin (at the line)
supply_work_center_iduuidNoSupplying work center
demand_work_center_iduuidNoConsuming work center
supplier_iduuidNoSupplier
source_warehouse_iduuidNoSource warehouse id
container_qtynumericNoQuantity per container — Units one container holds. Container × number of cards is the most the loop can ever hold (Max stock).
card_countintegerNoNumber of cards — One card per container in circulation. Fixed on purpose: it caps the stock in the loop.
container_typetextNoContainer type — Tote, pallet, rack, bin…
avg_daily_demandnumericNoAverage daily demand
replenishment_lead_daysnumericNoReplenishment lead (days)
safety_factornumericNoSafety factor
signal_modetextNoSignal — A two-bin system with no electronics is still a kanban system.
Allowed: manual barcode rfid plc iot api
auto_triggerbooleanNoAn emptied card raises supply on its own
target_cycle_hoursnumericNoTarget cycle (hours)
alert_after_hoursnumericNoAlert after (hours)
statustextNoStatus
Allowed: active draft on_hold retired
notestextNoNotes

Sample body

{
  "name": "Example",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supply_strategy": "text",
  "supply_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "demand_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supply_work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "loop_no": "LOO-000001",
  "name": "Example",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supply_strategy": "text",
  "supply_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "demand_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supply_work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "demand_work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "container_qty": "12.0000",
  "card_count": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/kanban-loops" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","supply_strategy":"text","supply_bin_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","demand_bin_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","supply_work_center_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/mfg/kanban-loops/{id}Change a kanban loop

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
nametextYesName
item_iduuidYesItem
supply_strategytextNoHow an empty container is refilled
supply_bin_iduuidNoSupply bin
demand_bin_iduuidNoDemand bin (at the line)
supply_work_center_iduuidNoSupplying work center
demand_work_center_iduuidNoConsuming work center
supplier_iduuidNoSupplier
source_warehouse_iduuidNoSource warehouse id
container_qtynumericNoQuantity per container — Units one container holds. Container × number of cards is the most the loop can ever hold (Max stock).
card_countintegerNoNumber of cards — One card per container in circulation. Fixed on purpose: it caps the stock in the loop.
container_typetextNoContainer type — Tote, pallet, rack, bin…
avg_daily_demandnumericNoAverage daily demand
replenishment_lead_daysnumericNoReplenishment lead (days)
safety_factornumericNoSafety factor
signal_modetextNoSignal — A two-bin system with no electronics is still a kanban system.
Allowed: manual barcode rfid plc iot api
auto_triggerbooleanNoAn emptied card raises supply on its own
target_cycle_hoursnumericNoTarget cycle (hours)
alert_after_hoursnumericNoAlert after (hours)
statustextNoStatus
Allowed: active draft on_hold retired
notestextNoNotes

Sample body

{
  "name": "Example",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "loop_no": "LOO-000001",
  "name": "Example",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supply_strategy": "text",
  "supply_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "demand_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supply_work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "demand_work_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "container_qty": "12.0000",
  "card_count": 10
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/mfg/kanban-loops/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/mfg/kanban-loops/{id}Delete a kanban loop

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/mfg/kanban-loops/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/kanban-loops/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/kanban-loops/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/mfg/kanban-loops/{id}/issue-cardsIssue cards

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

count, startFull

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/kanban-loops/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/issue-cards" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"count":"value","startFull":"value"}'
POST/api/mfg/kanban-loops/{id}/sizeSize

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

days

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/kanban-loops/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/size" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"days":"value"}'

Data model

Every field of a kanban loop, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
loop_notextread onlyLoop no
nametextread, writeName
item_iduuidread, writeItem
supply_strategytextread, writeHow an empty container is refilled
supply_bin_iduuidread, writeSupply bin
demand_bin_iduuidread, writeDemand bin (at the line)
supply_work_center_iduuidread, writeSupplying work center
demand_work_center_iduuidread, writeConsuming work center
supplier_iduuidread, writeSupplier
source_warehouse_iduuidread, writeSource warehouse id
container_qtynumericread, writeQuantity per container — Units one container holds. Container × number of cards is the most the loop can ever hold (Max stock).
card_countintegerread, writeNumber of cards — One card per container in circulation. Fixed on purpose: it caps the stock in the loop.
container_typetextread, writeContainer type — Tote, pallet, rack, bin…
avg_daily_demandnumericread, writeAverage daily demand
replenishment_lead_daysnumericread, writeReplenishment lead (days)
safety_factornumericread, writeSafety factor
signal_modetextread, writeSignal — A two-bin system with no electronics is still a kanban system.
Allowed: manual barcode rfid plc iot api
auto_triggerbooleanread, writeAn emptied card raises supply on its own
target_cycle_hoursnumericread, writeTarget cycle (hours)
alert_after_hoursnumericread, writeAlert after (hours)
statustextread, writeStatus
Allowed: active draft on_hold retired
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Manufacturing › Kanban Loops for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.