GET v1/Stores/{storeIdentifier}/PrepTime/ForOrderMode/{orderMode}?timeout={timeout}

GET Get Prep Time

Retrieves the next available time for the store to accept orders, along with the sites current time.

URI template

v1/Stores/{storeIdentifier}/PrepTime/ForOrderMode/{orderMode}?timeout={timeout}

Request Information

URI Parameters

Name	Type	Additional information	Description
storeIdentifier	integer	Required	The store to send the command to
orderMode	OrderModeType	Required	The ordermode you want used for time generation
timeout	integer	Default value is 30000	The timeout for this command

Body Parameters

None.

Response Information

Resource Description

A GetPrepTimeResponse object, which contains the StoreApiResponse, SiteTime, and PrepTime

GetPrepTimeResponse

Name	Type	Additional information	Description
ApiResult	StoreApiResponse	None.	The result returned by the Api
PrepTime	integer	None.	Requested prep time (in minutes) at the store
SiteTime	date	None.	Local time at the store

Response Formats

application/json, text/json

Sample:

{
  "PrepTime": 1,
  "SiteTime": "2024-09-19T03:31:02.383678-04:00",
  "ApiResult": {
    "$id": "2",
    "TransactionId": "e49be3c9-3a5d-4780-94f9-e6e71fbeed31",
    "ResultCode": 2,
    "ResultMessage": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<GetPrepTimeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses.ResponseObjects.StoreResponses">
  <ApiResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/StoreConnect.Responses" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses.ResponseObjects">
    <d2p1:ResultCode>2</d2p1:ResultCode>
    <d2p1:ResultMessage>sample string 3</d2p1:ResultMessage>
    <d2p1:TransactionId>e49be3c9-3a5d-4780-94f9-e6e71fbeed31</d2p1:TransactionId>
  </ApiResult>
  <PrepTime>1</PrepTime>
  <SiteTime>2024-09-19T03:31:02.383678-04:00</SiteTime>
</GetPrepTimeResponse>