Ready For Pickup Notification
Learn how to integrate Order Management System (OMS) with Marketing Automation Platforms for automated 'Ready to Pickup' email notifications.
Overview
These guidelines provide detailed steps for integrating the Order Management System (OMS) with Marketing Automation Platforms to enable the automated delivery of 'Ready to Pickup' email notifications to customers. These notifications are triggered when store staff packs the ordered items in a shipment and indicate their readiness for pickup using HotWax Commerce's BOPIS fulfillment app or Fulfillment APIs.
Step 1: Mark shipment-Ready for Pickup
When store staff pack the order items and indicate their readiness for pickup, the quickShipEntireShipGroup
API creates a shipment from the selected shipgroup and moves it to the "Packed" status.
Sample API Request
Parameter | Description | Required |
---|---|---|
| The unique identifier of the order. | Yes |
| A flag indicating if the shipment should only be packed. If the customer is going to pickup their order at the fulfillment location, then this should be enabled to prevent the order from being marked as shipped. Default value is 'Y' if not specified. | Yes |
| The unit of measurement for dimensions (e.g., inches, centimeters). | Yes |
| The Id of the shipment box type. | Yes |
| The weight of the package. | Yes |
| The unit of measurement for weight (e.g., pounds, kilograms). | Yes |
| The Id of the ship group sequence. | Yes |
Sample API Response
Parameter | Description |
---|---|
| The Id of the shipment made. |
| The message for the event performed. |
Step 2: Trigger sendReadyToPickupItemNotification
chained event condition action (ECA) service
sendReadyToPickupItemNotification
chained event condition action (ECA) serviceWhen the shipment status is packed
, the sendReadyToPickupItemNotification
chained ECA service is triggered to check the order type of the shipment and the configuration for sending ready-for-pickup emails.
The chained service works for both Store pickup
and Ship to store
shipments. Emails are triggered when Store pickup
shipments are moved to packed status and Ship to store
shipments are moved to "scheduled" status. The system responsible for sending the email and order details is configured in the following Product Store setting.
Note: Additionally, this ECA service also offers the option to manually trigger the "ready to pickup" email notification. When this ECA service is triggered, it internally initiates the email for shipment process. This feature allows users to manually initiate the sending of email notifications to inform recipients that their item is ready for pickup.
Configuration details:
Parameter | Description |
---|---|
| The email settings in the Order Management System (OMS) for the product store identifier. |
| The type of email to be sent. |
| The Id of the product store. |
| The subject of the email. |
| The Id of the template content. |
| The Id of the system responsible for sending the email. |
The email transmission system is identified by the parameter systemMessageRemoteId
, while the information to configure the email's content is specified by the templateContentId
. This templateContentId
enables the OMS (Order Management System) to locate and fetch the content required for composing the email.
ECA Details:
Parameter | Description | Required |
---|---|---|
| The Id of the shipment. | Yes |
| The type of the email. | Yes |
Step 3: Prepare content for email
When the marketing automation platform handles email transmission, the OMS shares the required information in JSON format, specified by the templateContentId
, to the platform.
A list of fields which are available out of box in HotWax which can be shared with a marketing automation platform:
Dynamic Variable | Description |
---|---|
First Name | The first name of the recipient. |
Last Name | The last name of the recipient. |
To Facility Name | The name of the facility for pickup. |
Address 1 | The first line of the pickup location's address. |
Address 2 | The second line of the pickup location's address (if applicable). |
City | The city where the pickup facility is located. |
State Name | The name of the state or region where the pickup facility is located. |
Country Name | The name of the country where the pickup facility is located. |
Order Name | The name or reference number of the pickup order. |
Product Name | The name of the product being picked up. |
Quantity | The quantity of the product being picked up. |
Price | The price of the product. |
Image | An image or visual representation of the product. |
Subtotal | The subtotal amount for the pickup order. |
GrandTotal | The grand total amount for the pickup order. |
Note: If the OMS is responsible for sending the email, it incorporates the data into a preconfigured email template within its system.
Step 4: Deliver Email Notification
After recieving the required content, the marketing automation platform personalizes the customer's email using the provided details and delivers the email to the customer.
HotWax Commerce has ready integration with Listrak, a marketing automation platform. Added below is a JSON file sample
By following these steps, you can send Ready-For-Pickup email notifications from the OMS to the marketing automation platform.
Last updated