The section details how various jobs contribute to the overall system, from order allocation to inventory management, and offers resolutions into troubleshooting and performance.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Learn about the Orders jobs in HotWax Commerce.
Job Name: Import Orders
Job Enum ID: JOB_IMP_ORD
Description
The Import Orders
job is designed to import new orders recently created on eCommerce platforms into HotWax Commerce. New orders are identified by checking those created since the last time the job was executed. If the job is run for the first time, it defaults to orders created in the last 15 minutes from the execution time. This default duration can be adjusted using the "frequency" custom parameter.
Recommended Frequency Importing new orders every 15 minutes is generally sufficient to ensure customers have a grace period for order cancellations and to process expedited orders on time. However:
Low Order Volume: For instances with lower order volume and more demanding fulfillment SLAs, consider increasing the frequency to every five minutes.
High Order Volume: During periods of higher order volume, importing orders every 15 minutes is recommended to leverage HotWax Commerce's bulk import capabilities fully.
Parameter
Type
Description
Default Value
frequency
Required
Defines the default duration for syncing orders if there is no Last Sync Time.
15 minutes
limit
Optional
Sets a limit on the order import job, restricting the number of orders fetched from eCommerce.
Not specified
bufferTime
Optional
Ensures orders are not imported until they have aged past a desired duration, accommodating post-processing workflows in eCommerce platforms.
5 minutes
thruDateBuffer
Optional
Skips Shopify orders created within the specified time interval. For example, if thruDateBuffer is set to 1, it implies that orders created in Shopify within the last 1 minute will be skipped during the import process.
2 minutes
scheduleNow
Optional
When importing files into the OMS, the system must pick the file out of sequence for immediate processing. Enabled by default when importing files from FTP, but can be disabled during high-volume syncs for system stability.
Enabled
Job Name: Approve Orders
Job Enum ID: JOB_APR_ORD
Description
In HotWax Commerce, all orders are initially marked as Created
after downloading. Orders can be auto-approved using a scheduled job called Approve Orders
, which checks the approval status of Shopify orders based on parameters set by Shopify merchants. The job runs at a default frequency and approves orders once all necessary details and required references are established.
Custom Parameters
Parameter
Type
Description
Default Value
orderId
Optional
The ID associated with the order is to be updated on the eCommerce platform.
Not specified
Job Name: Import Order Updates from Shopify
Job Enum ID: JOB_IMP_ORD_UPD
Description
The Import Order Updates from Shopify
job is specifically designed to handle the import of order updates from the eCommerce platform into HotWax Commerce. This job caters to a variety of order modifications, including the addition of new items, changes in item quantities, and the cancellation of items or entire orders.
Recommended Frequency The job is configured to run every 60 minutes, ensuring frequent updates and maintaining synchronization between Shopify and HotWax Commerce.
Parameter
Type
Description
Default Value
frequency
Required
Defines the default duration for syncing orders if there is no Last Sync Time.
60 minutes
bufferTime
Optional
Ensures orders are not imported until they have aged past a desired duration, accommodating post-processing workflows in Shopify.
Not specified
Job Name: Import Canceled Order
Job Enum ID: JOB_IMP_CAN_ORD
Description
The Import Canceled Orders
job synchronizes order cancellations between the eCommerce platform and HotWax Commerce. It identifies orders marked as canceled in the eCommerce system and updates their status in HotWax Commerce, ensuring alignment and preventing further processing of canceled orders.
Parameter
Type
Description
Default Value
frequency
Required
Defines the default duration for syncing orders if there is no Last Sync Time.
15 minutes
bufferTime
Optional
Ensures orders are not imported until they have aged past a desired duration, accommodating post-processing workflows in eCommerce platforms.
Not Specified
Job Name: Import Canceled Items
Job Enum ID: JOB_IMP_ITM_CNCL
Description
The Import Canceled Items
job is designed to actively monitor eCommerce platforms for order items that have been canceled. Unlike canceling the entire order, this job specifically targets canceled items and ensures their corresponding status is updated within HotWax Commerce.
This job is crucial for maintaining accurate inventory records and order status in HotWax Commerce. By identifying and canceling individual items that have been canceled on the eCommerce platform, it prevents discrepancies and ensures that the system reflects the most up-to-date order information.
Recommended Frequency The job is configured to run every 15 minutes, ensuring a regular check for canceled items and prompt updates within HotWax Commerce.
Parameter
Type
Description
Default Value
frequency
Required
Defines the default duration for syncing orders if there is no Last Sync Time.
15 minutes
bufferTime
Optional
Ensures orders are not imported until they have aged past a desired duration, accommodating post-processing workflows in Shopify.
Not specified
Job Name: Import Order Returns
Job Enum ID: JOB_IMP_RTN
Description
The Import Order Returns
job plays a crucial role in managing returned orders seamlessly between eCommerce platforms and HotWax Commerce. This job actively monitors eCommerce platforms to identify orders that have been returned. Subsequently, it initiates the creation of return transactions within HotWax Commerce. In cases where inventory is damaged, the job ensures accurate logging of Damaged variances in HotWax.
Return Creation: The primary function of the job is to create return transactions in HotWax Commerce for orders identified as returned on the eCommerce platform.
Restocking: If the inventory is damaged and marked as returnable, the job ensures that returned items are restocked appropriately.
Recommended Frequency The job is configured to run every 15 minutes, ensuring a regular check for returned orders and facilitating swift updates within HotWax Commerce.
Parameter
Type
Description
Default Value
frequency
Required
Defines the default duration for syncing orders if there is no Last Sync Time.
15 minutes
bufferTime
Optional
Ensures orders are not imported until they have aged past a desired duration, accommodating post-processing workflows in Shopify.
Not specified
financialStatus
Optional
Specifies the financial status of orders.
Not specified
limit
Optional
Sets a limit on the order import job, restricting the number of orders fetched from eCommerce.
Not specified
Webhooks can be subscribed to from the category pages within the Job Manager app for specific categories.
Automated messages sent from eCommerce (Shopify) to OMS whenever an event occurs. They contain data about the event and are received in OMS, allowing real time communication between eCommerce and OMS.
Subscribe to Shopify eCommerce Webhooks from OMS for:
Upload Completed Orders
JOB_UL_CMPLT_ORD
Description
The Upload Completed Orders
job synchronizes all orders marked as "Completed" in HotWax Commerce with Shopify. This ensures that orders in Shopify are updated to a "Fulfilled" status, maintaining accurate and consistent order tracking across both systems.
Recommended Frequency
The job is configured to run at a frequency that suits the needs of your business, ensuring timely updates for fulfilled orders.
Parameters
shipmentID
Required
The ID associated with the shipment to track and update orders.
Not specified
orderID
Required
The ID associated with the order to be updated on the eCommerce platform.
Not specified
shipmentCreatedDate
Required
The timestamp associated with the creation of shipments.
Not specified
Upload Canceled Orders
JOB_UL_CNCLD_ORD
Description
The Upload Canceled Orders
job is used to upload canceled orders from HotWax Commerce to Shopify. HotWax Commerce allows retailers to set an auto-cancel date for each order, which defaults to 7 days. If an order is not fulfilled within this time frame, it is automatically canceled in HotWax Commerce and requires updating on Shopify to ensure both systems stay in sync. This bulk operation helps streamline the cancellation process, reducing manual effort and minimizing discrepancies between HotWax Commerce and Shopify.
Custom Parameters
Frequency
Required
Defines the default duration of the last syncing of the canceled orders.
In an hour
Schedule
Optional
Ensures orders are not imported until they have aged past a desired duration, accommodating post-processing workflows in eCommerce platforms.
Not specified
OrderId
Optional
The ID associated with the order to be updated on the eCommerce platform.
Not specified
CanceledDate
Optional
This parameter specifies the date an order was canceled in HotWax Commerce.
Not specified
Job Name: Party Identification
Job Enum ID: JOB_PARTY_IDENT
Description The Party Identification job is designed to create or update Party Identification records within the system. This job ensures accurate and up-to-date identification of parties involved.
Recommended frequency The job is configured to run at a frequency that aligns with the business needs for regular updates of party identification records.
Custom Parameters
propertyResource
Required
Specifies the property resource for configuration.
FTP_CONFIG
configId
Required
Identifies the configuration for importing party identification records.
IMP_PARTY_IDENT
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
scheduleNow
Optional
Forces the system to pick the file out of sequence for immediate processing.
Not specified
Job Name: Update Order Tags
Job Enum ID: JOB_UPD_TAG_ORD
Description The Update Order Tags job, identified by Job Enum ID UPDATE_ORDER_TAGS, is designed to perform bulk updates to order tags on the eCommerce platform. This job facilitates efficient and large-scale modifications to order tags, ensuring synchronization with the latest data.
Recommended Frequency The job frequency can be configured based on the business needs and the desired frequency of updating order tags in bulk.
No custom parameters for this job
Job Name: Complete order items from Shopify
Job Enum ID: IMP_COMPL_ORD_ITM
Description
The Complete Order Items from Shopify
job ensures that order statuses remain synchronized between Shopify and HotWax Commerce. When items in an order are marked as completed in Shopify, this job automatically updates the corresponding items in HotWax to reflect their completed status. This synchronization helps maintain accurate order tracking, reduces manual updates, and ensures consistency across both platforms.
No custom parameters for this job
Job Name: Approve Sales Order
Job Enum ID: JOB_APR_SALES_ORD
Description The Approve Sales Order job is designed to facilitate the approval of sales orders within the system. This ensures that sales orders are processed and approved promptly.
Recommended frequency The job is configured to run at a frequency that aligns with the business needs for timely approval of sales orders.
Custom Parameters
propertyResource
Required
Specifies the property resource for configuration.
FTP_CONFIG
configId
Required
Identifies the configuration for Order Item Attribute records.
IMP_APR_SALES_ORD
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
scheduleNow
Optional
Forces the system to pick the file out of sequence for immediate processing.
Enabled
Job Name: Bulk Process Refund for Received Return
Job Enum ID: BLK_PROCESS_RTN_RFND
Description The Bulk Process Refund for Received Returns job is designed to efficiently process returns in bulk and push them to the Shopify platform. This job specifically handles returns that are associated with a sales channel set to POS. It is particularly useful for retailers who do not use Shopify's POS system, enabling them to manage returns and process refunds in bulk for smoother operations and accurate financial records.
Custom Parameters
startDateTime
Optional
It marks the beginning of the validity period for an entity or event, such as the defined period of the received returns.
Not Specified
returnId
Optional
Unique identifier for return transactions within the system.
Not Specified
Job Name: Import Create Exchange Order
Job Enum ID: JOB_CRT_SALES_ORD
Description
The Create Exchange Order
job processes orders for which an exchange has been initiated in Shopify and synchronizes these exchange details into HotWax Commerce. This ensures accurate tracking and management of exchange orders within the OMS.
Custom Parameters
configId
Required
Identifies the configuration for Order Item Attribute records.
IMP_CRT_EXCHG_ORD
propertyResource
Required
Specifies the property resource for configuration.
FTP_CONFIG
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
importpath
Optional
Specifies the SFTP location and path for importing the file into the system.
Not specified
scheduleNow
Optional
When importing files into the OMS, forces the system to pick the file out of sequence for immediate processing. Enabled by default when importing files from FTP, but can be disabled during high-volume syncs for system stability.
Not specified
createdByJobID
Optional
ID of the job that initiated this job.
Not specified
Job Name: Import Create Return Order
Job Enum ID: JOB_CRT_RETURN
Description This job imports all return requests created in Shopify into HotWax Commerce. It ensures that return data, including returned items and customer details, is automatically synced for processing. This job helps keep records up to date, supporting accurate inventory adjustments and streamlined return management across both platforms.
Custom Parameters
configId
Required
Identifies the configuration for Order Item Attribute records.
IMP_CRT_RTN_ORD
propertyResource
Required
Specifies the property resource for configuration.
FTP_CONFIG
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
importpath
Optional
Specifies the SFTP location and path for importing the file into the system.
Not specified
scheduleNow
Optional
When importing files into the OMS, forces the system to pick the file out of sequence for immediate processing. Enabled by default when importing files from FTP, but can be disabled during high-volume syncs for system stability.
Not specified
createdByJobID
Optional
ID of the job that initiated this job.
Not specified
Job Name: Create Shipment for Incoming Returns
Job EnumID: INCOMING_SHPMNT_RETN
Description
The Create Shipment for incoming returns
job serves to manage the reception of return shipments efficiently. When a return is initiated through Shopify, the return item details are added into the receiving app of HotWax Commerce.
Custom parameters
configId
Required
Identifies the configuration for Order Item Attribute records.
INCOMING_SHPMNT_RETN
propertyResource
Required
Specifies the property resource for configuration.
FTP_CONFIG
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
importpath
Optional
Specifies the SFTP location and path for importing the file into the system.
Not specified
scheduleNow
Optional
When importing files into the OMS, forces the system to pick the file out of sequence for immediate processing. Enabled by default when importing files from FTP, but can be disabled during high-volume syncs for system stability.
Not specified
createdByJobID
Optional
ID of the job that initiated this job.
Not specified
Job Name: Import last day orders from Shopify
Job Enum ID: JOB_IMP_MISS_ORD
Description
The Import Last Day Orders from Shopify
job imports all orders received on Shopify from the previous day into HotWax Commerce. This job ensures that no orders are missed, keeping the order data synchronized between Shopify and HotWax Commerce for accurate processing and inventory management. It helps maintain consistency across both platforms by ensuring all recent orders are promptly imported and recorded.
Custom Parameters
limit
Optional
Additional parameters for job customization.
Not specified
fileProcessingDelay
Optional
Specifies the Interval for processing a file.
Not specified
createdByJobID
Optional
ID of the job that initiated this job.
Not specified
Job Name: Order Item Attribute
Job Enum ID: JOB_ORDER_ITM_ATTR
Description The Order Item Attribute job is designed to create or update Order Item Attribute records. This job ensures the accurate maintenance of order item attributes within the system.
Recommended frequency The job is configured to run at a frequency that suits the needs of your business, ensuring timely updates for order item attributes.
Custom parameters
propertyResource
Required
Specifies the property resource for configuration.
IMP_ORDER_ITM_ATTR
configId
Required
Identifies the configuration for Order Item Attribute records.
FTP_CONFIG
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
scheduleNow
Optional
Forces the system to pick the file out of sequence for immediate processing.
Enabled
Job Name: Order Item Rejected
Job Enum ID: JOB_ORDER_ITM_RJCT
Description
The Order Item Rejected
job records items that cannot be fulfilled, creating a rejection record in HotWax Commerce. This job ensures that order items, that are rejected from the fulfillment location where they were first allocated, are recorded for tracking purposes. It helps improve inventory management by keeping accurate records of items that could not be fulfilled from their original location.
Custom Parameters
configId
Required
Identifies the configuration for Order Item Attribute records.
IMP_ORDER_ITM_RJCT
propertyResource
Required
Specifies the property resource for configuration.
FTP_CONFIG
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
scheduleNow
Optional
Forces the system to pick the file out of sequence for immediate processing.
Not specified
createdByJobID
Optional
ID of the job that initiated this job.
Not specified
Job Name: Import Transfer Order
Job Enum ID: JOB_ORDER_ITM_TO
Description
The Import Transfer Order
job brings transfer order details into the order management system from the ERP system to ensure consistency and accuracy in the inventory transfers. This process supports inventory accuracy by facilitating the fulfillment and receipt of inventory transfers.
Custom parameters
configId
Required
Identifies the configuration for Order Item Attribute records.
IMP_TRANSFER_ORD
propertyResource
Required
Specifies the property resource for configuration.
FTP_CONFIG
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
importpath
Optional
Specifies the SFTP location and path for importing the file into the system.
Not specified
scheduleNow
Optional
Forces the system to pick the file out of sequence for immediate processing.
Not specified
createdByJobID
Optional
ID of the job that initiated this job.
Not specified
Job Name: Order Identification
Job Enum ID: JOB_ORDER_IDENT
Description
The Order Identification
job is designed to create or update Order Identification records within the OMS. This job ensures accurate and up-to-date identification of orders.
Recommended frequency The job is configured to run at a frequency that aligns with the business needs for regular updates of order identification records.
Custom parameters
propertyResource
Required
Specifies the property resource for configuration.
FTP_CONFIG
configId
Required
Identifies the configuration for importing order attributes.
IMP_ORDER_IDENT
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
scheduleNow
Optional
Forces the system to pick the file out of sequence for immediate processing.
Enabled
Job Name: Import Order Metafield
Job Enum ID: IMP_ORD_META_FLD
Description
The Import Order Metafield
job is designed to schedule a job for downloading order metafields. This job ensures the timely synchronization of order metafields from the specified namespace.
Recommended frequency The job is configured to run at a frequency that aligns with the business needs for regular updates of order metafields.
Custom parameters
namespace
Required
Specifies the namespace for order metafields.
HotwaxOrderDetails
bufferTime
Optional
Specifies the buffer time (in minutes) for scheduling job downloads.
1 minute
thruDateBuffer
Optional
Specifies the buffer time (in minutes) for processing orders after the through date.
Not specified
filterQuery
Optional
Specifies a filter query for more targeted metafield downloads.
Not specified
frequency
Optional
Specifies the frequency (in minutes) for running the job.
Not specified
Job Name: Import Customers from Shopify Job Enum ID: JOB_IMP_CSTMR
Description The Import Customer job imports customer data from Shopify into HotWax Commerce. This job ensures that customer information, including contact details and order history, is accurately synced between the two platforms, supporting smooth order processing and customer management in HotWax Commerce.
Custom Parameters
frequency
Required
Defines the default duration of the last syncing of the shipment status.
15
bufferTime
Optional
Specifies the buffer time (in minutes) for scheduling job.
Not Specified
limit
Optional
Additional parameters for job customization.
Not Specified
Job Name: Approve Transfer Orders Job Enum ID: JOB_APR_TO
Description The Approve Transfer Order job approves all transfer orders imported into HotWax Commerce from Shopify. This job ensures that the transfer orders are validated and ready for fulfillment, allowing the processing and shipping of items to proceed smoothly. It helps streamline the order fulfillment process by automating the approval of transferred orders.
Custom Parameters
orderIds
Optional
The ID associated with the order to be updated on the eCommerce platform.
Not Specified
bufferTime
Optional
Specifies the buffer time (in minutes) for scheduling job.
Not Specified
Job Name: Import order attribute
Job Enum ID: JOB_ORDER_ITM_ATTR
Description Order attributes are additional details associated with an order that provides essential information for processing. For example, order attributes are used to move an order from the "created" state to the approved state, among other functions. The Import Order Attribute job imports these attributes, ensuring they are available for fulfillment once the order reaches the approved state.
Custom Parameters
configId
required
Identifies the configuration for Order Item Attribute records.
MOD_ORD_ATTR
propertyResource
required
Specifies the property resource for configuration.
FTP_CONFIG
remoteFilename
optional
Specifies the remote filename for processing.
Not specified
groupBy
optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
optional
Additional parameters for job customization.
Not specified
fileNameRegex
optional
Specifies a regular expression for filtering filenames.
Not specified
importpath
optional
Specifies the SFTP location and path for importing the file.
Not specified
scheduleNow
optional
Forces the system to pick the file out of sequence for immediate processing.
Not specified
createdByJobID
optional
ID of the job that initiated this job.
Not specified
Job Name: Order Item Fulfillment
Job Enum ID: JOB_ODR_ITM_FLFLMNT
Description The Order Item Fulfillment job is designed to complete order items using a JSON file in MDM (Master Data Management). This job ensures the fulfillment of order items and synchronization with the provided JSON file.
Recommended frequency The job is configured to run at a frequency that aligns with the business needs for completing order items using the MDM JSON file.
Custom Parameters
propertyResource
Required
Specifies the property resource for configuration.
Not specified
configId
Required
Identifies the configuration for importing order attributes.
IMP_ODR_ITM_FLFLMNT
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
scheduleNow
Optional
Forces the system to pick the file out of sequence for immediate processing.
Enabled
Learn about the miscellaneous jobs in HotWax Commerce.
Job Name: Process uploads to eCommerce
Job Enum ID: JOB_UL_PRCS
Description
This job is used in scenarios where multiple uploads to Shopify are queued, and it's crucial to ensure that these uploads are processed one at a time. This could be part of a larger system where inventory, product data, or other information needs to be synced with Shopify in an orderly and managed way, preventing conflicts and ensuring data integrity.
No custom parameters for this job
Job Name: Process bulk imported files
Job Enum ID: DMGR_RN_PNDNG_JB
Description This job is used in scenarios where a system needs to handle multiple data import jobs that are queued. It ensures that each job is processed in the correct order, with the appropriate service, and that the job statuses are accurately tracked. This is particularly useful in systems that manage large amounts of data, such as content management systems, e-commerce platforms, or enterprise resource planning (ERP) systems.
Custom Parameters
Parameter
Type
Description
Default Value
configId
Optional
Identifies the configuration for pending data manager job.
Not Specified
excludeConfigId
Optional
Not Specified
Not Specified
logTypeEnumId
Optional
Not Specified
Not Specified
continueOnError
Optional
Not Specified
Not Specified
Job Name: Import Historical Shopify Customer
Job Enum ID: JOB_SHOP_CUST
Description
The Import Historical Shopify Customer
job downloads historical customer data from Shopify and imports it into HotWax Commerce. This is crucial for integration with NetSuite, as NetSuite allows order creation only for customers that already exist in the system. By importing historical Shopify customers, this job ensures that all necessary customer records are available in HotWax Commerce, enabling seamless order transmission from HC to NetSuite alongside the customer data.
Custom Parameters
Parameter
Type
Description
Default Value
configId
Required
Identifies the configuration for Order Item Attribute records.
IMP_HIS_SHOP_CUST
propertyResource
Required
Specifies the property resource for configuration.
FTP_CONFIG
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
importpath
Optional
Specifies the SFTP location and path for importing the file into the system.
Not specified
scheduleNow
Optional
When importing files into the OMS, forces the system to pick the file out of sequence for immediate processing. Enabled by default when importing files from FTP, but can be disabled during high-volume syncs for system stability.
Not specified
createdByJobID
Optional
ID of the job that initiated this job.
Not specified
Job Name: Send Broker Order Mail
Job Enum ID: JOB_BROKER_MAIL_ODR
Description
The Send Broker Order Mail
job facilitates the bulk sending of email notifications for brokered orders. This job ensures that customers receive timely updates on the status of their brokered orders, enhancing communication and order tracking.
Custom Parameters
Parameter
Type
Description
Default Value
frequency
Optional
Defines the default duration of the last syncing of the orders.
30
emailType
Optional
Specifies the type of email template to use for a notification.
PRDS_ORD_BROKRED
Job Name: Send Completed Order Mail
Job Enum ID: JOB_COMPLET_MAIL_ODR
Description
The Send Completed Order Mail
job enables the bulk sending of email notifications for completed orders, ensuring customers are promptly informed when their orders are fulfilled and ready for receipt.
Custom Parameters
Parameter
Type
Description
Default Value
frequency
Optional
Defines the default duration of the last syncing of the orders.
30
emailType
Optional
Specifies the type of email template to use for a notification.
PRDS_ORD_COMPLETED
Job Name: Packaged multi-stream Import
Job Enum ID: JOB_IMP_GN_JSON_LIST
Description This job is useful in scenarios where multiple pieces of JSON data need to be imported and processed by different services. For instance, in a data integration or ETL (Extract, Transform, Load) system, this function can be used to import and process batches of data from JSON files or API responses. It ensures that each data item is processed through the correct service and handles any errors encountered during the process.
Custom Parameters
Parameter
Type
Description
Default Value
configId
Required
Identifies the configuration for import JSON list data.
IMP_JSON_LIST_DATA
propertyResource
Required
Specifies the property resource for configuration.
FTP_CONFIG
remoteFilename
Optional
Specifies the remote filename for processing.
Not Specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not Specified
additionalParameters
Optional
Additional parameters for job customization.
Not Specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not Specified
importPath
Optional
SFTP file location from where the file will be imported.
Not Specified
scheduleNow
Optional
When importing files into the OMS, forces the system to pick the file out of sequence for immediate processing. Enabled by default when importing files from FTP, but can be disabled during high-volume syncs for system stability.
Not Specified
createdByJobId
Optional
ID of the job that initiated this job.
Not Specified
Job Name: Multi-Stream Import
Job Enum ID: JOB_IMP_JSON_DATA
Description This job is used when there is a need to process a single JSON data object by invoking a specific service. For example, it can be used in scenarios where data needs to be imported from a JSON payload and processed by a particular service in an application. This function ensures that the data is correctly validated and passed to the service, and handles any errors that may occur during the process.
Custom Parameters
Parameter
Type
Description
Default Value
configId
Required
Identifies the configuration for import JSON data.
IMP_JSON_DATA
propertyResource
Required
Specifies the property resource for configuration.
FTP_CONFIG
remoteFilename
Optional
Specifies the remote filename for processing.
Not Specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not Specified
additionalParameters
Optional
Additional parameters for job customization.
Not Specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not Specified
importPath
Optional
SFTP file location from where the file will be imported.
Not Specified
scheduleNow
Optional
When importing files into the OMS, forces the system to pick the file out of sequence for immediate processing. Enabled by default when importing files from FTP, but can be disabled during high-volume syncs for system stability.
Not Specified
createdByJobId
Optional
ID of the job that initiated this job.
Not Specified
Job Name: Send Packed Order Mail
Job Enum ID: JOB_PACKED_MAIL_ODR
Description
The Send Packed Order Mail
job facilitates the bulk sending of email notifications for packed orders, notifying customers when their orders are prepared and ready for shipment.
Custom Parameters
Parameter
Type
Description
Default Value
frequency
Optional
Defines the default duration of the last syncing of the orders.
30
emailType
Optional
Specifies the type of email template to use for a notification.
PRDS_ORD_PACKED
Job Name: Send Packed Shipment Notification to Customer
Job Enum ID: SHPMNT_PKD_NT
Description This job is used in scenarios where notifications need to be sent for a large batch of shipments that have recently been packed. It is particularly useful for automating the process of informing customers or internal systems about the status of their shipments, ensuring timely communication and updates.
Custom Parameters
Parameter
Type
Description
Default Value
frequency
Required
Defines the default duration of the last syncing of the shipment status.
15
bufferTime
Optional
Specifies the buffer time (in minutes) for scheduling the job.
Not specified
shipmentMethodTypeIds
Optional
Unique identifier of Shipment Method type.
Not specified
Learn about the Import New Products job in HotWax Commerce. Keep your product catalog updated for accurate representation on your platform.
All Pre-order jobs have a defined frequency of 15 minutes by default which can be modified and adjusted at any point of time as per the requirement. The user may have various options to modify the job, such as altering the run time, adjusting the frequency, and adding custom parameters if required, or can also cancel the job to reduce system load. Users can follow the given steps to execute any changes in the existing jobs to update the runtime and the scheduled frequency of the job whenever required.
Runtime: Time at which a job is scheduled particularly. Scheduled Frequency: A time duration for repeated occurrence.
Go to the Pipeline and search for the Job, by job name or related keyword.
Click on the Job Card to refer to the job detailed view.
Select the runtime function dropdown to change the run time from the dropdown or make custom changes.
Or change the scheduled frequency by choosing it from the dropdown or make a custom requirement.
Ensure to save the changes.
Users can add custom parameters to the jobs and schedule them accordingly.
Users can also “Skip” or “Cancel” the jobs from the same job detailed card.
Job ID: JOB_REL_PREODR_CAT Job Name: Reset Preorder catalog Items
Description: The Pre-sell Catalog job automatically manages the addition or removal of pre-sell products from the HotWax Pre-order/Backorder category. This job checks for new products eligible for pre-order/backorder in the received feeds from ERP and adds them to the pre-order backorder catalog in HotWax Commerce based on specific eligibility criteria for product inventory, purchase orders, and order queues.
Issue 1: New or existing products do not appear as pre-orders or backorders.
Possible Causes:
Item does not exist in the system
PO status is canceled
Item has Inventory in the system
Resolution Steps:
Status of PO items must be created or approved, ensuring canceled PO items are not considered for Pre-Order.
The promise date of a PO item must be in the future, guaranteeing that purchase order items will arrive in the future, not from an old PO.
The current inventory of the item must be 0, indicating it's out of stock and qualified for Pre-Order or backorder.
If the 'isNewProduct' field of a PO is marked as “yes”, it’s identified as a Pre-Order product; if marked “no”, it's categorized as a backorder product.
Products from purchase orders that don't meet these criteria won't be listed in HotWax Commerce's pre-order catalog. It's important to ensure that purchase order items adhere to these criteria for accurate listing.
Issue 2: Products are not removed from the pre-order or backorder category.
Resolution Steps:
Ensure all future inventory of pre-orders is received.
Ensure the Purchase Order status changes to “Canceled” or “Completed”.
Ensure the Purchase Order arrival date (promised fulfillment date) has passed.
There is no Return for any pre-order or backorder.
Job ID: JOB_PREORDER_CAT_SYC Job Name: Preorder catalog sync
Job ID: JOB_ADD_PREORD_VRT Job Name: Bulk Upload to add preorder tags to products
Description These jobs facilitate updates to the Presell catalog on Shopify, encapsulating all pre-order-related changes, including promised delivery dates, product categories, and statuses. This file is placed on a dedicated SFTP location. These jobs set the pre-order or backorder category in the meta fields to add the suitable tag to the parent product on Shopify.
Tagging as HC:Pre-order or HC:Backorder can be easily managed by enabling the checkbox for the Add pre-order tags and Add backorder tags jobs, which helps to employ tags and meta fields to modify the Add to Cart button and display the expected delivery date on Shopify PDP.
It is essential to click checkboxes to schedule the Remove Pre-order tags and Remove Backorder tags jobs to eliminate the HC: Pre-order and HC: Backorder tags when a product is removed from the pre-order catalog.
Add Promise Date check box is also to be selected to enable setting the expected delivery dates on the product on Shopify PDP
Issue 1: The product is not updated as a pre-order or a backorder at Shopify and PDP
Possible Causes:
PO status is canceled
PO has a past expected delivery date.
Items have available inventory in the system.
The generated file is not processed by Shopify and is lying unread at the specified SFTP location
Resolution Steps:
Status of PO items must be created or approved, ensuring canceled PO items are not considered for Pre-Order.
The promise date of a PO item must be in the future, guaranteeing that the purchase order item will arrive in the future, not from an old PO.
The current inventory of the item must be 0, indicating it's out of stock and qualified for Pre-Order or backorder.
If the 'isNewProduct' field of a PO is marked as “yes”, it’s identified as a Pre-Order product; if marked “no”, it's categorized as a backorder product.
Item is associated with the pre-order or backorder category.
Ensure the file is read and processed from the SFTP location.
Products from purchase orders that don't meet these criteria won't be listed in Shopify’s pre-order catalog. Contact the Shopify team if your product is still not listed on Shopify.
Job ID: JOB_UL_PRMS_DTE Job Name: Update promise dates for pre-order products.
When there are any changes in the arrival dates of the multiple items in the purchase orders, the promise dates need to be first updated in the HotWax Commerce pre-sell category. The Sync Variant Details job ensures that the expected date changes in the purchase order arrival date, and the promise dates of the product are also updated on Shopify. These changes happen through the Update Pre-Order Category Item Arrival Date job which creates a file and processes all the updated date changes in the HotWax Commerce category, after this, the Sync Variant Details updates the changes on Shopify.
Troubleshooting Use Case
Issue 1: The promise date of the Product is not updated on Shopify PDP.
Possible Causes:
PO status is canceled
Item does not exist anymore in the pre-order or backorder category.
Item has Inventory in the system.
The generated file is not processed by Shopify and is lying unread at specified SFTP location
Resolution Steps:
Status of PO items must be created or approved.
The promise date of a PO item must be in the future.
Ensure the current inventory of the item must be 0.
Ensure that the file is processed by Shopify from the SFTP location
To ensure accurate representation of pre-order information when pre-orders are downloaded alongside regular orders, specific notes or tags are included in incoming sales orders for easy identification of pre-orders. The job is scheduled by selecting the respective checkboxes while configuring the Pre-sell on the Shopify job from the Job Manager application.
Users are allowed to select multiple checkboxes to schedule various jobs in HotWax Commerce for managing sales orders with pre-order items more efficiently.
Description: These jobs assign pre-order/backorder tags to orders containing pre-selling items. This simplifies identification for the operations team. The job is scheduled by selecting the respective checkbox against the Add Pre-Order Tag or Add Backorder Tag. By default, the frequency will be scheduled just as specified for the Pre-sell on the Shopify job.
Description: These jobs will assign promise dates to sales orders, mirroring the dates provided to customers upon order placement for pre-order or backorder items. This job, when activated via checkbox, appends promise date notes to sales orders. By default, the frequency will be scheduled just as specified for the Pre-sell on the Shopify job.
Description: There might be multiple purchase Orders uploaded in HotWax Commerce. Once the active PO is exhausted, the subsequent PO gets active with a new arrival date. Sometimes, a new PO is introduced with an early arrival date, while the Item already has a specified promise date at Shopify PDP. In cases where promise dates change due to shifts in the arrival date of purchase orders, updates to the promise dates in sales orders are necessary. The Update promise date job updates the promise date notes of the sales orders. This job, when activated via checkbox, adds notes to the impacted order items on Shopify for changes in promise dates. By default, the frequency will be scheduled just as specified for the Pre-sell on the Shopify job.
Description: The ATP available on the purchase orders needs to be handled when exhausted or shifted from one PO to the other PO. Merchandisers frequently handle multiple Purchase Orders for identical SKUs. Sometimes, they might upload a new Purchase Order with an earlier promised date, even if there's an existing Purchase Order for the same SKU in the system. In such cases, re-allocating sales orders from the initial Purchase Order to the latest one with an earlier date becomes vital. This ensures that customers who place pre-orders first are given priority, guaranteeing timely delivery. The task automatically adjusts Purchase Order ATP allocations and reallocates pre-orders accordingly. To schedule this, users need to enable and set up the Adjust ATP on Early PO in Bulk by selecting the checkbox available in the More Jobs section.
Description: Merchants can change the promise dates in sales orders if there are any changes in the promise date due to arrival date changes in Purchase orders through this job. This job can be scheduled by checking the box against the job name Auto Sync Date to order, available in the job card Promise Date Changes. The frequency can be set as required from the available dropdown or can be customized.
Description: To efficiently manage customer expectations regarding changes in promised dates, activating the Email customers checkbox initiates a job that triggers automatic emails to customers. This action ensures customers are informed whenever there's a modification in the promised date since the job notifies customers of any changed promise dates for their orders.
Description: HotWax Commerce facilitates users to automatically handle the release and brokering of Shopify Pre-Orders, ensuring fulfillment from the most suitable location without requiring manual intervention. HC strategically organizes all pre-orders in a dedicated queue until their physical inventory is received. This approach ensures that brokering processes are not initiated for orders lacking available inventory. Once the pre-order inventory arrives, HotWax Commerce transfers all orders from the pre-order queue to the brokering queue. This allows the system's engine to efficiently match the most suitable inventory with specific orders for fulfillment.
Daily Job
Description: Merchandisers can schedule this job through the Job Manager Application from the Pre Order Page by enabling the Run Daily checkbox in the auto-releasing card. This automated process releases pre-orders where the shipping date has arrived and inventory is available in HotWax Commerce for release.
Discover how Inventory job works in HotWax Commerce.
Job Name: Upload Inventory
Job Enum ID: JOB\_UL\_INV
Description
The Upload Inventory
job is designed to facilitate the upload of new inventory levels to the eCommerce platform for all the products. This job is crucial for keeping product availability up-to-date and ensuring accurate inventory representation on the eCommerce platform.
Recommended Frequency
The job frequency can be configured based on the business needs and the desired frequency of updating inventory levels.
Custom Parameters
Parameter
Type
Description
Default Value
Example Value
includeAll
Optional
Specifies whether to include all inventory levels.
true
false
Webhooks can be subscribed to from the category pages within the Job Manager app for specific categories.
Automated messages sent from eCommerce (Shopify) to OMS whenever an event occurs. They contain data about the event and are received in OMS, allowing real time communication between eCommerce and OMS.
Subscribe to Shopify eCommerce Webhooks from OMS for:
Job Name: Import inventroy reset
Job Enum ID: JOB_IMP_INV
Description This job is useful in scenarios where there is a need to reset inventory levels to match actual physical counts. It is commonly used during inventory audits, adjustments, or when discrepancies are found in inventory records, ensuring the system's inventory matches the physical stock accurately.
Custom Parameters
Parameter
Type
Description
Default Value
configId
Required
Identifies the configuration for Order Item Attribute records.
RESET_INVENTORY
propertyResource
Required
Specifies the property resource for configuration.
FTP_CONFIG
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
groupBy
, facilityId
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
importPath
Optional
Specifies the SFTP location and path for importing the file.
Not specified
scheduleNow
Optional
Forces the system to pick the file out of sequence for immediate processing when importing files into the OMS. Enabled by default when importing files from FTP but can be disabled during high-volume syncs for system stability.
Not specified
createdByJobID
Optional
ID of the job that initiated this job.
Not specified
Job Name: Import Item Receipt
Job Enum ID: JOB_ITM_RECEIPT
Description
The Import Item Receipt
job updates inventory levels based on a file provided by NetSuite. The file, placed on the SFTP server, contains inventory deltas and other data. This job processes the file, retrieves the product IDs from NetSuite, and updates the corresponding inventory in HotWax for the specified facility, ensuring accurate records across systems.
Custom Parameters
Parameter
Type
Description
Default Value
configId
Required
Identifies the configuration for Order Item Attribute records.
IMP_ITM_RECEIPT
propertyResource
Required
Specifies the property resource for configuration.
FTP_CONFIG
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
importpath
Optional
Specifies the SFTP location and path for importing the file into the system.
Not specified
scheduleNow
Optional
When importing files into the OMS, forces the system to pick the file out of sequence for immediate processing. Enabled by default when importing files from FTP, but can be disabled during high-volume syncs for system stability.
Not specified
createdByJobID
Optional
ID of the job that initiated this job.
Not specified
Job Name: Import Product Thresholds
Job Enum ID: IMP\_PROD\_THOLD
Description
The Import Product Thresholds
job, identified by Job ID IMP\_PROD\_THOLD
, is designed to import a list of product thresholds based on specified tags and categories. This job is essential for updating product stock levels and ensuring that inventory management aligns with defined thresholds.
Recommended Frequency
The job frequency can be configured based on the business needs and the frequency of updates required for product thresholds.
Custom Parameters
Parameter
Type
Description
Default Value
Example Value
configId
String
Specifies the configuration ID for importing product thresholds.
IMP_PROD_THOLD
IMP_PROD_THOLD
propertyResource
Required
Specifies the property resource for configuring FTP.
FTP_CONFIG
FTP_CONFIG
configId
Required
Specifies the configuration ID for importing inbound shipments.
IMP_TO_SHPMNT
IMP_TO_SHPMNT
remoteFilename
Optional
Specifies the remote filename for the job.
Not specified
sample_file.txt
groupBy
Optional
Specifies the grouping parameter for the job.
Not specified
category
additionalParameters
Optional
Specifies additional parameters for customization.
Not specified
{ "param1": "value1", "param2": "value2" }
fileNameRegex
Optional
Specifies the regular expression for matching file names.
Not specified
*.csv
scheduleNow
Optional
Specifies whether to schedule the job for immediate processing.
false
true
Job Name: Import product facility from FTP
Job Enum ID: JOB_IMP_PROD_FAC
Description
The Import Product Facility
job is used in scenarios where product data needs to be imported or updated for specific facilities. It is particularly useful for integrating or synchronizing product data from ERP or during system migrations.
Custom Parameters
Parameter
Type
Description
Default Value
configID
Required
Identifies the configuration for product facility.
IMP_PROD_FACILITY
propertyResources
Required
Specifies the property resource for configuration.
FTP_CONFIG
remoteFilename
Optional
Specifies the remote filename for processing.
Not Specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not Specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
importPath
Optional
Specifies the SFTP location and path for importing the file into the system.
Not Specified
scheduleNow
Optional
When importing files into the OMS, forces the system to pick the file out of sequence for immediate processing. Enabled by default when importing files from FTP, but can be disabled during high-volume syncs for system stability.
Not specified
createdByJobID
Optional
ID of the job that initiated this job.
Not specified
Job Name: Export Product Thresholds
Job Enum ID: EXP\_PROD\_THOLD
Description
The Export Product Thresholds
job is designed to export a list of product thresholds based on specified tags and categories. This job is essential for obtaining insights into product stock levels and ensuring inventory management aligns with defined thresholds.
Recommended Frequency The job frequency can be configured based on the business needs and the frequency of updates required for product thresholds.
Custom Parameters
Parameter
Type
Description
Default Value
Example Value
facilityId
String
Specifies the facility ID for exporting product thresholds.
null
FCTY-001
propertyResource
String
Specifies the property resource for configuring FTP export.
FTP_EXP_CONFIG
FTP_EXP_CONFIG
threshold
String
Specifies the threshold value for exporting products.
null
10 units
includeAll
Boolean
Specifies whether to include all products in the export.
null
true
searchPreferenceId
String
Specifies the search preference ID for customizing product search.
null
SEARCH_PREF_001
Job Name: Bulk Recent Kit Product Inventory Setup
Job Enum ID: BLK_RCNT_KIT_INV
Description
The Bulk Recent Kit Product Inventory Setup
job facilitates the configuration of inventory for newly added kit products in bulk. This job streamlines the setup process, ensuring that inventory levels for kit products are accurately computed in HotWax Commerce and synced with Shopify.
Custom Parameters
Parameter
Type
Description
Default Value
includeAll
Optional
Specifies whether to include all inventory levels.
Not Specified
Job Name: Import Inventory Transfer
Job Enum ID: JOB_INV_TRANS
Description This job synchronizes inventory transfer deltas between warehouses and HotWax. Whenever a transfer is received in the warehouse, this job updates the inventory delta in HotWax, ensuring accurate and consistent inventory levels across both the ERP and OMS systems.
Custom Parameters
Parameter
Type
Description
Default Value
configId
Required
Identifies the configuration for Order Item Attribute records.
IMP_INV_TRANS
propertyResource
Required
Specifies the property resource for configuration.
FTP_CONFIG
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
importpath
Optional
Specifies the SFTP location and path for importing the file into the system.
Not specified
scheduleNow
Optional
When importing files into the OMS, forces the system to pick the file out of sequence for immediate processing. Enabled by default when importing files from FTP, but can be disabled during high-volume syncs for system stability.
Not specified
createdByJobID
Optional
ID of the job that initiated this job.
Not specified
Job Name: Import Inbound Shipment
Job Enum ID: JOB\_IMP\_TO\_SHPMNT
Description
The Import Inbound Shipment
job is designed to import information about inbound shipments associated with fulfilled transfer orders. This job is crucial for maintaining accurate records of incoming shipments, facilitating efficient order fulfillment.
Recommended Frequency
The job frequency can be configured based on the business needs and the frequency of inbound shipments for fulfilled transfer orders.
Custom Parameters
Parameter
Type
Description
Default Value
Example Value
propertyResource
Required
Specifies the property resource for configuring FTP.
FTP_CONFIG
FTP_CONFIG
configId
Required
Specifies the configuration ID for importing inbound shipments.
IMP_TO_SHPMNT
IMP_TO_SHPMNT
remoteFilename
Optional
Specifies the remote filename for the job.
Not specified
sample_file.txt
groupBy
Optional
Specifies the grouping parameter for the job.
Not specified
category
additionalParameters
Optional
Specifies additional parameters for customization.
Not specified
{ "param1": "value1", "param2": "value2" }
fileNameRegex
Optional
Specifies the regular expression for matching file names.
Not specified
*.csv
scheduleNow
Optional
Specifies whether to schedule the job for immediate processing.
false
true
Job Name: Scheduled Restock
Job Enum ID: JOB_SCHEDULED_RSTK
Description This job is particularly useful in scenarios where a business needs to manage inventory for incoming shipments and ensure that their eCommerce platform (Shopify) is updated accordingly. Some potential use cases include:
Warehouse Operations: When a warehouse receives a shipment from a supplier, this function can automate the process of updating inventory levels and ensuring that the online store reflects accurate stock availability.
Inventory Management: For businesses that manage inventory across multiple locations or platforms, this function helps maintain consistency between the internal inventory system and Shopify.
Order Fulfillment: By ensuring that inventory levels are accurately updated in Shopify, the function helps prevent overselling and ensures that customers have access to real-time stock information.
Custom Parameters
Parameter
Type
Description
Default Value
shipmentId
Required
Specific Id to uniquely Identify each shipment
Not Specified
limit
Optional
Additional parameters for job customization.
Not Specified
Job Enum ID: JOB\_IMP\_INV
Job Name: Import Inventory
Description
The Import Inventory
job is designed to import inventory from the ERP (Enterprise Resource Planning) system. This job plays a crucial role in keeping the inventory information synchronized between the ERP and the OMS.
Recommended Frequency
The job frequency can be configured based on the business needs and the frequency of updates from the ERP system.
Custom Parameters
Parameter
Type
Description
Default Value
Example Value
propertyResource
Required
Specifies the property resource for configuring FTP.
FTP_CONFIG
FTP_CONFIG
fileNameRegex
Optional
Specifies the regular expression for matching file names.
*.csv
*.csv
configId
Required
Specifies the configuration ID for importing inventory.
RESET_INVENTORY
RESET_INVENTORY
remoteFilename
Optional
Specifies the remote filename for the job.
Not specified
sample_file.txt
groupBy
Optional
Specifies the grouping parameter for inventory.
facilityId
facilityId
locationSeqId
Optional
Specifies the location sequence ID for inventory import.
TLTLTLLL01
TLTLTLLL01
additionalParameters
Optional
Specifies additional parameters for customization.
Not specified
{ "param1": "value1", "param2": "value2" }
fileNameRegex
Optional
Specifies the regular expression for matching file names.
Not specified
*.csv
scheduleNow
Optional
Specifies whether to schedule the job for immediate processing.
false
true
Job Name: Sync Inventory From Shopify
Job Enum ID: JOB_SYNC_INV_FRM_SHPY
Description In the realm of inventory synchronization between HotWax Commerce and Shopify, typically, HotWax Commerce handles the updates to inventory data on Shopify. However, in specific scenarios, the Order Management System (OMS) sync inventory from Shopify. When there's a recent alteration in inventory, this task ensures that the inventory data is promptly updated from Shopify.
Custom Parameters
Parameter
Type
Description
Default Value
includeAll
Optional
Specifies whether to include all inventory levels.
True
frequency
Optional
Defines the default duration for syncing orders if there is no last sync time.
15 minutes
buffertime
Optional
Specifies the buffer time (in minutes) for scheduling job downloads.
5 minutes
scheduleNow
Optional
When importing files into the OMS, forces the system to pick the file out of sequence for immediate processing. Enabled by default when importing files from FTP, but can be disabled during high-volume syncs for system stability.
Enabled
Job Enum ID: SYNC\_INV\_SHPF\_MLTTHD
Job Name: Sync Inventory From Shopify in Multi-Threading
Description
The Sync Inventory From Shopify in Multi-Threading
job is designed to synchronize inventory from Shopify, utilizing multi-threading for enhanced efficiency. This job is crucial for maintaining accurate inventory levels and ensuring seamless integration with the Shopify platform.
Recommended Frequency
The job frequency can be configured based on the business needs and the frequency of updates required for inventory synchronization.
Custom Parameters
Parameter
Type
Description
Default Value
Example Value
propertyResource
String
Specifies the property resource for configuring FTP synchronization.
FTP_CONFIG
FTP_CONFIG
fileNameRegex
String
Specifies the regular expression for matching file names during synchronization.
*.csv
*.csv
configId
String
Specifies the configuration ID for the multi-threaded inventory synchronization.
SYNC_INV_SHPF_MLTTHD
SYNC_INV_SHPF_MLTTHD
groupBy
String
Specifies the grouping parameter for multi-threading, such as location_id
.
Not specified
location_id
additionalParameters
Optional
Specifies additional parameters for customization.
Not specified
{ "param1": "value1", "param2": "value2" }
remoteFilename
Optional
Specifies the remote filename for the job.
Not specified
sample_file.txt
scheduleNow
Optional
Specifies whether to schedule the job for immediate processing.
false
true
Job ID: UL\_RCNT\_INV
Job Name: Upload Recent Inventory Changes
Description
The Upload recent inventory changes
job examines the inventory records of HotWax Commerce's products. It identifies products that have undergone inventory changes since the last synchronization.
To update inventory records, HotWax Commerce initiates an API call to retrieve information from Shopify about products that have undergone changes in HotWax Commerce. The inventory counts for these products in Shopify are then compared with the inventory counts that HotWax Commerce has on file.
After comparing inventory changes, the Upload recent inventory changes
job records the difference and generates a GraphQL file for the affected products. This file is then uploaded to Shopify, which reads it and updates the available adjustments
field to either add or deduct inventory based on the changes.
Recommended Frequency The recommended frequency for this job is 15 minutes, but it can be configured based on the business needs and the desired frequency of updating inventory levels.
Custom Parameters
Parameter
Type
Description
Default Value
facilityGroupID
Required
Specifies which facilitygroup to be
FAC_GRP
includeAll
Optional
Specifies whether to include all inventory levels.
true
Learn about the Products job in HotWax Commerce.
Job Name: Import New Products
Job Enum ID: JOB\_IMP\_PROD\_NEW
Description
The Import New Products job is designed to import new products from eCommerce or Product Information Management systems. This job is crucial for keeping your product catalog updated with the latest additions and ensuring accurate representation on your platform.
Recommended Frequency
The job frequency is set to run every 15 minutes by default. You may adjust this frequency based on the frequency of new product additions and the desired update interval for your product catalog.
Custom Parameters
Job Name: Import Product Updates
Job Enum ID: JOB\_IMP\_PROD\_UPD
Description
The Import Product Updates job is designed to update existing products from eCommerce or Product Information Management (PIM) systems. This job ensures that your product information stays current and reflects any changes made in the source system.
Recommended Frequency
The job frequency is set to run every 15 minutes by default. Adjust the frequency based on the update frequency of your product data in the eCommerce or PIM system.
Custom Parameters
Webhooks can be subscribed to from the category pages within the Job Manager app for specific categories.
Automated messages sent from eCommerce (Shopify) to OMS whenever an event occurs. They contain data about the event and are received in OMS, allowing real time communication between eCommerce and OMS.
Subscribe to Shopify eCommerce Webhooks from OMS for:
Job Name: Import kit components
Job Enum ID: IMP\_KIT\_METAFIELD
Description
The Import Kit Product Components
job is specifically designed to import components of kit products from an external system. This job ensures that kit product components are accurately reflected in the Order Management System (OMS).
Recommended Frequency
The frequency of running this job depends on the frequency of updates or changes to kit product components. It is recommended to run this job as needed based on changes in the external system.
Custom Parameters
Job Name: Import Promo Code
Job Enum ID: JOB\_IMP\_PRMO\_CODE
Description
The Import Promo Code
job is designed to import promotional codes into the system. This job is essential for managing and updating promotional offers on your platform.
Recommended Frequency
The frequency for running this job depends on the frequency of updates to your promotional codes. Adjust the frequency accordingly to ensure timely and accurate updates.
Custom Parameters
Job Name: Product Identification
Job Enum ID: JOB\_PROD\_IDENT
Description
The Product Identification
job, identified by Job ID JOB_PROD_IDENT, is designed to create or update GoodIdentification records for products. This job is crucial for maintaining accurate identification and synchronization of product information across systems.
Recommended Frequency
The frequency for running this job depends on the frequency of updates to product identifications. Adjust the frequency accordingly to ensure timely and accurate updates.
Custom Parameters
Job Name: Activate products on Shopify
Job Enum ID: JOB_ACT_PROD_SHPFY
Description
The Activate Products on Shopify
job synchronizes activated products, such as gift cards, from HotWax Commerce to Shopify. Gift cards, as stored-value products, must be activated to ensure customers can redeem them upon receipt. This job ensures that once gift cards are activated in HotWax Commerce, the activation codes are automatically synced to Shopify, making them immediately redeemable for customers.
Custom Parameters
Job Name: Associate products with sub catalog
Job Enum ID: JOB\_UPD\_PROD\_ASSOC
Description
The job identified by Job ID JOB_UPD_PROD_ASSOC
is specifically crafted to link products within a child product catalog (typically a non-master catalog) with those in the master product catalog in OMS. This process is vital for ensuring accurate product associations across multiple Shopify stores utilizing the same product catalog, thereby enhancing consistency in the system.
Recommended Frequency
The recommended frequency for running this job is every 60 minutes. Adjust the frequency based on the frequency of updates or changes to product associations.
Custom Parameters
Job Name: Remove Promo Code
Job Enum ID: JOB\_RMV\_PRMO\_CODE
Description
The Remove Promo Code job, identified by Job ID JOB_RMV_PRMO_CODE, is designed to remove promotional codes from the system. This job is crucial for maintaining an accurate and up-to-date list of active promotional offers on your platform.
Recommended Frequency
The frequency for running this job depends on the removal frequency of your promotional codes. Adjust the frequency accordingly to ensure timely and accurate removals.
Custom Parameters
RunTime
String
Specifies the Runtime scheduled for a job, which can be customized.
null
April 17, 2024, 1:15 PM
Schedule Frequency
String
Schedules frequency from the dropdown as every 5 minutes, Hourly, Daily, Weekly, etc. which can be customized as required.
Daily Once
11:30:00:00 AM
RunTime
String
Specifies the Runtime scheduled for a job, which can be customized.
null
April 17, 2024, 1:15 PM
Schedule Frequency
String
Schedules frequency from the dropdown as every 5 minutes, Hourly, Daily, Weekly, etc.
Daily Once
23:59:00:00 PM
RunTime
String
Specifies the Runtime scheduled for a job, which can be customized.
null
April 17, 2024, 1:15 PM
Schedule Frequency
String
Schedules frequency from the dropdown as every 5 minutes, Hourly, Daily, Weekly, etc. which can be customized as required.
15 Minutes
Every 15 minutes
RunTime
String
Specifies the Runtime scheduled for a job, which can be customized.
null
April 17, 2024, 1:15 PM
Schedule Frequency
String
Schedules frequency from the dropdown as every 5 minutes, Hourly, Daily, Weekly, etc. which can be customized as required.
15 Minutes
Every 15 Minutes
RunTime
String
Specifies the Runtime scheduled for a job, which can be customized.
null
April 17, 2024, 1:15 PM
Schedule Frequency
String
Schedules frequency from the dropdown as every 5 minutes, Hourly, Daily, Weekly, etc. which can be customized as required.
15 Minutes
Every 15 Minutes
RunTime
String
Specifies the Runtime scheduled for a job, which can be customized.
null
April 17, 2024, 1:15 PM
Schedule Frequency
String
Schedules frequency from the dropdown as every 5 minutes, Hourly, Daily, Weekly, etc. which can be customized as required.
Every Hour
Hourly
RunTime
String
Specifies the Runtime scheduled for a job, which can be customized.
null
April 17, 2024, 1:15 PM
Schedule Frequency
String
Schedules frequency from the dropdown as every 5 minutes, Hourly, Daily, Weekly, etc. which can be customized as required.
Every Hour
Hourly
RunTime
String
Specifies the Runtime scheduled for a job, which can be customized.
null
April 17, 2024, 1:15 PM
Schedule Frequency
String
Schedules frequency from the dropdown as every 5 minutes, Hourly, Daily, Weekly, etc. which can be customized as required.
15 Minutes
Every 15 Minutes
RunTime
String
Specifies the Runtime scheduled for a job, which can be customized.
null
April 17, 2024, 7:15 AM
Schedule Frequency
String
Schedules frequency from the dropdown as every 5 minutes, Hourly, Daily, Weekly, etc. which can be customized as required.
Daily Once
Every Day
Parameter
Type
Description
Default Value
Example Value
shopifyConfigId
String
Specifies the configuration ID for Shopify, if applicable.
null
SHOP_CONFIG_001
limit
Integer
Sets a limit on the number of products to import per job run.
100
50
frequency
Integer
Defines the default duration for syncing products if there is no Last Sync Time
.
15 minutes
10 minutes
bufferTime
Integer
Specifies the buffer time (in minutes) for scheduling job downloads.
Not specified
5
scheduleNow
Boolean
When set to true, forces the system to pick the file out of sequence for immediate processing.
false
true
Parameter
Type
Description
Default Value
Example Value
shopifyConfigId
String
Specifies the configuration ID for Shopify.
null
SHOPIFY_CONFIG_001
configId
String
Specifies the configuration ID for importing kit product components.
BULK_IMP_VARIANTS_MF
KIT_COMP_IMPORT_CONFIG
productVariantsQuery
String
Specifies the query to identify kit products.
product_type: Kit
category: Bundle
namespaces
String
Specifies the namespaces for kit product components.
bundles_app
kit_components
Parameter
Type
Description
Default Value
Example Value
propertyResource
String
Specifies the property resource for the FTP configuration.
FTP_CONFIG
SFTP_CONFIG_001
configId
String
Specifies the configuration ID for importing promo codes.
IMP_PRMO_CODE
PROMO_CONFIG_001
fileNameRegex
String
Specifies the regular expression for matching file names during synchronization.
*.csv
*.csv
groupBy
String
Specifies the grouping parameter for multi-threading, such as location_id
.
Not specified
location_id
additionalParameters
Optional
Specifies additional parameters for customization.
Not specified
{ "param1": "value1", "param2": "value2" }
remoteFilename
Optional
Specifies the remote filename for the job.
Not specified
sample_file.txt
scheduleNow
Optional
Specifies whether to schedule the job for immediate processing.
false
true
Parameter
Type
Description
Default Value
Example Value
propertyResource
String
Specifies the property resource for the FTP configuration.
FTP_CONFIG
SFTP_CONFIG_001
configId
String
Specifies the configuration ID for importing product identifications.
IMP_PROD_IDENT
PROD_IDENT_CONFIG_001
additionalParameters.idType
String
Specifies the type of identification used (e.g., SHOPIFY_PROD_ID).
Not specified
SHOPIFY_PROD_ID
additionalParameters.goodIdentificationTypeId
String
Specifies the type of GoodIdentification (e.g., NETSUITE_PRODUCT_ID).
Not specified
NETSUITE_PRODUCT_ID
groupBy
String
Specifies the grouping parameter for multi-threading, such as location_id
.
Not specified
location_id
remoteFilename
Optional
Specifies the remote filename for the job.
Not specified
sample_file.txt
groupBy
String
Specifies the grouping parameter for multi-threading, such as location_id
.
Not specified
location_id
Parameter
Type
Description
Default Value
facilityids
Optional
Identifies the configuration for Order Item Attribute records.
Not specified
productId
Optional
Specifies the property resource for configuration.
Not specified
idType
Optional
Specifies the remote filename for processing.
Not specified
iDValue
Optional
Specifies a grouping parameter for the job.
Not specified
limit
Optional
Additional parameters for job customization.
Not specified
Parameter
Type
Description
Default Value
Example Value
configId
String
Specifies the configuration ID for updating product associations.
IMP_SHPFY_SHOP_PROD
ASSOC_PROD_CONFIG_001
frequency
Integer
Specifies the frequency (in minutes) for running the job.
60
30
limit
Optional
Sets a limit on the order import job, restricting the number of orders fetched from eCommerce.
Not specified
100
bufferTime
Optional
Ensures orders are not imported until they have aged past a desired duration, accommodating post-processing workflows in eCommerce platforms.
Not specified
30 minutes
scheduleNow
Optional
When importing files into the OMS, force the system to pick the file out of sequence for immediate processing. Enabled by default when importing files from FTP, but can be disabled during high-volume syncs for system stability.
Enabled
false
Parameter
Type
Description
Default Value
Example Value
propertyResource
String
Specifies the property resource for the FTP configuration.
FTP_CONFIG
SFTP_CONFIG_001
configId
String
Specifies the configuration ID for removing promo codes.
IMP_RMV_PRMO_CODE
PROMO_CONFIG_002
fileNameRegex
String
Specifies the regular expression for matching file names during synchronization.
*.csv
*.csv
groupBy
String
Specifies the grouping parameter for multi-threading, such as location_id
.
Not specified
location_id
additionalParameters
Optional
Specifies additional parameters for customization.
Not specified
{ "param1": "value1", "param2": "value2" }
remoteFilename
Optional
Specifies the remote filename for the job.
Not specified
sample_file.txt
scheduleNow
Optional
Specifies whether to schedule the job for immediate processing.
false
true
Parameter
Type
Description
Default Value
Example Value
shopifyConfigId
String
Specifies the configuration ID for Shopify, if applicable.
null
SHOP_CONFIG_001
limit
Integer
Sets a limit on the number of products to import per job run.
100
50
frequency
Integer
Defines the default duration for syncing products if there is no Last Sync Time
.
15 minutes
10 minutes
bufferTime
Integer
Specifies the buffer time (in minutes) for scheduling job downloads.
Not specified
5
scheduleNow
Boolean
When set to true, forces the system to pick the file out of sequence for immediate processing.
false
true
Learn about the Fulfillment jobs in HotWax Commerce.
Job name: Ship packed orders Job Enum ID: JOB_SHIP_ORD_PKD
Description
The Ship Packed Orders Job is activated in the Job Manager App, orders will be automatically marked as shipped. Ensure to enable the isTrackingRequired
setting on shipping methods to prevent automatic shipment for methods without tracking codes. However, note that this setting does not directly apply to the orders being shipped. To streamline order shipping in HotWax Commerce, navigate to the Completed tab and select the Ship Orders function to bulk mark them as shipped.
No custom parameters for this job
Job Name: Order Fulfillment History
Job Enum ID: JOB_ORD_FLMNT_HST
Description
The order fulfillment history job within HotWax Commerce is a crucial component of the system's functionality. It involves the creation or updating of records related to order fulfillment, which typically includes tasks such as processing orders, tracking inventory, and managing shipping and delivery. This job ensures that accurate and up-to-date information regarding order fulfillment is maintained within the system, enabling efficient handling of customer orders and timely delivery of products. By integrating with FTP (File Transfer Protocol), the job can securely access and exchange data, enhancing the automation and reliability of the order fulfillment process. Overall, this job plays a vital role in optimizing the operational efficiency and customer satisfaction of HotWax Commerce-powered businesses.
Custom Parameters
configID
Required
Identifies the configuration for Order Item Attribute records.
MDM_UPD_ORD_FMNT_HST
propertyResources
Required
Specifies the property resource for configuration.
FTP_CONFIG
remoteFilename
Optional
Specifies the remote filename for processing.
Not specified
groupBy
Optional
Specifies a grouping parameter for the job.
Not specified
additionalParameters
Optional
Additional parameters for job customization.
Not specified
fileNameRegex
Optional
Specifies a regular expression for filtering filenames.
Not specified
importPath
Optional
Specifies the SFTP location and path for importing the file into the system.
Not specified
scheduleNow
Optional
When importing files into the OMS, forces the system to pick the file out of sequence for immediate processing. Enabled by default when importing files from FTP, but can be disabled during high-volume syncs for system stability.
Enabled
Job Name: Open BOPIS Order Notification
Job Enum ID: JOB_OPN_BOPIS_ORD_NT
To send an Open BOPIS order notification HotWax Commerce sends a notification for open and ready-to-pickup orders. In the Job Manager app, navigate to the fulfillment page, and click on the Open BOPIS order notification button. An extended menu will appear on the right allowing selection of the run time and scheduling preferences. Save the settings to regulate the frequency of the notifications.
No custom parameter for this job
Job Name: Ready to Pick BOPIS Order Notification
Job Enum ID: JOB_RP_BOPIS_ORD_NT
The Ready to Pick BOPIS Order Notification
job sends a notification to the customer once their Buy Online, Pick Up In Store (BOPIS) order is packed and ready for pickup, ensuring timely communication about the order's availability for collection.
Custom Parameters
topicEnumId
Required
This is used to represent a unique identifier for an enumerated value related to a topic or subject.
READYPICK_BOPIS_ODR
Job Name: Open Shipping Order Notification
Job Enum ID: JOB_OPEN_SHIP_ORD_NT
Description The Open Shipping Order Notification
job notifies store associates whenever an open order is received. This ensures that store associates are promptly alerted to new orders, enabling them to begin the fulfillment process without delay.
Custom Parameters
topicEnumId
Required
This is used to represent a unique identifier for an enumerated value related to a topic or subject.
OPEN_SHIPPING_ODR
Job Name: Auto Cancellations
Description
Orders that remain unfulfilled beyond their auto-cancellation date will be automatically canceled within HotWax Commerce. Additionally, if the upload for canceled orders is enabled, these orders will also be canceled in Shopify.
No custom parameters for this job
Job Name: Notification using communication events
Job Enum ID: JOB_SND_ML_COMM
Description The Notification Using Communication Events
job enables retailers to communicate to internal users by the help of the communication event feature on the view order page. This job ensures that internal teams are promptly alerted to important events for that particular order, facilitating efficient communication within the organization.
No custom parameters for this job
Job Name: Packed BOPIS Order Reminder Notification
Description The Packed BOPIS Order Reminder Notification
job sends a reminder notification to customers informing them that their Buy Online, Pick Up In Store (BOPIS) order has been packed and is ready for pickup. This reminder is sent every 7 days, up to 3 times, ensuring the customer is informed and reminded to collect their order.
Custom Parameters
intervalDays
Optional
Number of days between each reminder
7
maxOccurrences
Optional
Maximum number of occurrences of the reminder
3
emailType
Optional
Specific type of email template to use for a notification
PRDS_READY_TO_PICKUP