Skip to content

Import Amasty Companies to Magento V2

This task will create or update companies in the Amasty B2B Companies extension for Magento. See below for a sample input file.

If the <id> element is specified in the input file, the task will update the company with the specified ID. If no ID is specified, the task will use the <company_name>, then the <company_email> element to check if the company already exists. If a match is found the existing company will be updated, otherwise a new company will be created.

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.

POST /V1/amcompany/company

This method will be used for creating new companies.

PUT /V1/amcompany/company/{id}

This method will be used for updating existing companies. The matching routine is noted above.
{id} You must provide either the company id or the email in order find a successfully match for the company. You can also use a match clause.

Settings

Connection

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

Fail File

Required
The XML file to save failed company imports to. The data will be written in the same format as the input file.

Input File

Required
The XML file containing the companies to import in Magento.

Success File

Required
The XML file to save successful company imports to. The data will be written in the same format as the input file.

Prevent Reprocessing

Required
Set to true to prevent the same record being processed more than once by the task. This setting will only work where an <external_id> element is provided in the XML.

Store View Code

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

Zynk Settings

See Common Task Settings.

Examples

A sample input 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>
      <int>3</int>
    </customer_ids>
    <restricted_payments>
      <string>1</string>
    </restricted_payments>
    <use_company_group>true</use_company_group>
    <credit>
      <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>
  </AmastyCompany>
</ArrayOfAmastyCompany>