Orders
Explore job workflows for importing various types of orders into OMS.
Shopify
Import Orders
Job Enum ID: JOB_IMP_ORD
Job Name: Import Orders
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.
Common Troubleshooting Use Cases
The Import Orders job is primarily used for the regular flow of orders and is not commonly employed for troubleshooting. Custom parameter descriptions may provide insights into how the job can be adapted for different use cases.
Custom Parameters
Parameter | Type | Description | Default Value | Example Value |
| Required | Defines the default duration for syncing orders if there is no | 15 minutes | 10 |
| Optional | Sets a limit on the order import job, restricting the number of orders fetched from eCommerce. | Not specified | 100 |
| Optional | Ensures orders are not imported until they have aged past a desired duration, accommodating post-processing workflows in eCommerce platforms. | 5 minutes | 30 minutes |
| Optional | Skips Shopify orders created within the specified time interval. For example, if | 2 minutes | 1 minute |
| 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 | false |
Import Order Updates from Shopify
Job Enum ID: JOB_IMP_ORD_UPD
Job Name: Import Order Updates from Shopify
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.
Common troubleshooting Use Case
Issue 1: Order Updates Not Reflecting in HotWax Commerce
Possible Causes: Job Frequency
Resolution Steps Review the frequency parameter to ensure it aligns with the intended import frequency. Occasional delays may occur in the immediate reflection of order updates when the frequency is set high.
Custom Parameters
Parameter | Type | Description | Default Value | Example Value |
| Required | Defines the default duration for syncing orders if there is no | 60 minutes | 10 |
| Optional | Ensures orders are not imported until they have aged past a desired duration, accommodating post-processing workflows in Shopify. | Not specified | 15 minutes |
Import Canceled Items
Job ID: JOB_IMP_ITM_CNCL
Job Name: Import Canceled Items
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.
Troubleshooting Use Case
Issue: Cancelled Order item Not Reflecting in HotWax Commerce
Possible Causes: Job Frequency
Resolution Steps Review the frequency parameter to ensure it aligns with the intended import frequency. Occasional delays may occur in the immediate reflection of order updates when the frequency is set high.
Custom Parameters
Parameter | Type | Description | Default Value | Example Value |
| Required | Defines the default duration for syncing orders if there is no | 15 minutes | 10 |
| Optional | Ensures orders are not imported until they have aged past a desired duration, accommodating post-processing workflows in Shopify. | Not specified | 5 minutes |
Import Order Returns
Job ID: JOB_IMP_RTN
Job Name: Import Order Returns
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 facilitates swift updates within HotWax Commerce.
Troubleshooting Use Case
Issue 1: Orders marked as returned on the eCommerce platform are not creating return transactions in HotWax Commerce
Possible Causes: Job Frequency
Resolution steps: Review the frequency parameter to ensure it aligns with the intended frequency for checking and creating return transactions. Lower frequencies might result in delays in processing returns.
Issue 2: Damaged variances are not being logged as expected
Possible Causes: Restock Inventory Configurations
Resolution steps: Verify that the return handling settings allow for restocking of returnable items.
Custom Parameters
Parameter | Type | Description | Default Value | Example Value |
| Required | Defines the default duration for syncing orders if there is no | 15 minutes | 10 |
| Optional | Ensures orders are not imported until they have aged past a desired duration, accommodating post-processing workflows in Shopify. | Not specified | 30 minutes |
| Optional | Specifies the financial status of orders. | Not specified |
|
| Optional | Sets a limit on the order import job, restricting the number of orders fetched from eCommerce. | Not specified | 100 |
Upload Completed Orders
Job ID: JOB_UL_CMPLT_ORD
Job Name: Upload Completed Orders
Description
The Upload Completed Orders job is designed to update the order status of fulfilled orders to the eCommerce platform. This ensures that the eCommerce platform accurately reflects the current status of orders that have been successfully fulfilled by OMS.
Recommended frequency
The job is configured to run at a frequency that suits the needs of your business, ensuring timely updates for fulfilled orders.
Troubleshooting Use Case
Issue 1: Orders are not updating their status on the eCommerce platform after being fulfilled.
Possible Causes: Job Frequency
Resolution Steps: Review the frequency parameter to ensure it aligns with the intended frequency for updating the order status. Lower frequencies might result in delays in processing fulfillment.
Custom Parameters
Parameter | Type | Description | Default Value | Example Value |
| Required | The ID associated with the shipment to track and update orders. | Not specified | "SH123456" |
| Required | The ID associated with the order to be updated on the eCommerce platform. | Not specified | "ORD789012" |
| Required | The timestamp associated with the creation of shipments. | Not specified | "1649883480000" |
Order Item Attribute
Job ID: JOB_ORDER_ITM_ATTR
Job Name: Order Item Attribute
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.
Troubleshooting Use Case
Issue 1: Order Item Attributes are not being created or updated as expected.
Possible Causes: Configuration or Data Issues
Resolution Steps:
Review the
propertyResourceparameter to ensure it is correctly set to FTP_CONFIG.Verify that the
configIdparameter is set to IMP_ORDER_ITM_ATTR for the intended configuration.
Custom Parameters
Parameter | Type | Description | Default Value | Example Value |
| Required | Specifies the property resource for configuration. | Not specified | FTP_CONFIG |
| Required | Identifies the configuration for Order Item Attribute records. | Not specified | IMP_ORDER_ITM_ATTR |
| Optional | Specifies the remote filename for processing. | Not specified | Order_Attribute.csv |
| Optional | Specifies a grouping parameter for the job. | Not specified | AttributeType |
| Optional | Additional parameters for job customization. | Not specified | param1=value1,param2=value2 |
| Optional | Specifies a regular expression for filtering filenames. | Not specified | ^OrderAttr_\d+.csv$ |
| 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 | false |
Approve Sales Order
Job ID: JOB_APR_SALES_ORD
Job Name: Approve Sales Order
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.
Troubleshooting Use Case
Issue 1: Sales orders are not being approved as expected.
Possible Causes: Configuration or Authorization Issues
Resolution Steps:
Review the
propertyResourceparameter to ensure it is correctly set to FTP_CONFIG.Verify that the
configIdparameter is set to IMP_APR_SALES_ORD for the intended configuration.
Custom Parameters
Parameter | Type | Description | Default Value | Example Value |
| Required | Specifies the property resource for configuration. | Not specified | FTP_CONFIG |
| Required | Identifies the configuration for Order Item Attribute records. | Not specified | IMP_APR_SALES_ORD |
| Optional | Specifies the remote filename for processing. | Not specified | Order_Attribute.csv |
| Optional | Specifies a grouping parameter for the job. | Not specified | AttributeType |
| Optional | Additional parameters for job customization. | Not specified | param1=value1,param2=value2 |
| Optional | Specifies a regular expression for filtering filenames. | Not specified | ^OrderAttr_\d+.csv$ |
| 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 | false |
Import Order Attribute
Job ID: JOB_MOD_ORD_ATTR
Job Name: Import Order Attribute
Description
The Import Order Attribute job is designed to import order attributes from an SFTP location into the OMS. This job ensures that order attributes are updated and synchronized with the latest information.
Recommended frequency
The job is configured to run at a frequency that suits the business needs for regular updates of order attributes.
Troubleshooting Use Case
Issue 1: Order attributes are not being imported as expected.
Possible Causes: Configuration or Connectivity Issues
Resolution Steps:
Review the
propertyResourceparameter to ensure it is correctly set to FTP_CONFIG.Verify that the
configIdparameter is set to MOD_ORD_ATTR for the intended configuration.Check for any connectivity issues between the system and the specified SFTP location.
Custom Parameters
Parameter | Type | Description | Default Value | Example Value |
| Required | Specifies the property resource for configuration. | Not specified | FTP_CONFIG |
| Required | Identifies the configuration for importing order attributes. | Not specified | MOD_ORD_ATTR |
| Optional | Specifies the remote filename for processing. | Not specified | Order_Attribute.csv |
| Optional | Specifies a grouping parameter for the job. | Not specified | AttributeType |
| Optional | Additional parameters for job customization. | Not specified | param1=value1,param2=value2 |
| Optional | Specifies a regular expression for filtering filenames. | Not specified | ^OrderAttr_\d+.csv$ |
| 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 | false |
Order Identification
Job ID: JOB_ORDER_IDENT
Job Name: Order Identification
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.
Troubleshooting Use Case
Issue 1: Order identification records are not being created or updated as expected.
Possible Causes: Configuration or Data Issues
Resolution Steps:
Review the
propertyResourceparameter to ensure it is correctly set to FTP_CONFIG.Verify that the
configIdparameter is set to IMP_ORDER_IDENT for the intended configuration.
Custom Parameters
Parameter | Type | Description | Default Value | Example Value |
| Required | Specifies the property resource for configuration. | Not specified | FTP_CONFIG |
| Required | Identifies the configuration for importing order attributes. | Not specified | IMP_ORDER_IDENT |
| Optional | Specifies the remote filename for processing. | Not specified | Order_Attribute.csv |
| Optional | Specifies a grouping parameter for the job. | Not specified | AttributeType |
| Optional | Additional parameters for job customization. | Not specified | param1=value1,param2=value2 |
| Optional | Specifies a regular expression for filtering filenames. | Not specified | ^OrderAttr_\d+.csv$ |
| 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 | false |
Order Item Fulfillment
Job ID: JOB_ODR_ITM_FLFLMNT
Job Name: Order Item Fulfillment
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.
Troubleshooting Use Case
Issue 1: Order item fulfillment is not completing as expected.
Possible Causes: Configuration or Data Issues
Resolution Steps:
Review the
propertyResourceparameter to ensure it is correctly set to FTP_CONFIG.Verify that the
configIdparameter is set to IMP_ODR_ITM_FLFLMNT for the intended configuration.
Custom Parameters
Parameter | Type | Description | Default Value | Example Value |
| Required | Specifies the property resource for configuration. | Not specified | FTP_CONFIG |
| Required | Identifies the configuration for importing order attributes. | Not specified | ODR_ITM_FLFLMNT |
| Optional | Specifies the remote filename for processing. | Not specified | Order_Attribute.csv |
| Optional | Specifies a grouping parameter for the job. | Not specified | AttributeType |
| Optional | Additional parameters for job customization. | Not specified | param1=value1,param2=value2 |
| Optional | Specifies a regular expression for filtering filenames. | Not specified | ^OrderAttr_\d+.csv$ |
| 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 | false |
Party Identification
Job ID: JOB_PARTY_IDENT
Job Name: Party Identification
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.
Troubleshooting Use Case
Issue 1: Party identification records are not being created or updated as expected.
Possible Causes: Configuration or Data Issues
Resolution Steps:
Review the
propertyResourceparameter to ensure it is correctly set to FTP_CONFIG.Verify that the
configIdparameter is set to IMP_PARTY_IDENT for the intended configuration.
Custom Parameters
Parameter | Type | Description | Default Value | Example Value |
| Required | Specifies the property resource for configuration. | Not specified | FTP_CONFIG |
| Required | Identifies the configuration for importing order attributes. | Not specified | IMP_PARTY_IDENT |
| Optional | Specifies the remote filename for processing. | Not specified | Order_Attribute.csv |
| Optional | Specifies a grouping parameter for the job. | Not specified | AttributeType |
| Optional | Additional parameters for job customization. | Not specified | param1=value1,param2=value2 |
| Optional | Specifies a regular expression for filtering filenames. | Not specified | ^OrderAttr_\d+.csv$ |
| 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 | false |
Import Order Metafield
Job ID: IMP_ORD_META_FLD
Job Name: Import Order Metafield
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.
Troubleshooting Use Case
Issue 1: Order metafields are not downloading as expected.
Possible Causes: Configuration or Timing Issues
Resolution Steps:
Ensure that the
shopifyConfigIdparameter is appropriately configured or set to null for the intended source.Review the
bufferTimeparameter to ensure it aligns with the desired duration for scheduling job downloads.Verify that the
namespaceparameter is set to HotwaxOrderDetails for the intended metafield source.
Custom Parameters
Parameter | Type | Description | Default Value | Example Value |
| Required | Specifies the namespace for order metafields. | HotwaxOrderDetails | HotwaxOrderDetails |
| Optional | Specifies the buffer time (in minutes) for scheduling job downloads. | 1 minute | 5 minutes |
| Optional | Specifies the buffer time (in minutes) for processing orders after the through date. | Not specified | 10 |
| Optional | Specifies a filter query for more targeted metafield downloads. | Not specified | "field_name: value" |
| Optional | Specifies the frequency (in minutes) for running the job. | Not specified | 15 |
Update Order Tags
Job ID: UPDATE_ORDER_TAGS
Job Name: Update Order Tags
Description
The Update Order Tags job, identified by Job 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.
Troubleshooting Use Case
Issue 1: Bulk updates to order tags are not reflected on the eCommerce platform.
Possible Causes: Configuration or Data Issues
Resolution Steps:
Check the configuration settings to ensure they align with the eCommerce platform's requirements.
Verify that the provided order tags for updating are correct and match the expected format.
Custom Parameters
No specific custom parameters
Netsuite
Last updated