All pages
Powered by GitBook
1 of 11

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Import from an SFTP

Troubleshooting

These Troubleshooting document contains the common issues user may face when managing data imports and exports.

Shopify MDM

To access the logs for import and export jobs, navigate to the MDM (Master Data Management) > EXIM (Export-Import) page from the Hamburger menu. Here, under the Shopify section, various MDM pages display the processes between Shopify and HotWax Commerce. These pages include:

  • Shopify GraphQL job: Records all GraphQL files uploaded from Hotwax Commerce to Shopify for API calls like adding pre-order catalogs or tags.

  • Shopify Order MDM: Contains files generated from Shopify for importing orders into Hotwax Commerce.

  • Shopify Order Return: Covers all created order returns.

  • Shopify Product MDM: Includes all product import files generated from Shopify.

  • Shopify Inventory Sync MDM: Lists files for inventory changes from Hotwax Commerce to Shopify.

  • Shopify Cancel Order Import MDM: Displays details of all canceled orders from Shopify to Hotwax Commerce.

  • Shopify Fulfilled Item MDM: Provides information on all fulfilled items feeds generated from Hotwax Commerce to mark items as fulfilled in Shopify.

Manual Import

Importing Data in OMS

  1. Open a relevant import topic from the category based on your requirements. For instance, Procurement > Purchase Order.

  2. Download the provided sample CSV template.

  3. Once you've prepared a CSV or JSON file to import, click on Choose File to upload the file containing your data.

  4. The system will initiate the import, processing the provided data according to the chosen import topic.

If the file you uploaded does not begin processing immediately, the MDM you're using may be set to run in queued mode, which means it will be run by the queue polling job that runs at set intervals. In this case, to process the file immediately, go to the job manager app and run the Process Pending Bulk Imported Files job manually using the Run Now function.

After finishing its run, if the file terminates in a Failed status or produces Error Records, your data has not been processed and needs to be retried. To learn more about troubleshooting this, please refer to this document. (add link)

Configuration options

Add or edit a configuration

If you're creating a new Import configuration to import data from an SFTP location

  1. Click the Add button

  2. Enter configuration details

If you're editing an existing import or export configuration

  • Use the search bar to find the configuration by name or ID.

  • Click the Edit icon at the end of the search result.

The Config ID cannot be modified. To use a different ID, create a new configuration.

Field
Description

Execution mode should always be set to Queued

Multi-threading should be disabled on all configs unless explicitly instructed by HotWax Support. Incorrect use of multi-threading can cause to system overload and downtime. If you've decided multi-threading is your poison, make sure that the configuration is set to execute in queued mode or else your almost certain to cause a system overload.

Notifications are sent to the email addresses configured in the instances.

View a configuration

You may need to view a data manager configuration to either manually import data or to audit data that has been imported either by another user or scheduled SFTP file import job.

  1. Click the open link icon beside the service name on the Data Manager Configuration search page.

  • This opens the for the selected service.

  1. Once a file is done processing, its status will change to Finished.

    If processing finished with error records, download the error records for review. These are usually in JSON or CSV format, with error reasons attached to each record.

  2. Click the Log button to view detailed logs related to the service.

  3. Use the log to identify any specific failure or irregularity.

Schedule Error Mail

Discover how to schedule error emails for Master Data Management (MDM) processes in HotWax Commerce for efficient error handling and resolution.

Steps:

1. Enable Postfix Service:

  • Postfix is a Sendmail-compatible mail transport agent that ensures secure, fast, and easy email configuration.

  • The technical team can enable the Postfix service on your server and provide you with instance-specific Postfix details.

2. Configure Postfix Relay Host:

  • Postfix uses the relay host configuration directive to send emails to external domains.

  • Configure the relay host directive with the hostname or IP address of the remote SMTP server or service.

  • Upon enabling Postfix, note the received IP address of the server. Once the Postfix service is enabled, you will get the relay hostname and Port name.

3. Add Configurations in General Settings:

  • Access the general settings page in HotWax Commerce.

  • Add the following configurations:

    • a. SMTP Relay Host Configuration Details.

    • b. Enable Notifications.

4. Configure Email Template:

  • Navigate to the DM\_ERROR\_FILE table in the EmailTemplateSetting entity in HotWax Commerce's web tools.

  • Set the default email address from which users will receive emails in the From Address field (e.g., [email protected]).

  • Configure the email template to be used for communicating error files effectively.

5. Import XML File for System Properties:

  • Import the following XML file to configure system properties:

  • Ensure the email addresses specified are accurate and designated for receiving error files.

Conclusion: Following these steps will enable you to schedule MDM error emails effectively in HotWax Commerce. By promptly identifying and addressing errors, you can maintain the integrity and efficiency of your system's data management processes.

Data Manager

The Data Manager allows users audit data ingress and egress from the OMS while also being able to manually import and export data.

Getting to the Data Manager Configurations page:

  1. Go to the Hamburger Menu

  2. Select Settings

  3. Click on Data Manager Configurations

Key features and functionalities include:

  1. Manual Data Import and Export: Manually import or extract data as needed.

  2. Multithreaded: Import large amounts of data at high speeds to keep the OMS in sync with external systems.

  3. Error notifications: Automatically get notified when an error occurs during import.

  4. Audit imported data: Audit imported files as they were provided, ensuring tracability.

MDM Under the Hood

Understanding the inner workings of the OMS MDM is essential to building scalable integrations, troubleshooting integrations, and amending corrupted data.

Configurations

A data manager configuration represents the import settings for a type of data. For example, importing sales orders from Shopify, fulfillment from a 3PL, or inventory from a POS are all separate configurations because they are all importing different types of data.

The primary function of a configuration is defined by the import and export services configured in it. Looking at the examples above, here is how that would work:

Config Name
Import service

Import orders from Shopify

importShopifyOrders

Import order fulfillment from 3PL

fulfillOrderItem

Reset inventory from POS

resetInventoryByIdentification

Looking at this example, you'll notice that the Shopify order import service name is very specific to Shopify but the other two are generic OMS functions. This is because Shopify is a native integration of the OMS and has dedicated import services that handle Shopify's JSON structure unmodified and perform data transformation before actual ingestion internally.

Most configurations you'll find in the OMS will be for generic import services, not specific to any named system. This indicates that any transformation needed to align the data format with what the OMS can consume is done in a middleware platform.

A benefit of generic imports is that they can be used by multiple systems. For example, resetting inventory in the morning. Many retailers will connect the OMS to their POS and WMS to pull inventory and technically both are importing the same kind of data into the OMS with the same intent.

To better accommodate this kind of setup, all we'll need to do is rename the POS inventory import from before:

Config Name
Import service

Import orders from Shopify

importShopifyOrders

Import order fulfillment from 3PL

fulfillOrderItem

Reset inventory from POS

resetInventoryByIdentification

Available Functions

The MDM becomes truly powerful once you understand that any service in the OMS can be turned into a data manager configuration.

Essentially, what happens when you assign an import service to an MDM, is that the OMS uses that service to loop through the file submitted to it row by row. When setting up an integration, enriching data in the OMS, or fixing corrupted data, this allows you to quickly turn any simple function into a bulk function with multithreading and transaction management.

To make the MDM more approachable for starters, we've identified the most commonly used configurations and organized them on the EXIM (Export Import) page. You can, however, see all configurations in the Data Manager Configurations page.

We aim to soon publish a more comprehensive list of available services in the MDM.

Execution

The MDM is one unified import queue across all configurations. When a file is added to the MDM to be processed, the OMS looks at its execution mode to determine how to prioritize it. You have three options to choose from when setting up a configuration:

  1. Queued: Queued configurations will respect the FIFO order of the entire MDM.

  2. Sync: Files uploaded to a configuration set to execute in sync will be processed immediately by the OMS. Uploading large files to a configuration set to execute in-sync will almost certainly be fatal because it will demand that the OMS route all required resources to process the file immediately. As a general rule, just don't use this setting unless very specifically instructed.

  3. Async: Similar to sync, these configurations will not follow the FIFO order that queued imports follow. Instead, an async import will process in the background when threads are available.

To understand how these work in practice lets look at an example.

Here are the three configurations we have setup for import

Config
Import service
Execution mode

Import Shopify orders

importShopifyOrders

Queued

Import order fulfillment

fulfillOrderItem

Async

Reset inventory

resetInventoryByIdentification

Queued

Most retailers reset the inventory in the OMS every morning for all products at every location. At this time, there may be some customers placing orders on Shopify but probably no fulfillment is happening.

Here is an example MDM state at this point:

Config
Import service
Execution mode
Submitted time

Reset inventory

resetInventoryByIdentification

Queued

4:00 am

Import Shopify orders

importShopifyOrders

Queued

4:15 am

All orders placed after the morning inventory file is submitted will not be processed in the OMS until the reset inventory file is finished processing. While this may seem problematic at first because orders are not being processed as they're being placed, the time of day when this operation happens is important to consider. Inventory update processing is happening somewhere between 12 a.m. - 4 a.m. during which no fulfillment operations are running; therefore, orders processing after the inventory file finishes does not actually hurt a retailer’s fulfillment SLA.

Queue poller

All file import tasks enter the MDM queue in a Pending status. As the poller works its way through the queue, it transitions the current active file to a Running status. The frequency that the poller checks for pending files can be configured using the Process Bulk Imported Files job in the job manager app. Every time the poller runs, it registers all Pending items in the queue and will continue to run until all the pending files at the time of polling are finished processing.

During this time, other scheduled occurrences of the queue poller job, Process Bulk Imported Files, may take place, but since there is already an instance of the file processor active, it will cancel itself. In the job manager app, this may look like an error that needs to be resolved but is normal behavior.

Export Path

SFTP Destination folder for exported files.

File Name Pattern

Identify and match only relevant files during processing using REGEX expressions

Multi-threading

Y/N flag to enable multi-threading on all files imported in this config (default N)

Execution Mode

Select from Sync, Async or Queued to set how the OMS prioritizes the processing of this configuration. (default Queued)

Notify on Failure

Y/N flag to disable notifications on file import error (default Y)

Config ID

Unique identifier for the configuration.

Description

Short explanation of what the configuration handles.

Import Service

Service name that handles incoming data.

Import Path

SFTP Folder path for imported files.

Export Content ID

Template identifier used while exporting data.

Export Service

Service that handles outgoing data.

Import Data page
<SystemProperty description="Configuration to send the error file to FTP/Email" systemPropertyId="error.file.sendTo.config" systemPropertyValue="EMAIL" systemResourceId="datamanager"/>
<SystemProperty description="**List of email addresses to which data manager error files would be sent.**" systemPropertyId="error.file.sendTo.email.addresses" systemPropertyValue="**email ID from which the emails will be sent from**" systemResourceId="datamanager"/>

Audit Logs

Data manager logs help verify the status of imported data, ensuring the accuracy and completeness of data imported into the OMS.

Logs are located below the import function on all Data Manager detail pages.

In the result section, you will see the following columns

Column
Explanation

Log Id

A unique identifier for the transaction.

User

The user who performed the action.

Date

The date and time the event occurred.

Statuses

Understand the different status types in the data logs:

Status
Description

File Upload Failed:

This typically occurs when the file format does not align with the required CSV format. To resolve this, convert the file to CSV format before attempting to upload it again.

File upload is partially failed:

Failed records are generated when a file is successfully processed, but discrepancies in the uploaded data lead to some records failing. In these scenarios, the record with correct data gets processed and a file containing all failed records with invalid data becomes available in the Failed Records section. You'll find a failed records file associated with such cases in the logs. By examining this file, you can easily identify and comprehend data errors in the uploaded file. Details about the errors in the records are available in the failed records file, providing clarity on what went wrong. After addressing the identified errors, you can confidently reupload the failed record file after removing the error reason column without encountering further issues. Some of the possible error types are as follows:

Error Type
Description

Data Not Imported

Troubleshoot data import issues in the HC OMS to ensure successful data loading and processing.

Scenario 1: Data Not Imported in OMS

You scheduled a job to import data into OMS, but the imported data is not loaded. This could be due to the job Process bulk imported files not being scheduled in the Job Manager application.

Steps to Resolve

  1. Verify Job Status:

  • Check the status of the job that imports data in bulk. Ensure it is scheduled and completed successfully in the Job Manager app.

  1. Schedule Process bulk imported files:

  • Navigate to the Miscellaneous page in the Job Manager application.

  • Locate the Process bulk imported files job and schedule it.

  • The suggested frequency is 15 minutes, but adjust based on specific requirements.

  1. Check Data Processing:

  • After scheduling the Process bulk imported files job, observe the Data Manager logs in the EXIM page of OMS to confirm that the imported data is being processed.

  1. Check Data Manager Logs in OMS:

  • Go to Hamburger Menu > MDM > EXIM > Import section.

  • Navigate to the import menu to find the files you have imported in OMS.

  • Check the status of the files; they should transition from Pending to Finished.

Scenario 2: Incorrect File Format

When importing data from external systems into HotWax Commerce, files must adhere to specific formats supported by the system. Failure to do so can result in import failures and data discrepancies.

Steps to Resolve

  1. Verification Steps:

  • Navigate to the Exim page from the MDM section via the Hamburger Menu.

  • Select the relevant import type (e.g., inventory import) to review import logs.

  • Identify and inspect the failed records column in the logs for error details.

  1. Checking File Format:

  • Download the uploaded file from the import log.

  • Verify that the file format is CSV, as HotWax Commerce supports CSV format for data imports.

  • If the format is incorrect (e.g., XLSX), investigate the data transformation process:

    • If handled by middleware, review the transformation flow.

Scenario 3: Empty Records

Empty records in an imported file indicate that the expected data from the external system is not present or properly generated, leading to failed imports in HotWax Commerce.

Steps to Resolve

  1. Verification Steps:

  • Navigate to the Exim page from the MDM section via the Hamburger Menu.

  • Select the relevant import type (e.g., inventory import) to review import logs.

  • Verify if the imported file contains any data records.

  1. Checking File Records:

  • If the file format is correct (CSV), review imported records from the file.

  • Ensure the external system generates data records:

    • Access the SFTP path specified for file uploads.

    • Refer to for correct file paths and SFTP settings.

SFTP Errors

To import data into HotWax Commerce, a scheduled job retrieves the data from an SFTP location and places it under a specific configuration. Issues can occur if there is an incorrect "Configuration ID" in the job or if the "SFTP location" is missing in the configuration. These issues can prevent the job from picking up the file and importing it into the system.

Scenario 1: Incorrect Configuration ID in the Job

In HotWax Commerce, each scheduled job is associated with a specific "Configuration ID" that determines the job's settings and execution parameters. If the Configuration ID is incorrect, the job will fail to execute properly, preventing data from being imported into the system. This issue often arises during initial setup or when configurations are manually updated.

You can refer to our troubleshooting guide to resolve job configuration errors.

Scenario 2: Missing SFTP Location in the Configuration

HotWax Commerce relies on data being retrieved from specified "SFTP locations". Each job must have a correctly configured "SFTP path" where it can find the files to import. If the "SFTP location" is missing or incorrectly configured, the job will not be able to locate the files, leading to import failures. This issue can occur due to changes in SFTP credentials, path updates, or errors during configuration.

Resolution

Finding the SFTP Credentials in OMS:

  1. Log in to HotWax Commerce with your user credentials.

  2. Navigate to the Settings section via the hamburger menu.

  3. Click on the General page and navigate to the FTP Connection Settings section.

Finding SFTP Path for Data Import in HotWax:

  1. Log in to HotWax Commerce with your user credentials.

  2. Navigate to the Settings section via the hamburger menu.

  3. Click on Data Manager Configurations to go to the Data Manager Configurations page.

Connecting to the SFTP Server:

Download and Install FileZilla:

  1. Download and install FileZilla from the official website.

Accessing SFTP with FileZilla:

  1. Open FileZilla.

  2. Click on File in the top menu, then select Site Manager.

  3. Click on New Site and enter a name for the connection.

Navigating Remote Site:

  1. After connecting, you’ll see the Remote Site section in FileZilla.

  2. Navigate through the directory to locate the path where your data needs to be transferred.

  3. Verify if the files that need to be imported exist at that location. If not, verify the correct path from the remote site where the file exists.

Updating the SFTP Path in HotWax Commerce:

  1. Navigate to the Data Manager Configuration page in HotWax Commerce.

  2. Search for the job, then click on the pencil icon to update the configuration.

  3. Paste the correct import path and click Update to save the configuration.

By following these steps, you can diagnose and resolve issues related to incorrect Configuration IDs and missing SFTP locations in HotWax Commerce, ensuring successful data imports.

Copy the SFTP credentials ("host", "username", "port", and "password").

Search for the job name; the SFTP path locations are listed below the job name.

Input the "Host", "Username", "Port", and "Password" obtained from HotWax Commerce settings.

  • Click Connect to establish the connection.

  • Once you’ve found or created the desired path, right-click on it and select Copy.

    Uploaded File

    The CSV file that was uploaded.

    View Log

    Provides detailed transaction logs for the entire event with timestamps.

    Failed Records

    A CSV file containing records that failed to upload, along with error messages for each failed record.

    Status

    The status of the upload or download (Pending, Queued, Running, Finished, or Failed).

    Action

    Action to delete the record.

    Pending

    Transaction is yet to be initiated.

    Running

    Download or Import is getting processed.

    Finished

    Transaction success.

    Failed

    Transaction has failed.

    Invalid Data

    Data that does not conform to expected values.

    Invalid Format

    Correct type but doesn't follow the expected structure.

    Missing Field

    A required field is not provided or is empty.

    Required Field

    A field marked as required is left blank.

    Contact HotWax Commerce support to check Nifi flow if handled internally.

    Verify the existence of records in the SFTP directory.

    user manuals

    Frequently Used Imports

    Import/Export Facilities

    Instead of creating facilities individually through the Facilities App, retailers can upload a CSV file for all facilities.

    To import a Facilities CSV, go to the EXIM page under the Imports tab in the Warehouse section and click on Facility MDM. Similarly, to export facilities for any specific reason, retailers can navigate to the Export tab in the Facilities MDM within the Warehouse section.

    When importing facilities, some fields need to be filled mandatorily, while others can be filled for further reference. Here is the list of mandatory fields:

    S.No.
    Field Name
    Description

    Import Employee

    Instead of creating each user individually through the User App, retailers can upload a CSV for all the Users.

    To import an Employee CSV, go to the EXIM page under the Imports tab and click on Employee MDM.

    When importing Employee data, some fields need to be filled mandatorily, while others can be filled for further reference. Here is the list of mandatory fields:

    S.No.
    Field Name
    Description

    Import Calendar

    HotWax Commerce provides two convenient options for managing the facility calendar: through the Facilities App or via the Calendar MDM. Retailers can import a generic calendar based on the store's operating hours. Later, it can be linked to the facility using the Import Store Calendar Assoc under the Imports tab in the MDM section.

    To import a Calendar CSV, go to the EXIM page under the Imports tab in the MDM section and click on Calendar MDM. When importing a calendar, some fields need to be filled mandatorily. Here is the list:

    S.No.
    Field Name
    Description

    Import Store Calendar Assoc

    In HotWax Commerce, retailers can set the operating hours of a facility in two ways:

    1. From the Operating Hours setting in the Settings page of the Facilities App.

    2. From the Import Calendar Assoc in MDM.

    The Import Calendar Assoc is used to set the operating hours of a particular facility. Retailers can find this under the Imports tab in the MDM section.

    When importing the CSV, some fields need to be filled mandatorily. Here is the list:

    S.No.
    Field Name
    Description

    Import Inventory Variances

    This import in HotWax allows retailers to update inventory based on the identification type used in external systems. By importing a CSV file into HotWax, inventory adjustments are marked.

    This import records based on the given delta and updates both (Available to Promise) and QOH (Quantity on Hand). The MDM feature can set inventory to 0 but cannot make it negative.

    Example: When an Inventory Reset file is provided by an external system (e.g., NetSuite), and Product A's inventory is updated to 5 while HotWax currently shows 10, a variance of (+5) will be logged, increasing the total inventory to 15. Similarly, if the file specifies a variance of -5, the system's inventory will adjust to 5. When importing Inventory Adjustments, some fields need to be filled mandatorily, while others can be filled for further reference. Here is the list of mandatory fields:

    S.No.
    Field Name
    Description

    Import Future Inventory

    This import is used by retailers to schedule restocking for a product at future scheduled date and time, making the inventory available in HotWax Commerce and on Shopify at their preferred times.

    When scheduling a restock, certain mandatory fields should be filled. These fields are listed below:

    S.No.
    Field Name
    Description

    Reset Inventory by ATP

    When NetSuite (or any third-party system) is used as a Warehouse Management System (WMS), it reserves inventory for orders that need to be fulfilled. To sync inventory with HotWax Commerce OMS based on the sellable inventory in NetSuite (or any third-party system of records for inventory), the Reset Inventory by ATP method is used. This process updates HotWax OMS by comparing the quantity in the import file with the system's current ATP. The difference (delta in ATP) is applied to both ATP and QOH (Quantity on Hand) in HotWax OMS.

    Example:

    For Product A at a store:

    • Initial QOH: 10 units

    • Initial ATP: 5 units

    • File’s Quantity: 4 units

    After resetting:

    • ATP: 4 units (adjusted by the delta of -1).

    • QOH: 9 units (adjusted by the delta of -1).

    This method ensures accurate syncing of sellable inventory while accounting for reserved stock in NetSuite.

    The Reset file contains the following fields:

    S. No.
    Field Name
    Description

    Reset Inventory by QOH

    The Reset Inventory by QOH method is used when you want to sync the physical inventory from a third-party system, such as NetSuite, to HotWax Commerce OMS without considering inventory reservations. This ensures that the QOH (Quantity on Hand) in HotWax matches the physical inventory recorded in the external system. When the reset file is imported, the OMS compares the QOH value in the file with its systemic QOH. The difference (delta in QOH) is then applied to both QOH and ATP (Available to Promise), ignoring any reservations.

    Example:

    For Product A at a store:

    • Initial QOH: 10 units

    • Initial ATP: 5 units

    • File’s Quantity: 4 units

    After resetting:

    • QOH: 4 units (adjusted by a delta of -6).

    • ATP: -1 unit (adjusted by the same delta of -6).

    This method ensures a direct update of physical inventory levels in HotWax OMS.

    When the “RESET INVENTORY BY QOH” file is uploaded it has some fields which are listed below:

    S. No.
    Field Name
    Description

    Reset Inventory by ATP & QOH

    The Reset Inventory by ATP & QOH method is used when you want to update both QOH (Quantity on Hand) and ATP (Available to Promise) in HotWax Commerce OMS, while maintaining the difference between them. This method accounts for reservations, safety stock, and network thresholds configured in HotWax OMS when recalculating ATP.

    Example:

    For Product A

    • Initial QOH: 15 units

    • Initial ATP: 10 units

    • Difference (QOH - ATP): 5 units

    • File’s Quantity: 20 units

    After resetting:

    • New QOH: 20 units (updated to match the file).

    • New ATP: 15 units (adjusted to retain the difference of 5 units).

    This approach ensures accurate updates to inventory levels while respecting the system's inventory policies and calculations.

    When the “RESET INVENTORY BY ATP & QOH” file is uploaded it has some fields which are listed below:

    S. No.
    Field Name
    Description

    Export Order

    If the admin team wants to export orders based on multiple filters or criteria, they can navigate to their OMS instance. The default page that opens is the “Find Order Page”. From there, they can apply filters and then export the CSV file of orders.

    When exporting the CSV it gives some major fields which are listed here :

    S. No.
    Field Name
    Description

    Import/ Export that are generally used

    Export Inventory Config

    This is used to export inventory details such as Product Id, Facility Id, ATP, Minimum Stock from HotWax. To export an Inventory CSV file, go to the EXIM page, navigate to the Exports tab in the Warehouse section, and click on Import Inventory Config MDM.

    When exporting CSV fields are in this way:

    S.No.
    Field
    Description

    Import/Export Inbound Shipment

    Inbound shipments are used to receive inventory at a facility or warehouse. Majorly inbound shipments are created in the ERP and synced to HotWax Commerce via API, they can also be manually imported using MDM. To import a Shipment CSV file, go to the EXIM page, navigate to the Imports tab in the Warehouse section, and click on Shipment.

    In situations where retailers want to verify or edit their upcoming shipments, they can do so by exporting the Shipment CSV from the Warehouse section under the Exports tab. When importing shipment some fields need to be filled mandatorily, while others can be filled for further references. Here is the list of mandatory fields:

    S.No.
    Field Name
    Description

    Import Safety Stock

    Retailers can manually apply safety stock at products per location by importing a CSV. To import a Safety Stock CSV file, go to the EXIM page, navigate to the Imports tab in the Warehouse section, and click on Safety Stock MDM.

    When importing safety stock some fields need to be filled mandatorily, while others can be filled for further references. Here is the list of mandatory fields:

    S.No.
    Field Name
    Description

    Import/Export Purchase Order

    While most Purchase Orders are created in ERP and synced with OMS through automated jobs, in some cases, when a retailer intends to upload or download a PO manually, they can do this using EXIM. To import a Purchase Order CSV file, go to the EXIM page, navigate to the Imports tab in the Procurement section, and click on Purchase Order MDM.

    Similarly, users can export the CSV of Purchase Order in the Procurement section under the Exports tab.

    When importing Purchase Order some fields need to be mandatorily filled, while others can be filled for further references. Here is the list of mandatory fields:

    S.No.
    Field Name
    Description

    Import/Export Purchase Order ATP

    PO ATP (Purchase Order Available to Promise) refers to the pre-sellable inventory from a purchase order promised for delivery by a vendor and available for pre-orders.

    Retailers may need to update PO ATP when they want to adjust the pre-sellable inventory on a purchase order after it's already been uploaded and do not want to make their entire upcoming inventory available for pre-orders on eCommerce. To import a PO ATP CSV, go to the EXIM page > Imports tab > Procurement section > PO ATP. Allowing retailers to adjust promised inventory as needed.

    Similarly, users can export the CSV of PO ATP from the EXIM page in the Procurement section under the Exports tab. When importing PO ATP, some fields need to be filled mandatorily, while others can be filled for further reference. Here is the list of mandatory fields:

    S.No.
    Field Name
    Description

    Import Product ERP Code

    Instead of updating ERP codes individually through the ViewProduct page, retailers can upload a CSV file for multiple products at once.

    To import a Product ERP Code CSV, go to the EXIM page under the Imports tab in the PIM section and click on Create and Update Product ERP Code.

    When importing product ERP codes, certain fields must be filled in mandatorily. Below is the list of required fields:

    S.No.
    Field Name
    Description

    Example: Create a Product ERP Code


    Example: Update a Product ERP Code

    address-line-2

    Secondary address line of the facility, if applicable.

    6

    city

    The city where the facility is located.

    7

    zip-code

    Zip or postal code of the facility's location.

    8

    state

    State or province of the facility's location.

    9

    country

    Country where the facility is located.

    10

    latitude

    Latitude coordinate of the facility's location.

    11

    longitude

    Longitude coordinate of the facility's location.

    12

    phone-number

    Phone number for contacting the facility.

    13

    email

    Contact email address for the facility.

    5

    enabled

    Indicates if the account is active (true/false).

    6

    relationship-status

    Current status of the party’s relationship (e.g., active, inactive).

    7

    user-login-id

    Login ID for the user.

    8

    password

    Password for user authentication.

    9

    party-classifications

    Classifications assigned to the party (e.g., customer, supplier).

    10

    party-identifications

    Identifications or IDs associated with the party.

    11

    relationships

    Relationships linked to the party (e.g., parent-child relationships).

    5

    tuesday-start

    The start time for operations on Tuesday.

    6

    tuesday-capacity

    The maximum capacity or limit for operations on Tuesday.

    7

    wednesday-start

    The start time for operations on Wednesday.

    8

    wednesday-capacity

    The maximum capacity or limit for operations on Wednesday.

    9

    thursday-start

    The start time for operations on Thursday.

    10

    thursday-capacity

    The maximum capacity or limit for operations on Thursday.

    11

    friday-start

    The start time for operations on Friday.

    12

    friday-capacity

    The maximum capacity or limit for operations on Friday.

    13

    saturday-start

    The start time for operations on Saturday.

    14

    saturday-capacity

    The maximum capacity or limit for operations on Saturday.

    15

    sunday-start

    The start time for operations on Sunday.

    16

    sunday-capacity

    The maximum capacity or limit for operations on Sunday.

    5

    availableDelta

    Change in the available quantity for the facility.

    6

    locationSeqId

    Sequence ID of the location within the facility.

    7

    varianceReasonId

    Identifier for the reason behind a variance in inventory or data.

    8

    comments

    Additional remarks or notes related to the record.

    5

    Product Store

    The name of the Product Store.

    6

    Shopify Store

    Name of the Shopify Store on which the inventory will change.

    7

    Restock Name

    Name for the restock.

    5

    quantity

    Number of items involved in the action.

    6

    reason

    Explanation for the inventory adjustment.

    7

    comments

    Additional notes or remarks.

    5

    quantity

    Number of items involved in the action.

    6

    reason

    Explanation for the inventory adjustment.

    7

    comments

    Additional notes or remarks.

    5

    quantity

    Number of items involved in the action.

    6

    reason

    Explanation for the inventory adjustment.

    7

    comments

    Additional notes or remarks.

    5

    parentProductName

    Name of the parent product associated with the order item.

    6

    productName

    Name of the product in the order.

    7

    internalName

    Internal name of the product within the system.

    8

    quantity

    Quantity of the order item.

    9

    orderItemStatusId

    Status identifier for the order item.

    10

    orderItemStatusDesc

    Description of the order item status.

    5

    external-id

    Identifier for the product used in external systems or integrations.

    6

    ATP

    Available to Promise - quantity of product available to fulfill orders.

    7

    minimum-stock

    The minimum required stock level to prevent stockouts.

    8

    inv-group-member

    Specifies the inventory group or category the product belongs to.

    5

    origin-facility-id

    ID of the facility from which the shipment is originating.

    6

    destination-facility-id

    ID of the facility where the shipment is being delivered.

    7

    product-id

    Unique identifier for the product being shipped.

    8

    id-type

    Type of ID used for identifying the product (e.g., SKU, barcode).

    9

    product-sku

    SKU (Stock Keeping Unit) for the product being shipped.

    10

    quantity

    Quantity of the product being shipped.

    11

    serial-number

    Serial number of the product being shipped, if applicable.

    12

    order-id

    Unique identifier for the order related to the shipment.

    13

    tracking-number

    Unique tracking number assigned to the shipment for tracking its status.

    5

    facility-safety-stock

    Quantity of safety stock reserved for walk-in customers at the facility.

    5

    product-SKU

    The unique Stock Keeping Unit (SKU) identifier for the product.

    6

    quantity

    The available quantity of the product in stock or expected.

    7

    atp

    The quantity of the product that can be promised for delivery.

    8

    arrival-date

    The expected date when the product will arrive at the facility or store. Users can use either MM-DD-YYYY or DD-MM-YYYY for the arrival-date based on their region.

    5

    product-sku

    The Stock Keeping Unit (SKU) represents the product.

    6

    ATP

    Available-to-Promise quantity for the product based on current inventory data.

    5

    good-identification-value

    The ERP code assigned to the product.

    1

    facility-id

    Unique identifier for the facility.

    2

    external-id

    External identifier for the facility.

    3

    facility-name

    The name of the facility.

    4

    address-line-1

    Primary address line of the facility.

    1

    party-id

    Unique identifier for the party (individual or organization).

    2

    external-id

    External system reference ID for integration purposes.

    3

    first-name

    First name of the party.

    4

    last-name

    Last name of the party.

    1

    calendar-id

    A unique identifier for the calendar used to manage facility schedules.

    2

    description

    A brief description of the calendar or its purpose.

    3

    monday-start

    The start time for operations on Monday.

    4

    monday-capacity

    The maximum capacity or limit for operations on Monday.

    1

    store-id

    Unique identifier for the store.

    2

    calendar-id

    Unique identifier for the calendar associated with the store.

    3

    from-date

    Start date for the calendar's validity period. Users can use either MM-DD-YYYY or DD-MM-YYYY for the arrival-date based on their region.

    4

    thru-date

    End date for the calendar's validity period. Users can use either MM-DD-YYYY or DD-MM-YYYY for the arrival-date based on their region.

    1

    facilityId

    Unique identifier for the facility.

    2

    externalFacilityId

    Identifier used for the facility in external systems.

    3

    idType

    Type of identifier being referenced (e.g., product).

    4

    idValue

    Specific value of the referenced identifier.

    1

    Shopify Product SKU

    Unique ID for a Product in Shopify.

    2

    Restock Quantity

    The quantity of items restocked.

    3

    Schedule

    Allows selecting the time.

    4

    Facility ID

    Unique ID for a facility where restock is scheduled.

    1

    productId

    Unique identifier for the product.

    2

    idValue

    Value corresponding to the identification type.

    3

    facilityId

    Identifier for the facility location.

    4

    locationSeqId

    1

    productId

    Unique identifier for the product.

    2

    idValue

    Value corresponding to the identification type.

    3

    facilityId

    Identifier for the facility location.

    4

    locationSeqId

    1

    productId

    Unique identifier for the product.

    2

    idValue

    Value corresponding to the identification type.

    3

    facilityId

    Identifier for the facility location.

    4

    locationSeqId

    1

    orderId

    Unique identifier for the order.

    2

    orderName

    Name or description of the order.

    3

    orderItemSeqId

    Sequential identifier for the order item.

    4

    productId

    1

    product-id

    Unique identifier for each product.

    2

    internal-name

    Internal reference name for the product.

    3

    product-id-value

    Specific value assigned to the product ID for mapping or identification.

    4

    facility-id

    Unique identifier for the facility (e.g., warehouse or store) where the product is managed.

    1

    shipment-id

    Unique identifier for the shipment.

    2

    external-shipment-id

    External identifier for the shipment, often used in third-party systems.

    3

    shipment-type

    Type of shipment (e.g., inbound, outbound, transfer).

    4

    shipment-status

    Current status of the shipment (e.g., pending, in-transit, delivered).

    1

    facility-id

    Unique identifier for the facility within the system.

    2

    facility-external-id

    External identifier used to represent the facility in external systems.

    3

    product-id

    Unique identifier for the product in the system.

    4

    product-sku

    Stock Keeping Unit (SKU) of the product for tracking and inventory management.

    1

    external-id

    A unique identifier for the record in an external system or database.

    2

    product-store-id

    The unique identifier for the product store where the item is located.

    3

    facility-id

    The identifier for the facility handling the product.

    4

    external-facility-id

    The unique external identifier for the facility in another system.

    1

    po-id

    The unique identifier for the Purchase Order (PO) within the system.

    2

    po-external-id

    The unique identifier for the Purchase Order in an external system.

    3

    po-item-seq-id

    The sequence identifier for items within the Purchase Order.

    4

    product-id

    The unique identifier for the product in the system.

    1

    productId

    HC Unique identifier for the product.

    2

    id-type

    Secondary identifier type such as UPCA or SKU.

    3

    id-value

    The value corresponding to the identifier type.

    4

    good-identification-type

    The type of identification. For ERP codes, the value should always be ERP_ID.

    variances
    ATP

    5

    Sequence ID for the specific storage location.

    Sequence ID for the specific storage location.

    Sequence ID for the specific storage location.

    Unique identifier for the product.

    productId,id-type id-value,good-identification-type,good-identification-value
    100182,UPCA, 69684750301, ERP_ID,31-1350
    productId,id-type id-value,good-identification-type,good-identification-value
    100182,UPCA, 69684750301, ERP_ID,31-1351