Check Delivery Assurance

There are 5 services available within Delivery Assurance:

Store Boundary: Checks if the delivery address is within the coverage boundary of any store and returns a list of stores that can service the delivery address. We recommend passing either the zip code or latitude and longitude in the request to avoid geo-coding costs. Boundary needs to be defined around each store for this feature to work. (Refer: Add Boundary to define boundary for a store).
DSP: This checks if at least one of the providers associated with the store has delivery coverage.
Store Boundary + DSP: This is a combination of both the store boundary and DSP. It checks if drop-off address is within the coverage boundary as well as at least one of the providers associated with the store can service the drop-off address.
Confidence Score: This provides a confidence score for a specified drop-off address.
Return Confidence Score: This provides a confidence score of return from a specified drop-off address.

📘

BothpickupTimeanddropoffTimemust be provided to check for delivery within a specific time window.

The dsp and store-boundary-dspDelivery Assurance check is restricted to the providers configured for the pickup location. This API is for assurance of delivery, hence the first positive response from a provider is considered assurance of delivery.

WhennearestPickupvalue is passed, showTags and showBoundaries tags will not be available in the response.

Confidence Scores are currently available only for locations in the United States.

❗️
Caching can be enabled through configuration to reduce latency, especially when used on a PDP page. Caching works only if parameters that affect assurance (pickupTime and dropoffTime) are not provided.

🚧
Delivery Assurance does not utilize business rules and the orchestration engine.

Store-boundary service response

Property	Description	Type	Required
store-boundary	Name of the selected service	Object	Conditional Based on the service selected for the delivery assurance call
value	List of storeExternalIds that can deliver to the delivery address	Array of Strings	true
errors	List of base errors	Array of BaseError Objects	false
fulfillments	List of provider fulfillment options.	Array of Fulfillment Objects	Conditional This is sent when `showFulfillmentOptions` is true
boundaries	List of boundaries associated with a pickup location	Array of Boundary Details	Conditional This is sent when `showBoundaries` is true
distances	List of storeExternalIds sorted by distance.	Array of Distance Details	Conditional This is sent when `sortByDistance` is true

dsp service response

Property	Description	Type	Required
dsp	Name of the selected service	Object	Based on the service selected for the delivery assurance call
value	List of providers that can deliver to the delivery address	Array of Strings	true
errors	List of Base and Provider Errors	Array of Errors	false

store-boundary-dsp service response
This service is a combination of both store-boundary and dsp service. Hence all sub-properties of both the services are shown

Property	Description	Type	Required
store-boundary-dsp	Name of the selected service	Object	Based on the service selected for the delivery assurance call
value	List of providers that can deliver to the delivery address	Array of Strings	true
errors	List of Base and Provider Errors and storeExternalId	Array of Errors	false

confidence-score service response

Property	Description	Type	Required
confidence-score	Name of the selected service	Object	Based on the service selected for the delivery assurance call
value	addressScore for the delivery address	Array of Strings	true
score	List of scores for the delivery address	Object	true
errors	List of Base Errors	Array of Errors	false

return-confidence-score service response

Property	Description	Type	Required
return-confidence-score	Name of the selected service	Object	Based on the service selected for the delivery assurance call
value	addressScore for the delivery address	Array of Strings	true
score	List of scores for the delivery address	Object	true
errors	List of base errors	Array of Errors	false
isResidential	Flag indicating whether the delivery address is residential	Boolean	true
scoredAddress	Delivery address that has been scored	Object	true

200200