- Acknowledgement_Message
Onetrail TPN™ Acknowledgement Message
Introduction
The Onetrail Acknowledgement is used to confirm the receipt or non-receipt of a document, like an order request.
Process
If a message is submitted by Onetrail to the recipient, either Onetrail or the recipient will create and send an Onetrail Acknowledgement. In practice, the Onetrail Acknowledgement is generated on the receipt or non-receipt of orders. With the usage of web services, the response always contains an Onetrail Acknowledgement to indicate the receipt of the message at Onetrail TPN™. A second Acknowledgement will still be created as described in the first lines above.
Choreography
Process management
Orders submitted by Onetrail TPN™ have to be confirmed with an Onetrail Acknowledgement within 1 hour, otherwise an alert will be generated and sent to the Onetrail TPN™ Support department who will take action.
Content
GLNs are used to identify the sender and receiver of the Acknowledgement.
Scenarios
There are 2 scenarios:
- The positive Acknowledgement (Ack)
- The Negative Acknowledgement (NAck).
The Negative Acknowledgement can have multiple error codes and descriptions covering mulitple error scenarios.
Exceptions
The exception element consists of 3 elements: the exception code, the -description and -type.
The table below specifies the error codes and -descriptions for the order request:
Error code | Description |
---|---|
000E | OK |
501E | Item number(s) unknown: %X%. Check the item number and resend the order. |
502E | Not authorized. Onetrail will fix the problem and resend the order. |
503E | Bill to address code unknown: %X%. Verify the Bill To address and resend the order. |
504E | Ship to address code unknown: %X%. Verify the Ship To address and resend the order. |
505E | Order number %X% already exist in supplier’s system. Check together with Onetrail support why the order was sent more than once. |
506E | Format or syntax error: %X%. Onetrail will fix the problem and resend the order. |
507E | Illegal date: %X%. Verify the Date and resend the order. |
599E | Unclassified error: %X%. Onetrail will fix the problem with the supplier and resend the order. |
Remark: “%X%” = Variable
Use code and description OR combi tag without description. Onetrail will use the default description to the recipient as stated in the above exception codes list.
Example 1:
000E
Ok
Remark: Where “000E” = exception code and Freeform text = “OK”. Freeform text will ALWAYS overrule the default description as stated in the above exception codes list.
Example 2:
504E%21120
Remark: Where “504E” = exception code and “21120” = Ship to address(code) “%” needs to precede the variable!
<Exceptions>
<ExceptionDescription>
<errorClassification>
<GlobalMessageExceptionCode>000E</GlobalMessageExceptionCode>
</errorClassification>
<errorDescription>
<FreeFormText lang="EN">Ok</FreeFormText>
</errorDescription>
</ExceptionDescription>
<GlobalExceptionTypeCode>Receipt Acknowledgement Exception</GlobalExceptionTypeCode>
</Exceptions>
Format & Syntax
The format of the standard Onetrail XML messages is XML version 1.0.
The encoding must be UTF-8. Please refer to our OT(N)ACK XSD Documentation for default values, multiplicity of elements, attributes, business rules and an overview for mapping design purposes.
For more information we refer to: Format & Syntax Acknowledgement
Communication
Please refer to the communication page: Onetrail TPN™ Communication