Zynk Workflow Documentation

This task will download customer groups from Magento in an XML format. The results can be filtered if required. See below for a sample output file.

API Enpoint

GET /V1/customerGroups/search



The Magento V2 connection to use. See the Connecting to Magento V2 article if you require more information on how to create/manage connections.

Filter Groups

The filtering to apply to the records. Only records which match the criteria specified will be downloaded.

Filters are arranged into groups. The individual filters within a group will be combined using the OR operator. Groups of filters are combined using the AND operator.

Filter Groups > Filter > Condition

The following types of filter are available:

Filter Groups > Filter > Field

The name of the field the filter is to be based upon. The name should match the API field name, as seen in the output file.

Filter Groups > Filter > Value

The value the filter is to be based upon. This is not required when using the ‘Null’ or ‘NotNull’ condition type.

Page Size

The number of records to include in each page of results. Defaults to 50. Increasing this value will increase the speed of the download, but will consume more memory.

Store View Code

The magento store view code to perform the API calls against. Default value of ‘default’.

Output File

The name of the file to export the customer groups to.

Zynk Settings

See Common Task Settings.


A sample output file is shown below.

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfGroup xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <tax_class_name>Retail Customer</tax_class_name>

Back | Edit on Github