Configuring caching for Estimated Delivery Dates by using APIs

Enable the caching of Estimated Delivery Dates (EDD) computations for use in the Product List Page (PLP). These dates help shoppers to make informed decisions that are based on delivery timelines specific to their chosen delivery method.

Before you begin

  • Ensure that you are familiar with the EDD caching for the PLP. For more information, see Estimated Delivery Dates.
  • Identify the shipping groups that you want to include in the caching process for the SHIP delivery method.

    You can pass the shipping group IDs to the cachedShippingGroupIds array when you enable caching by using the Define settings API.

Procedure

  1. Open the Define settings API.
  2. To enable caching, include the eddCache object and set it to true. Then, provide an array of shipping group IDs to include in caching for the SHIP delivery method. For more information, see the following example: 
    {
  "settings": {
    "eddCache": {
      "enabled": true,
      "cachedShippingGroupIds": ["FREE_SHIPPING", "ECONOMY"]
    }
  }
}
  3. To validate that the caching process is successful, complete the following steps:
    1. Send the request to enable caching and confirm that the response reflects the updated settings.
    2. Call the Get EDD API to generate delivery estimates and populate the cache.
    3. Use the getCachedEDDs API to verify that the cached results are retrievable.

What to do next

Become familiar with the scenario, for more information, see Scenario: Estimated Delivery Dates for the Product list page.