Inventory
Discover how Inventory job works in HotWax Commerce.
Last updated
Discover how Inventory job works in HotWax Commerce.
Last updated
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Parameter
Type
Description
Default Value
includeAll
Optional
Specifies whether to include all inventory levels.
Not Specified
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
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
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
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
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
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
Parameter
Type
Description
Default Value
facilityGroupID
Required
Specifies which facilitygroup to be
FAC_GRP
includeAll
Optional
Specifies whether to include all inventory levels.
true
Parameter
Type
Description
Default Value
Example Value
includeAll
Optional
Specifies whether to include all inventory levels.
true
false
