Scenario: Calculate item delivery or pickup date based on finite capacity windows

The Calculate item delivery or pickup date using finite capacity windows API calculates the earliest date that an item can be picked up from or delivered to a specified place.

In addition to the functionality provided through version 1 of the API, a support for the pick delivery method is available in version 2 of the API. For information about the functionality provided through version 1 and version 2, see Scenario: Calculate item delivery or pickup date based on infinite capacity windows and Calculate item delivery or pickup date based on infinite capacity windows.

API

You can use the Sterling Intelligent Promising Calculate item delivery or pickup date APIs to display estimated delivery dates to shoppers who are browsing your online store on the product details page.

For adding a pick-up area for the pick delivery method, the destination property is added to the API. You can input PICKUP_AREA the format parameter, and provide the latitude, longitude, and radius to facilitate in calculating the estimated delivery date. Refer to the following sample JSON.

 "destination": {
    "format": "PICKUP_AREA",
    "latitude": 42.5486,
    "longitude": -71.4726,
    "radius": 10
  }
Note: When the delivery method is set to pick, ensure that the values for the shippingGroupId and preferredCarrierServices parameters are not passed.

Calculation criteria

For making promising calculations, only those stores that have the pick delivery method is enabled are considered. The API returns details for only those stores that are within the radius of the shopper's provided location. It also provides the best possible pick-up time for each store in the ascending order of approximate distance from the shopper.

Override node list

While calculating estimated delivery date, you can configure the API to calculate and display the capacity and inventory availability for a preselected node or list of nodes. For more information about override node list, see Buy online and pick-up in store (BOPIS).

Note: When the overrideNodeList attribute is enabled, the application ignores the sourcing and Promising rules while making promising calculations.

Ship to store

While making promising calculations and estimating the delivery date, you can configure the transfer rules. In the events when an inventory is not available in a store, the required inventory can be transferred from the nearby nodes. For more information, see Ship to store (STS).
Note: The ship to store is available for only the pick delivery method.

When the delivery method is set to pickup, the API evaluates transfer rules for a match. If the match is found, the API accounts for the possibility of transferring the inventory from another node to the node from which the inventory is to be picked by the customer. For more information, see Ship to store. For more information about Transfer rules APIs, see Configuring transfer rules.

Requested fulfillment delivery and pick up dates

While calculating the estimated delivery and pickup dates, the API now also considers the following:
  • Find the earliest delivery or pick-up date on or after a specific date
  • The latest an order can be placed for it to be delivered or made available for pick-up by a specific date

For more information about requested fulfillment date for delivery, see Scenario: Ship from store (SFS). For more information about requested fulfillment date for pickup, see Buy online and pick-up in store (BOPIS).

Example

The shopper is interested in Item_A and the shopper indicates that only stores within a 10-kilometer radius must be checked. The application must find two stores with sufficient availability and capacity within the radius, but with the following pickup times:

Store Pick enabled Available Capacity Distance Earliest pickup time
Store_A Y Y Y 6 kilometers 2022-09-21T16:00:00.000Z
Store_B Y Y Y 9 kilometers 2022-09-21T15:00:00.000Z

Store_B has earlier pick-up time. However, it is located at 20-km distance. The application API returns both the stores in the ascending order of the approximate distance from the shopper.

For more information about understanding and troubleshooting promising calculations, see Scenario: Troubleshooting promising calculations.

The Estimated Delivery Date calculation is dependent on the following factors:
Lead time
For more information, see Lead time.
Capacity availability
For more information, see Capacity.

Use the Insert or update available capacity API to use this functionality.

Inventory availability
For more information, see Supply and demand.
Carrier Pickup
For more information, see Configuring carrier pickup schedules.

Use the Define node carrier pickup schedule API to use this functionality.

Carrier transit time
For more information, see Configuring carrier transit times.

Use the Upload transit duration (and optionally transit delay) by shipping zones API to use this functionality.

Radius from the shopper in case of PICK delivery