TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/scm/replenishment-needsPublished as /api/v1/replenishment-needs

Download specification (OpenAPI 3.1) Screen: What Needs Replenishing

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 › 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.
Tablescm.replenishment_needs · kept per company (and organisational unit where it has one)
RecordRead only; key rule_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/replenishment-needsList what needs replenishing

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": [
    {
      "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

NameTypeDescription
rule_idstring (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

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/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

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/replenishment-needs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/replenishment-needs/{id}Delete what needs replenishing

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/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.

FieldTypeAccessDescription
rule_iduuidread onlyRule id
org_iduuidread onlyOrg id
warehouse_iduuidread onlyWarehouse id
item_iduuidread onlyItem id
to_bin_iduuidread onlyTo bin id
min_quantitynumericread onlyMin quantity
max_quantitynumericread onlyMax quantity
methodtextread onlyMethod
priorityintegerread onlyPriority
trigger_modetextread onlyTrigger mode
item_notextread onlyItem no
item_nametextread onlyItem name
uomtextread onlyUom
bin_codetextread onlyBin code
bin_addresstextread onlyBin address
on_handnumericread onlyOn hand
shortfallnumericread onlyShortfall
open_tasksintegerread onlyOpen tasks

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 › What Needs Replenishing 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.