Edifact

Connect to EDIFACT API to perform encode and decode actions.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions

Creating a connection

To connect your account, you will need the following information:

Name Type Description
Integration Account ID string

Integration Account ID

Integration Account SAS URL securestring

Integration Account SAS URL

Size of Control Numbers block int

Specifies the block size of control numbers to be reserved from an agreement. This is intended for high throughput scenarios

Throttling Limits

Name Calls Renewal Period
API calls per connection180060 seconds

Actions

Add or update control numbers

Add or update control numbers

Decode EDIFACT message

Decode EDIFACT message

Encode to EDIFACT batch message by agreement name

Encode to EDIFACT batch message by agreement name

Encode to EDIFACT batch message by identities

Encode to EDIFACT batch message by identities

Encode to EDIFACT message by agreement name

Encode to EDIFACT message by agreement name

Encode to EDIFACT message by agreement name (V2)

Encode XML interchange to EDIFACT interchange by agreement name. The interchange can have one or more transaction sets.

Encode to EDIFACT message by identities

Encode to EDIFACT message by identities

Encode to EDIFACT message by identities (V2)

Encode XML interchange to EDIFACT interchange by identities. The interchange can have one or more transaction sets.

Resolve EDIFACT agreement

Resolve EDIFACT agreement

Add or update control numbers

Add or update control numbers

Parameters

Name Key Required Type Description
Agreement Name
AgreementName string

Add or update control numbers

Control Number Type
ControlNumberType string

Add or update control numbers

Control Number
ControlNumber string

Add or update control numbers

Control Number Changed Time
ControlNumberChangedTime date-time

Add or update control numbers

Message Direction
MessageDirection string

Add or update control numbers

Is Acknowledgement
IsAcknowledgement boolean

Add or update control numbers

Is Message Processing Failed
IsMessageProcessingFailed boolean

Add or update control numbers

Returns

Decode EDIFACT message

Decode EDIFACT message

Parameters

Name Key Required Type Description
Component separator
componentSeparator integer

Component separator.

Data element separator
dataElementSeparator integer

Data element separator.

Release indicator
releaseIndicator integer

Release indicator.

Repetition separator
repetitionSeparator integer

Repetition separator.

Segment terminator
segmentTerminator integer

Segment terminator.

Segment terminator suffix
segmentTerminatorSuffix string

Segment terminator suffix.

Decimal indicator
decimalIndicator string

Decimal indicator.

Preserve Interchange
preserveInterchange boolean

Preserve interchange - Overrides agreement setting.

Suspend Interchange On Error
suspendInterchangeOnError boolean

Suspend interchange on error - Overrides agreement setting.

EDIFACT flat file message to decode
body True binary

EDIFACT flat file message to decode

Returns

Encode to EDIFACT batch message by agreement name

Encode to EDIFACT batch message by agreement name

Parameters

Name Key Required Type Description
Name of EDIFACT agreement
agreementName True string

The agreement name.

BatchName
BatchName string

The agreement name.

PartitionName
PartitionName string

The agreement name.

MessageId
MessageId string

The agreement name.

Data element separator
dataElementSeparator integer

Data element separator - Overrides agreement setting.

Release indicator
releaseIndicator integer

Release indicator - Overrides agreement setting.

Component separator
componentSeparator integer

Component separator - Overrides agreement setting.

Repetition separator
repetitionSeparator integer

Repetition separator - Overrides agreement setting.

Segment terminator
segmentTerminator integer

Segment terminator - Overrides agreement setting.

Segment terminator suffix
segmentTerminatorSuffix string

Segment terminator suffix - Overrides agreement setting.

Decimal indicator
decimalIndicator string

Decimal indicator - Overrides agreement setting.

Returns

Encode to EDIFACT batch message by identities

Encode to EDIFACT batch message by identities

Parameters

Name Key Required Type Description
Sender identifier
senderIdentifier True string

The sender identifier.

Sender qualifier
senderQualifier True string

The sender qualifier.

Receiver identifier
receiverIdentifier True string

The receiver identifier.

Receiver qualifier
receiverQualifier True string

The receiver qualifier.

BatchName
BatchName string

The sender identifier.

PartitionName
PartitionName string

The sender identifier.

MessageId
MessageId string

The sender identifier.

Data element separator
dataElementSeparator integer

Data element separator - Overrides agreement setting.

Release indicator
releaseIndicator integer

Release indicator - Overrides agreement setting.

Component separator
componentSeparator integer

Component separator - Overrides agreement setting.

Repetition separator
repetitionSeparator integer

Repetition separator - Overrides agreement setting.

Segment terminator
segmentTerminator integer

Segment terminator - Overrides agreement setting.

Segment terminator suffix
segmentTerminatorSuffix string

Segment terminator suffix - Overrides agreement setting.

Decimal indicator
decimalIndicator string

Decimal indicator - Overrides agreement setting.

Returns

Encode to EDIFACT message by agreement name

Encode to EDIFACT message by agreement name

Parameters

Name Key Required Type Description
Name of EDIFACT agreement
agreementName True string

Name of EDIFACT agreement

Data element separator
dataElementSeparator integer

Data element separator - Overrides agreement setting.

Release indicator
releaseIndicator integer

Release indicator - Overrides agreement setting.

Component separator
componentSeparator integer

Component separator - Overrides agreement setting.

Repetition separator
repetitionSeparator integer

Repetition separator - Overrides agreement setting.

Segment terminator
segmentTerminator integer

Segment terminator - Overrides agreement setting.

Segment terminator suffix
segmentTerminatorSuffix string

Segment terminator suffix - Overrides agreement setting.

Decimal indicator
decimalIndicator string

Decimal indicator - Overrides agreement setting.

XML message to encode
body True binary

XML message to encode

Returns

Encode to EDIFACT message by agreement name (V2)

Encode XML interchange to EDIFACT interchange by agreement name. The interchange can have one or more transaction sets.

Parameters

Name Key Required Type Description
Name of EDIFACT agreement
agreementName True string

Name of EDIFACT agreement

Data element separator
dataElementSeparator integer

Data element separator - Overrides agreement setting.

Release indicator
releaseIndicator integer

Release indicator - Overrides agreement setting.

Component separator
componentSeparator integer

Component separator - Overrides agreement setting.

Repetition separator
repetitionSeparator integer

Repetition separator - Overrides agreement setting.

Segment terminator
segmentTerminator integer

Segment terminator - Overrides agreement setting.

Segment terminator suffix
segmentTerminatorSuffix string

Segment terminator suffix - Overrides agreement setting.

Decimal indicator
decimalIndicator string

Decimal indicator - Overrides agreement setting.

XML message to encode
body True binary

XML message to encode

Returns

Encode to EDIFACT message by identities

Encode to EDIFACT message by identities

Parameters

Name Key Required Type Description
Sender identifier
senderIdentifier True string

Sender identifier

Receiver identifier
receiverIdentifier True string

Receiver identifier

Sender qualifier
senderQualifier string

Sender qualifier

Receiver qualifier
receiverQualifier string

Receiver qualifier

Data element separator
dataElementSeparator integer

Data element separator - Overrides agreement setting.

Release indicator
releaseIndicator integer

Release indicator - Overrides agreement setting.

Component separator
componentSeparator integer

Component separator - Overrides agreement setting.

Repetition separator
repetitionSeparator integer

Repetition separator - Overrides agreement setting.

Segment terminator
segmentTerminator integer

Segment terminator - Overrides agreement setting.

Segment terminator suffix
segmentTerminatorSuffix string

Segment terminator suffix - Overrides agreement setting.

Decimal indicator
decimalIndicator string

Decimal indicator - Overrides agreement setting.

XML message to encode
body True binary

XML message to encode

Returns

Encode to EDIFACT message by identities (V2)

Encode XML interchange to EDIFACT interchange by identities. The interchange can have one or more transaction sets.

Parameters

Name Key Required Type Description
Sender identifier
senderIdentifier True string

Sender identifier

Receiver identifier
receiverIdentifier True string

Receiver identifier

Sender qualifier
senderQualifier string

Sender qualifier

Receiver qualifier
receiverQualifier string

Receiver qualifier

Data element separator
dataElementSeparator integer

Data element separator - Overrides agreement setting.

Release indicator
releaseIndicator integer

Release indicator - Overrides agreement setting.

Component separator
componentSeparator integer

Component separator - Overrides agreement setting.

Repetition separator
repetitionSeparator integer

Repetition separator - Overrides agreement setting.

Segment terminator
segmentTerminator integer

Segment terminator - Overrides agreement setting.

Segment terminator suffix
segmentTerminatorSuffix string

Segment terminator suffix - Overrides agreement setting.

Decimal indicator
decimalIndicator string

Decimal indicator - Overrides agreement setting.

XML message to encode
body True binary

XML message to encode

Returns

Resolve EDIFACT agreement

Resolve EDIFACT agreement

Parameters

Name Key Required Type Description
Component separator
componentSeparator integer

Component separator

Data element separator
dataElementSeparator integer

Data element separator

Release indicator
releaseIndicator integer

Release indicator

Repetition separator
repetitionSeparator integer

Repetition separator

Segment terminator
segmentTerminator integer

Segment terminator

Segment terminator suffix
segmentTerminatorSuffix string

Segment terminator suffix

Decimal indicator
decimalIndicator string

Decimal indicator

EDIFACT flat file message
body True binary

EDIFACT flat file message

Returns

Triggers

When a control number is modified

When a control number is modified

When a control number is modified

When a control number is modified

Parameters

Name Key Required Type Description
Initial date time to poll for changes.
startSyncTime date-time

Initial date time to poll for changes.

Returns

Definitions

ReplicableControlNumberContent

Name Path Type Description
Agreement Name
AgreementName string
Control Number Type
ControlNumberType string
Control Number
ControlNumber string
Control Number Changed Time
ControlNumberChangedTime date-time
Message Direction
MessageDirection string
Is Acknowledgement
IsAcknowledgement boolean
Is Message Processing Failed
IsMessageProcessingFailed boolean

UpdateControlNumberResult

Name Path Type Description
Status of the update control number action
UpdateControlNumberStatus string
OldControlNumberContent
OldControlNumberContent ControlNumberContent
ErrorDetails
ErrorDetails ErrorResponseBody

ControlNumberContent

Name Path Type Description
ControlNumber
ControlNumber string
ControlNumberChangedTime
ControlNumberChangedTime date-time

ErrorResponseBody

Name Path Type Description
StatusCode
StatusCode string
ErrorMessage
ErrorMessage string
source
source string
errors
errors array of string

EdiDecodeResponse[EdifactDecodeResponse,EdifactAcknowledgement]

Name Path Type Description
InterchangeControlNumber
InterchangeControlNumber string
GroupControlNumbers
GroupControlNumbers array of string
GoodMessages
GoodMessages array of EdifactDecodeResponse
BadMessages
BadMessages array of EdifactDecodeResponse
GeneratedAcks
GeneratedAcks array of EdifactAcknowledgement
ReceivedAcks
ReceivedAcks array of EdifactAcknowledgement
AgreementName
AgreementName string
GuestPartnerName
GuestPartnerName string
HostPartnerName
HostPartnerName string
ReceiverIdentifier
ReceiverIdentifier string
ReceiverQualifier
ReceiverQualifier string
SenderIdentifier
SenderIdentifier string
SenderQualifier
SenderQualifier string

EdifactDecodeResponse

Name Path Type Description
UNA_Segment
UNA_Segment string
UNB
UNB EdifactInterchangeHeaders
UNG
UNG EdifactGroupHeaders
UNH
UNH EdifactMessageHeaders
DecimalPointIndicator
DecimalPointIndicator integer
RepetitionSeparator
RepetitionSeparator integer
EscapeCharacter
EscapeCharacter integer
TechnicalAckExpected
TechnicalAckExpected boolean
FunctionalAckExpected
FunctionalAckExpected boolean
Exception
Exception string
ComponentSeparator
ComponentSeparator integer
DataElementSeparator
DataElementSeparator integer
GroupControlNumber
GroupControlNumber string
InterchangeControlNumber
InterchangeControlNumber string
MessageType
MessageType string
Payload
Payload string
ReplacementCharacter
ReplacementCharacter integer
SegmentTerminator
SegmentTerminator integer
SegmentTerminatorSuffix
SegmentTerminatorSuffix string
TransactionSetControlNumber
TransactionSetControlNumber string
AgreementName
AgreementName string
GuestPartnerName
GuestPartnerName string
HostPartnerName
HostPartnerName string
ReceiverIdentifier
ReceiverIdentifier string
ReceiverQualifier
ReceiverQualifier string
SenderIdentifier
SenderIdentifier string
SenderQualifier
SenderQualifier string

EdifactAcknowledgement

Name Path Type Description
Acknowledgement
Acknowledgement EdifactFunctionalAcknowledgement
AckPayload
AckPayload string
IsFunctionalAck
IsFunctionalAck boolean
IsTechnicalAck
IsTechnicalAck boolean
TechnicalAckExpected
TechnicalAckExpected boolean
FunctionalAckExpected
FunctionalAckExpected boolean
MessageType
MessageType string

EdifactInterchangeHeaders

Name Path Type Description
UNB_Segment
UNB_Segment string
UNB2.1
UNB2.1 string
UNB2.2
UNB2.2 string
UNB2.3
UNB2.3 string
UNB2.4
UNB2.4 string
UNB3.1
UNB3.1 string
UNB3.2
UNB3.2 string
UNB3.3
UNB3.3 string
UNB3.4
UNB3.4 string
UNB11
UNB11 string

EdifactGroupHeaders

Name Path Type Description
UNG_Segment
UNG_Segment string
UNG1
UNG1 string
UNG2.1
UNG2.1 string
UNG2.2
UNG2.2 string
UNG3.1
UNG3.1 string
UNG3.2
UNG3.2 string
UNG4.1
UNG4.1 string
UNG4.2
UNG4.2 string
UNG5
UNG5 string
UNG6
UNG6 string
UNG7.1
UNG7.1 string
UNG7.2
UNG7.2 string
UNG7.3
UNG7.3 string

EdifactMessageHeaders

Name Path Type Description
UNH1
UNH1 string
UNH2.1
UNH2.1 string
UNH2.2
UNH2.2 string
UNH2.3
UNH2.3 string
UNH2.4
UNH2.4 string
UNH2.5
UNH2.5 string
UNH2.6
UNH2.6 string
UNH2.7
UNH2.7 string

EdifactFunctionalAcknowledgement

Name Path Type Description
SG1Loop
SG1Loop SG1Loop
SG3Loop
SG3Loop array of SG3Loop
UNH1
UNH1 string
UNH2.1
UNH2.1 string
UNH2.2
UNH2.2 string
UNH2.3
UNH2.3 string
UNH2.4
UNH2.4 string
UCI
UCI UCISegment
UNT1
UNT1 string
UNT2
UNT2 string

SG1Loop

Name Path Type Description
UCM1
UCM1 string
UCM2
UCM2 EdifactMessageIdentification
UCM3
UCM3 string
UCM4
UCM4 string
UCM5
UCM5 string
UCM6
UCM6 EdifactDataElementIdentification
SG2Loop
SG2Loop array of EdifactTransactionSetErrorDetails

SG3Loop

Name Path Type Description
UCF1
UCF1 string
UCF2
UCF2 EdifactApplicationIdentification
UCF3
UCF3 EdifactApplicationIdentification
UCF4
UCF4 integer
UCF5
UCF5 string
UCF6
UCF6 string
UCF7
UCF7 EdifactDataElementIdentification
SG4Loop
SG4Loop array of SG4Loop

UCISegment

Name Path Type Description
UCI1
UCI1 string
UCI2.1
UCI2.1 string
UCI2.2
UCI2.2 string
UCI2.3
UCI2.3 string
UCI3.1
UCI3.1 string
UCI3.2
UCI3.2 string
UCI4
UCI4 string
UCI5
UCI5 string
UCI6
UCI6 string
UCI7
UCI7 EdifactDataElementIdentification

EdifactMessageIdentification

Name Path Type Description
UCM2.1
UCM2.1 string
UCM2.2
UCM2.2 string
UCM2.3
UCM2.3 string
UCM2.4
UCM2.4 string

EdifactDataElementIdentification

Name Path Type Description
DataElementPosition
DataElementPosition integer
ComponentElementPosition
ComponentElementPosition integer
DataElementOccurrence
DataElementOccurrence integer

EdifactTransactionSetErrorDetails

Name Path Type Description
UCS1
UCS1 string
UCS2
UCS2 string
UCD1
UCD1 string
UCD2
UCD2 EdifactDataElementIdentification

EdifactApplicationIdentification

Name Path Type Description
Id
Id string
Qualifier
Qualifier string

SG4Loop

Name Path Type Description
UCM1
UCM1 string
UCM2
UCM2 EdifactMessageIdentification
UCM3
UCM3 integer
UCM4
UCM4 string
UCM5
UCM5 string
UCM6
UCM6 EdifactDataElementIdentification
SG5Loop
SG5Loop array of EdifactTransactionSetErrorDetails

EdiAgreementProperties

Name Path Type Description
AgreementName
AgreementName string
GuestPartnerName
GuestPartnerName string
HostPartnerName
HostPartnerName string
ReceiverIdentifier
ReceiverIdentifier string
ReceiverQualifier
ReceiverQualifier string
SenderIdentifier
SenderIdentifier string
SenderQualifier
SenderQualifier string

EdifactEncodeResponse

Name Path Type Description
Acknowledgement
Acknowledgement EdifactTechnicalAcknowledgement
UNB
UNB EdifactInterchangeHeaders
UNG
UNG EdifactGroupHeaders
UNH
UNH EdifactMessageHeaders
DecimalPointIndicator
DecimalPointIndicator integer
IsFunctionalAck
IsFunctionalAck boolean
IsTechnicalAck
IsTechnicalAck boolean
TechnicalAckExpected
TechnicalAckExpected boolean
FunctionalAckExpected
FunctionalAckExpected boolean
ComponentSeparator
ComponentSeparator integer
DataElementSeparator
DataElementSeparator integer
GroupControlNumber
GroupControlNumber string
InterchangeControlNumber
InterchangeControlNumber string
MessageType
MessageType string
Payload
Payload string
ReplacementCharacter
ReplacementCharacter integer
SegmentTerminator
SegmentTerminator integer
SegmentTerminatorSuffix
SegmentTerminatorSuffix string
TransactionSetControlNumber
TransactionSetControlNumber string
AgreementName
AgreementName string
GuestPartnerName
GuestPartnerName string
HostPartnerName
HostPartnerName string
ReceiverIdentifier
ReceiverIdentifier string
ReceiverQualifier
ReceiverQualifier string
SenderIdentifier
SenderIdentifier string
SenderQualifier
SenderQualifier string

EdifactTechnicalAcknowledgement

Name Path Type Description
UNH1
UNH1 string
UNH2.1
UNH2.1 string
UNH2.2
UNH2.2 string
UNH2.3
UNH2.3 string
UNH2.4
UNH2.4 string
UCI
UCI UCISegment
UNT1
UNT1 string
UNT2
UNT2 string

EdifactEncodeV2Response

Name Path Type Description
Interchange
Interchange EdifactInterchangeBatchEnvelope
Content
Content Object
AgreementProperties
AgreementProperties EdiAgreementProperties
Delimiters
Delimiters Delimiters

EdifactInterchangeBatchEnvelope

Name Path Type Description
InterchangeControlNumber
InterchangeControlNumber string
FunctionalGroups
FunctionalGroups array of EdifactFunctionalGroupBatchEnvelope
TransactionSets
TransactionSets array of EdifactTransactionSetBatchEnvelope
UNB_Segment
UNB_Segment string
UNB2_1
UNB2_1 string
UNB2_2
UNB2_2 string
UNB2_3
UNB2_3 string
UNB2_4
UNB2_4 string
UNB3_1
UNB3_1 string
UNB3_2
UNB3_2 string
UNB3_3
UNB3_3 string
UNB3_4
UNB3_4 string
UNB11
UNB11 string

Object

Delimiters

Name Path Type Description
ComponentSeparator
ComponentSeparator integer
DataElementSeparator
DataElementSeparator integer
ReplacementCharacter
ReplacementCharacter integer
ReleaseIndicator
ReleaseIndicator integer
RepetitionSeparator
RepetitionSeparator integer
SegmentTerminator
SegmentTerminator integer
SegmentTerminatorSuffix
SegmentTerminatorSuffix string
DecimalIndicator
DecimalIndicator integer

EdifactFunctionalGroupBatchEnvelope

Name Path Type Description
GroupControlNumber
GroupControlNumber string
TransactionSets
TransactionSets array of EdifactTransactionSetBatchEnvelope
UNG_Segment
UNG_Segment string
UNG1
UNG1 string
UNG2_1
UNG2_1 string
UNG2_2
UNG2_2 string
UNG3_1
UNG3_1 string
UNG3_2
UNG3_2 string
UNG4_1
UNG4_1 string
UNG4_2
UNG4_2 string
UNG5
UNG5 string
UNG6
UNG6 string
UNG7_1
UNG7_1 string
UNG7_2
UNG7_2 string
UNG7_3
UNG7_3 string

EdifactTransactionSetBatchEnvelope

Name Path Type Description
TransactionSetControlNumber
TransactionSetControlNumber string
MessageId
MessageId string
UNH1
UNH1 string
UNH2_1
UNH2_1 string
UNH2_2
UNH2_2 string
UNH2_3
UNH2_3 string
UNH2_4
UNH2_4 string
UNH2_5
UNH2_5 string
UNH2_6
UNH2_6 string
UNH2_7
UNH2_7 string

EdifactBatchEncodeResponse

Name Path Type Description
Interchange
Interchange EdifactInterchangeBatchEnvelope
BatchName
BatchName string
PartitionName
PartitionName string
Content
Content Object
BadMessages
BadMessages array of BatchItemError
AgreementProperties
AgreementProperties EdiAgreementProperties
Delimiters
Delimiters Delimiters

BatchItemError

Name Path Type Description
MessageId
MessageId string
Error
Error string