BETA: Please note that the current endpoints are considered beta. It is possible there may be changes before these endpoints are finalised.

Fulfillment Wait Times & Suspension

These endpoints let you control each fulfillment type at a location on its own:

  • Wait time: how long customers should expect to wait for an order, as a range in minutes.
  • Suspension: stop accepting orders for a fulfillment type until a given time.

{fulfillmentType} in the path is one of DELIVERY, PICK_UP or SERVICE.

These endpoints are not live yet. Until they launch, every request returns 503 service_unavailable. The request and response shapes below are what you can build against.

Wait time

minWaitTime and maxWaitTime are in minutes, and maxWaitTime must be greater than or equal to minWaitTime. If it's lower, the request is rejected with 400 and error type invalid_wait_time. For a single wait time rather than a range, set both to the same value. A new wait time applies to orders placed after the request succeeds.

Get Wait Time

This endpoint allows you to get the current wait time for a fulfillment type at a location.

Scope: orders:read

get /organizations/{organizationId}/locations/{locationId}/fulfillment/{fulfillmentType}/wait-time

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID
locationIdstringpathLocation ID
fulfillmentTypestringpathThe fulfillment type
"DELIVERY", "PICK_UP", "SERVICE"

Responses

200: OK response.FulfillmentWaitTime
{
  "maxWaitTime": 35,
  "minWaitTime": 25
}
404: not_found: Not Found response.
503: service_unavailable: Service Unavailable response.

Set Wait Time

This endpoint allows you to set the wait time for a fulfillment type at a location. The new wait time applies to orders placed after the request succeeds. Returns an invalid_wait_time error if maxWaitTime is less than minWaitTime.

Scope: orders:write

put /organizations/{organizationId}/locations/{locationId}/fulfillment/{fulfillmentType}/wait-time

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID
locationIdstringpathLocation ID
fulfillmentTypestringpathThe fulfillment type
"DELIVERY", "PICK_UP", "SERVICE"

Request Body

FulfillmentWaitTime
{
  "maxWaitTime": 35,
  "minWaitTime": 25
}

Responses

204: No Content response.
400: invalid_wait_time: maxWaitTime is less than minWaitTime.
404: not_found: Not Found response.
503: service_unavailable: Service Unavailable response.

Suspension

While a fulfillment type is suspended, customers can't place orders for it at that location. It resumes automatically at suspendUntil.

suspendUntil is always in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ (the trailing Z means UTC). It is not in the location's local time, so convert local times to UTC before sending. For example, to suspend a Melbourne location until 10:00 pm AEDT (UTC+11) on 11 November 2026, send 2026-11-11T11:00:00Z. GET responses are also in UTC.

  • To suspend, or change when a suspension ends, PUT a future suspendUntil. suspendUntil is required.
  • To resume early, DELETE the suspension. This succeeds even if the fulfillment type isn't suspended.
  • GET returns suspendUntil while suspended. When the fulfillment type isn't suspended, GET returns 404 with error type not_suspended. A missing location also returns 404, but with error type not_found, so check type to tell them apart.

Get Suspension

This endpoint allows you to check whether a fulfillment type is suspended at a location, and until when. Returns a not_suspended error if the fulfillment type is not currently suspended.

Scope: orders:read

get /organizations/{organizationId}/locations/{locationId}/fulfillment/{fulfillmentType}/suspend

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID
locationIdstringpathLocation ID
fulfillmentTypestringpathThe fulfillment type
"DELIVERY", "PICK_UP", "SERVICE"

Responses

200: OK response.FulfillmentSuspension
{
  "suspendUntil": "2026-11-11T23:00:00Z"
}
404: not_found: Not Found response.
503: service_unavailable: Service Unavailable response.

Set Suspension

This endpoint allows you to suspend a fulfillment type at a location until a given time. If it is already suspended, the new time replaces the old one. While suspended, customers cannot place orders for that fulfillment type.

Scope: orders:write

put /organizations/{organizationId}/locations/{locationId}/fulfillment/{fulfillmentType}/suspend

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID
locationIdstringpathLocation ID
fulfillmentTypestringpathThe fulfillment type
"DELIVERY", "PICK_UP", "SERVICE"

Request Body

FulfillmentSuspension
{
  "suspendUntil": "2026-11-11T23:00:00Z"
}

Responses

204: No Content response.
404: not_found: Not Found response.
503: service_unavailable: Service Unavailable response.

Resume (Delete Suspension)

This endpoint allows you to resume a suspended fulfillment type at a location immediately. Succeeds even if the fulfillment type is not suspended.

Scope: orders:write

delete /organizations/{organizationId}/locations/{locationId}/fulfillment/{fulfillmentType}/suspend

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID
locationIdstringpathLocation ID
fulfillmentTypestringpathThe fulfillment type
"DELIVERY", "PICK_UP", "SERVICE"

Responses

204: No Content response.
404: not_found: Not Found response.
503: service_unavailable: Service Unavailable response.

Models

FulfillmentWaitTime

The range of time, in minutes, a customer can expect to wait for their order. For a single wait time, set minWaitTime and maxWaitTime to the same value.

NameTypeDescription
maxWaitTimeintegerThe maximum wait time in minutes. Must be greater than or equal to minWaitTime.
minWaitTimeintegerThe minimum wait time in minutes.

FulfillmentSuspension

A suspension of a fulfillment type at a location.

NameTypeDescription
suspendUntilstringSuspends the fulfillment type until this date and time, in UTC. The format must be 'YYYY-MM-DDTHH:MM:SSZ', where the trailing Z means UTC. Convert the location's local time to UTC before sending. Responses always use UTC.

In this article