GetOrders

​

This call is to retrieve all Orders opened on the business date requested.

Note: This call is quite heavy. We recommend a longer wait time on the Response, and to implement at least a 2-minute sleep in between calls to this method. Please refer to the Best Practice Guide.

Request Parameters
  • BusinessDate DateTime — Specify the business date that you would like to retrieve Orders for.
  • ExcludeOpenOrders bool — (optional) Specify True to display only closed Orders, or False to display both open and closed Orders. Default is False if not specified.
  • ModifiedTime DateTimeOffset — (optional) When specified, only Orders that have been modified on or after the specified time will be retrieved.
  • PriceRollUp string — (optional) How to display pricing for combo items. Default is RollUp if not specified.
    • RollUp - Child Items' prices roll up into the Combo (Child Items = 0, Parent/Combo has value)
    • DetailsOnly - Combo Items = 0, Child Items have individual pricing
    • RollUpAndDetails - Both Combo and Child Items display their pricing
Response Parameters

  • Message string — Returns a PAR POS Error message if the request did not go through. Otherwise, this field will be null.

  • ResultCode int — Returns one of the following:

    • 0 — Success
    • 1 — Unknown Error
    • 2 — Invalid Request
    • 3 — Server Unavailable
    • 4 — Access Denied

  • Orders Array of Order — Orders for the business date requested.

    Order Properties

    • BusinessDate DateTime — Business date of this Order (the time component will always return as 00:00:00)

    • ClosedTime DateTimeOffset? — Date and time this Order was closed in UTC, null if not yet closed

    • Count int — Returns one of the following, depending on content of the Order: 0 = Reflects an empty Order (e.g. Entries deleted or voided, Total is 0), 1 = Reflects a full Order

    • CustomerId Guid? — Id of the Customer on this Order, or null if there was no assigned Customer

    • CustomerMaskedAccountNumber string? — Masked account number associated with the Customer on this Order, or null if unavailable

    • Deposits Array of OrderDeposit — Deposits paid for this Order, typically for future date orders

      OrderDeposit Properties
      • Amount decimal — Amount of this OrderDeposit
      • BusinessDate DateTime — Business date this OrderDeposit was taken
      • EmployeeId int? — Maps to the Id of the Employee who applied this OrderDeposit
      • Id int — Unique Id of this OrderDeposit
      • IsApplied bool — True if this OrderDeposit has been applied to the Order, False if not
      • IsDeleted bool — True if this OrderDeposit has been deleted, False if not
      • IsReversal bool — True if this OrderDeposit is a reversal that offsets a deleted deposit, False if not
      • OriginalOrderDepositId int? — Id of the original OrderDeposit being reversed, if this OrderDeposit is a reversal
      • PaymentId int — Id of the OrderPayment that correlates to this OrderDeposit
      • TenderId int — Maps to the Id of the Tender used for this OrderDeposit

    • DestinationId int? — Maps to the Id of the Destination of this Order

    • Discounts Array of OrderDiscount — Discounts applied to this Order

      OrderDiscount Properties
      • Amount decimal — Amount of this OrderDiscount
      • ApproverEmployeeId int? — Maps to the Id of the Employee who approved this OrderDiscount
      • DiscountId int — Maps to the Id of the Discount for this OrderDiscount
      • EmployeeId int? — Maps to the Id of the Employee who applied this OrderDiscount
      • ExternalLoyaltyAccount string — Number of the external loyalty account through which this OrderDiscount is applied
      • Id int — Unique Id of this OrderDiscount within the Order
      • LoyaltyRewardId int? — Maps to the Id of the LoyaltyReward if this OrderDiscount is applied via a loyalty reward
      • Name string — Name of this OrderDiscount
      • Source int — 0 = Other, 1 = LoyaltyCard, 2 = LoyaltyReward

    • DisplaySubtotal decimal — Same as Subtotal unless this Order contains inclusive tax, then those taxes would be added to this DisplaySubtotal and subtracted from DisplayTax

    • DisplayTax decimal — Same as Tax unless this Order contains inclusive tax, then those taxes won't be counted in this DisplayTax

    • EmployeeId int? — Maps to the Id of the Employee who processed this Order

    • Entries Array of OrderEntry — Entries in this Order. An OrderEntry can either be of type OrderItem or an OrderGiftCard.

      OrderEntry — OrderItem Properties

      • CompositeOrderItemId int? — Maps to the Id of the OrderItem within the Order that is the CompositeOrderItem, if this OrderItem is part of a combo

      • DayPartId int? — Maps to the Id of the DayPart of this OrderItem

      • Denominator byte — Denominator by which this OrderItem was split

      • Description string — Description of this OrderItem

      • DestinationId int? — Maps to the Id of the Destination of this OrderItem

      • Discounts Array of OrderItemDiscount — Discounts applied to this OrderItem

        OrderItemDiscount Properties
        • Amount decimal — Amount of discount applied to the OrderItem
        • Id int — Unique Id of this OrderItemDiscount within the OrderItem
        • OrderDiscountId int — Maps to the Id of the Discount for this OrderItemDiscount

      • DisplayPrice decimal — Price displayed for this OrderItem

      • GrossSales decimal — Gross sales for this OrderItem and its children

      • Id int — Unique Id of this OrderItem within the Order

      • IsCleared bool — True if this OrderItem was cleared, False if not

      • IsDeleted bool — True if this OrderItem was deleted, False if not

      • IsVoided bool — True if this OrderItem was voided, False if not

      • ItemGrossSales decimal — Gross sales for this OrderItem only

      • ItemId int — Maps to the Id of the Item of this OrderItem

      • ItemNetSales decimal — Net sales for this OrderItem only

      • Modifiers Array of OrderItemModifier — Modifiers applied to this OrderItem

        OrderItemModifier Properties

        • DisplayPrice decimal — Price displayed for this OrderItemModifier

        • GrossSales decimal — Gross sales for this OrderItemModifier and its children

        • Id int — Unique Id of this OrderItemModifier within the OrderItem

        • ItemGrossSales decimal — Gross sales for this OrderItemModifier only

        • ItemId int — Maps to the Id of the Item for this OrderItemModifier

        • ItemNetSales decimal — Net sales for this OrderItemModifier only

        • ModifierCodeId int — Maps to the Id of the ModifierCode for this OrderItemModifier

        • ModifierGroupId int — Maps to the Id of the ModifierGroup for this OrderItemModifier

        • Modifiers Array of OrderItemModifier — Nested modifiers

        • NetSales decimal — Net sales for this OrderItemModifier and its children

        • Price decimal — Price of this OrderItemModifier

        • Taxes Array of OrderEntryTax — Taxes applied to this OrderItemModifier

          OrderEntryTax Properties
          • Amount decimal — Amount of tax applied to the OrderEntry
          • Id int — Unique Id of this OrderEntryTax within the OrderEntry
          • IsInclusive bool — True if this OrderEntryTax is an inclusive tax, False if not
          • TaxId int — Maps to the Id of the Tax of this OrderEntryTax

      • NetSales decimal — Net sales for this OrderItem and its children

      • NonRevenueItem bool — True if this OrderItem is a non-revenue Item, False if not

      • Note string — Note for this OrderItem

      • Promotions Array of OrderEntryPromotion — Promotions applied to this OrderItem

        OrderEntryPromotion Properties
        • Amount decimal — Amount of promotion applied to the OrderEntry
        • Id int — Unique Id of this OrderItemPromotion within the OrderEntry
        • OrderPromotionId int — Maps to the Id of the Promotion of this OrderEntryPromotion

      • Price decimal — Price of this OrderItem

      • RevenueCenterId int — Maps to the Id of the RevenueCenter of this OrderItem

      • SplitItemId short — Maps to the Id of the OrderItem within the Order that this OrderItem was split from

      • Taxes Array of OrderEntryTax — Taxes applied to this OrderItem

        OrderEntryTax Properties
        • Amount decimal — Amount of tax applied to the OrderEntry
        • Id int — Unique Id of this OrderEntryTax within the OrderEntry
        • IsInclusive bool — True if this OrderEntryTax is an inclusive tax, False if not
        • TaxId int — Maps to the Id of the Tax of this OrderEntryTax

      • Void OrderItemVoid — Details about a void, if this OrderItem was voided

        OrderItemVoid Properties
        • ApproverEmployeeId int — Maps to the Id of the Employee who approved this void
        • EmployeeId int — Maps to the Id of the Employee who performed this void
        • Time DateTimeOffset — Date and time this void was performed in UTC
        • VoidReasonId int — Maps to the Id of the VoidReason for this void
      OrderEntry — OrderGiftCard Properties

      • AccountNumber string — Card number of this OrderGiftCard, populated for gift card item(typically only the last 4 digits)

      • DayPartId int? — Maps to the Id of the DayPart of this OrderItem

      • Description string — Description of this OrderGiftCard

      • Id int — Unique Id of this OrderGiftCard within the Order

      • ItemId int — Maps to the Id of the Item of this OrderGiftCard

      • Price decimal — Price of this OrderGiftCard

      • Promotions Array of OrderEntryPromotion — Promotions applied to this OrderGiftCard

        OrderEntryPromotion Properties
        • Amount decimal — Amount of promotion applied to the OrderEntry
        • Id int — Unique Id of this OrderItemPromotion within the OrderEntry
        • OrderPromotionId int — Maps to the Id of the Promotion of this OrderEntryPromotion

    • FirstSendTime DateTimeOffset? — Date and time this Order was first sent to the kitchen in UTC, null if not sent

    • FutureDateOrderStatus string? — Status of the future date order, null if not applicable

    • GrossSales decimal — Gross sales for this Order

    • GuestCount int — Number of guests for this Order

    • GuestCountFractional decimal — Fractional number of guests for this Order

    • Id long — Unique Id of this Order

    • IdEncoded string — Unique encoded Id of this Order

    • IdNoLocation int — Unique Id of this order with location identifier removed. This is shorter and generally passed to integrations, including credit processors.

    • IsClosed bool — True if this Order is closed, False if not

    • IsFutureOrder bool — True if this Order is a future order, False if not

    • IsRefund bool — True if this Order is a refund, False if not

    • IsTaxExempt bool — True if this Order is exempt from taxes, False if not

    • ModifiedTime DateTimeOffset — Date and time this Order was last modified in the location's local time

    • Name string — Name of this Order

    • NetSales decimal — Net sales for this Order

    • Number short — Order, receipt, or call out number that cashiers use to call the customer for this Order

    • OpenedTime DateTimeOffset — Date and time this Order was opened in UTC

    • OrderAdditionalDetails string — Additional loyalty or payment information for this Order, depending on each individual processor. Note: This is a JSON-formatted string.

    • Payments Array of OrderPayment — Payments applied to this Order

      OrderPayment Properties

      • Amount decimal — Amount of this OrderPayment

      • AdditionalData List<NameValuePair> — Any additional information

      • BusinessDate DateTime — Business date this OrderPayment was applied (time component is 00:00:00)

      • CardHolderName string — Name of the cardholder of this OrderPayment, for card payments

      • CardNumber string — Card number of this OrderPayment, populated for credit card and gift card payments (typically only the last 4 digits)

      • Change decimal — Change given on this OrderPayment

      • CreditCardTransactionInformation CreditCardTransactionInformation — Additional credit card transaction information returned by Vantiv

        CreditCardTransactionInformation Properties
        • AuthorizationCode string — Authorization code returned from Vantiv
        • CardToken string — Card token returned from Vantiv
        • ClientTransactionIdentifier string — Client transaction identifier returned from Vantiv
        • Result string — Result returned from Vantiv

      • Details Array of OrderPaymentDetail — Transactional details for this OrderPayment

        OrderPaymentDetail Properties
        • Amount decimal — Amount of this OrderPaymentDetail
        • EmployeeId int? — Maps to the Id of the Employee who processed this OrderPaymentDetail
        • Id int — Unique Id of this OrderPaymentDetail within the Order
        • TillNumber int? — Maps to the Number of the Till that this OrderPaymentDetail was originally taken on
        • TipAmount decimal — Tip amount for this OrderPaymentDetail
        • Type int — 1 = Initial Payment, 2 = Adjustment, 3 = Change given, 4 = Transfer from, 5 = Transfer to

      • EmployeeId int? — Maps to the Id of the Employee who applied this OrderPayment

      • Id int — Unique Id of this OrderPayment within the Order

      • IsDeleted bool — True if this OrderPayment was deleted, False if not

      • MerchantAccountType int? — For credit card payments: 0 = Standard Merchant Account, 1 = eCommerce Merchant Account

      • TenderId int — Maps to the Id of the Tender of this OrderPayment

      • TillNumber int? — Maps to the Number of the Till that this OrderPayment was originally taken on

      • TipAmount decimal — Tip amount for this OrderPayment

    • PickupTime DateTime? — Date and time this Order is scheduled for pick up in UTC, null if not applicable

    • Promotions Array of OrderPromotion — Promotions applied to this Order

      OrderPromotion Properties
      • Amount decimal — Amount of promotion applied to the Order
      • ApproverEmployeeId int? — Maps to the Id of the Employee who approved this OrderPromotion
      • EmployeeId int? — Maps to the Id of the Employee who applied this OrderPromotion
      • Id int — Unique Id of this OrderPromotion within the Order
      • Name string — Name of this OrderPromotion
      • PromotionId int — Maps to the Id of the Promotion of this OrderPromotion

    • Rounding decimal — Amount by which the Order was rounded to, reflecting the rounding settings

    • RefundReasonId int — Maps to the Id of the RefundReason used for this refund Order

    • SectionId int? — Maps to the Id of the Section of this Order

    • Subtotal decimal — Subtotal of this Order

    • Surcharges Array of OrderSurcharge — Surcharges applied to this Order

      OrderSurcharge Properties

      • Amount decimal — Amount of surcharge applied to the Order

      • ApproverEmployeeId int? — Maps to the Id of the Employee who approved this OrderSurcharge

      • EmployeeId int? — Maps to the Id of the Employee who applied this OrderSurcharge

      • Id int — Unique Id of this OrderSurcharge within the Order

      • IsSystemApplied bool — True if this OrderSurcharge is automatically applied by the system, False if not

      • Name string — Name of this OrderSurcharge

      • SurchargeId int — Maps to the Id of the Surcharge of this OrderSurcharge

      • Taxes Array of OrderEntryTax — Taxes on this OrderSurcharge

        OrderEntryTax Properties
        • Amount decimal — Amount of tax applied to the OrderEntry
        • Id int — Unique Id of this OrderEntryTax within the OrderEntry
        • IsInclusive bool — True if this OrderEntryTax is an inclusive tax, False if not
        • TaxId int — Maps to the Id of the Tax of this OrderEntryTax

    • Tax decimal — Total tax for this Order

    • Taxes Array of OrderTax — Order taxes applied to this Order

      OrderTax Properties
      • Amount decimal — Amount of tax applied to the Order
      • Id int — Unique Id of this OrderTax within the Order
      • TaxId int — Maps to the Id of the Tax of this OrderTax

    • TaxExemptId string — Tax identifier for the tax-exempt entity

    • TerminalId int — Id of the terminal this Order was placed on

    • TillNumber int? — Id of the till that owns this Order, null if not owned

    • Total decimal — Total for this Order

Headers
  • SOAPAction
    Type: string
    required
Body
required
application/json

SOAP envelope containing the GetOrders request with BusinessDate and optional filters.

Responses
  • text/xml; charset=utf-8
Request Example for post/GetOrders
cURL
curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Sales2.svc?GetOrders' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'AccessToken: your-access-token' \
  --header 'LocationToken: your-location-token' \
  --header 'SOAPAction: "http://www.brinksoftware.com/webservices/sales/v2/ISalesWebService2/GetOrders"' \
  --data '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v2="http://www.brinksoftware.com/webservices/sales/v2">
    <soapenv:Header/>
    <soapenv:Body>
      <v2:GetOrders>
        <v2:request>
          <v2:BusinessDate>2024-01-15</v2:BusinessDate>
          <v2:ExcludeOpenOrders>false</v2:ExcludeOpenOrders>
          <v2:PriceRollUp>false</v2:PriceRollUp>
        </v2:request>
      </v2:GetOrders>
    </soapenv:Body>
  </soapenv:Envelope>'

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetOrdersResponse xmlns="http://www.brinksoftware.com/webservices/sales/v2">
      <GetOrdersResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Orders>
          <Order>
            <BusinessDate>2024-01-15T00:00:00</BusinessDate>
            <ClosedTime>2024-01-15T12:45:00Z</ClosedTime>
            <Count>1</Count>
            <CustomerId i:nil="true"/>
            <CustomerMaskedAccountNumber>Guest</CustomerMaskedAccountNumber>
            <Deposits/>
            <DestinationId>1</DestinationId>
            <Discounts>
              <OrderDiscount>
                <Amount>2.00</Amount>
                <ApproverEmployeeId i:nil="true"/>
                <DiscountId>5</DiscountId>
                <EmployeeId>42</EmployeeId>
                <ExternalLoyaltyAccount i:nil="true"/>
                <Id>1</Id>
                <LoyaltyRewardId i:nil="true"/>
                <Name>10% Off</Name>
                <Source>0</Source>
              </OrderDiscount>
            </Discounts>
            <DisplaySubtotal>22.00</DisplaySubtotal>
            <DisplayTax>1.76</DisplayTax>
            <EmployeeId>42</EmployeeId>
            <Entries>
              <OrderEntry i:type="OrderItem">
                <CompositeOrderItemId i:nil="true"/>
                <DayPartId>2</DayPartId>
                <Denominator>1</Denominator>
                <Description>Lunch Special</Description>
                <DestinationId>1</DestinationId>
                <Discounts>
                  <OrderItemDiscount>
                    <Amount>2.00</Amount>
                    <Id>1</Id>
                    <OrderDiscountId>1</OrderDiscountId>
                  </OrderItemDiscount>
                </Discounts>
                <DisplayPrice>22.00</DisplayPrice>
                <GrossSales>24.00</GrossSales>
                <Id>1</Id>
                <IsCleared>false</IsCleared>
                <IsDeleted>false</IsDeleted>
                <IsVoided>false</IsVoided>
                <ItemGrossSales>24.00</ItemGrossSales>
                <ItemId>102</ItemId>
                <ItemNetSales>22.00</ItemNetSales>
                <Modifiers>
                  <OrderItemModifier>
                    <DisplayPrice>0.00</DisplayPrice>
                    <GrossSales>0.00</GrossSales>
                    <Id>1</Id>
                    <ItemGrossSales>0.00</ItemGrossSales>
                    <ItemId>202</ItemId>
                    <ItemNetSales>0.00</ItemNetSales>
                    <ModifierCodeId>0</ModifierCodeId>
                    <ModifierGroupId>3</ModifierGroupId>
                    <Modifiers/>
                    <NetSales>0.00</NetSales>
                    <Price>0.00</Price>
                    <Taxes/>
                  </OrderItemModifier>
                </Modifiers>
                <NetSales>22.00</NetSales>
                <Note/>
                <Price>24.00</Price>
                <Promotions/>
                <SplitItemId>0</SplitItemId>
                <Taxes>
                  <OrderEntryTax>
                    <Amount>1.76</Amount>
                    <Id>1</Id>
                    <IsInclusive>false</IsInclusive>
                    <TaxId>1</TaxId>
                  </OrderEntryTax>
                </Taxes>
                <Void i:nil="true"/>
              </OrderEntry>
            </Entries>
            <FirstSendTime>2024-01-15T12:35:00Z</FirstSendTime>
            <FutureDateOrderStatus>Pending</FutureDateOrderStatus>
            <GrossSales>24.00</GrossSales>
            <GuestCount>1</GuestCount>
            <GuestCountFractional>1.0</GuestCountFractional>
            <Id>12345</Id>
            <IdEncoded>MTIzNDU=</IdEncoded>
            <IdNoLocation>12345</IdNoLocation>
            <IsClosed>true</IsClosed>
            <IsFutureOrder>false</IsFutureOrder>
            <IsRefund>false</IsRefund>
            <IsTaxExempt>false</IsTaxExempt>
            <ModifiedTime>2024-01-15T12:45:00-06:00</ModifiedTime>
            <Name>Dine-In Order</Name>
            <NetSales>22.00</NetSales>
            <Number>1001</Number>
            <OpenedTime>2024-01-15T12:30:00Z</OpenedTime>
            <OrderAdditionalDetails i:nil="true"/>
            <Payments>
              <OrderPayment>
                <AdditionalData/>
                <Amount>23.76</Amount>
                <BusinessDate>2024-01-15T00:00:00</BusinessDate>
                <CardHolderName>John Doe</CardHolderName>
                <CardNumber>************1234</CardNumber>
                <Change>0.00</Change>
                <CreditCardTransactionInformation>
                  <AuthorizationCode>ABC123</AuthorizationCode>
                  <CardToken>token123</CardToken>
                  <ClientTransactionIdentifier>txn001</ClientTransactionIdentifier>
                  <Result>Approved</Result>
                </CreditCardTransactionInformation>
                <Details>
                  <OrderPaymentDetail>
                    <Amount>23.76</Amount>
                    <EmployeeId>42</EmployeeId>
                    <Id>1</Id>
                    <TillNumber>1</TillNumber>
                    <TipAmount>0.00</TipAmount>
                    <Type>1</Type>
                  </OrderPaymentDetail>
                </Details>
                <EmployeeId>42</EmployeeId>
                <Id>1</Id>
                <IsDeleted>false</IsDeleted>
                <MerchantAccountType>0</MerchantAccountType>
                <TenderId>2</TenderId>
                <TillNumber>1</TillNumber>
                <TipAmount>0.00</TipAmount>
              </OrderPayment>
            </Payments>
            <PickupTime i:nil="true"/>
            <Promotions/>
            <RefundReasonId>0</RefundReasonId>
            <Rounding>0.00</Rounding>
            <SectionId>1</SectionId>
            <Subtotal>22.00</Subtotal>
            <Surcharges/>
            <Tax>1.76</Tax>
            <TaxExemptId i:nil="true"/>
            <Taxes>
              <OrderTax>
                <Amount>1.76</Amount>
                <Id>1</Id>
                <TaxId>1</TaxId>
              </OrderTax>
            </Taxes>
            <TerminalId>1</TerminalId>
            <TillNumber>1</TillNumber>
            <Total>23.76</Total>
          </Order>
        </Orders>
      </GetOrdersResult>
    </GetOrdersResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Order objects for the specified business date.

Copyright © 2026 PAR Technology Corporation. All rights reserved.
PAR Technology Corporation 8383 Seneca Turnpike, Suite 3 New Hartford, New York 13413 (315) 738-0600 legal@partech.com. PAR Tech is a leading global provider of software, systems, and service solutions to the restaurant and retail industries. You may learn about its product offerings here.
Before using this application, please read the Limited License Agreement and the PAR Tech Terms of Use. In addition, the sample applications of PAR Technology are licensed under the terms of the O'Saasy License.