Validate and Manage Your Delivery Estimation Configuration
Learning Objectives
After completing this unit, you'll be able to:
- Describe the steps to turn on and sync the Delivery Estimation Service configuration from Order Management System to Commerce Delivery Service.
- Explain how to test the Delivery Estimation Service using the Commerce Delivery Service API and verify the response structure.
- Explain how Standard routing rules (Inventory, Proximity, Splits) determine which fulfillment location is used to calculate the estimate.
- Identify common configuration errors that cause failed or missing delivery estimates and describe the resolution steps.
- Summarize how Delivery Estimation Analytics can be used to compare estimated vs. actual delivery times and improve configuration accuracy over time.
Bring It All Together
Earlier this badge, you completed the configuration work in Order Management System (OMS) Core and B2C Business Manager. In this unit, you turn on and sync the service, test the API, verify that the product detail page (PDP) includes the delivery estimate, and troubleshoot common issues.
Turn On and Sync the Delivery Estimation Service
Before you can sync your delivery estimation configuration from OMS to the Commerce Delivery Service (CDS), confirm all your location objects have time zone and country code added. The sync process pushes your OMS metadata (locations, processing times, business hours, carrier methods) to CDS so it can calculate delivery estimates.
- In the Delivery Estimations tab of Order Fulfillment Setup, for the delivery estimation you're syncing, open the action menu and select Turn on.
- To sync your delivery estimation, select Sync.
The sync operation sends your configuration from OMS to CDS. After syncing, CDS has the information it needs to calculate delivery dates when your storefront makes an API request.
Test the End-to-End Flow
After syncing, test the delivery estimate by making a CDS API request. You can use Postman, a test tool, or your storefront code to verify the response structure.
The API response includes:
- estimatedDeliveryReference: A unique reference ID for the delivery estimate
- deliveryEstimates: An array containing estimates for each shipping method
- shippingCarrierMethod: The carrier method name (for example, Ground, 2-Day, Overnight)
- productDeliverEstimations: Estimates for each product, including:
- stockKeepingUnit: The product ID
- quantity: The quantity ordered
- estimatedDeliveryDate: An object with
minandmaxdates (for example, “2024-03-14T13:00:00” to “2024-03-17T13:00:00”)
- stockKeepingUnit: The product ID
- shippingCarrierMethod: The carrier method name (for example, Ground, 2-Day, Overnight)
After you receive a valid response from the CDS API, check that the delivery estimate displays correctly on your storefront PDP. The min and max dates from the API response populate the custom ProductLineItem attributes you created in Unit 3, and your .isml template displays them to the shopper.
Troubleshoot Common Configuration Issues
If your storefront is missing delivery estimates or the API returns an error, check these common configuration problems.
Issue | Root Cause | Resolution |
|---|---|---|
API returns an error or no response | Mismatched external references across OMS, CDS, and B2C Commerce | Verify external references match exactly for locations, shipping carriers, and shipping methods in all three systems. |
Sync fails | Missing time zone or country code on location objects | Add time zone and country code to all locations before syncing. |
Delivery estimate doesn't appear on PDP | Service not turned on or synced | Turn on the delivery estimation in Order Fulfillment Setup, then select Sync. |
API authentication fails | Incorrect API credentials or expired bearer token | Verify cdsClientId and cdsPassword in site preference, and confirm that Account Manager token generation succeeds. |
Storefront displays no estimate | Cartridge path issues or .isml template not updated | Verify cartridge path order and confirm .isml template includes delivery estimate display logic. |
No delivery date returned for a product | No inventory available or OCI integration problems | Check Omnichannel Inventory (OCI) for stock availability, and then verify OCI sync. |
Incorrect transit time | Managed carrier method not linked properly | Confirm Shipping Carrier Method is linked to a Managed Shipping Carrier Method, and verify the scope (Domestic, International, Both). |
Static transit time used instead of managed carrier data | No managed carrier method configured or carrier data unavailable for destination | Set up managed carrier method for supported carriers (Canadian Post, FedEx, Royal Mail, UPS, USPS), and configure static transit time fallback for other carriers or destinations. |
To resolve issues not covered in this table, gather the API request and response details, check the CDS API logs, and contact Salesforce Support with the delivery estimation reference ID.
Wrap It Up
You've completed the end-to-end Delivery Estimation setup. You configured OMS Core with delivery estimation records, locations, processing times, and shipping carriers. You set up B2C Commerce Business Manager with authentication, custom attributes, site preferences, and the API implementation. You turned on and synced the service, tested the API, and confirmed that the delivery estimate displays on the PDP.