TRANXACT.AI Help

Supply Chain · Network

Bins

Read and maintain bins records (scm.bins).

Type REST6 operationsBase path /api/scm/binsPublished as /api/v1/bins

Download specification (OpenAPI 3.1) Screen: Bins

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 › Bins 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.bins
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

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

GET/api/scm/binsList bins

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",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "zone": "text",
      "location_type": "text",
      "allow_negative": true,
      "is_active": true,
      "shelf_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "bin_type": "bin",
      "capacity_qty": "12.0000",
      "storage_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "travel_sequence": 10,
      "x_mm": "1250.00",
      "y_mm": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "zone": "text",
  "location_type": "text",
  "allow_negative": true,
  "is_active": true,
  "shelf_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bin_type": "bin",
  "capacity_qty": "12.0000",
  "storage_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "travel_sequence": 10,
  "x_mm": "1250.00",
  "y_mm": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
warehouse_iduuidYesWarehouse
codetextYesBin code
zonetextNoZone
allow_negativebooleanNoAllow negative stock
is_activebooleanNoActive
shelf_iduuidNoShelf — Leave blank for a warehouse that does not model aisles.
bin_typetextNoBin type
Allowed: bin staging dock quarantine
capacity_qtynumericNoCapacity

Sample body

{
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "zone": "text",
  "allow_negative": true,
  "is_active": true,
  "shelf_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "zone": "text",
  "location_type": "text",
  "allow_negative": true,
  "is_active": true,
  "shelf_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bin_type": "bin",
  "capacity_qty": "12.0000",
  "storage_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "travel_sequence": 10,
  "x_mm": "1250.00",
  "y_mm": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/bins" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001","zone":"text","allow_negative":true,"is_active":true,"shelf_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/scm/bins/{id}Change a bins

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
warehouse_iduuidYesWarehouse
codetextYesBin code
zonetextNoZone
allow_negativebooleanNoAllow negative stock
is_activebooleanNoActive
shelf_iduuidNoShelf — Leave blank for a warehouse that does not model aisles.
bin_typetextNoBin type
Allowed: bin staging dock quarantine
capacity_qtynumericNoCapacity

Sample body

{
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "zone": "text",
  "location_type": "text",
  "allow_negative": true,
  "is_active": true,
  "shelf_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bin_type": "bin",
  "capacity_qty": "12.0000",
  "storage_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "travel_sequence": 10,
  "x_mm": "1250.00",
  "y_mm": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/bins/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001"}'
DELETE/api/scm/bins/{id}Delete a bins

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

Data model

Every field of a bins, 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
warehouse_iduuidread, writeWarehouse
codetextread, writeBin code
zonetextread, writeZone
location_typetextread onlyLocation type
allow_negativebooleanread, writeAllow negative stock
is_activebooleanread, writeActive
shelf_iduuidread, writeShelf — Leave blank for a warehouse that does not model aisles.
bin_typetextread, writeBin type
Allowed: bin staging dock quarantine
capacity_qtynumericread, writeCapacity
storage_type_iduuidread onlyStorage type id
travel_sequenceintegerread onlyTravel sequence
x_mmnumericread onlyX mm
y_mmnumericread onlyY mm
z_mmnumericread onlyZ mm
max_weight_kgnumericread onlyMax weight kg
max_volume_lnumericread onlyMax volume l
fixed_item_iduuidread onlyFixed item id
min_qtynumericread onlyMin qty
max_qtynumericread onlyMax qty
is_blockedbooleanread onlyIs blocked
blocked_reasontextread onlyBlocked reason
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_attimestamp with time zoneread onlyCreated at
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 Supply Chain › Bins 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.