Supply Chain · Warehouse Structure
Replenishment Rules
Keeping the pick face full from the reserve, so a picker never walks to an empty bin.
/api/scm/replenishment-rulesPublished as /api/v1/replenishment-rulesDownload specification (OpenAPI 3.1) Screen: Replenishment Rules
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 › Replenishment Rules 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_rules · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key 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-rulesList replenishment rules
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": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_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",
"from_storage_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"method": "min_max",
"min_quantity": "12.0000",
"max_quantity": "12.0000",
"replenish_qty": "12.0000",
"round_to_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"trigger_mode": "batch",
"priority": 10,
"is_active": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/replenishment-rules?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/replenishment-rules/{id}Read one replenishment rule
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"to_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"from_storage_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"method": "min_max",
"min_quantity": "12.0000",
"max_quantity": "12.0000",
"replenish_qty": "12.0000",
"round_to_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"trigger_mode": "batch",
"priority": 10,
"is_active": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/replenishment-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/replenishment-rulesCreate a replenishment rule
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
warehouse_id | uuid | Yes | Warehouse |
item_id | uuid | Yes | Item |
to_bin_id | uuid | Yes | Pick face bin |
from_storage_type_id | uuid | No | Drawn from |
method | text | No | Method Allowed: min_max fixed_quantity order_driven top_off demand |
min_quantity | numeric | No | Replenish at |
max_quantity | numeric | No | Replenish to |
replenish_qty | numeric | No | Fixed quantity |
round_to_uom_id | uuid | No | Round to unit |
trigger_mode | text | No | Triggered Allowed: batch immediate wave manual |
priority | integer | No | Priority |
is_active | boolean | No | Active |
Sample body
{
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"to_bin_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"from_storage_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"method": "min_max",
"min_quantity": "12.0000",
"max_quantity": "12.0000"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_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",
"from_storage_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"method": "min_max",
"min_quantity": "12.0000",
"max_quantity": "12.0000",
"replenish_qty": "12.0000",
"round_to_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"trigger_mode": "batch",
"priority": 10,
"is_active": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/replenishment-rules" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","to_bin_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","from_storage_type_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","method":"min_max","min_quantity":"12.0000","max_quantity":"12.0000"}'PUT/api/scm/replenishment-rules/{id}Change a replenishment rule
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
warehouse_id | uuid | Yes | Warehouse |
item_id | uuid | Yes | Item |
to_bin_id | uuid | Yes | Pick face bin |
from_storage_type_id | uuid | No | Drawn from |
method | text | No | Method Allowed: min_max fixed_quantity order_driven top_off demand |
min_quantity | numeric | No | Replenish at |
max_quantity | numeric | No | Replenish to |
replenish_qty | numeric | No | Fixed quantity |
round_to_uom_id | uuid | No | Round to unit |
trigger_mode | text | No | Triggered Allowed: batch immediate wave manual |
priority | integer | No | Priority |
is_active | boolean | No | Active |
Sample body
{
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_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",
"from_storage_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"method": "min_max",
"min_quantity": "12.0000",
"max_quantity": "12.0000",
"replenish_qty": "12.0000",
"round_to_uom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"trigger_mode": "batch",
"priority": 10,
"is_active": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/replenishment-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"warehouse_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/scm/replenishment-rules/{id}Delete a replenishment rule
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/replenishment-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/replenishment-rules/{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-rules/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 replenishment rule, 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 |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
warehouse_id | uuid | read, write | Warehouse |
item_id | uuid | read, write | Item |
to_bin_id | uuid | read, write | Pick face bin |
from_storage_type_id | uuid | read, write | Drawn from |
method | text | read, write | Method Allowed: min_max fixed_quantity order_driven top_off demand |
min_quantity | numeric | read, write | Replenish at |
max_quantity | numeric | read, write | Replenish to |
replenish_qty | numeric | read, write | Fixed quantity |
round_to_uom_id | uuid | read, write | Round to unit |
trigger_mode | text | read, write | Triggered Allowed: batch immediate wave manual |
priority | integer | read, write | Priority |
is_active | boolean | read, write | Active |
last_run_at | timestamp with time zone | read only | Last run at |
created_at | timestamp with time zone | read only | Created at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 › Replenishment Rules 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.