Supply Chain · Electronic Data Interchange
EDI Connectors
How files travel: AS2, SFTP, a VAN mailbox — or the sandbox, which keeps every file on its interchange to download. Credentials are stored sealed and never shown.
/api/scm/edi-connectorsPublished as /api/v1/edi-connectorsOverview
| 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 Connectors 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_connectors · 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
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/edi-connectorsList edi connectors
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",
"connector_code": "CON-000001",
"name": "Example",
"transport": "sandbox",
"endpoint_url": "https://example.com",
"as2_from": "text",
"as2_to": "text",
"mdn_mode": "sync",
"sftp_host": "text",
"sftp_port": 10,
"sftp_user": "text",
"outbound_path": "text",
"inbound_path": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/edi-connectors?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/edi-connectors/{id}Read one edi connector
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",
"connector_code": "CON-000001",
"name": "Example",
"transport": "sandbox",
"endpoint_url": "https://example.com",
"as2_from": "text",
"as2_to": "text",
"mdn_mode": "sync",
"sftp_host": "text",
"sftp_port": 10,
"sftp_user": "text",
"outbound_path": "text",
"inbound_path": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/edi-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/edi-connectorsCreate a edi connector
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
connector_code | text | Yes | Connector code |
name | text | Yes | Name |
transport | text | No | Transport Allowed: sandbox as2 sftp van |
endpoint_url | text | No | Partner or VAN address |
as2_from | text | No | AS2 from |
as2_to | text | No | AS2 to |
mdn_mode | text | No | MDN Allowed: sync async none |
sftp_host | text | No | SFTP host |
sftp_port | integer | No | SFTP port |
sftp_user | text | No | SFTP user |
outbound_path | text | No | Folder for outbound files |
inbound_path | text | No | Folder for inbound files |
van_name | text | No | VAN |
van_mailbox | text | No | Our mailbox |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"connector_code": "CON-000001",
"name": "Example",
"transport": "sandbox",
"endpoint_url": "https://example.com",
"as2_from": "text",
"as2_to": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"connector_code": "CON-000001",
"name": "Example",
"transport": "sandbox",
"endpoint_url": "https://example.com",
"as2_from": "text",
"as2_to": "text",
"mdn_mode": "sync",
"sftp_host": "text",
"sftp_port": 10,
"sftp_user": "text",
"outbound_path": "text",
"inbound_path": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/edi-connectors" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"connector_code":"CON-000001","name":"Example","transport":"sandbox","endpoint_url":"https://example.com","as2_from":"text","as2_to":"text"}'PUT/api/scm/edi-connectors/{id}Change a edi connector
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 |
|---|---|---|---|
connector_code | text | Yes | Connector code |
name | text | Yes | Name |
transport | text | No | Transport Allowed: sandbox as2 sftp van |
endpoint_url | text | No | Partner or VAN address |
as2_from | text | No | AS2 from |
as2_to | text | No | AS2 to |
mdn_mode | text | No | MDN Allowed: sync async none |
sftp_host | text | No | SFTP host |
sftp_port | integer | No | SFTP port |
sftp_user | text | No | SFTP user |
outbound_path | text | No | Folder for outbound files |
inbound_path | text | No | Folder for inbound files |
van_name | text | No | VAN |
van_mailbox | text | No | Our mailbox |
is_active | boolean | No | Active |
notes | text | No | Notes |
Sample body
{
"connector_code": "CON-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"connector_code": "CON-000001",
"name": "Example",
"transport": "sandbox",
"endpoint_url": "https://example.com",
"as2_from": "text",
"as2_to": "text",
"mdn_mode": "sync",
"sftp_host": "text",
"sftp_port": 10,
"sftp_user": "text",
"outbound_path": "text",
"inbound_path": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/edi-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"connector_code":"CON-000001","name":"Example"}'DELETE/api/scm/edi-connectors/{id}Delete a edi connector
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/edi-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/edi-connectors/{id}/secretSecret
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):
secret*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-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/secret" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"secret":"value"}'POST/api/scm/edi-connectors/{id}/inbound-tokenInbound token
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-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/inbound-token" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/edi-connectors/{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-connectors/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 edi connector, 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 |
connector_code | text | read, write | Connector code |
name | text | read, write | Name |
transport | text | read, write | Transport Allowed: sandbox as2 sftp van |
endpoint_url | text | read, write | Partner or VAN address |
as2_from | text | read, write | AS2 from |
as2_to | text | read, write | AS2 to |
mdn_mode | text | read, write | MDN Allowed: sync async none |
sftp_host | text | read, write | SFTP host |
sftp_port | integer | read, write | SFTP port |
sftp_user | text | read, write | SFTP user |
outbound_path | text | read, write | Folder for outbound files |
inbound_path | text | read, write | Folder for inbound files |
van_name | text | read, write | VAN |
van_mailbox | text | read, write | Our mailbox |
secret_cipher | bytea | read only | Secret cipher |
secret_set_at | timestamp with time zone | read only | Secret set at |
inbound_token_hash | text | read only | Inbound token hash |
inbound_token_set_at | timestamp with time zone | read only | Inbound token set at |
last_used_at | timestamp with time zone | read only | Last used at |
last_result | text | read only | Last result |
is_active | boolean | read, write | Active |
notes | text | read, write | Notes |
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 Connectors 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.