Get Smart Windows

post

https://sandbox.api.deliverysolutions.co/api/v2/smartWindows

Use this API to retrieve the possible time windows for pick-up/delivery based on the given category and date for a store. A maximum of 7 days of time window can be obtained with this API.

Additionally, we can retrieve the windows supported by the provider by adding the provider name in the request. Note that, store timings must be configured before getting the provider-specific windows.

Body Params

storeExternalIds

array of strings

required

Array of storeExternalId. One or many Location Ids for which delivery timings are to be returned.

storeExternalIds*

categories

startDate

string

Baseline date from which numberOfDays to be calculated. ISO 8601 Calendar Date (YYYY-MM-DD) as per location’s timezone. Defaults to current date.

numberOfDays

int32

Non-zero positive integer indicating how many days of windows to return. Defaults to 1.

dspCheck

boolean

Defaults to false

Flag to indicate if the system should intelligently check top and bottom windows of each day to ensure DSP availability for the start and end. Uses location’s address/zipcode for the check against the DSPs. Default is false.

types

array of strings

Defaults to delivery

Type of window timings. Options are pickup, delivery or return. Defaults to type delivery.

types

provider

string

Windows will be retrieved from the requested provider instead of matching windows configured at our end.

options

object

Override default configured options.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

404404