TRANXACT.AI Help

Supply Chain · Warehouse Execution

Bin Utilization

How full each bin is against what it will take. The number the warehouse map colors by, and the one a putaway strategy checks before it proposes anything.

Type REST6 operationsBase path /api/scm/bin-utilizationPublished as /api/v1/bin-utilization

Download specification (OpenAPI 3.1) Screen: Bin Utilization

Overview

PackageSupply Chain
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 Supply Chain › Bin Utilization 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.
Tablescm.bin_utilization · kept per company (and organisational unit where it has one)
RecordRead only; key bin_id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/scm/bin-utilizationList bin utilization

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": [
    {
      "bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "bin_code": "BIN-000001",
      "zone": "text",
      "storage_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "x_mm": "1250.00",
      "y_mm": "1250.00",
      "z_mm": "1250.00",
      "is_blocked": true,
      "storage_type_code": "STO-000001",
      "storage_type_name": "Example",
      "storage_class": "text",
      "is_pick_face": true,
      "is_reserve": true
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/bin-utilization?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/bin-utilization/{bin_id}Read one bin

Path parameters

NameTypeDescription
bin_idstring (uuid)The record's bin_id, as a list returns it.

Response 200

{
  "bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bin_code": "BIN-000001",
  "zone": "text",
  "storage_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "x_mm": "1250.00",
  "y_mm": "1250.00",
  "z_mm": "1250.00",
  "is_blocked": true,
  "storage_type_code": "STO-000001",
  "storage_type_name": "Example",
  "storage_class": "text",
  "is_pick_face": true,
  "is_reserve": true
}

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

Sample request

curl "https://demo.tranxact.ai/api/scm/bin-utilization/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/bin-utilizationPost bin utilization

No body is required.

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/scm/bin-utilization" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/bin-utilization/{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/scm/bin-utilization/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/scm/bin-utilization/{id}Put bin utilization

Path parameters

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

No body is required.

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 PUT "https://demo.tranxact.ai/api/scm/bin-utilization/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/bin-utilization/{id}Delete bin utilization

Path parameters

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

No body is required.

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 DELETE "https://demo.tranxact.ai/api/scm/bin-utilization/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

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

FieldTypeAccessDescription
bin_iduuidread onlyBin id
org_iduuidread onlyOrg id
warehouse_iduuidread onlyWarehouse id
bin_codetextread onlyBin code
zonetextread onlyZone
storage_type_iduuidread onlyStorage type id
x_mmnumericread onlyX mm
y_mmnumericread onlyY mm
z_mmnumericread onlyZ mm
is_blockedbooleanread onlyIs blocked
storage_type_codetextread onlyStorage type code
storage_type_nametextread onlyStorage type name
storage_classtextread onlyStorage class
is_pick_facebooleanread onlyIs pick face
is_reservebooleanread onlyIs reserve
full_addresstextread onlyFull address
warehouse_codetextread onlyWarehouse code
lane_codetextread onlyLane code
shelf_codetextread onlyShelf code
on_handnumericread onlyOn hand
item_countintegerread onlyItem count
capacity_qtynumericread onlyCapacity qty
max_weight_kgnumericread onlyMax weight kg
max_volume_lnumericread onlyMax volume l
fill_pctnumericread onlyFill pct
handling_unitsintegerread onlyHandling units
occupancytextread onlyOccupancy

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 Supply Chain › Bin Utilization 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.