Supply Chain · Electronic Data Interchange
EDI Partners
The customers, suppliers and carriers you exchange EDI with: X12 004010/005010 or EDIFACT D96A/D01B, the interchange IDs and qualifiers on both sides, the separators, and how files travel.
/api/scm/edi-partnersPublished as /api/v1/edi-partnersOverview
| 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 Partners 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_partners · 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/edi-partnersList edi partners
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",
"partner_code": "PAR-000001",
"name": "Example",
"partner_type": "customer",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"standard": "x12",
"version": "004010",
"our_qualifier": "text",
"our_id": "text",
"partner_qualifier": "text",
"partner_id": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/edi-partners?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/edi-partners/{id}Read one edi partner
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",
"partner_code": "PAR-000001",
"name": "Example",
"partner_type": "customer",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"standard": "x12",
"version": "004010",
"our_qualifier": "text",
"our_id": "text",
"partner_qualifier": "text",
"partner_id": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/edi-partners/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/edi-partnersCreate a edi partner
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
partner_code | text | Yes | Partner code |
name | text | Yes | Name |
partner_type | text | No | Type Allowed: customer supplier carrier logistics |
customer_account_id | uuid | No | Customer — Their purchase orders become sales orders for this customer. |
supplier_id | uuid | No | Supplier — Their acknowledgments, ship notices and invoices answer our purchase orders to this supplier. |
carrier_id | uuid | No | Carrier |
standard | text | No | Standard Allowed: x12 edifact |
version | text | No | Version — X12 004010 or 005010; EDIFACT directory D96A or D01B. Allowed: 004010 005010 D96A D01B |
our_qualifier | text | No | Our ID qualifier — ISA05: ZZ mutually defined, 01 DUNS, 12 phone, 14 DUNS+suffix. |
our_id | text | No | Our interchange ID — ISA06 / UNB sender. At most 15 characters for X12. |
partner_qualifier | text | No | Their ID qualifier |
partner_id | text | Yes | Their interchange ID — ISA08 / UNB recipient. Files from this ID are matched to this partner. |
our_gs_code | text | No | Our GS application code — Leave empty to use the interchange ID. |
partner_gs_code | text | No | Their GS application code |
our_unb_qualifier | text | No | Our UNB qualifier |
partner_unb_qualifier | text | No | Their UNB qualifier |
segment_terminator | text | No | Segment terminator — X12 usually ~ ; EDIFACT ' |
element_separator | text | No | Element separator — X12 usually * ; EDIFACT + |
component_separator | text | No | Component separator — Usually : |
repetition_separator | text | No | Repetition separator — X12 005010 ISA11, usually ^ |
release_character | text | No | Release character — EDIFACT escape, usually ? |
usage_indicator | text | No | Test or production Allowed: T P |
ack_requested | boolean | No | Acknowledgements (997 / CONTRL) |
connector_id | uuid | No | Connector |
status | text | No | Status Allowed: active testing inactive |
contact_name | text | No | Their EDI contact |
contact_email | text | No | Contact email |
notes | text | No | Notes |
Sample body
{
"partner_code": "PAR-000001",
"name": "Example",
"partner_id": "text",
"partner_type": "customer",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"partner_code": "PAR-000001",
"name": "Example",
"partner_type": "customer",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"standard": "x12",
"version": "004010",
"our_qualifier": "text",
"our_id": "text",
"partner_qualifier": "text",
"partner_id": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/edi-partners" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"partner_code":"PAR-000001","name":"Example","partner_id":"text","partner_type":"customer","customer_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/scm/edi-partners/{id}Change a edi partner
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 |
|---|---|---|---|
partner_code | text | Yes | Partner code |
name | text | Yes | Name |
partner_type | text | No | Type Allowed: customer supplier carrier logistics |
customer_account_id | uuid | No | Customer — Their purchase orders become sales orders for this customer. |
supplier_id | uuid | No | Supplier — Their acknowledgments, ship notices and invoices answer our purchase orders to this supplier. |
carrier_id | uuid | No | Carrier |
standard | text | No | Standard Allowed: x12 edifact |
version | text | No | Version — X12 004010 or 005010; EDIFACT directory D96A or D01B. Allowed: 004010 005010 D96A D01B |
our_qualifier | text | No | Our ID qualifier — ISA05: ZZ mutually defined, 01 DUNS, 12 phone, 14 DUNS+suffix. |
our_id | text | No | Our interchange ID — ISA06 / UNB sender. At most 15 characters for X12. |
partner_qualifier | text | No | Their ID qualifier |
partner_id | text | Yes | Their interchange ID — ISA08 / UNB recipient. Files from this ID are matched to this partner. |
our_gs_code | text | No | Our GS application code — Leave empty to use the interchange ID. |
partner_gs_code | text | No | Their GS application code |
our_unb_qualifier | text | No | Our UNB qualifier |
partner_unb_qualifier | text | No | Their UNB qualifier |
segment_terminator | text | No | Segment terminator — X12 usually ~ ; EDIFACT ' |
element_separator | text | No | Element separator — X12 usually * ; EDIFACT + |
component_separator | text | No | Component separator — Usually : |
repetition_separator | text | No | Repetition separator — X12 005010 ISA11, usually ^ |
release_character | text | No | Release character — EDIFACT escape, usually ? |
usage_indicator | text | No | Test or production Allowed: T P |
ack_requested | boolean | No | Acknowledgements (997 / CONTRL) |
connector_id | uuid | No | Connector |
status | text | No | Status Allowed: active testing inactive |
contact_name | text | No | Their EDI contact |
contact_email | text | No | Contact email |
notes | text | No | Notes |
Sample body
{
"partner_code": "PAR-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"partner_code": "PAR-000001",
"name": "Example",
"partner_type": "customer",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"standard": "x12",
"version": "004010",
"our_qualifier": "text",
"our_id": "text",
"partner_qualifier": "text",
"partner_id": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/edi-partners/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"partner_code":"PAR-000001","name":"Example"}'DELETE/api/scm/edi-partners/{id}Delete a edi partner
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-partners/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/edi-partners/{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-partners/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 partner, 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 |
partner_code | text | read, write | Partner code |
name | text | read, write | Name |
partner_type | text | read, write | Type Allowed: customer supplier carrier logistics |
customer_account_id | uuid | read, write | Customer — Their purchase orders become sales orders for this customer. |
supplier_id | uuid | read, write | Supplier — Their acknowledgments, ship notices and invoices answer our purchase orders to this supplier. |
carrier_id | uuid | read, write | Carrier |
standard | text | read, write | Standard Allowed: x12 edifact |
version | text | read, write | Version — X12 004010 or 005010; EDIFACT directory D96A or D01B. Allowed: 004010 005010 D96A D01B |
our_qualifier | text | read, write | Our ID qualifier — ISA05: ZZ mutually defined, 01 DUNS, 12 phone, 14 DUNS+suffix. |
our_id | text | read, write | Our interchange ID — ISA06 / UNB sender. At most 15 characters for X12. |
partner_qualifier | text | read, write | Their ID qualifier |
partner_id | text | read, write | Their interchange ID — ISA08 / UNB recipient. Files from this ID are matched to this partner. |
our_gs_code | text | read, write | Our GS application code — Leave empty to use the interchange ID. |
partner_gs_code | text | read, write | Their GS application code |
our_unb_qualifier | text | read, write | Our UNB qualifier |
partner_unb_qualifier | text | read, write | Their UNB qualifier |
segment_terminator | text | read, write | Segment terminator — X12 usually ~ ; EDIFACT ' |
element_separator | text | read, write | Element separator — X12 usually * ; EDIFACT + |
component_separator | text | read, write | Component separator — Usually : |
repetition_separator | text | read, write | Repetition separator — X12 005010 ISA11, usually ^ |
release_character | text | read, write | Release character — EDIFACT escape, usually ? |
usage_indicator | text | read, write | Test or production Allowed: T P |
ack_requested | boolean | read, write | Acknowledgements (997 / CONTRL) |
connector_id | uuid | read, write | Connector |
status | text | read, write | Status Allowed: active testing inactive |
contact_name | text | read, write | Their EDI contact |
contact_email | text | read, write | Contact email |
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 Partners 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.