POST /tms/transloads/spare-bale¶
What it does¶
/tms/transloads/spare-bale accepts POST and is declared in app/systems/TMS/transload/api_routes.php:156 as a path.
The route handler delegates to wmsInventoryCreateSpareBale(). That function is the owner of
this behaviour; the route entry is only dispatch.
Call chain:
- →
wmsInventoryCreateSpareBale()—app/systems/WMS/inventory/spare_bale_create_helper.php:91 - ↳
wmsInventoryBaleInt()—app/systems/WMS/inventory/bale_adjustment_helper.php:167
Who calls it¶
Called from:
frontend/pages/system/TMS/transload/inbound-planning.phppublic/assets/js/modules/shared/kj-scale-ticket-modal.js
A caller is the strongest available evidence of the intended use.
Input¶
| Where | Key |
|---|---|
body |
COMMODITY_NAME |
body |
GRADE |
body |
NET_WEIGHT |
body |
QUANTITY |
body |
REMARK |
body |
SCALE_TICKET_ID |
body |
SOURCE_TRANSLOAD_ID |
body |
UNLOCATED_SPARE |
body |
WAREHOUSE_LOCATION |
body |
WEIGHT |
Request bodies must not use TYPE, ACTION or USERNAME as contract fields.
Output¶
| Key |
|---|
BILLING_COMPANY_ID |
CARRIER_COMPANY_NAME |
CLIENT_ID |
COMMODITY_NAME |
INBOUND_FINAL_QUANTITY |
INBOUND_FINAL_WEIGHT |
INITIAL_COMMODITY_NAME |
INITIAL_COMMODITY_QUANTITY |
INITIAL_COMMODITY_WEIGHT |
INITIAL_EQUIPMENT_NUMBER |
INITIAL_EQUIPMENT_TYPE |
LEDGER |
LOAD_NUMBER |
LOAD_TYPE |
LOT |
NET_WEIGHT |
QUANTITY |
REFERENCE_NUMBER |
REMARK |
REQUEST |
RESULT |
SHIPPER_COMPANY_ID |
STATUS |
TRANSLOAD |
TRANSLOAD_COMPANY_ID |
TRANSLOAD_ID |
TRANSLOAD_IN_TIME |
UNLOAD_OUT_TIME |
UNLOCATED_SPARE |
WAREHOUSE_LOCATION |
Success is { "data": …, "requestId": "…" }.
Failure is { "error": { "code", "message" }, "requestId": "…" }.
SQL executed¶
SELECT ST.UUID AS SCALE_TICKET_UUID, ST.GROSS_TIME, ST.TARE_TIME FROM T_SCALE_TICKET ST JOIN T_TRANSLOAD T ON T.CLIENT_ID=ST.CLIENT_ID AND T.SCALE_TICKET_ID=ST.ID AND T.ID=? AND T.DELETED_AT IS NULL WHERE ST.CLIENT_ID=? AND ST.ID=? AND ST.DELETED_AT IS NULL LIMIT 1
UPDATE T_TRANSLOAD SET STATUS='SPARE' WHERE CLIENT_ID=? AND ID=? AND STATUS='UNLOADED' AND DELETED_AT IS NULL
Data¶
Tables reached from the owner function:
T_SCALE_TICKETT_TRANSLOAD
Access¶
- module-gated on
tms.transload, so tenant module access applies
Validation and failure messages¶
- Source load is required.
- Commodity is required.
- Quantity must be a positive whole number.
- Weight must be a positive whole-pound value.
- Warehouse location is required.
These strings come from the owner function and are the messages a client can receive. They are also the cheapest way to tell a rejected request from a broken one.