👍

What fields to use in your Data Mapper?

Creating a Data Mapper means deciding what pieces of data will be exported or imported.

You can mimic the Full Order Data Export with Data Mappers here.

Export Invoices and their information using the fields listed here.

Export and Import Shipments with tracking numbers here.

Export and Import Products to update them here.

Order Update Mapper Templates

📘

Some Data Mappers have templates because the values they require are not optional, or the mapper exports a specific set of data.

• The following are Mapper Templates which can be selected after choosing the Orders object.

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.

Order Attribute Update (Import)

🚧

Connection Limits:

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

The Order Attribute Update template will import a CSV file to set the Order Attribute values specified in your mapper.

👍

This enables you to sync Order Attributes between systems, set custom data on your Orders after submission, and more!

📘

Your Order Attributes' values can be set by this importer when they are not visible in the Admin.

In the Field Mapping section there will be one required column called Order Lookup. Your Order Number will be used to find the order to update.

• Set the CSV Column name to match the column header of the file being imported.
• Map the Order Attributes which will be updated by this importer.

👍

You can map any type of attribute by searching for them in the Zoey Value drop-down menu.