TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/scm/edi-partnersPublished as /api/v1/edi-partners

Download specification (OpenAPI 3.1) Screen: EDI Partners

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 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.
Tablescm.edi_partners · 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

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/scm/edi-partnersList edi partners

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

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",
  "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.

FieldTypeRequiredDescription
partner_codetextYesPartner code
nametextYesName
partner_typetextNoType
Allowed: customer supplier carrier logistics
customer_account_iduuidNoCustomer — Their purchase orders become sales orders for this customer.
supplier_iduuidNoSupplier — Their acknowledgments, ship notices and invoices answer our purchase orders to this supplier.
carrier_iduuidNoCarrier
standardtextNoStandard
Allowed: x12 edifact
versiontextNoVersion — X12 004010 or 005010; EDIFACT directory D96A or D01B.
Allowed: 004010 005010 D96A D01B
our_qualifiertextNoOur ID qualifier — ISA05: ZZ mutually defined, 01 DUNS, 12 phone, 14 DUNS+suffix.
our_idtextNoOur interchange ID — ISA06 / UNB sender. At most 15 characters for X12.
partner_qualifiertextNoTheir ID qualifier
partner_idtextYesTheir interchange ID — ISA08 / UNB recipient. Files from this ID are matched to this partner.
our_gs_codetextNoOur GS application code — Leave empty to use the interchange ID.
partner_gs_codetextNoTheir GS application code
our_unb_qualifiertextNoOur UNB qualifier
partner_unb_qualifiertextNoTheir UNB qualifier
segment_terminatortextNoSegment terminator — X12 usually ~ ; EDIFACT '
element_separatortextNoElement separator — X12 usually * ; EDIFACT +
component_separatortextNoComponent separator — Usually :
repetition_separatortextNoRepetition separator — X12 005010 ISA11, usually ^
release_charactertextNoRelease character — EDIFACT escape, usually ?
usage_indicatortextNoTest or production
Allowed: T P
ack_requestedbooleanNoAcknowledgements (997 / CONTRL)
connector_iduuidNoConnector
statustextNoStatus
Allowed: active testing inactive
contact_nametextNoTheir EDI contact
contact_emailtextNoContact email
notestextNoNotes

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

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
partner_codetextYesPartner code
nametextYesName
partner_typetextNoType
Allowed: customer supplier carrier logistics
customer_account_iduuidNoCustomer — Their purchase orders become sales orders for this customer.
supplier_iduuidNoSupplier — Their acknowledgments, ship notices and invoices answer our purchase orders to this supplier.
carrier_iduuidNoCarrier
standardtextNoStandard
Allowed: x12 edifact
versiontextNoVersion — X12 004010 or 005010; EDIFACT directory D96A or D01B.
Allowed: 004010 005010 D96A D01B
our_qualifiertextNoOur ID qualifier — ISA05: ZZ mutually defined, 01 DUNS, 12 phone, 14 DUNS+suffix.
our_idtextNoOur interchange ID — ISA06 / UNB sender. At most 15 characters for X12.
partner_qualifiertextNoTheir ID qualifier
partner_idtextYesTheir interchange ID — ISA08 / UNB recipient. Files from this ID are matched to this partner.
our_gs_codetextNoOur GS application code — Leave empty to use the interchange ID.
partner_gs_codetextNoTheir GS application code
our_unb_qualifiertextNoOur UNB qualifier
partner_unb_qualifiertextNoTheir UNB qualifier
segment_terminatortextNoSegment terminator — X12 usually ~ ; EDIFACT '
element_separatortextNoElement separator — X12 usually * ; EDIFACT +
component_separatortextNoComponent separator — Usually :
repetition_separatortextNoRepetition separator — X12 005010 ISA11, usually ^
release_charactertextNoRelease character — EDIFACT escape, usually ?
usage_indicatortextNoTest or production
Allowed: T P
ack_requestedbooleanNoAcknowledgements (997 / CONTRL)
connector_iduuidNoConnector
statustextNoStatus
Allowed: active testing inactive
contact_nametextNoTheir EDI contact
contact_emailtextNoContact email
notestextNoNotes

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

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-partners/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/edi-partners/{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-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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
partner_codetextread, writePartner code
nametextread, writeName
partner_typetextread, writeType
Allowed: customer supplier carrier logistics
customer_account_iduuidread, writeCustomer — Their purchase orders become sales orders for this customer.
supplier_iduuidread, writeSupplier — Their acknowledgments, ship notices and invoices answer our purchase orders to this supplier.
carrier_iduuidread, writeCarrier
standardtextread, writeStandard
Allowed: x12 edifact
versiontextread, writeVersion — X12 004010 or 005010; EDIFACT directory D96A or D01B.
Allowed: 004010 005010 D96A D01B
our_qualifiertextread, writeOur ID qualifier — ISA05: ZZ mutually defined, 01 DUNS, 12 phone, 14 DUNS+suffix.
our_idtextread, writeOur interchange ID — ISA06 / UNB sender. At most 15 characters for X12.
partner_qualifiertextread, writeTheir ID qualifier
partner_idtextread, writeTheir interchange ID — ISA08 / UNB recipient. Files from this ID are matched to this partner.
our_gs_codetextread, writeOur GS application code — Leave empty to use the interchange ID.
partner_gs_codetextread, writeTheir GS application code
our_unb_qualifiertextread, writeOur UNB qualifier
partner_unb_qualifiertextread, writeTheir UNB qualifier
segment_terminatortextread, writeSegment terminator — X12 usually ~ ; EDIFACT '
element_separatortextread, writeElement separator — X12 usually * ; EDIFACT +
component_separatortextread, writeComponent separator — Usually :
repetition_separatortextread, writeRepetition separator — X12 005010 ISA11, usually ^
release_charactertextread, writeRelease character — EDIFACT escape, usually ?
usage_indicatortextread, writeTest or production
Allowed: T P
ack_requestedbooleanread, writeAcknowledgements (997 / CONTRL)
connector_iduuidread, writeConnector
statustextread, writeStatus
Allowed: active testing inactive
contact_nametextread, writeTheir EDI contact
contact_emailtextread, writeContact email
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 Partners 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.