Buy Online, Pickup In Store (BOPIS) & Buy Online, Ship to Store (BOSS)
With Buy Online, Pickup In Store (BOPIS) & Buy Online, Ship to Store (BOSS) tracking, shoppers will be able to track when and where to pick up their orders. Proactively communicate with customers, enabling them to prepare for order pickups. Businesses control the information in BOPIS & BOSS tracking page and notifications.
This documentation outlines typical scenarios for Buy Online, Pickup In Store (BOPIS) related to Commerce API, and provides detailed instructions on how to utilize the API effectively in each case. For additional scenarios and further information, please refer to the index page.
1. Scenarios
Notification Emails
To send notification emails for shipment status updates, you can design email templates tailored specifically for BOPIS or BOSS use cases. These templates should include essential information such as the pickup location, opening hours, and any customized instructions.
To incorporate BOPIS details in the notification email, navigate to the Flow Template portal, and create the flow and customize the email templates accordingly.
Branded Tracking Page
For pickup shipments, our branded tracking page can showcase specialized templates and information for BOPIS or BOSS shipments.
2. Specific Required Fields for creating the order
| Field | Description | Sample |
|---|---|---|
| delivery_method | Set the value to pickup | pickup |
| pickup_location.location_id | The ID of the location for picking up the order. Please configure the locations here and retrieve the location ID. Please enable In-store pickups option when creating the location. | 16a8c49459074f66a7c7305ccbb1571f |
| pickup_info | Detailed pickup information object | - |
| pickup_info.instructions | Order pickup instruction. Specify details when creating a location here. If this field is included in the API request, the provided value will override the default value in the location. | - |
| pickup_info.estimated_ready_for_pickup_at | Estimated ready for pickup date time. If this value is not provided in the API request, it is calculated automatically from the pickup location's pickup_setting durations. The countdown starts from the order's source_created_at, or from the time the request is processed if source_created_at was not supplied. On the branded tracking page, the shopper-facing "Estimated pickup date" currently comes from max. | - |
| pickup_info.estimated_ready_for_pickup_at.min | Earliest estimated ready for pickup date time | 2024-07-05T00:00:00Z |
| pickup_info.estimated_ready_for_pickup_at.max | latest estimated ready for pickup date time | 2024-07-05T00:00:00Z |
| pickup_info.pickup_deadline_at | The latest time by which the pickup must be completed | 2024-07-09T17:00:00Z |
3. Specific Required Fields for creating the fulfillment
| Field | Description | Sample |
|---|---|---|
| delivery_method | Set the value to pickup | pickup |
| pickup_location.location_id | The ID of the location for picking up the order. Please configure the locations here and retrieve the location ID. Please enable In-store pickups option when creating the location. | 16a8c49459074f66a7c7305ccbb1571f |
| pickup_info | Detailed pickup information object | - |
| pickup_info.instructions | Order pickup instruction. Specify details when creating a location here. If this field is included in the API request, the provided value will override the default value in the location. | - |
| pickup_info.estimated_ready_for_pickup_at | Estimated ready for pickup date time. If this value is not provided in the API request, it is calculated automatically from the pickup location's pickup_setting durations. The countdown starts from the order's source_created_at, or from the time the request is processed if source_created_at was not supplied. On the branded tracking page, the shopper-facing "Estimated pickup date" currently comes from max. | - |
| pickup_info.estimated_ready_for_pickup_at.min | Earliest estimated ready for pickup date time | 2024-07-05T00:00:00Z |
| pickup_info.estimated_ready_for_pickup_at.max | latest estimated ready for pickup date time | 2024-07-05T00:00:00Z |
| pickup_info.pickup_deadline_at | The latest time by which the pickup must be completed | 2024-07-09T17:00:00Z |