Skip to content

Export Amasty Companies from Magento V2

This task will export companies from the Amasty B2B Companies extension for Magento in an XML format. The results can be filtered if required. See below for an example output file.

Important

This task will only work if you have the Amasty B2B Companies extension installed on your Magento site. You must also apply a patch to the extension to add a company search endpoint to the API. This patch can be obtained from Amasty.

GET /V1/amcompany/company

Settings

Export Settings > Export Company Credit

Optional
Optionally enable this task setting to export the credit information related to each company.

Export Settings > Export Customer

Optional
Optionally export the related customer record who is designated as the super user for each company.

Filter Groups

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

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

Optional
The following types of filter are available:

  • Equal - Returns records where the field matches the specified value.
  • NotEqual - Returns records where the field does not match the specified value.
  • Like - Returns records where the field contains the specified value.
  • In - Returns records where the field matches one of the specified values.
  • NotIn - Returns records where the field does not match one of the specified values.
  • Null - Returns records where the field does not have a value.
  • NotNull - Returns records where the field has a value.
  • GreaterThan - Returns records where the field is greater than the specified value.
  • LessThan - Returns records where the field is less than the specified value.
  • GreaterThanOrEqual - Returns records where the field is greater than or equal to the specified value.
  • LessThanOrEqual - Returns records where the field is less than or equal to the specified value.

Filter Groups > Filter > Field

Optional
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

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

Page Size

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

Store View Code

Required
The Magento store view code to perform the API calls against. Default value of 'default'.

Output File

Required
The name of the file to export the companies to.

Zynk Settings

See Common Task Settings.

Examples

A sample output file is shown below.

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfAmastyCompany xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <AmastyCompany>
    <external_id>ZYNK0001</external_id>
    <company_id>2</company_id>
    <company_name>Zynk Software Ltd</company_name>
    <status>0</status>
    <company_email>[email protected]</company_email>
    <vat_tax_id>1</vat_tax_id>
    <street>
      <string>Office 16</string>
      <string>6 Charlotte Square</string>
    </street>
    <city>Newcastle</city>
    <country_id>GB</country_id>
    <postcode>NE1 4XF</postcode>
    <telephone>0191 123 4567</telephone>
    <customer_group_id>1</customer_group_id>
    <sales_representative_id xsi:nil="true" />
    <super_user_id>2</super_user_id>
    <customer_ids />
    <restricted_payments>
      <string>1</string>
    </restricted_payments>
    <use_company_group>true</use_company_group>
    <credit>
      <id>2</id>
      <company_id>2</company_id>
      <balance>50</balance>
      <issued_credit>100</issued_credit>
      <be_paid>0</be_paid>
      <currency_code>GBP</currency_code>
      <overdraft_allowed>false</overdraft_allowed>
      <overdraft_limit>0</overdraft_limit>
      <overdraft_repay>0</overdraft_repay>
      <overdraft_repay_digit>1</overdraft_repay_digit>
      <overdraft_repay_type>0</overdraft_repay_type>
      <overdraft_penalty>0</overdraft_penalty>
    </credit>
    <customer>
      <id>2</id>
      <group_id>1</group_id>
      <created_at>2024-08-20T11:08:24</created_at>
      <default_billing>0</default_billing>
      <default_shipping>0</default_shipping>
      <created_in>Default Store View</created_in>
      <dob xsi:nil="true" />
      <email>[email protected]</email>
      <firstname>Zynk</firstname>
      <lastname>Test</lastname>
      <gender>0</gender>
      <store_id>1</store_id>
      <website_id>1</website_id>
      <addresses />
      <disable_auto_group_change>0</disable_auto_group_change>
      <updated_at>2024-08-20T11:08:24</updated_at>
      <custom_attributes>
        <custom_attribute>
          <attribute_code>trade_status</attribute_code>
          <value>2</value>
        </custom_attribute>
      </custom_attributes>
    </customer>
  </AmastyCompany>
</ArrayOfAmastyCompany>