Check Delivery Assurance

storeExternalId

string

Required when utilising dsp service. If storeExternalId is provided for store-boundary service, the location boundary check will be limited to that location.

deliveryAddress

object

required

Zipcode is mandatory in Address. If full address is provided then it would be geocoded if latitude and longitude are not provided for store boundary service and if a delivery service provider requires it. Full address is required when utilising confidence-score and return-confidence-score services.

services

array of strings

required

An array of service keys to determine which service is being invoked. Available services are: dsp, store-boundary, store-boundary-dsp, confidence-score, return-confidence-score.

services*

matchBoundaryTags

array of strings

Match stores whose boundaries have at least one of the tags (eg: "tags":["sdd","fleet"]) that are passed in an array and cover the dropoff address.

matchBoundaryTags

matchProviderTags

array of strings

All the providers matching at least one tag are returned. This is only available for the dsp and store-boundary-dsp services.

matchProviderTags

pickupTime

object

Check provider availability based on pickup time. If not provided, the system will use the appropriate time window. If pickupTime is null then it means that the package needs to be picked as soon as possible.

dropoffTime

object

Check provider availability based on drop-off time. If not provided, the system will use the appropriate time window. If dropoff time is null then it means that the package needs to be dropped off as soon as possible after the pickup.

sortByDistance

boolean

When true, it returns all the pickup locations that cover the deliveryAddress sorted in the ascending order by distance.

nearestPickup

object

Fetches the nearest pickup locations that serve the deliveryAddress for a given radius. When this field is provided, the coverage boundaries associated with the pickup locations are ignored. This is only available for the store-boundary and store-boundary-dsp services.

showFulfillmentOptions

boolean

When true, it returns the order type and provider services supported by the pickup location.

bypassCache

boolean

If caching in enabled in corporate profile to reduce latency, a customer can disable cache for this API by sending bypassCache as true

matchLocationTags

array of strings

All the locations matching at least one tag are returned. This is only available for the store-boundary and store-boundary-dsp services.

matchLocationTags

200200