GET v1/Customers/{customerId}/Order/Recent

Returns recent orders for given customer

URI template

v1/Customers/{customerId}/Order/Recent?offset={offset}&limit={limit}&VerifyOrderDesignIdBySite={VerifyOrderDesignIdBySite}

Request Information

URI Parameters

Name	Description	Type	Additional information
customerId	customer Id	globally unique identifier	Required
offset	offset for paging	integer	Default value is 0
limit	count of orders	integer	Default value is 5
VerifyOrderDesignIdBySite	Specify false to include old orders that use a different design for the site	boolean	None.

Body Parameters

None.

Response Information

Resource Description

collection of orders. Known internal errors are BadRequest and Error

Collection of ExternalOrder

Name	Description	Type	Additional information
SiteId	Get or set the SiteId property	integer	None.
OrderId	Get or set the OrderId property	integer	None.
MenuId	Get or set the MenuId property	integer	None.
PromoId	POS Promo that were applied to the order.	integer	None.
DesignId	Get or set the DesignId property	integer	None.
OrderMode	Get or set the OrderMode property	OrderModeType	None.
LastModifiedTimestamp	Get or set the LastModifiedTimestamp property	date	None.
Status	Get or set the Status property	OrderStatus	None.
PromiseDateTime	Get or set the PromiseDateTime property	date	None.
PaymentMode	Get or set the PaymentMode property	PaymentMode	None.
Customer	Get or set the Customer property	OrderCustomer	None.
CustomerAddressForOrder	Get or set the CustomerAddressForOrder property	CustomerAddress	None.
LineItems	Get or set the LineItems property	Collection of ExternalLineItem	None.
SubTotalAmount	Value is valid after successful Calculate Tax And Total or Submit Order call. This is only amount charged for items and amount charged for fees. This does not include discounts, tips, tax, ... [To be deprecated in the future. Refer to the Financial Summary object]	decimal number	None.
TotalSurchargeAmount	Value returned from CTT This is the total amount of surcharge applied to the order and broken out as a separate item for review. Refer to AO-12989.	decimal number	None.
TaxAmount	Value is valid after successful Calculate Tax And Total or Submit Order call.	decimal number	None.
PaymentAmount	Get or set the PaymentAmount property	decimal number	None.
TotalAmount	Value is valid after successful Calculate Tax and Total or Submit Order call. Before that, it is not valid. This is almost complete amount charged for order. Only Tips are not included in TotalAmount. After including TipAmount, we will have complete amount charged for order. So total amount includes amount charged for items, amount charged for delivery fee, amount charged for tax and discounts. [To be deprecated in the future. Refer to the Financial Summary object]	decimal number	None.
BalanceDueAmount	Value is proper after successful Calculate Tax and Total, or Submit Order call. Before that, it is estimated value. How much still needs to be paid. But this does not include Tips and stored value card (gift card) payments.	decimal number	None.
LoyaltyCardNumber	Get or set the loyalty card number sent with the order	string	None.
LoyaltyRewards	Get or set the loyalty rewards	Collection of RewardDetails	None.
OrderSource	Get or set the OrderSource property	OrderSourceType	None.
Destination	Describes where the order is suppose to be at	DestinationType	None.
NextItemLineNumber	Get or set the NextItemLineNumber property	integer	None.
SpecialInstructions	Get or set the SpecialInstructions property	string	None.
SubmitCommandId	Get or set the SubmitCommandId property	globally unique identifier	None.
SubmitOrderNumber	Get or set the SubmitOrderNumber property	integer	None.
HumanReadableSubmitOrderNumber	Get or set the HumanReadableSubmitOrderNumber property	integer	None.
SubmitMessage	Get or set the SubmitMessage property	string	None.
CreationDateTime	Get or set the CreationDateTime property	date	None.
CompId	Get or set the CompId property	integer	None.
AppliedComps	POS Comps that were applied to the order.	Collection of ExternalPosComp	None.
CompValue	Get or set the CompValue property	decimal number	None.
CompName	Get or set the CompName property	string	None.
DeliveryFeeAmount	Amount charged for delivery fee.	decimal number	None.
TaxJurisdictionId	Get or set the TaxJurisdictionId property	integer	None.
SubmitOrderId	Get or set the SubmitOrderId property	integer	None.
IsFailover	Get or set the IsFailover property	boolean	None.
ReferenceNumber	Gets or sets the reference number.	integer	None.
ExternalOrderId	Gets or sets the external order id.	string	None.
ComboItems	A list of combo items in the order	Collection of ComboItem	None.
Guests	Represents a guest (seat) on the order and the items associated with that guest. Also includes sub-elements for total, tax, and order charge information.	Collection of OutGuest	None.
SVCAmount	Stored value card amount applied to the order. This is amount paid using stored value card.	decimal number	None.
Payments	List of payments assigned to this order	Collection of ExternalPayment	None.
NextOrderOfProcessing	The order of processing that will be given to the next payment added to the order	integer	None.
SiteNotes	The site notes that are returned by the point of sale	string	None.
IsVisible	The IsVisible value of the order	boolean	None.
DiscountTotal	The total discount on the order returned by RPOS including loyalty assigned at the store.	decimal number	None.
Metadata	Gets or sets the OrderMetadata property.	OrderMetadata	None.
ComputedDiscount	+ summed up items and modifiers prices - with subtracted total amount + tax, for exclusive taxes (usual case, Tax is specified on ATO-xml response)	decimal number	None.
OrderDiscounts	Accepted Order discounts	Collection of OrderDiscount	None.
SavedOrderId	ID of the corresponding SavedOrder. Note: This is not returned in the Submit Order response.	integer	None.
PromotionsServiceResponse		PesGetPromotionsServiceResponse	None.
LoyaltyStatus		integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "SiteId": 0,
    "OrderId": 0,
    "MenuId": 0,
    "PromoId": 0,
    "DesignId": 0,
    "OrderMode": 0,
    "LastModifiedTimestamp": "0001-01-01T00:00:00",
    "Status": 0,
    "PromiseDateTime": null,
    "PaymentMode": 0,
    "Customer": null,
    "CustomerAddressForOrder": null,
    "LineItems": null,
    "SubTotalAmount": 0.0,
    "TotalSurchargeAmount": 0.0,
    "TaxAmount": 0.0,
    "PaymentAmount": 0.0,
    "TotalAmount": 0.0,
    "BalanceDueAmount": 0.0,
    "LoyaltyCardNumber": null,
    "LoyaltyRewards": null,
    "OrderSource": null,
    "Destination": null,
    "NextItemLineNumber": 0,
    "SpecialInstructions": null,
    "SubmitCommandId": null,
    "SubmitOrderNumber": null,
    "HumanReadableSubmitOrderNumber": null,
    "SubmitMessage": null,
    "CreationDateTime": null,
    "CompId": 0,
    "CompValue": 0.0,
    "CompName": null,
    "DeliveryFeeAmount": 0.0,
    "TaxJurisdictionId": null,
    "SubmitOrderId": null,
    "IsFailover": false,
    "ReferenceNumber": null,
    "ExternalOrderId": null,
    "ComboItems": null,
    "Guests": null,
    "SVCAmount": 0.0,
    "Payments": null,
    "NextOrderOfProcessing": 0,
    "SiteNotes": null,
    "IsVisible": false,
    "DiscountTotal": 0.0,
    "Metadata": null,
    "ComputedDiscount": 0.0,
    "OrderDiscounts": null,
    "TipAmount": 0.0,
    "PromotionsServiceResponse": null,
    "LoyaltyStatus": null
  }
]

application/xml, text/xml

Sample:

<ArrayOfExternalOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
  <ExternalOrder>
    <AppliedComps i:nil="true" />
    <BalanceDueAmount>0</BalanceDueAmount>
    <ComboItems xmlns:d3p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound" i:nil="true" />
    <CompId>0</CompId>
    <CompName i:nil="true" />
    <CompValue>0</CompValue>
    <ComputedDiscount>0</ComputedDiscount>
    <CreationDateTime i:nil="true" />
    <Customer i:nil="true" />
    <CustomerAddressForOrder i:nil="true" />
    <DeliveryFeeAmount>0</DeliveryFeeAmount>
    <DesignId>0</DesignId>
    <Destination i:nil="true" />
    <DiscountTotal>0</DiscountTotal>
    <ExternalOrderId i:nil="true" />
    <Guests i:nil="true" />
    <HumanReadableSubmitOrderNumber i:nil="true" />
    <IsFailover>false</IsFailover>
    <IsVisible>false</IsVisible>
    <LastModifiedTimestamp>0001-01-01T00:00:00</LastModifiedTimestamp>
    <LineItems i:nil="true" />
    <LoyaltyCardNumber i:nil="true" />
    <LoyaltyRewards xmlns:d3p1="http://schemas.datacontract.org/2004/07/Radiant.Order.Shared.Contracts.ServiceEntities" i:nil="true" />
    <LoyaltyStatus i:nil="true" />
    <MenuId>0</MenuId>
    <Metadata xmlns:d3p1="http://schemas.datacontract.org/2004/07/Radiant.Order.Shared.Contracts.ServiceEntities" i:nil="true" />
    <NextItemLineNumber>0</NextItemLineNumber>
    <NextOrderOfProcessing>0</NextOrderOfProcessing>
    <OrderDiscounts i:nil="true" />
    <OrderId>0</OrderId>
    <OrderMode />
    <OrderSource i:nil="true" />
    <PaymentAmount>0</PaymentAmount>
    <PaymentMode>Unknown</PaymentMode>
    <Payments i:nil="true" />
    <PromiseDateTime i:nil="true" />
    <PromoId>0</PromoId>
    <PromotionsServiceResponse xmlns:d3p1="http://schemas.datacontract.org/2004/07/Radiant.Order.Shared.Contracts.ServiceEntities.Entities.PesLoyalty" i:nil="true" />
    <ReferenceNumber i:nil="true" />
    <SVCAmount>0</SVCAmount>
    <SavedOrderId i:nil="true" />
    <SiteId>0</SiteId>
    <SiteNotes i:nil="true" />
    <SpecialInstructions i:nil="true" />
    <Status>Invalid</Status>
    <SubTotalAmount>0</SubTotalAmount>
    <SubmitCommandId i:nil="true" />
    <SubmitMessage i:nil="true" />
    <SubmitOrderId i:nil="true" />
    <SubmitOrderNumber i:nil="true" />
    <TaxAmount>0</TaxAmount>
    <TaxJurisdictionId i:nil="true" />
    <TipAmount>0</TipAmount>
    <TotalAmount>0</TotalAmount>
    <TotalSurchargeAmount>0</TotalSurchargeAmount>
  </ExternalOrder>
</ArrayOfExternalOrder>