Zynk Workflow Documentation

To integrate with Sage 50 US using Zynk you will need to import and export data using XML. While each task uses its own specific format there are some nodes they have in common, as described below.

External Id

The ExternalId field is used when importing data, and should be the unique id of the record from the third party system you are importing from. For example if you are downloading orders from a website this should be the id of the order from the websites database. This field is used to track which records have been imported by Zynk to prevent duplicate data entry.


The Key field will contain the unique id of the record from the Sage 50 US database. This can be used to ensure the third party system does not reprocess records, or can be used to identify records if the id changes e.g. you change the id of an inventory record. 

Import Messages

The output files for import tasks can contain messages to inform of the result, success files can contain Warning messages, while fail files can contain Error and Validation messages. If you are processing the results of an import you should check the ImportMessages collection in the XML.

The following is an example of the above fields within a customer record.

<?xml version="1.0" encoding="utf-8"?>
  <Customer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
        <Field>Custom Field: Sales Contact</Field>
        <Message>Record not found</Message>
        <Message>No employee with ID 'DGROSS11' was found.</Message>

Back | Edit on Github