GET v1/Times/{SiteId}/{OrderMode}/{OrderSource}/{MenuId}

Retrieves all the available times for a given number of days

URI template

v1/Times/{siteId}/{orderMode}/{orderSource}/{menuId}?daysFromToday={daysFromToday}&numberOfDays={numberOfDays}&noCache={noCache}

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId	The site where you are trying to get available times for	integer	Required
orderMode	How the customer is planning to order the food, this is important because of the different prep times for pickup and delivery	OrderModeType	Required
orderSource	How the customer placed the order	OrderSourceType	Required
menuId	The menu where the customer is planning on placing an order with	integer	Required
daysFromToday	Retrieve how many days in the future. Not needed, value is 0 if it's not provided	integer	Default value is 0
numberOfDays	Nullable The number of days to retrieve the available times for If no value is provided it uses a value of 2	integer	Default value is 2
noCache		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

A list of available times. Known internal error is BadRequest

Collection of Pair of date [key] and Collection of OrderingTime [value]

Response Formats

application/json, text/json

Sample:

[
  {
    "Key": "2024-04-18T20:45:33.9252957",
    "Value": [
      {
        "$id": "1",
        "Time": "2024-04-18T20:45:33.9396196",
        "IsCarryOver": true
      },
      {
        "$id": "2",
        "Time": "2024-04-18T20:45:33.9396196",
        "IsCarryOver": true
      }
    ]
  },
  {
    "Key": "2024-04-18T20:45:33.9396196",
    "Value": [
      {
        "$id": "3",
        "Time": "2024-04-18T20:45:33.9396196",
        "IsCarryOver": true
      },
      {
        "$id": "4",
        "Time": "2024-04-18T20:45:33.9396196",
        "IsCarryOver": true
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfKeyValuePairOfdateTimeArrayOfOrderingTime9UYD8duj xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
  <KeyValuePairOfdateTimeArrayOfOrderingTime9UYD8duj>
    <key>2024-04-18T20:45:33.9252957</key>
    <value xmlns:d3p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
      <d3p1:OrderingTime>
        <d3p1:IsCarryOver>true</d3p1:IsCarryOver>
        <d3p1:Time>2024-04-18T20:45:33.9396196</d3p1:Time>
      </d3p1:OrderingTime>
      <d3p1:OrderingTime>
        <d3p1:IsCarryOver>true</d3p1:IsCarryOver>
        <d3p1:Time>2024-04-18T20:45:33.9396196</d3p1:Time>
      </d3p1:OrderingTime>
    </value>
  </KeyValuePairOfdateTimeArrayOfOrderingTime9UYD8duj>
  <KeyValuePairOfdateTimeArrayOfOrderingTime9UYD8duj>
    <key>2024-04-18T20:45:33.9396196</key>
    <value xmlns:d3p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
      <d3p1:OrderingTime>
        <d3p1:IsCarryOver>true</d3p1:IsCarryOver>
        <d3p1:Time>2024-04-18T20:45:33.9396196</d3p1:Time>
      </d3p1:OrderingTime>
      <d3p1:OrderingTime>
        <d3p1:IsCarryOver>true</d3p1:IsCarryOver>
        <d3p1:Time>2024-04-18T20:45:33.9396196</d3p1:Time>
      </d3p1:OrderingTime>
    </value>
  </KeyValuePairOfdateTimeArrayOfOrderingTime9UYD8duj>
</ArrayOfKeyValuePairOfdateTimeArrayOfOrderingTime9UYD8duj>