TRANXACT.AI Help

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.

Type REST8 operationsBase path /api/scm/edi-connectorsPublished as /api/v1/edi-connectors

Download specification (OpenAPI 3.1) Screen: EDI Connectors

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 › 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.
Tablescm.edi_connectors · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
connector_codetextYesConnector code
nametextYesName
transporttextNoTransport
Allowed: sandbox as2 sftp van
endpoint_urltextNoPartner or VAN address
as2_fromtextNoAS2 from
as2_totextNoAS2 to
mdn_modetextNoMDN
Allowed: sync async none
sftp_hosttextNoSFTP host
sftp_portintegerNoSFTP port
sftp_usertextNoSFTP user
outbound_pathtextNoFolder for outbound files
inbound_pathtextNoFolder for inbound files
van_nametextNoVAN
van_mailboxtextNoOur mailbox
is_activebooleanNoActive
notestextNoNotes

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
connector_codetextYesConnector code
nametextYesName
transporttextNoTransport
Allowed: sandbox as2 sftp van
endpoint_urltextNoPartner or VAN address
as2_fromtextNoAS2 from
as2_totextNoAS2 to
mdn_modetextNoMDN
Allowed: sync async none
sftp_hosttextNoSFTP host
sftp_portintegerNoSFTP port
sftp_usertextNoSFTP user
outbound_pathtextNoFolder for outbound files
inbound_pathtextNoFolder for inbound files
van_nametextNoVAN
van_mailboxtextNoOur mailbox
is_activebooleanNoActive
notestextNoNotes

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

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

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):

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

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
connector_codetextread, writeConnector code
nametextread, writeName
transporttextread, writeTransport
Allowed: sandbox as2 sftp van
endpoint_urltextread, writePartner or VAN address
as2_fromtextread, writeAS2 from
as2_totextread, writeAS2 to
mdn_modetextread, writeMDN
Allowed: sync async none
sftp_hosttextread, writeSFTP host
sftp_portintegerread, writeSFTP port
sftp_usertextread, writeSFTP user
outbound_pathtextread, writeFolder for outbound files
inbound_pathtextread, writeFolder for inbound files
van_nametextread, writeVAN
van_mailboxtextread, writeOur mailbox
secret_cipherbytearead onlySecret cipher
secret_set_attimestamp with time zoneread onlySecret set at
inbound_token_hashtextread onlyInbound token hash
inbound_token_set_attimestamp with time zoneread onlyInbound token set at
last_used_attimestamp with time zoneread onlyLast used at
last_resulttextread onlyLast result
is_activebooleanread, writeActive
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

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 › EDI Connectors 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.