Timeslots

List time slots for the delivery provider method

get

/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots

List all time slots belonging to the delivery provider method

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

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots

GET /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "deliveryProviderMethodTimeslotUid": "text",
      "name": "text",
      "startTime": "12:33:50",
      "endTime": "12:33:50",
      "applicableDays": [
        "MONDAY"
      ],
      "excludedDates": [
        "2023-12-24"
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a time slot for the delivery provider method

post

/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots

Create new time slot for the delivery provider method

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-_]+

Body

timeslotRequestModel

namestringRequired

startTimestring · timeRequired

endTimestring · timeRequired

excludedDatesstring[]Optional

Format: YYYY-MM-DD

Example: 2023-12-24

deliveryProviderMethodTimeslotUidstringOptional

Responses

201

Example response

application/json

post

/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots

POST /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 161

{
  "name": "text",
  "startTime": "12:33:50",
  "endTime": "12:33:50",
  "applicableDays": [
    "MONDAY"
  ],
  "excludedDates": [
    "2023-12-24"
  ],
  "deliveryProviderMethodTimeslotUid": "text"
}

201

Example response

{
  "deliveryProviderMethodTimeslotUid": "text",
  "name": "text",
  "startTime": "12:33:50",
  "endTime": "12:33:50",
  "applicableDays": [
    "MONDAY"
  ],
  "excludedDates": [
    "2023-12-24"
  ]
}

List available time slots for a given time range

get

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

List available time slots belonging to the delivery provider method

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

ENUM	Description
ASC	Sort in ascending order
DESC	Sort 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-29T12%3A33%3A50.262Z HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

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

Get time slot for the delivery provider method

get

/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots/{deliveryProviderMethodTimeslotUid}

Get time slot for the delivery provider method by deliveryProviderMethodTimeslotUid

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-_]+

deliveryProviderMethodTimeslotUidstringRequired

Reference to a timeslot.

Responses

200

Example response

application/json

get

/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots/{deliveryProviderMethodTimeslotUid}

GET /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots/{deliveryProviderMethodTimeslotUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "deliveryProviderMethodTimeslotUid": "text",
  "name": "text",
  "startTime": "12:33:50",
  "endTime": "12:33:50",
  "applicableDays": [
    "MONDAY"
  ],
  "excludedDates": [
    "2023-12-24"
  ]
}

Update time slot for the delivery provider method

put

/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots/{deliveryProviderMethodTimeslotUid}

Update time slot for the delivery provider method by deliveryProviderMethodTimeslotUid

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-_]+

deliveryProviderMethodTimeslotUidstringRequired

Reference to a timeslot.

Body

DeliveryProviderMethodTimeslotUpdateRequestSchema

namestringOptional

startTimestring · timeOptional

endTimestring · timeOptional

excludedDatesstring[]Optional

Format: YYYY-MM-DD

Example: 2023-12-24

Responses

200

Example response

application/json

put

/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots/{deliveryProviderMethodTimeslotUid}

PUT /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots/{deliveryProviderMethodTimeslotUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "name": "text",
  "startTime": "12:33:50",
  "endTime": "12:33:50",
  "applicableDays": [
    "MONDAY"
  ],
  "excludedDates": [
    "2023-12-24"
  ]
}

200

Example response

{
  "deliveryProviderMethodTimeslotUid": "text",
  "name": "text",
  "startTime": "12:33:50",
  "endTime": "12:33:50",
  "applicableDays": [
    "MONDAY"
  ],
  "excludedDates": [
    "2023-12-24"
  ]
}

Delete time slot for the delivery provider method

delete

/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots/{deliveryProviderMethodTimeslotUid}

Delete time slot for the delivery provider method by deliveryProviderMethodTimeslotUid

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-_]+

deliveryProviderMethodTimeslotUidstringRequired

Reference to a timeslot.

Responses

200Success

No content

delete

/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots/{deliveryProviderMethodTimeslotUid}

DELETE /v2/tenants/{tenantUid}/delivery-providers/{deliveryProviderUid}/methods/{deliveryProviderMethodUid}/timeslots/{deliveryProviderMethodTimeslotUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

No content

PreviousTenant NextUser

Last updated 9 months ago

Was this helpful?

hashtagList time slots for the delivery provider method

hashtagCreate a time slot for the delivery provider method

hashtagList available time slots for a given time range

hashtagGet time slot for the delivery provider method

hashtagUpdate time slot for the delivery provider method

hashtagDelete time slot for the delivery provider method

List time slots for the delivery provider method

Create a time slot for the delivery provider method

List available time slots for a given time range

Get time slot for the delivery provider method

Update time slot for the delivery provider method

Delete time slot for the delivery provider method