Availability API

View as Markdown

Returns the earliest available delivery windows for a given store and destination. The response is pre-calculated based on enabled delivery types, store trading hours, pickup hours, public holidays, and cut-off logic.

Use this endpoint to power delivery time selection at checkout, or to determine the fastest available delivery type for backend routing decisions.

This endpoint is best used as an estimator. Delivery windows are calculated without considering distance or pricing rules — use the Quote Delivery endpoint when pricing accuracy is required.


Endpoint

POST {{domain}}/{{tenant_id}}/deliveries/quote/availability

Authentication: Bearer token required via the Authorization header.


Request Payload

The request payload follows the same structure as the Quote Delivery endpoint.

POST /{{tenant_id}}/deliveries/quote/availability
1{
2 "store_id": "rendr-store_001",
3 "ready_for_pickup_at": "2025-03-12T12:00:00.000",
4 "address": {
5 "address": "100 Gould Street",
6 "address2": "Unit 1",
7 "city": "Bondi",
8 "state": "NSW",
9 "post_code": "2026"
10 }
11}

Sample Response

Each available delivery type is returned with an estimated from_datetime and to_datetime window. Delivery types that are not available for the given store and destination will be omitted from the response.

200 OK
1{
2 "fast": {
3 "from_datetime": "2025-03-12T12:01:00+11:00",
4 "to_datetime": "2025-03-12T15:01:00+11:00"
5 },
6 "flexible": {
7 "from_datetime": "2025-03-13T09:01:00+11:00",
8 "to_datetime": "2025-03-13T14:01:00+11:00"
9 },
10 "standard": {
11 "from_datetime": "2025-03-13T09:01:00+11:00",
12 "to_datetime": "2025-03-20T09:01:00+11:00"
13 }
14}

Response Fields

FieldTypeDescription
fastObjectEstimated delivery window for the fast delivery type, if available.
flexibleObjectEstimated delivery window for the flexible delivery type, if available.
standardObjectEstimated delivery window for the standard delivery type, if available.
expressObjectEstimated delivery window for the express delivery type, if available.
*.from_datetimeString (ISO 8601)The start of the estimated delivery window.
*.to_datetimeString (ISO 8601)The end of the estimated delivery window.