Import Job Types

Import Jobs

This table describes the different types of import jobs available in the job system. Select the specific import job type via the drop-down in the Extra Settings section.

Note: Some import jobs can be used to delete objects from the database. These are explained in the descriptions/ notes.
Note: An import job imports up to 50 data files matching the specified filename pattern.
Job name Description Extra settings Data source/ Mapping notes
(ASN) Shipping Notification Imports shipment information associated with waiting fulfillment shipping orders from an external provider such as UPS WorldShip or a 3PL.

Processing these records create shipments for the associated shipping orders, which are then fulfilled and closed.

Note: This job can't be used to short-ship a shipping order. It automatically assumes that each Item on a shipping order was included in the shipment.
Specify whether shipping confirmation emails are sent to customers. The following data is required for each record. See the Map tab in the job configuration for optional data fields.
  • Shipping order ID or GUID
  • Tracking number
Bulk Order Import Imports sales orders.
Note: Imported orders are placed in waiting approval status if order approvals are enabled; otherwise they are placed in waiting allocation.
The following settings are available:
  • Specify whether to associate customer records with the imported orders or create the order records with no customers associated. If using customer records, and no existing customer matches the customer on an order, a new customer is created.
  • Specify how customer records are identified if orders are being associated with customers. Valid values include:
    • Email (Bill To)
    • Address 1 and Postal Code (Bill To)
    • Customer Key (Code or GUID)
    • Full Address (Bill To)
    • Phone (Bill To)
  • Code Prefix: When a new customer record is generated as a result of importing an order, the prefix defined here is prepended to the imported customer code. For example, if the code prefix is ic_ and an order is imported with a new customer that has the code Cust1, the generated customer record in Order Management has the code ic_Cust1.
  • Specify whether to use the imported order IDs or to generate new order IDs for the imported orders. If generating new order IDs, the imported IDs is set as the reference IDs.
    Note: If the order ID or reference ID of an imported order isn't unique, the process fails.
  • Order ID Prefix: Text entered here is prefixed to the order IDs of the imported orders.
  • Specify whether to send a confirmation email for each imported order.
  • Specify whether to create new Item records for imported order line Items that don't exist in the system. If not creating new items, then an order containing an item not in the system is not processed.
    Note: Items are created with the supplied item numbers only. Other item information must be added later.
  • Specify optional processing when item records are created (only if new item records are being created). The following are valid values:
    • Alert: The new item is alerted.
    • None: No special action is taken.
    • Approve: The new item is approved.
    • Hide: The new item is hidden.
  • Specify whether new orders are force closed immediately upon creation. If this option is selected, then the imported orders won't follow the normal workflow. This is useful when migrating old orders that have already been fulfilled.
The following data is required for each record. See the Map tab in the job configuration for optional data fields.
  • Order ID or reference ID
  • Type - valid values include:
    • Auction
    • AutoShip
    • InStore
    • NotSet
    • Phone
    • Provider
    • Show
    • Website
  • Customer key - valid values include:
    • Email
    • Code
    • Username
    • GUID
  • BillTo-Email
  • BillTo-Address-Attention
  • BillTo-Address-Address1
  • BillTo-Address-City
  • BillTo-Address-CountryRegion (ISO name or code)
  • BillTo-Address-Country (ISO name or code)
  • ShipTo-Address-Attention
  • ShipTo-Address-Address1
  • ShipTo-Address-City
  • ShipTo-Address-PostalCode
  • ShipTo-Address-CountryRegion (ISO name or code)
  • ShipTo-Address-Country (ISO name or code)
  • ShipTo-ShippingMethod
  • ShipTo-OrderItem-Cd
  • ShipTo-OrderItem-Quantity
  • ShipTo-OrderItem-UnitPrice
  • ShipTo-OrderItem-Item
  • ShipTo-OrderItem-Site
  • Payment-Processor
Catalogs Imports catalogs. N/A The following data is required for each record. See the Map tab in the job configuration for optional data fields.
  • Unique catalog code (if multiple catalogs use the same catalog code, only the first one is updated)
Categories (Localized) Imports categories and their general info fields. N/A See the Map tab in the job configuration for the data fields.
Customers Imports customers. The system checks the customer code of each record against existing customer records, and update the existing record if one exists. If there is no customer code match, it checks for an existing record that matches both the customer email and last name fields.

If there is no matching record, or if there are multiple matching records, then the system creates a new customer record.

N/A See the Map tab in the job configuration for the data fields.
Force Fulfill Import Imports sales orders and attempts to close them. It will unsuspend, approve, and fulfill orders as needed. Related invoices and payments follow their configured workflow. The following settings are available:
  • Specify whether shipping confirmation emails are sent to customers.
  • Specify a site to assign to the shipping orders. If no site is specified, then no site is assigned.
See the Map tab in the job configuration for the data fields.
Fulfillment Site Quotas Imports fulfillment site quota information. Allows creating or removing site quotas. N/A See the Map tab in the job configuration for the data fields.
Fulfillment Sites Imports new or updated site-level information and attributes for one or more sites. N/A See the Map tab in the job configuration for the data fields.
Gift Cards Imports gift cards. N/A See the Map tab in the job configuration for the data fields.
Item Association Imports item associations. Can also be used to delete item associations. Select one of the following modes:
  • Add to/ update existing associations.
  • Replace existing associations.
See the Map tab in the job configuration for the data fields. Use the Custom - association_remove field to delete associations. Importing an association record with a value of '1' in this column deletes the association if it exists.
Item Back Order Authorization Imports item backorder authorization settings. Can also be used to delete back order authorizations.
Note: Backorder settings other than the Backorderable flag are not exposed in the Administration module. They can only be set via this job or directly in the database.
Select one of the following modes:
  • Add to/ update existing back order authorization statuses.
  • Replace existing back order authorization statuses.
  • Clear existing back order authorization statuses for all Items (not just those referenced in the import data), then update the back order statuses referenced in the import data.
See the Map tab in the job configuration for the complete list of data fields. Some of the available fields include the following:
  • Standard item_backorder_authorization_quantity: This amount limits the quantity available to be backordered at any given time. This value is ignored unless the item_backorder_authorization_type_id is 2.
  • Standard item_backorder_authorization_start_date: Backorders for the item are only accepted after this date. This value is ignored unless the item_backorder_authorization_type_id is 2.
  • Standard item_backorder_authorization_end_date: Backorders for the item are only accepted prior to this date. This value is ignored unless the item_backorder_authorization_type_id is 2.
  • Standard item_backorder_authorization_type_id: This setting controls the backorder behavior of the item as follows:
    • NULL or 1: Backorders for the item are not limited, regardless of the other settings. Orders are always allowed. (The value is NULL for an item if no record is imported for it.)
    • 2: Backorders for the item are limited by the other fields set on this record. The actual on-hand quantity is ignored. (For example, if the backorder auth quantity is 30 and the on-hand quantity is 10, then the system lets 30 units be sold.) Note, however, that the on-hand quantity is still incremented as items are received and decremented as items are shipped.
  • Custom backorder_authorization_remove: Use this field to delete backorder authorizations. Importing a backorder authorization record with a value of '1' in this column deletes the authorization if it exists.
Item Catalog Adds items to catalogs. Can also be used to remove items from catalogs. Select one of the following modes:
  • Add items to catalogs.
  • Replace existing catalog assignments.
See the Map tab in the job configuration for the data fields. Use the Custom - catalog_remove field to remove an item from a catalog. Importing an item/ catalog record with a value of '1' in this column removes the item from the catalog.
Item Category Adds items to categories. Can also be used to remove items from categories. Select one of the following modes:
  • Add items to categories.
  • Replace existing category assignments.
See the Map tab in the job configuration for the data fields. Use the Custom - category_remove field to remove an item from a category. Importing an item/ category record with a value of '1' in this column removes the item from the category.
Item Inventory Updates item on hand and safety stock inventory levels, including site and location information. Importing multiple files is useful for updating inventory levels at multiple sites. Up to 50 data files matching the filename pattern are imported. Check the Set On Hand Quantity for Unspecified Items to 0 to set the on hand quantity to 0 for all items in the system that are not included in the import data. See Zero Inventory Import Option for more information.
Note: Use caution when enabling this feature.
Setting the Delta value to 0 causes the imported values to be set as absolute on hand levels (a value of 10 sets the on hand level to 10, regardless of the current level). Setting it to one causes the imported values to be used as deltas (a value of 10 increases the current on hand level by 10).
Note: Safety Stock quantities can only be updated using absolute values. If the Delta value is one, then any Safety Stock values in the data are ignored.

See the Map tab in the job configuration for the other data fields.

Item Photos Imports hosted photos and associates them with items. Can also be used to disassociate images from items. Select one of the following modes:
  • Add/ update photos.
  • Replace all existing photos on items included in the import data.
Each image must be hosted at a unique URL that is referenced in the import data. Images can't be embedded directly in the data. Image URLs can't contain special characters such as spaces, because the job system won't convert them.

The following data is required for each record. See the Map tab in the job configuration for optional data fields.

  • Item code
  • Image code (typically in the format IMG_12345_1, where 12345 is the item code)
  • URL
  • Image type - codes include the following:
    • 1: Main
    • 2: Secondary
    • 3: Mark
    • 4: Swatch
Use the Custom - image_unlink field to disassociate an image from an item. Importing an image/ item record with a value of '1' in this column disassociates the image from the item.
Item Price Point Updates item price points. Can also be used to remove price points from items. Select one of the following modes:
  • Add/ update price points.
  • Replace all existing price points on items included in the import data.
See the Map tab in the job configuration for the data fields.

Price point calc method IDs are as follows:

  • 1: Actual
  • 2: Markdown %
  • 3: Markdown $
  • 4: Markup %
  • 5: Markup $

Price point calc basis IDs are as follows:

  • 1: Sales
  • 2: Cost
  • 3: Retail
  • 4: Last Point
Use the Custom - price_point_remove field to remove a price point from an item. Importing an item/ price point record with a value of '1' in this column will remove the price point from the item.
Item Safety Stock Updates safety stock quantities for selected items/sites. N/A The quantity_safety_stock value is the safety stock quantity to apply to the specified items at the appropriate sites

You must specify either item_cd or item_attribute_cd (or both). Using item_attribute_cd without item_cd affects all items that have the corresponding attribute assigned to them. You may also specify item_attribute_value to set the safety stock for items that have that attribute value. If you specify item_attribute_value, you must also specify item_attribute_cd to identify the attribute to check.

The site_cd field is optional. If it is not specified, then the quantity is applied to all sites where the specified items exist.

If multiple fields are specified, then only items/sites matching all of them are affected.

Item Vendor Updates item vendor associations. Can also be used to remove a vendor association. Select one of the following modes:
  • Add/ update vendor associations.
  • Replace all existing vendor associations on Items included in the import data.
See the Map tab in the job configuration for the data fields. Use the Custom - vendor_remove field to disassociate a vendor from an item. Importing an item/ vendor record with a value of '1' in this column will disassociate the vendor from the item.
Items Imports new items and updates fields and attributes on existing items.
Note: Imported attributes must exist in the system. This job won't create new attributes.
Note: When importing master and child items, a master Item must exist before its child Items can be imported. If they are in the same import data file, then the master Item must appear before the child items. When importing a master item, the master item code field must be NULL.
N/A See the Map tab in the job configuration for the data fields.

Note the following when importing items:

  • If a record in the import data has an item code that doesn't exist in the system, the job creates a new item.
  • If a record in the import data has an item code that already exists in the system, the behavior depends on the Maintain Unique Item Codes setting in the Inventory - Defaults Preferences as follows:
    • Enabled: The import updates the existing record. However, if multiple records already exist with that item code, then no update is made.
    • Disabled: A new item is created with the same item code.
  • A NULL value for an attribute in the import data for an existing item clears the value, but won't remove the attribute from the item record. If the attribute does not exist on the item record, it is added.
  • When importing item records with vendor codes, the vendor codes must already exist in the system. This job will not create vendor codes.
Items (Localized) Imports localized values for item fields that can be localized. The items must already exist, because this job only imports values for localizable fields. N/A See the Map tab in the job configuration for the data fields.
Postal Codes Imports postal codes. Select one of the following modes:
  • Add new/ update existing postal codes.
  • Replace all existing postal codes on countries included in the import data. Caution: this deletes any existing codes for countries included in the import data.
The following data is required for each record. See the Map tab in the Job configuration for optional data fields.
Note: Many postal codes include leading zeroes. Be careful to preserve them when generating input files.
  • Country Postal Code
  • Country Postal Code - City
  • Country Postal Code - Latitude
  • Country Postal Code - Longitude
  • Either Country ID or Country Code
  • Either Country Region ID or Country Region Code
Promotion Codes Imports promotion codes. N/A The following data is required for each record. See the Map tab in the job configuration for optional data fields.
  • Promotion GUID
  • Promotion code GUID or code
Purchase Order Advice Notification Imports purchase order information associated with received shipments from vendors.

Processing these records will update purchase orders with received quantities. If all items on a purchase order have been received, the purchase order will proceed to the next workflow step and close if appropriate.

N/A See the Map tab in the job configuration for the data fields.
Serialized Items Imports additional quantities of existing serialized items. N/A See the Map tab in the job configuration for the data fields.
Tax Table Imports a tax rate table. Can also be used to delete a tax rate table. N/A See the Map tab in the job configuration for the data fields. Use the Custom - tax_remove field to delete a tax rate table. Importing a tax rate table record with a value of '1' in this column deletes the tax rate table if it exists.
Vendors Imports vendor records. N/A See the Map tab in the job configuration for the data fields.