Supply Chain · Warehouse Execution
What Needs Replenishing
Every pick face at or below its minimum, right now. The replenishment run reads exactly this and turns each row into a task.
/api/scm/replenishment-needsPublished as /api/v1/replenishment-needsDownload specification (OpenAPI 3.1) Screen: What Needs Replenishing
Overview
| Package | Supply Chain |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Supply Chain › What Needs Replenishing 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. |
| Table | scm.replenishment_needs · kept per company (and organisational unit where it has one) |
| Record | Read only; key rule_id |
| Rules | The 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/replenishment-needsList what needs replenishing
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"to_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"min_quantity": "12.0000",
"max_quantity": "12.0000",
"method": "text",
"priority": 10,
"trigger_mode": "text",
"item_no": "ITE-000001",
"item_name": "Example",
"uom": "text",
"bin_code": "BIN-000001",
"bin_address": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/replenishment-needs?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/replenishment-needs/{rule_id}Read one replenishment need
Path parameters
| Name | Type | Description |
|---|---|---|
rule_id | string (uuid) | The record's rule_id, as a list returns it. |
Response 200
{
"rule_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"to_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"min_quantity": "12.0000",
"max_quantity": "12.0000",
"method": "text",
"priority": 10,
"trigger_mode": "text",
"item_no": "ITE-000001",
"item_name": "Example",
"uom": "text",
"bin_code": "BIN-000001",
"bin_address": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/replenishment-needs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/replenishment-needsPost what needs replenishing
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/replenishment-needs" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/replenishment-needs/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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/replenishment-needs/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/replenishment-needs/{id}Put what needs replenishing
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/replenishment-needs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/replenishment-needs/{id}Delete what needs replenishing
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/replenishment-needs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a replenishment need, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
rule_id | uuid | read only | Rule id |
org_id | uuid | read only | Org id |
warehouse_id | uuid | read only | Warehouse id |
item_id | uuid | read only | Item id |
to_bin_id | uuid | read only | To bin id |
min_quantity | numeric | read only | Min quantity |
max_quantity | numeric | read only | Max quantity |
method | text | read only | Method |
priority | integer | read only | Priority |
trigger_mode | text | read only | Trigger mode |
item_no | text | read only | Item no |
item_name | text | read only | Item name |
uom | text | read only | Uom |
bin_code | text | read only | Bin code |
bin_address | text | read only | Bin address |
on_hand | numeric | read only | On hand |
shortfall | numeric | read only | Shortfall |
open_tasks | integer | read only | Open tasks |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Supply Chain › What Needs Replenishing for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.