For the complete documentation index, see llms.txt. This page is also available as Markdown.

List available time slots for a given time range

List available time slots belonging to the delivery provider method

get
/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots/available
Authorizations
AuthorizationstringRequired

Token received from the auth service

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
deliveryProviderUidstringRequired

Reference to a delivery provider.

Pattern: ^[A-Za-z0-9-_]+
deliveryProviderMethodUidstringRequired

Reference to a delivery provider method.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUMDescription
ASCSort in ascending order
DESCSort in descending order
Possible values:
fromDateTimestring · date-timeRequired

The time to fetch available timeslots from

toDateTimestring · date-timeOptional

The time to fetch available timeslots to

Responses
200

Example response

application/json
get/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots/available
GET /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots/available?fromDateTime=2026-01-01T00%3A00%3A00.000Z HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "date": "2026-01-01",
      "timeslots": [
        {
          "deliveryProviderMethodTimeslotUid": "text",
          "name": "text",
          "startTime": "00:00:00",
          "endTime": "00:00:00",
          "applicableDays": [
            "MONDAY"
          ],
          "excludedDates": [
            "2023-12-24"
          ],
          "deliveryCount": 1
        }
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Last updated

Was this helpful?