GetOrder

​

Retrieve an open Order at the location.

Request Parameters
  • OrderId long — Specify the Id of the Order you would like to retrieve.
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
    • 101 — Order with the OrderId specified was not found

  • Order Order — Order with the OrderId you specified, if one is found.

    Order Properties

    • Balance decimal — Balance remaining on this Order

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

    • CreatedTime DateTimeOffset — Date and time this Order was created in UTC

    • CustomerId Guid — Id of the Customer on this Order, or an empty guid if there was no assigned Customer

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

    • 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 discount applied to the Order
      • DiscountId int — Maps to the Id of the Discount of this OrderDiscount
      • Id int — Unique Id of this OrderDiscount within the Order
      • LoyaltyRewardId int — Maps to the Id of the LoyaltyReward of this OrderDiscount
      • Name string — Name of this OrderDiscount

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

      OrderEntry — OrderItem Properties

      • ComboItems Array of OrderItem — Combo component items in this OrderItem, if this OrderItem is a combo

      • ComponentId int? — Maps to the Id of the ItemCompositeComponent for this OrderItem, if part of a combo

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

      • 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

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

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

      • Modifiers Array of OrderItemModifier — Modifiers applied to this OrderItem

        OrderItemModifier Properties
        • Description string — Description of this OrderItemModifier
        • Id int — Unique Id of this OrderItemModifier within the OrderItem
        • ItemId int — Maps to the Id of the Item for this OrderItemModifier
        • 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
        • Price decimal — Price of this OrderItemModifier
        • Taxes Array of OrderEntryTax — Taxes applied to this OrderItemModifier

      • 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

      • Seat byte — Seat number of this OrderItem

      • SplitItemId short — Id of the SplitItem if this OrderItem is Split, 0 if not split

      • 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
        • TaxId int — Maps to the Id of the Tax of this OrderEntryTax
      OrderEntry — OrderGiftCard Properties

      • 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

    • FutureOrder FutureOrderDetails — Details for this future Order

      FutureOrderDetails Properties

      • Delivery DeliveryDetails — Details for this FutureOrder, if it's a delivery

        DeliveryDetails Properties
        • Address1 string — Address line 1 for this Delivery
        • Address2 string — Address line 2 for this Delivery
        • City string — City for this Delivery
        • Country string — Country for this Delivery
        • PostalCode string — Postal code for this Delivery
        • StateCode string — State code for this Delivery

      • EmailAddress string — Contact email address for this FutureOrder

      • IsCancelled bool — True if the future order is cancelled, False if not

      • ManualSend bool — True if the order will not be sent to the Kitchen automatically based on the Configured Send Time rules, False if not

      • PhoneNumber string — Contact phone number for this FutureOrder

      • PickupTime DateTimeOffset — Time for this FutureOrder to be picked up or delivered in UTC

    • Id long — Unique Id of this Order

    • IdEncoded string — Unique encoded Id of this Order

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

    • IsSent bool — True if this Order has been sent to the kitchen, False if not

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

    • LaneId int — Id of the Lane for this Order

    • Name string — Name of this Order

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

    • Payments Array of OrderPayment — Payments applied to this Order

      OrderPayment Properties

      • AccountNumber string — Account number of this OrderPayment, populated for credit card, gift card, and house account payments

      • AccountType int — Account type for credit card payments. 0=Unspecified, 1=MasterCard, 2=Visa, 3=American Express, 4=Diners, 5=Discover, 6=enRoute, 7=JCB, 8=Private

      • Amount decimal — Amount of this OrderPayment

      • 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

      • 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

      • Id int — Id of this OrderPayment within the Order

      • IsDeposit bool — True if this OrderPayment was a deposit, False if not

      • ReferenceNumber string — Reference number, populated with the authorization code for credit card and gift card payments

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

      • Time DateTimeOffset — Date and time that this OrderPayment was made in UTC

      • TipAmount decimal — Tip amount for this OrderPayment

      • AdditionalData Array of NameValuePair — Any additional information

    • Promotions Array of OrderPromotion — Promotions applied to this Order

      OrderPromotion Properties
      • Amount decimal — Amount of promotion applied to the Order
      • Code string — Code for this OrderPromotion
      • Id int — Unique Id of this OrderPromotion within the Order
      • IsSystemApplied bool — True if this OrderPromotion is system applied, False if not
      • 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

    • 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

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

      • IsSystemApplied bool — True if this OrderSurcharge is system applied, 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 applied to this OrderSurcharge

        OrderEntryTax Properties
        • Amount decimal — Amount that will be applied as tax amount.
        • Id int — Chronologically created unique identifier of tax object which will be applied on order.
        • TaxId int — Unique identifier of this tax, setup in Settings Editor against this location.

    • 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

    • Total decimal — Total for this Order

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

SOAP envelope containing the GetOrder request with OrderId.

Responses
  • text/xml; charset=utf-8
Request Example for post/GetOrder
cURL
curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Ordering.svc?GetOrder' \
  --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/ordering/20140219/IOrderingWebService/GetOrder"' \
  --data '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ns="http://www.brinksoftware.com/webservices/ordering/20140219">
    <soapenv:Header/>
    <soapenv:Body>
      <ns:GetOrder>
        <ns:request>
          <ns:OrderId>12345</ns:OrderId>
        </ns:request>
      </ns:GetOrder>
    </soapenv:Body>
  </soapenv:Envelope>'

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetOrderResponse xmlns="http://www.brinksoftware.com/webservices/ordering/20140219">
      <GetOrderResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Order>
          <Balance>0.00</Balance>
          <BusinessDate>2024-01-15T00:00:00</BusinessDate>
          <CreatedTime>2024-01-15T14:30:00Z</CreatedTime>
          <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
          <CustomerMaskedAccountNumber>Guest</CustomerMaskedAccountNumber>
          <DestinationId>1</DestinationId>
          <Discounts/>
          <Entries>
            <OrderEntry i:type="OrderItem">
              <ComboItems/>
              <ComponentId i:nil="true"/>
              <CompositeOrderItemId>0</CompositeOrderItemId>
              <Denominator>1</Denominator>
              <Description>Classic Burger</Description>
              <DestinationId>1</DestinationId>
              <Discounts/>
              <Id>1</Id>
              <ItemId>101</ItemId>
              <Modifiers>
                <OrderItemModifier>
                  <Description>Extra Cheese</Description>
                  <Id>1</Id>
                  <ItemId>201</ItemId>
                  <ModifierCodeId>0</ModifierCodeId>
                  <ModifierGroupId>5</ModifierGroupId>
                  <Modifiers/>
                  <Price>0.50</Price>
                  <Taxes/>
                </OrderItemModifier>
              </Modifiers>
              <Note/>
              <Price>8.99</Price>
              <Promotions/>
              <Seat>1</Seat>
              <SplitItemId>0</SplitItemId>
              <Taxes>
                <OrderEntryTax>
                  <Amount>0.72</Amount>
                  <Id>1</Id>
                  <TaxId>1</TaxId>
                </OrderEntryTax>
              </Taxes>
            </OrderEntry>
          </Entries>
          <FutureOrder i:nil="true"/>
          <Id>12345</Id>
          <IdEncoded>MTIzNDU=</IdEncoded>
          <IsClosed>false</IsClosed>
          <IsSent>true</IsSent>
          <IsTaxExempt>false</IsTaxExempt>
          <LaneId>1</LaneId>
          <Name>Online Order</Name>
          <Number>1001</Number>
          <Payments>
            <OrderPayment>
              <AccountNumber>************1234</AccountNumber>
              <AccountType>2</AccountType>
              <Amount>9.71</Amount>
              <BusinessDate>2024-01-15T00:00:00</BusinessDate>
              <CardHolderName>John Smith</CardHolderName>
              <CreditCardTransactionInformation>
                <AuthorizationCode>ABC123</AuthorizationCode>
                <CardToken>token123</CardToken>
                <ClientTransactionIdentifier>txn001</ClientTransactionIdentifier>
                <Result>Approved</Result>
              </CreditCardTransactionInformation>
              <Id>1</Id>
              <IsDeposit>false</IsDeposit>
              <ReferenceNumber>ABC123</ReferenceNumber>
              <TenderId>2</TenderId>
              <Time>2024-01-15T14:35:00Z</Time>
              <TipAmount>0.00</TipAmount>
            </OrderPayment>
          </Payments>
          <Promotions/>
          <Rounding>0.00</Rounding>
          <SectionId>1</SectionId>
          <Subtotal>9.49</Subtotal>
          <Surcharges/>
          <Tax>0.72</Tax>
          <Taxes>
            <OrderTax>
              <Amount>0.72</Amount>
              <Id>1</Id>
              <TaxId>1</TaxId>
            </OrderTax>
          </Taxes>
          <Total>10.21</Total>
        </Order>
      </GetOrderResult>
    </GetOrderResponse>
  </s:Body>
</s:Envelope>

SOAP response containing the Order object.

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.