EDI Profiles

API for managing EDI profiles in Celigo.

EDI profiles define the interchange envelope configuration for EDI X12 and EDIFACT document exchange between trading partners. They contain the control fields (ISA/GS for X12, UNB for EDIFACT) that identify sender/receiver, standards versions, and interchange control settings.

EDI profile schema

List EDI profiles

get

/v1/ediprofiles

Returns all EDI profiles configured in the account.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successfully retrieved list of EDI profiles

application/json

204

No EDI profiles exist in the account

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

get/v1/ediprofiles

GET /v1/ediprofiles HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "_id": "690146d901d66a7545038179",
    "lastModified": "2026-05-02T18:10:01.832Z",
    "name": "Dyno",
    "fileType": "edix12",
    "tpInterchangeId": "9253390501",
    "myInterchangeId": "KOMAR3PL",
    "controlNumber": 1,
    "isa01": "00",
    "isa03": "00",
    "tpIdQualifier": "08",
    "myIdQualifier": "ZZ",
    "isa11": "U",
    "isa12": "00401",
    "isa14": "0",
    "isa15": "T",
    "isa16": ":",
    "tpGroupId": "9253390501",
    "myGroupId": "KOMAR3PL",
    "gs07": "T",
    "gs08": "004010UCS"
  },
  {
    "_id": "689e2e2c11a53a05a0337115",
    "lastModified": "2025-08-14T18:51:52.968Z",
    "name": "Amazon.eu",
    "fileType": "edifact",
    "tpInterchangeId": "49494949494",
    "myInterchangeId": "12345678911",
    "controlNumber": 1,
    "unb010_0001": "UNOA",
    "unb010_0002": "1",
    "tpIdQualifier": "ZZZ",
    "myIdQualifier": "ZZZ",
    "versionNumber": "96A",
    "controllingAgency": "EU"
  }
]

Create an EDI profile

post

/v1/ediprofiles

Creates a new EDI profile for EDI X12 or EDIFACT document exchange. fileType is immutable after creation. Only name and fileType are required; all ISA/GS/UNB control fields default to safe values.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

EDI profile configuration. The fileType field determines which set of interchange control fields apply (X12 ISA/GS or EDIFACT UNB) and is immutable after creation. Fields for the other standard are ignored.

namestringRequired

Human-readable name for the EDI profile

Example: Acme Corp X12 Profile

descriptionstringOptional

Detailed description of the EDI profile's purpose

Example: X12 interchange profile for Acme Corp trading partner

fileTypestring · enumRequired

The EDI standard this profile is configured for. Immutable after creation.

Example: edix12Possible values:

tpInterchangeIdstringOptional

Trading partner's interchange identifier (ISA06 for X12, UNB sender/receiver ID for EDIFACT)

Example: ACMECORP

myInterchangeIdstringOptional

Your (sender/receiver) interchange identifier

Example: MYCOMPANY

controlNumberinteger · min: 1 · max: 999999999Optional

Current interchange control number. Incremented with each interchange sent.

Default: 1Example: 1

isa01string · enumOptional

X12 ISA01 — Authorization Information Qualifier.

Example: 00Possible values:

isa02stringOptional

X12 ISA02 - Authorization Information (10 characters)

Example:

isa03string · enumOptional

X12 ISA03 — Security Information Qualifier.

Example: 00Possible values:

isa04stringOptional

X12 ISA04 - Security Information (10 characters)

Example:

tpIdQualifierstringOptional

Trading partner ID qualifier.

For X12 (ISA05/ISA07): Values include 01 (DUNS), 08 (UCC EDI), 12 (phone), 14 (DUNS+4), ZZ (mutually defined), etc.

For EDIFACT: Values include 14 (EAN), ZZZ (mutually defined), etc.

Example: ZZ

myIdQualifierstringOptional

Your (sender/receiver) ID qualifier. Same enum as tpIdQualifier.

Example: ZZ

isa11stringOptional

X12 ISA11 - Repetition Separator (or Interchange Control Standards Identifier in older versions). Single character.

Example: U

isa12stringOptional

X12 ISA12 - Interchange Control Version Number (5 characters)

Example: 00401

isa14string · enumOptional

X12 ISA14 — Acknowledgment Requested.

Example: 0Possible values:

isa15string · enumOptional

X12 ISA15 — Interchange Usage Indicator.

Example: PPossible values:

isa16stringOptional

X12 ISA16 - Component Element Separator. Single character.

Example: >

tpGroupIdstringOptional

X12 GS02 - Trading partner's application sender/receiver code

Example: ACME

myGroupIdstringOptional

X12 GS03 - Your application sender/receiver code

Example: MYAPP

gs07string · enumOptional

X12 GS07 — Responsible Agency Code.

Example: XPossible values:

gs08stringOptional

X12 GS08 - Version/Release/Industry Identifier Code

Example: 004010

unb010_0001string · enumOptional

EDIFACT UNB S001/0001 - Syntax Identifier. Identifies the character set used in the interchange.

Example: UNOBPossible values:

unb010_0002string · enumOptional

EDIFACT UNB S001/0002 - Syntax Version Number.

Example: 3Possible values:

versionNumberstringOptional

EDIFACT message version number (e.g., "D" for directory).

Example: D

releaseNumberstringOptional

EDIFACT message release number.

Example: 96A

controllingAgencystringOptional

EDIFACT controlling agency code.

Example: UN

Responses

201

EDI profile created successfully

application/json

EDI profile with metadata and interchange control fields.

namestringRequired

Human-readable name for the EDI profile

Example: Acme Corp X12 Profile

descriptionstringOptional

Detailed description of the EDI profile's purpose

Example: X12 interchange profile for Acme Corp trading partner

fileTypestring · enumRequired

The EDI standard this profile is configured for. Immutable after creation.

Example: edix12Possible values:

tpInterchangeIdstringOptional

Trading partner's interchange identifier (ISA06 for X12, UNB sender/receiver ID for EDIFACT)

Example: ACMECORP

myInterchangeIdstringOptional

Your (sender/receiver) interchange identifier

Example: MYCOMPANY

controlNumberinteger · min: 1 · max: 999999999Optional

Current interchange control number. Incremented with each interchange sent.

Default: 1Example: 1

isa01string · enumOptional

X12 ISA01 — Authorization Information Qualifier.

Example: 00Possible values:

isa02stringOptional

X12 ISA02 - Authorization Information (10 characters)

Example:

isa03string · enumOptional

X12 ISA03 — Security Information Qualifier.

Example: 00Possible values:

isa04stringOptional

X12 ISA04 - Security Information (10 characters)

Example:

tpIdQualifierstringOptional

Trading partner ID qualifier.

For X12 (ISA05/ISA07): Values include 01 (DUNS), 08 (UCC EDI), 12 (phone), 14 (DUNS+4), ZZ (mutually defined), etc.

For EDIFACT: Values include 14 (EAN), ZZZ (mutually defined), etc.

Example: ZZ

myIdQualifierstringOptional

Your (sender/receiver) ID qualifier. Same enum as tpIdQualifier.

Example: ZZ

isa11stringOptional

X12 ISA11 - Repetition Separator (or Interchange Control Standards Identifier in older versions). Single character.

Example: U

isa12stringOptional

X12 ISA12 - Interchange Control Version Number (5 characters)

Example: 00401

isa14string · enumOptional

X12 ISA14 — Acknowledgment Requested.

Example: 0Possible values:

isa15string · enumOptional

X12 ISA15 — Interchange Usage Indicator.

Example: PPossible values:

isa16stringOptional

X12 ISA16 - Component Element Separator. Single character.

Example: >

tpGroupIdstringOptional

X12 GS02 - Trading partner's application sender/receiver code

Example: ACME

myGroupIdstringOptional

X12 GS03 - Your application sender/receiver code

Example: MYAPP

gs07string · enumOptional

X12 GS07 — Responsible Agency Code.

Example: XPossible values:

gs08stringOptional

X12 GS08 - Version/Release/Industry Identifier Code

Example: 004010

unb010_0001string · enumOptional

EDIFACT UNB S001/0001 - Syntax Identifier. Identifies the character set used in the interchange.

Example: UNOBPossible values:

unb010_0002string · enumOptional

EDIFACT UNB S001/0002 - Syntax Version Number.

Example: 3Possible values:

versionNumberstringOptional

EDIFACT message version number (e.g., "D" for directory).

Example: D

releaseNumberstringOptional

EDIFACT message release number.

Example: 96A

controllingAgencystringOptional

EDIFACT controlling agency code.

Example: UN

_idstring · objectIdRead-onlyRequired

Unique identifier for the resource. Format is a 24-character hexadecimal string.

Example: 5f8d43a1b9e5a80011a35f2c

createdAtstring · date-timeRead-onlyOptional

Timestamp when the resource was created. Set automatically and cannot be modified.

Example: 2023-04-01T09:15:32Z

lastModifiedstring · date-timeRead-onlyRequired

Timestamp when the resource was last updated. Changes whenever any property is modified.

Example: 2023-04-15T14:30:15Z

deletedAtstring · nullableRead-onlyOptional

Timestamp when the resource was soft-deleted. When null or absent, the resource is active.

Example: 2023-05-20T11:45:32Z

_templateIdstring · objectIdRead-onlyOptional

Template this EDI profile was installed from.

Example: 5f8d43a1b9e5a80011a35f2c

_sourceIdstring · objectIdRead-onlyOptional

Original profile ID when cloned or installed from a template.

Example: 5f8d43a1b9e5a80011a35f2c

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

422

Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.

application/json

post/v1/ediprofiles

POST /v1/ediprofiles HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "name": "Acme Corp X12",
  "fileType": "edix12"
}

{
  "_id": "5f8d43a1b9e5a80011a35f2c",
  "lastModified": "2026-06-09T17:30:12.481Z",
  "name": "Acme Corp X12",
  "fileType": "edix12"
}

Get an EDI profile

get

/v1/ediprofiles/{_id}

Returns a specific EDI profile.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstring · objectIdRequired

The unique identifier of the EDI profile

Example: 5f8d43a1b9e5a80011a35f2c

Responses

200

EDI profile retrieved successfully

application/json

EDI profile with metadata and interchange control fields.

namestringRequired

Human-readable name for the EDI profile

Example: Acme Corp X12 Profile

descriptionstringOptional

Detailed description of the EDI profile's purpose

Example: X12 interchange profile for Acme Corp trading partner

fileTypestring · enumRequired

The EDI standard this profile is configured for. Immutable after creation.

Example: edix12Possible values:

tpInterchangeIdstringOptional

Trading partner's interchange identifier (ISA06 for X12, UNB sender/receiver ID for EDIFACT)

Example: ACMECORP

myInterchangeIdstringOptional

Your (sender/receiver) interchange identifier

Example: MYCOMPANY

controlNumberinteger · min: 1 · max: 999999999Optional

Current interchange control number. Incremented with each interchange sent.

Default: 1Example: 1

isa01string · enumOptional

X12 ISA01 — Authorization Information Qualifier.

Example: 00Possible values:

isa02stringOptional

X12 ISA02 - Authorization Information (10 characters)

Example:

isa03string · enumOptional

X12 ISA03 — Security Information Qualifier.

Example: 00Possible values:

isa04stringOptional

X12 ISA04 - Security Information (10 characters)

Example:

tpIdQualifierstringOptional

Trading partner ID qualifier.

For X12 (ISA05/ISA07): Values include 01 (DUNS), 08 (UCC EDI), 12 (phone), 14 (DUNS+4), ZZ (mutually defined), etc.

For EDIFACT: Values include 14 (EAN), ZZZ (mutually defined), etc.

Example: ZZ

myIdQualifierstringOptional

Your (sender/receiver) ID qualifier. Same enum as tpIdQualifier.

Example: ZZ

isa11stringOptional

X12 ISA11 - Repetition Separator (or Interchange Control Standards Identifier in older versions). Single character.

Example: U

isa12stringOptional

X12 ISA12 - Interchange Control Version Number (5 characters)

Example: 00401

isa14string · enumOptional

X12 ISA14 — Acknowledgment Requested.

Example: 0Possible values:

isa15string · enumOptional

X12 ISA15 — Interchange Usage Indicator.

Example: PPossible values:

isa16stringOptional

X12 ISA16 - Component Element Separator. Single character.

Example: >

tpGroupIdstringOptional

X12 GS02 - Trading partner's application sender/receiver code

Example: ACME

myGroupIdstringOptional

X12 GS03 - Your application sender/receiver code

Example: MYAPP

gs07string · enumOptional

X12 GS07 — Responsible Agency Code.

Example: XPossible values:

gs08stringOptional

X12 GS08 - Version/Release/Industry Identifier Code

Example: 004010

unb010_0001string · enumOptional

EDIFACT UNB S001/0001 - Syntax Identifier. Identifies the character set used in the interchange.

Example: UNOBPossible values:

unb010_0002string · enumOptional

EDIFACT UNB S001/0002 - Syntax Version Number.

Example: 3Possible values:

versionNumberstringOptional

EDIFACT message version number (e.g., "D" for directory).

Example: D

releaseNumberstringOptional

EDIFACT message release number.

Example: 96A

controllingAgencystringOptional

EDIFACT controlling agency code.

Example: UN

_idstring · objectIdRead-onlyRequired

Unique identifier for the resource. Format is a 24-character hexadecimal string.

Example: 5f8d43a1b9e5a80011a35f2c

createdAtstring · date-timeRead-onlyOptional

Timestamp when the resource was created. Set automatically and cannot be modified.

Example: 2023-04-01T09:15:32Z

lastModifiedstring · date-timeRead-onlyRequired

Timestamp when the resource was last updated. Changes whenever any property is modified.

Example: 2023-04-15T14:30:15Z

deletedAtstring · nullableRead-onlyOptional

Timestamp when the resource was soft-deleted. When null or absent, the resource is active.

Example: 2023-05-20T11:45:32Z

_templateIdstring · objectIdRead-onlyOptional

Template this EDI profile was installed from.

Example: 5f8d43a1b9e5a80011a35f2c

_sourceIdstring · objectIdRead-onlyOptional

Original profile ID when cloned or installed from a template.

Example: 5f8d43a1b9e5a80011a35f2c

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

get/v1/ediprofiles/{_id}

GET /v1/ediprofiles/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "690146d901d66a7545038179",
  "lastModified": "2026-05-02T18:10:01.832Z",
  "name": "Dyno",
  "fileType": "edix12",
  "tpInterchangeId": "9253390501",
  "myInterchangeId": "KOMAR3PL",
  "controlNumber": 1,
  "isa01": "00",
  "isa03": "00",
  "tpIdQualifier": "08",
  "myIdQualifier": "ZZ",
  "isa11": "U",
  "isa12": "00401",
  "isa14": "0",
  "isa15": "T",
  "isa16": ":",
  "tpGroupId": "9253390501",
  "myGroupId": "KOMAR3PL",
  "gs07": "T",
  "gs08": "004010UCS"
}

Update an EDI profile

put

/v1/ediprofiles/{_id}

Updates an existing EDI profile. fileType cannot be changed after creation. Omitted fields are cleared to defaults.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstring · objectIdRequired

The unique identifier of the EDI profile

Example: 5f8d43a1b9e5a80011a35f2c

Body

EDI profile configuration. The fileType field determines which set of interchange control fields apply (X12 ISA/GS or EDIFACT UNB) and is immutable after creation. Fields for the other standard are ignored.

namestringRequired

Human-readable name for the EDI profile

Example: Acme Corp X12 Profile

descriptionstringOptional

Detailed description of the EDI profile's purpose

Example: X12 interchange profile for Acme Corp trading partner

fileTypestring · enumRequired

The EDI standard this profile is configured for. Immutable after creation.

Example: edix12Possible values:

tpInterchangeIdstringOptional

Trading partner's interchange identifier (ISA06 for X12, UNB sender/receiver ID for EDIFACT)

Example: ACMECORP

myInterchangeIdstringOptional

Your (sender/receiver) interchange identifier

Example: MYCOMPANY

controlNumberinteger · min: 1 · max: 999999999Optional

Current interchange control number. Incremented with each interchange sent.

Default: 1Example: 1

isa01string · enumOptional

X12 ISA01 — Authorization Information Qualifier.

Example: 00Possible values:

isa02stringOptional

X12 ISA02 - Authorization Information (10 characters)

Example:

isa03string · enumOptional

X12 ISA03 — Security Information Qualifier.

Example: 00Possible values:

isa04stringOptional

X12 ISA04 - Security Information (10 characters)

Example:

tpIdQualifierstringOptional

Trading partner ID qualifier.

For X12 (ISA05/ISA07): Values include 01 (DUNS), 08 (UCC EDI), 12 (phone), 14 (DUNS+4), ZZ (mutually defined), etc.

For EDIFACT: Values include 14 (EAN), ZZZ (mutually defined), etc.

Example: ZZ

myIdQualifierstringOptional

Your (sender/receiver) ID qualifier. Same enum as tpIdQualifier.

Example: ZZ

isa11stringOptional

X12 ISA11 - Repetition Separator (or Interchange Control Standards Identifier in older versions). Single character.

Example: U

isa12stringOptional

X12 ISA12 - Interchange Control Version Number (5 characters)

Example: 00401

isa14string · enumOptional

X12 ISA14 — Acknowledgment Requested.

Example: 0Possible values:

isa15string · enumOptional

X12 ISA15 — Interchange Usage Indicator.

Example: PPossible values:

isa16stringOptional

X12 ISA16 - Component Element Separator. Single character.

Example: >

tpGroupIdstringOptional

X12 GS02 - Trading partner's application sender/receiver code

Example: ACME

myGroupIdstringOptional

X12 GS03 - Your application sender/receiver code

Example: MYAPP

gs07string · enumOptional

X12 GS07 — Responsible Agency Code.

Example: XPossible values:

gs08stringOptional

X12 GS08 - Version/Release/Industry Identifier Code

Example: 004010

unb010_0001string · enumOptional

EDIFACT UNB S001/0001 - Syntax Identifier. Identifies the character set used in the interchange.

Example: UNOBPossible values:

unb010_0002string · enumOptional

EDIFACT UNB S001/0002 - Syntax Version Number.

Example: 3Possible values:

versionNumberstringOptional

EDIFACT message version number (e.g., "D" for directory).

Example: D

releaseNumberstringOptional

EDIFACT message release number.

Example: 96A

controllingAgencystringOptional

EDIFACT controlling agency code.

Example: UN

Responses

200

EDI profile updated successfully

application/json

EDI profile with metadata and interchange control fields.

namestringRequired

Human-readable name for the EDI profile

Example: Acme Corp X12 Profile

descriptionstringOptional

Detailed description of the EDI profile's purpose

Example: X12 interchange profile for Acme Corp trading partner

fileTypestring · enumRequired

The EDI standard this profile is configured for. Immutable after creation.

Example: edix12Possible values:

tpInterchangeIdstringOptional

Trading partner's interchange identifier (ISA06 for X12, UNB sender/receiver ID for EDIFACT)

Example: ACMECORP

myInterchangeIdstringOptional

Your (sender/receiver) interchange identifier

Example: MYCOMPANY

controlNumberinteger · min: 1 · max: 999999999Optional

Current interchange control number. Incremented with each interchange sent.

Default: 1Example: 1

isa01string · enumOptional

X12 ISA01 — Authorization Information Qualifier.

Example: 00Possible values:

isa02stringOptional

X12 ISA02 - Authorization Information (10 characters)

Example:

isa03string · enumOptional

X12 ISA03 — Security Information Qualifier.

Example: 00Possible values:

isa04stringOptional

X12 ISA04 - Security Information (10 characters)

Example:

tpIdQualifierstringOptional

Trading partner ID qualifier.

For X12 (ISA05/ISA07): Values include 01 (DUNS), 08 (UCC EDI), 12 (phone), 14 (DUNS+4), ZZ (mutually defined), etc.

For EDIFACT: Values include 14 (EAN), ZZZ (mutually defined), etc.

Example: ZZ

myIdQualifierstringOptional

Your (sender/receiver) ID qualifier. Same enum as tpIdQualifier.

Example: ZZ

isa11stringOptional

X12 ISA11 - Repetition Separator (or Interchange Control Standards Identifier in older versions). Single character.

Example: U

isa12stringOptional

X12 ISA12 - Interchange Control Version Number (5 characters)

Example: 00401

isa14string · enumOptional

X12 ISA14 — Acknowledgment Requested.

Example: 0Possible values:

isa15string · enumOptional

X12 ISA15 — Interchange Usage Indicator.

Example: PPossible values:

isa16stringOptional

X12 ISA16 - Component Element Separator. Single character.

Example: >

tpGroupIdstringOptional

X12 GS02 - Trading partner's application sender/receiver code

Example: ACME

myGroupIdstringOptional

X12 GS03 - Your application sender/receiver code

Example: MYAPP

gs07string · enumOptional

X12 GS07 — Responsible Agency Code.

Example: XPossible values:

gs08stringOptional

X12 GS08 - Version/Release/Industry Identifier Code

Example: 004010

unb010_0001string · enumOptional

EDIFACT UNB S001/0001 - Syntax Identifier. Identifies the character set used in the interchange.

Example: UNOBPossible values:

unb010_0002string · enumOptional

EDIFACT UNB S001/0002 - Syntax Version Number.

Example: 3Possible values:

versionNumberstringOptional

EDIFACT message version number (e.g., "D" for directory).

Example: D

releaseNumberstringOptional

EDIFACT message release number.

Example: 96A

controllingAgencystringOptional

EDIFACT controlling agency code.

Example: UN

_idstring · objectIdRead-onlyRequired

Unique identifier for the resource. Format is a 24-character hexadecimal string.

Example: 5f8d43a1b9e5a80011a35f2c

createdAtstring · date-timeRead-onlyOptional

Timestamp when the resource was created. Set automatically and cannot be modified.

Example: 2023-04-01T09:15:32Z

lastModifiedstring · date-timeRead-onlyRequired

Timestamp when the resource was last updated. Changes whenever any property is modified.

Example: 2023-04-15T14:30:15Z

deletedAtstring · nullableRead-onlyOptional

Timestamp when the resource was soft-deleted. When null or absent, the resource is active.

Example: 2023-05-20T11:45:32Z

_templateIdstring · objectIdRead-onlyOptional

Template this EDI profile was installed from.

Example: 5f8d43a1b9e5a80011a35f2c

_sourceIdstring · objectIdRead-onlyOptional

Original profile ID when cloned or installed from a template.

Example: 5f8d43a1b9e5a80011a35f2c

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

put/v1/ediprofiles/{_id}

PUT /v1/ediprofiles/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "name": "Dyno",
  "fileType": "edix12",
  "tpInterchangeId": "9253390501",
  "myInterchangeId": "KOMAR3PL"
}

{
  "_id": "690146d901d66a7545038179",
  "lastModified": "2026-05-12T09:21:14.005Z",
  "name": "Dyno",
  "fileType": "edix12",
  "tpInterchangeId": "9253390501",
  "myInterchangeId": "KOMAR3PL",
  "controlNumber": 1,
  "isa01": "00",
  "isa03": "00",
  "tpIdQualifier": "08",
  "myIdQualifier": "ZZ",
  "isa11": "U",
  "isa12": "00401",
  "isa14": "0",
  "isa15": "T",
  "isa16": ":",
  "tpGroupId": "9253390501",
  "myGroupId": "KOMAR3PL",
  "gs07": "T",
  "gs08": "004010UCS"
}

Delete an EDI profile

delete

/v1/ediprofiles/{_id}

Deletes an EDI profile. Soft-deleted and retained for 30 days.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstring · objectIdRequired

The unique identifier of the EDI profile

Example: 5f8d43a1b9e5a80011a35f2c

Responses

204

EDI profile deleted successfully

No content

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

422

The resource has dependents that must be deleted first. Each entry in the errors array names one blocking resource.

application/json

delete/v1/ediprofiles/{_id}

DELETE /v1/ediprofiles/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List dependencies of an EDI profile

get

/v1/ediprofiles/{_id}/dependencies

Returns the set of resources that depend on the specified resource. The response is an object whose keys are dependent-resource types (e.g. flows, imports) and whose values are arrays of dependency entries. Returns {} when no dependents exist, including for well-formatted but nonexistent IDs.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstring · objectIdRequired

Resource ID.

Example: 5f8d43a1b9e5a80011a35f2c

Responses

200

Dependency map. Keys are resource-type strings; values are arrays of dependency entries. Returns {} when no dependents exist.

application/json

Map of dependent-resource types to arrays of dependency entries. Keys are plural resource type strings (e.g. flows, imports, connections). An empty object {} means no dependents.

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

get/v1/ediprofiles/{_id}/dependencies

GET /v1/ediprofiles/{_id}/dependencies HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}