GuidesAPI DocsLatest NewsStatusCreate Support RequestReturn to zoey.com

Data Mapper Integrations

Allow your Zoey Store to automatically either Export to or Import from external systems.

Suggest Edits

🚧

PAGE UNDER CONSTRUCTION

Connections

In order to use a Zoey Data Mapper, a Connection to an external system must first be made. All Connections require a Connection Name to help identify the Connection within your Zoey Store

The available Connection types and associated fields are listed below:

  • Dropbox - Import & Export
  • Email - Export Only - Sends an email with files attached to the specified email addresses.
    • Email Recipients: Specify who should receive emails for this connection. One email per line, maximum 10 emails.
    • Sender: The email address that "sends" the email. The list of Senders is populated by the "Sender Email Addresses" within your Zoey Store under Settings > Emails
  • FTP - Import & Export - Upload File to or Download files from an FTP Server
    • Host URL: Either the IP Address or HTTPS URL of the FTP Server
    • Port: Port used when making the FTP connection. Defaults to 21
    • Username: User to log into the FTP server
    • Password: Password for the User logging into the FTP server
    • File Transfer Mode: ASCII or Binary. This value depends on your FTP server's settings.
    • Default Directory: The default directory the user has access to after Logging In
  • HTTPS - Export Only - Submit HTTPS POST Requests to a Specified URL
    • URL Endpoint: The HTTPS URL destination for the POST requests. Requests will automatically timeout after 60 seconds. URL must start with https://
    • Test URL Endpoint: Zoey will execute a sample request with an empty body to this URL when testing the connection and check for the HTTP response code defined below. You may use the URL Endpoint defined above or a separate URL (belonging to the same domain) if the URL Endpoint is not configured to receive an empty body. URL must start with https://
    • HTTPS Method: The HTTP Method used when submitting the request
    • HTTPS Success Code: Zoey will check for this HTTP response code to verify the HTTPS request was successfully sent.
    • HTTPS Signature Header: The HTTPS Header Name for the HTTPS Signature. This value will be a 64 character randomly generated string for each request. Hash this value using the HTTPS Signature Key to verify the HTTPS Signature Hash.
    • HTTPS Signature Hash Header: The HTTPS Header Name for the hashed HTTPS Signature. This is the hashed value of the HTTPS Signature using the HTTPS Signature Key.
    • HTTPS Signature Key: The key used for hashing the HTTPS signature. Use this signature when validation the HTTPS Signature Header and HTTPS Signature Hash Header
    • HTTPS Signature Method: The hashing algorithm used for the HTTPS Signature Hash.
    • Additional HTTPS Headers: Additional Header Names/Values to be sent in the Request
  • SFTP - Import & Export - Upload File to or Download files from an SFTP Server
    • Host URL: Either the IP Address or HTTPS URL of the SFTP Server
    • Port: Port used when making the SFTP connection. Defaults to 22
    • Authentication Type: Specify whether to use Username/Password or Private Key authentication
    • Server Type: Specify either Unix or Windows depending on your SFTP server
    • Username: User to log into the SFTP server
    • Password: If Username/Password Authentication is selected, the password for the User logging into the SFTP Server.
    • Private Key: If Private Key Authentication is selected, the Private Key for the User logging into the SFTP Server
  • SSH - Import & Export - Upload File to or Download files from an SSH Server
    • Available Connection Fields for the SSH connection are the same as SFTP Connections defined above.

Creating a Data Mapper

Configuration

  • Name: Provide a name to help identify the Data Mapper and distinguish it from others. This is for reference only.
  • Connection: Select a previously created Connection to use for the Data Mapper.
  • Enabled: A Yes/No flag to determine if the Data Mapper will be run automatically.
  • Priority: Numerical value to determine the order in which this Data Mapper will run. Data Mappers will run from lowest priority to highest priority (Priority 1 will run before Priority 2)
  • Use Schedule: Configure how often this Data Mapper will run in the background.

📘

HTTPS Data Mappers

Data Mappers with HTTPS connections will not use a schedule and will always run automatically every two minutes if Enabled.

Mapper Settings

  • Zoey Object: The type of object to be either exported or imported by the Data Mapper.

🚧

Zoey Object Note

In order to maintain data integrity for a Data Mapper, the Zoey Object CANNOT be changed after a Zoey Object has been selected and the Data Mapper has been saved.

The following objects are available for use with the Data Mapper

📘

Export and Import Notes

Export Action "CSV File with Customizable Fields" is only available to Non HTTPS Connections

Export Action "HTTPS POST Request with Customizable Fields" is only available to HTTPS Connections

Imports are only available for the following Connections: Dropbox, FTP, SFTP, SSH

  • Contacts (formerly Customers)
    • Export
      • CSV File or HTTPS POST with Customizable Fields
  • Invoices
    • Export
      • CSV File or HTTPS POST with Customizable Fields
      • Can be Grouped by Order
  • Quotes
    • Export
      • CSV File or HTTPS POST with Customizable Fields
  • Quote Items
    • Export
      • CSV File or HTTPS POST with Customizable Fields
      • Can be Grouped by Quote
  • Orders
  • Order Items
    • Export
      • CSV File or HTTPS POST with Customizable Fields
      • Can be Grouped by Order
  • Products
    • Export
      • CSV File or HTTPS POST with Customizable Fields
    • Import
      • Mapper Template: Zoey Product CSV Import
      • [Mapper Template: Group and Tier Prices (One File per Group)](Group and Tier Prices (One File for All Groups))
      • [Mapper Template: Group and Tier Prices (One File for All Groups)](Group and Tier Prices (One File for All Groups))
  • Shipments
    • Export
      • Mapper Template: Standard Shipment Export
        • CSV File or HTTPS POST with Customizable Fields
        • Can be Grouped by Order
      • Mapper Template: Tracking Number Updates (HTTPS Connections Only)
      • Mapper Template: Comment Updates (HTTPS Connections Only)
    • Import
      • Mapper Template: Zoey CSV Shipment Import
  • Shipment Items
    • Export
      • CSV File or HTTPS POST with Customizable Fields

Mapper Templates

Orders

  • Order Status / Status Update

  • Update Order Status and Comments

Products

  • Zoey Product CSV Import

  • Group and Tier Prices (One File per Group)

  • Group and Tier Prices (One File for All Groups)

Shipments

Updated 6 days ago