Data Mapper Templates

Mapper Templates

πŸ“˜

Zoey has built in Mapper Templates that can be selected when setting up your Data Mapper.

In this article, we will describe those templates and provide help for creating common automated Imports/Exports.

❗️

Some Mapper Templates are only available for certain Connections.

Orders

πŸ‘

You can mimic the Full Order Data Export with Data Mappers to automatically export the file to your endpoint.

Click here to find out how.

Order State / Status Update (Export)

🚧

HTTPS Connections Only

The Order Status / Status Update Mapper Template is only available to export for HTTPS Connection

The Order State / Status Update will automatically send updates for the chosen HTTPS Connection whenever an Order's State or Status is changed. Examples of when an Order's State or Status may change is when an Order is Invoiced or Shipped.

  • The following fields are automatically included in the Order State / Status Export

πŸ“˜

Change the values in Field Name column to update the column headers sent in the Export.

Additional Order Fields can be added by clicking the Add Field button.

  • Order Number - The Zoey Order Number
  • Old State - The state of the Order before the change occurs.
  • New State - The state of the Order after the change occurs.
  • Old Status - The status of the Order before the change occurs.
  • New Status - The status of the Order after the change occurs.
  • Created At - The Date/Time when the status/state change occurred. This Date/Time will use the time zone of your Zoey Store.
    • The Date/Time format of Created At can be changed after the Data Mapper has been saved.

Update Order Status and Comments (Import)

🚧

Connection Limits:

Update Order Status and Comments is only available to Dropbox, FTP, SFTP, and SSH Connections

The Update Order Status and Comments template will import a CSV file that adds a comment to the specified Order(s) and optionally change the Order status and optionally alert the Contact who created the Order of the comment.

πŸ“˜

Change the value in the CSV Column field to match the column name to the CSV file being imported.

  • The following fields should be included in the CSV file being imported
    • status - The Status Code for the Order. This value must be the Status Code and not the Status Label. Status Codes can be found under Orders > Order Status Settings in your Zoey Admin. To not change the Status of the Order, use the status_code the Order currently belongs to.
    • comment - The comment to add to the Order
    • order_number - The customer facing Order Number of the Zoey Order
    • notify_customer - Specify if the comment should be visible to the customer. Use values "yes", "y", or "1" (without quotes) to make it a public comment visible to the Customer

      πŸ“˜

      There is an additional setting in your Data Mapper to decide if an email should be sent to the customer when public comments are added via this import.

    • attachment_path (optional) - The column name for any attachments to be added to the Order

Attachment Settings (Optional)

Additional Settings if attachments should be added to the Order when the CSV file is imported.

  • Download - When enabled, attachments will be downloaded and processed based on the Mapper Template
  • Folder - Directory location of attachments for import. This value should always start with a /
  • Columns - List of CSV column names that contain attachment paths. One per line.
  • File Action after Processing:
    1. None - Do nothing with attachments after they are added to the Order
    2. Move File - Move the file to a separate directory after they are added to the Order
    3. File Folder After Processing - Directory location the files will be moved to after processing. This directory must already exist. This value should always start and end with a /
    4. Add Timestamp - When set to Yes, a timestamp will be added to the attachment filename after it is moved.

Products

Zoey Product Inventory (Export)

🚧

The Product Inventory Export does not have a Data Mapper Template.

These are the steps for setting up an Inventory Export Data Mapper.

Begin creating your Product Export Data Mapper by choosing a Connection and configuring the output file settings.

  • Zoey Object = Products
  • Type = File Export
  • Export Mode = All Objects To One File

Export Filters

  • Use Advanced Filters: When enabled, specific fields can be set to determine which Zoey objects are exported.
    When disabled, Zoey objects are exported if they were created after the Last Run Time.

Example for an out of stock inventory report, when set to Yes, Qty Is Equal To, Zero

  • Always Export All Data: When set to Yes, the Data Mapper will export all data. When set to No, the Data Mapper will
    only export data that has changed since the Last Run Time.

Field Mapping

The fields below can be set to export your products stock details.

CSV ColumnZoey Value
skuSKU (sku | 74)
nameName (name | 71)
qty in stock[Stock Item] Qty (qty)

Zoey Product CSV (Import)

🚧

Connection Limits:

Zoey Product CSV Import is only available to Dropbox, FTP, SFTP, and SSH Connections

The Product Import Data Mapper template automates the normal Zoey Product Importer using Append Behavior

πŸ“˜

Click here to view the expected CSV Column names for a Zoey Product CSV Import

Mapper Settings

  • Remove SKUs not in Zoey: When set to Yes, any rows with SKUs that do not exist in Zoey will be removed from the Product Import CSV. This is useful when only performing product updates (such as inventory quantity) and the imported file contains SKUs that do not exist in Zoey.

Image Settings

Optional settings if Images should be imported and set on the Zoey Products

  • Download: When enabled, images can be downloaded and associated to the Zoey object.
  • Folder: Directory location of images for import. This value should always start with a /
  • Columns: List of column names that contain image paths. One per line.

Header Mapping

Use the Header Mapping tool to map the expected Zoey CSV Column Names, to the CSV column headers in the CSV file being imported. CSV Column is the column name in your CSV file, and the Zoey Header Column is the expected Zoey Column Name.


Group and Tier Prices (One File per Group) (Import)

🚧

Connection Limits

Group and Tier Prices (One File per Group) is only available to Dropbox, FTP, SFTP, and SSH Connections

The Group and Tier Prices (One File per Group) template will import a CSV file that sets Group and Tier Prices for Zoey Products with a separate CSV file being processed for each Customer Group.

πŸ“˜

Change the value in the CSV Column field to match the column name to the CSV file being imported.

  • The following fields are expected for this mapper template:

    • Product SKU: The SKU of the Zoey Product to assign Group and Tier Prices
    • Customer Group Name: The name of the Customer Group for the Group and Tier Prices
    • Group Price: The Price for the specific Customer Group
    • Quantity Step: How much of each Quantity the Customer must add to their Cart to be eligible for the associated Price Step
    • Price Step: The Tier Price for the Customer if the associated Quantity Step is added to the Cart

πŸ“˜

Quantity / Price Step Details

To define Tier Prices of:

  • $20 for a quantity of 5 or more
  • $10 for a quantity of 10 or more
  • $5 for a quantity of 15 or more

Configure your CSV file as follows:

sku,group_name,group_price,qty_step1,qty_step_2,qty_step3,price_step1,price_step_2,price_step3
mysku,General,50,5,10,15,20,10,5

Adding {{COUNT}} to the defined CSV column in the screenshot above indicates to the Data Mapper to replace {{COUNT}} with the current qty_step or price_step being processed.


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

🚧

Connection Limits

Group and Tier Prices (One File for All Group) is only available to Dropbox, FTP, SFTP, and SSH Connections

The Group and Tier Prices (One File for All Groups) uses the exact same configuration as Group and Tier Prices (One File per Group) configured above, except all Customer Groups to be imported will be defined in the same file.


Shipments

Tracking Number Updates (Export)

🚧

HTTPS Connections Only

Tracking Number Updates is only available to HTTPS Connections

The Tracking Number Updates template will automatically send updates for the chosen HTTPS Connection whenever a Tracking Number is added to a Zoey Shipment.

  • The following fields are automatically included in the Tracking Number Updates Export

    πŸ“˜

    Change the values in the Field Name column to update the field names sent in the Export.

    Additional Shipment Fields can be added by clicking the Add Field button.

  • Title: The Carrier Title for the Tracking Number (Ground, AIR, Custom, etc...)

  • Shipment Number: The Customer facing Zoey Shipment Number

  • Carrier Code: Carrier used for the Tracking Number (FedEx, UPS, USPS, Custom, etc...)

  • Tracking Number: The Tracking Number added to the Shipment

  • Created At: The Date/Time when the tracking number was added. This Date/Time will use the time zone of your Zoey Store.

    • The Date/Time format of Created At can be changed after the Data Mapper has been saved.

Comment Updates (Export)

🚧

HTTPS Connections Only

Comment Updates is only available to HTTPS Connections

The Comment Updates template will automatically send updates for the chosen HTTPS Connection whenever a comment that is visible to the Customer who placed the Order is added to a Zoey Shipment.

  • The following fields are automatically included in the Comment Updates Export

    πŸ“˜

    Change the values in the Field Name column to update the field names sent in the Export.

    Additional Order Fields can be added by clicking the Add Field button.

    • Comment: The comment added to the Shipment
    • Shipment Number: The Customer facing Zoey Shipment Number
    • Created At: The Date/Time when the tracking number was added. This Date/Time will use the time zone of your Zoey Store.
      • The Date/Time format of Created At can be changed after the Data Mapper has been saved.

Zoey CSV Shipment Import

🚧

Connection Limits

Zoey CSV Shipment Import is only available to Dropbox, FTP, SFTP, and SSH Connections

❗️

You must first enable the Shipment Importer to use this Data Mapper.

The Zoey CSV Shipment Import template automates the importing of tracking numbers and shipping costs for to your orders.

You can find the Shipments Importer and its settings in Import & Export Menu > Shipments from the left vertical navigation bar.

πŸ“˜

Click here for the Shipment Import Template and more details about the importer.

Mapper Settings

  • Auto-Invoice Shipped Items: When set to Yes, the Qty to Ship will also be Invoiced for items in the Shipment CSV. Once all items have been Shipped and Invoiced the Order status will be set to Complete
  • Send Invoice Email for Auto-Invoiced Items: When set to Yes, an Invoice Email will be sent when Items are Auto-Invoiced by the Shipment Import

Header Mapping

Use the Header Mapping tool to map the expected Zoey CSV Column Names to the CSV column names in the CSV file being imported. CSV Column is the column name in your CSV file, and the Zoey Header Column is the expected Zoey Column Name.