Supply Chain · Electronic Data Interchange
EDI Interchanges
Every interchange sent or received: the control numbers, the status, the acknowledgement, the faults in sentences, the documents it made, and the file exactly as it was.
/api/scm/edi-interchangesPublished as /api/v1/edi-interchangesDownload specification (OpenAPI 3.1) Screen: EDI Interchanges
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 › EDI Interchanges 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.edi_interchanges · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
13 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/edi-interchangesList edi interchanges
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",
"interchange_no": "INT-000001",
"partner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"direction": "text",
"standard": "text",
"version": "text",
"doc_type": "text",
"control_no": "CON-000001",
"group_control_no": "GRO-000001",
"set_control_nos": [],
"sender_id": "text",
"receiver_id": "text",
"usage_indicator": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/edi-interchanges?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/edi-interchanges/{id}Read one edi interchange
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",
"interchange_no": "INT-000001",
"partner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"direction": "text",
"standard": "text",
"version": "text",
"doc_type": "text",
"control_no": "CON-000001",
"group_control_no": "GRO-000001",
"set_control_nos": [],
"sender_id": "text",
"receiver_id": "text",
"usage_indicator": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/edi-interchanges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/edi-interchanges/sendSend
Request body
The keys this action reads (* = required; "one of" lists the only values):
sourceType*, sourceId, partnerId, ackType; ackType one of AT|AC|RJResponse
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/edi-interchanges/send" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"sourceType":"value","sourceId":"value","partnerId":"value","ackType;":"value"}'POST/api/scm/edi-interchanges/{id}/transmitTransmit
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 POST "https://demo.tranxact.ai/api/scm/edi-interchanges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/transmit" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/edi-interchanges/receiveReceive
Request body
The keys this action reads (* = required; "one of" lists the only values):
fileName, partnerIdResponse
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/edi-interchanges/receive" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"fileName":"value","partnerId":"value"}'POST/api/scm/edi-interchanges/validateValidate
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/edi-interchanges/validate" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/edi-interchanges/{id}/reprocessReprocess
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 POST "https://demo.tranxact.ai/api/scm/edi-interchanges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reprocess" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/edi-interchanges/{id}/downloadDownload
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/edi-interchanges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/download" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/edi-interchanges/{id}/setsSets
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/scm/edi-interchanges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/sets" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/edi-interchangesPost edi interchanges
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/edi-interchanges" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/edi-interchanges/{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/edi-interchanges/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/edi-interchanges/{id}Put edi interchanges
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/edi-interchanges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/edi-interchanges/{id}Delete edi interchanges
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/edi-interchanges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a edi interchange, 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 |
interchange_no | text | read only | Interchange no |
partner_id | uuid | read only | Partner id |
direction | text | read only | Direction |
standard | text | read only | Standard |
version | text | read only | Version |
doc_type | text | read only | Doc type |
control_no | text | read only | Control no |
group_control_no | text | read only | Group control no |
set_control_nos | _text | read only | Set control nos |
sender_id | text | read only | Sender id |
receiver_id | text | read only | Receiver id |
usage_indicator | text | read only | Usage indicator |
status | text | read only | Status |
ack_status | text | read only | Ack status |
ack_interchange_id | uuid | read only | Ack interchange id |
acknowledges_id | uuid | read only | Acknowledges id |
raw_payload | text | read only | Raw payload |
payload_sha256 | text | read only | Payload sha256 |
file_name | text | read only | File name |
segment_count | integer | read only | Segment count |
transaction_count | integer | read only | Transaction count |
errors | jsonb | read only | Errors |
source_type | text | read only | Source type |
source_id | uuid | read only | Source id |
source_no | text | read only | Source no |
documents | jsonb | read only | Documents |
transport | text | read only | Transport |
transport_ref | text | read only | Transport ref |
transport_note | text | read only | Transport note |
sent_at | timestamp with time zone | read only | Sent at |
received_at | timestamp with time zone | read only | Received at |
processed_at | timestamp with time zone | read only | Processed at |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 |
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 › EDI Interchanges 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.