DELETE v1/FormattedOrders/{storeIdentifier}/{orderId}/{depositId}/Refund?timeout={timeout}

DELETE Refund Deposit

Refunds a deposit off of an order.

URI template

v1/FormattedOrders/{storeIdentifier}/{orderId}/{depositId}/Refund?timeout={timeout}

Request Information

URI Parameters

Name	Type	Additional information	Description
storeIdentifier	integer	Required	The store to send the command to
orderId	long	Required	The Id of the order
depositId	long	Required	Id of the deposit to refund
timeout	integer	Default value is 30000	The timeout for this command, in milliseconds

Body Parameters

None.

Response Information

Resource Description

A FormattedOrderResponse

FormattedOrderResponse

Name	Type	Additional information	Description
ApiResult	StoreApiResponse	None.	The result returned by the Api
UpdatedOrder	OutOrder	None.	The updated Order returned by the POS
NewSuggestedTime	date	None.	Set when the attempt to fulfill the Order at the specified PromiseTime would exceed the set Capacity for the restaurant. Only set in a Submit Order call

Response Formats

application/json, text/json

Sample:

{
  "UpdatedOrder": {
    "$id": "2",
    "OrderId": 0,
    "OrderNumber": 0,
    "SequenceNumber": 0,
    "FirstSentToKitchenTime": null,
    "LastSentToKitchenTime": null,
    "FirstBumpTime": null,
    "LastBumpTime": null,
    "FirstPaymentTime": null,
    "LastPaymentTime": null,
    "DispatchTime": null,
    "FulfilledTime": null,
    "ClosedTime": null,
    "ModeCharge": 0.0,
    "SubTotal": 0.0,
    "DiscountTotal": 0.0,
    "Tax": 0.0,
    "PaymentTotal": 0.0,
    "Total": 0.0,
    "Tendered": false,
    "DriverId": 0,
    "Customer": {
      "$id": "3",
      "DeliveryZone": null,
      "ExtraAddresses": null,
      "Vehicle": null,
      "CustomerId": 0,
      "ReferenceId": 0,
      "FirstName": "",
      "LastName": "",
      "EMail": null,
      "LoyaltyCardNumber": "",
      "TaxId": "",
      "Notes": "",
      "VoicePhone": "",
      "VoicePhoneExtension": null,
      "PhoneType": 0,
      "AddressLine1": "",
      "AddressLine2": "",
      "City": "",
      "State": "",
      "Postal": "",
      "AddressNotes": null,
      "AddressType": 0,
      "SaveAddress": false,
      "BusinessName": "",
      "DepartmentName": ""
    },
    "Items": [],
    "FailedItems": [],
    "Tenders": [],
    "Promos": [],
    "Comps": [],
    "Guests": [],
    "ReferenceNumber": 0,
    "ExternalOrderId": null,
    "OrderTime": null,
    "PrepTime": 0,
    "DriveTime": 0,
    "PromiseDateTime": "0001-01-01T00:00:00",
    "OrderSource": 0,
    "Destination": null,
    "SourceId": null,
    "DestinationId": null,
    "OrderMode": 0,
    "OverrideModeCharge": null,
    "Status": 0,
    "AutoSendToKitchen": false,
    "TaxExempt": false,
    "EstimatedSubTotal": 0.0,
    "EstimatedTax": 0.0,
    "SpecialInstructions": null,
    "CheckedIn": false,
    "CheckInSummary": null,
    "CheckInApplication": null,
    "CheckInOriginType": null,
    "CheckInOriginId": null,
    "CheckInVectorType": null,
    "CheckInVectorId": null,
    "CheckInIntent": null,
    "AutoRelease": false,
    "PartySize": 0,
    "ReleaseAwaitingDeposit": false,
    "AssignAlohaLoyalty": false,
    "SiteInformation": null,
    "KitchenStatus": 0
  },
  "NewSuggestedTime": "0001-01-01T00:00:00",
  "ApiResult": {
    "$id": "4",
    "TransactionId": "00000000-0000-0000-0000-000000000000",
    "ResultCode": 0,
    "ResultMessage": "Success"
  }
}

application/xml, text/xml

Sample:

<FormattedOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses.ResponseObjects.OrderResponses">
  <ApiResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/StoreConnect.Responses" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Responses.ResponseObjects">
    <d2p1:ResultCode>0</d2p1:ResultCode>
    <d2p1:ResultMessage>Success</d2p1:ResultMessage>
    <d2p1:TransactionId>00000000-0000-0000-0000-000000000000</d2p1:TransactionId>
  </ApiResult>
  <NewSuggestedTime>0001-01-01T00:00:00</NewSuggestedTime>
  <UpdatedOrder xmlns:d2p1="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Outbound">
    <AssignAlohaLoyalty xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">false</AssignAlohaLoyalty>
    <AutoRelease xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">false</AutoRelease>
    <AutoSendToKitchen xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">false</AutoSendToKitchen>
    <CheckInApplication i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <CheckInIntent i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <CheckInOriginId i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <CheckInOriginType i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <CheckInSummary i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <CheckInVectorId i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <CheckInVectorType i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <CheckedIn xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">false</CheckedIn>
    <Destination i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <DestinationId i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <DriveTime xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</DriveTime>
    <EstimatedSubTotal xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</EstimatedSubTotal>
    <EstimatedTax xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</EstimatedTax>
    <ExternalOrderId i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <KitchenStatus xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</KitchenStatus>
    <LaneIdentifier i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <OrderMode xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</OrderMode>
    <OrderSource xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</OrderSource>
    <OrderTime i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <OverrideModeCharge i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <PartySize xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</PartySize>
    <PrepTime xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</PrepTime>
    <PromiseDateTime xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0001-01-01T00:00:00</PromiseDateTime>
    <ReferenceNumber xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</ReferenceNumber>
    <ReleaseAwaitingDeposit xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">false</ReleaseAwaitingDeposit>
    <SiteInformation xmlns:d3p1="http://schemas.datacontract.org/2004/07/StoreConnect.Models" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <SourceId i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <SpecialInstructions i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
    <Status xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</Status>
    <TaxExempt xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">false</TaxExempt>
    <d2p1:ClosedTime i:nil="true" />
    <d2p1:Comps />
    <d2p1:Customer>
      <AddressLine1 xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></AddressLine1>
      <AddressLine2 xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></AddressLine2>
      <AddressNotes i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
      <AddressType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</AddressType>
      <BusinessName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></BusinessName>
      <City xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></City>
      <CustomerId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</CustomerId>
      <DepartmentName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></DepartmentName>
      <EMail i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
      <FirstName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></FirstName>
      <LastName xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></LastName>
      <LoyaltyCardNumber xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></LoyaltyCardNumber>
      <Notes xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></Notes>
      <PhoneType xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">None</PhoneType>
      <Postal xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></Postal>
      <ReferenceId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">0</ReferenceId>
      <SaveAddress xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core">false</SaveAddress>
      <State xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></State>
      <TaxId xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></TaxId>
      <VoicePhone xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core"></VoicePhone>
      <VoicePhoneExtension i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/StoreConnect.Models.Core" />
      <d2p1:DeliveryZone i:nil="true" />
      <d2p1:ExtraAddresses i:nil="true" />
      <d2p1:Vehicle i:nil="true" />
    </d2p1:Customer>
    <d2p1:DiscountTotal>0</d2p1:DiscountTotal>
    <d2p1:DispatchTime i:nil="true" />
    <d2p1:DriverId>0</d2p1:DriverId>
    <d2p1:FailedItems />
    <d2p1:FirstBumpTime i:nil="true" />
    <d2p1:FirstPaymentTime i:nil="true" />
    <d2p1:FirstSentToKitchenTime i:nil="true" />
    <d2p1:FulfilledTime i:nil="true" />
    <d2p1:Guests />
    <d2p1:Items />
    <d2p1:LastBumpTime i:nil="true" />
    <d2p1:LastPaymentTime i:nil="true" />
    <d2p1:LastSentToKitchenTime i:nil="true" />
    <d2p1:ModeCharge>0</d2p1:ModeCharge>
    <d2p1:OrderId>0</d2p1:OrderId>
    <d2p1:OrderNumber>0</d2p1:OrderNumber>
    <d2p1:PaymentTotal>0</d2p1:PaymentTotal>
    <d2p1:Promos />
    <d2p1:SequenceNumber>0</d2p1:SequenceNumber>
    <d2p1:SubTotal>0</d2p1:SubTotal>
    <d2p1:Tax>0</d2p1:Tax>
    <d2p1:Tendered>false</d2p1:Tendered>
    <d2p1:Tenders />
    <d2p1:Total>0</d2p1:Total>
  </UpdatedOrder>
</FormattedOrderResponse>