Correlation Identifiers
-----------------------

In order to allow an external system use its own identifiers to cross-reference transactions
in the system, the API supports two external identifiers for all transactions. This
allows the external system to:

1. Tie together multiple transactions in the system (using for example an order number)
#. Track individual requests in the system using the external IDs.

External identifiers are not supported for the parent transactions tool/BulkLoad and 
tool/DataImport.

The transaction log will include these two IDs and the transaction log, as 
shown below. 

You can obtain the details of the parent transaction with a given ID by using the 
following API call:

::

   GET http://my.fulfillmentserver/api/tool/Transaction/
       ?hierarchy=[hierarchy]&
        filter_condition=contains&
        format=json&
        filter_text=3x4mpl3-3xtern4l-FF&
        filter_field=external.id

You can obtain the details of transactions tied together using an external reference number
using the following API call:

::

   GET http://my.fulfillmentserver/api/tool/Transaction/
    ?hierarchy=[hierarchy]&
        filter_condition=contains&
        format=json&
        filter_text=Example%20External%20Reference-FF&
        filter_field=external.reference



|async-callback-status1|

.

|async-callback-status2|

.. |async-callback-status1| image:: /src/images/async-callback-status1.png
.. |async-callback-status2| image:: /src/images/async-callback-status2.png
.. |VOSS Automate| replace:: VOSS Automate
.. |Unified CM| replace:: Unified CM