OrderProcessing Web Service

OrderProcessing

Click here for a complete list of operations.

GetAllTransactionsByCustomer

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /ws14/orderprocessing.asmx HTTP/1.1
Host: ws.bloyal.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://bloyal.com/GetAllTransactionsByCustomer"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAllTransactionsByCustomer xmlns="http://bloyal.com/">
      <customerId>int</customerId>
      <associatedEntities>None or Properties or Customer or Lines or Payments or Order or Store or All</associatedEntities>
    </GetAllTransactionsByCustomer>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAllTransactionsByCustomerResponse xmlns="http://bloyal.com/">
      <GetAllTransactionsByCustomerResult>
        <Transaction>
          <ExternalBatchId>string</ExternalBatchId>
          <ExternalTransactionId>string</ExternalTransactionId>
          <OrderId>int</OrderId>
          <CustomerId>int</CustomerId>
          <StoreId>int</StoreId>
          <Store>
            <Type>PhysicalStore or ExternalWebStore or InternalWebStore or VirtualStore or BackOffice</Type>
            <Code>string</Code>
            <Name>string</Name>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <City>string</City>
            <State>string</State>
            <ZipCode>string</ZipCode>
            <Country>string</Country>
            <WebStoreUrl>string</WebStoreUrl>
            <ReplicationLocationId>int</ReplicationLocationId>
            <DefaultShippingLocationId>int</DefaultShippingLocationId>
            <DefaultPickupLocationId>int</DefaultPickupLocationId>
            <Locations xsi:nil="true" />
            <StockOutHandling>Unknown or AcceptSales or AcceptSalesWithWarning or RejectSalesWithWarning or DoNotDisplay</StockOutHandling>
            <PickupType>Unknown or Standard or ShipToLocation</PickupType>
          </Store>
          <DeviceId>int</DeviceId>
          <Device>
            <Model>string</Model>
            <Title>string</Title>
            <Channel>WebStore or Kiosk or Club or Phone or POS or Event or Other or OutsideSales or Mobile or SocialNetwork or Wholesale or Samples</Channel>
            <GiftCardTerminalId>string</GiftCardTerminalId>
            <CreditCardTerminalId>string</CreditCardTerminalId>
            <GiftEnabled>boolean</GiftEnabled>
            <StoreId>int</StoreId>
            <Store xsi:nil="true" />
            <Type>string</Type>
            <Access xsi:nil="true" />
            <RegisterNumber>string</RegisterNumber>
          </Device>
          <ReturnId>int</ReturnId>
          <Token>string</Token>
          <CalcToken>string</CalcToken>
          <AccountNumber>string</AccountNumber>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <CompanyName>string</CompanyName>
          <Phone1>string</Phone1>
          <Phone2>string</Phone2>
          <EmailAddress>string</EmailAddress>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <ZipCode>string</ZipCode>
          <Country>string</Country>
          <Comment>string</Comment>
          <BLoyalReferenceNumber>string</BLoyalReferenceNumber>
          <ReferenceNumber>string</ReferenceNumber>
          <CashierCode>string</CashierCode>
          <Channel>WebStore or Kiosk or Club or Phone or POS or Event or Other or OutsideSales or Mobile or SocialNetwork or Wholesale or Samples</Channel>
          <TotalShipping>decimal</TotalShipping>
          <TotalShippingTax>decimal</TotalShippingTax>
          <TransactionLevelDiscount>decimal</TransactionLevelDiscount>
          <DiscountCode>string</DiscountCode>
          <DiscountReasonCode>string</DiscountReasonCode>
          <CouponCode>string</CouponCode>
          <ReceiptEmail>string</ReceiptEmail>
          <TransactionLines>
            <TransactionLine xsi:nil="true" />
            <TransactionLine xsi:nil="true" />
          </TransactionLines>
          <TransactionPayments>
            <TransactionPayment xsi:nil="true" />
            <TransactionPayment xsi:nil="true" />
          </TransactionPayments>
        </Transaction>
        <Transaction>
          <ExternalBatchId>string</ExternalBatchId>
          <ExternalTransactionId>string</ExternalTransactionId>
          <OrderId>int</OrderId>
          <CustomerId>int</CustomerId>
          <StoreId>int</StoreId>
          <Store>
            <Type>PhysicalStore or ExternalWebStore or InternalWebStore or VirtualStore or BackOffice</Type>
            <Code>string</Code>
            <Name>string</Name>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <City>string</City>
            <State>string</State>
            <ZipCode>string</ZipCode>
            <Country>string</Country>
            <WebStoreUrl>string</WebStoreUrl>
            <ReplicationLocationId>int</ReplicationLocationId>
            <DefaultShippingLocationId>int</DefaultShippingLocationId>
            <DefaultPickupLocationId>int</DefaultPickupLocationId>
            <Locations xsi:nil="true" />
            <StockOutHandling>Unknown or AcceptSales or AcceptSalesWithWarning or RejectSalesWithWarning or DoNotDisplay</StockOutHandling>
            <PickupType>Unknown or Standard or ShipToLocation</PickupType>
          </Store>
          <DeviceId>int</DeviceId>
          <Device>
            <Model>string</Model>
            <Title>string</Title>
            <Channel>WebStore or Kiosk or Club or Phone or POS or Event or Other or OutsideSales or Mobile or SocialNetwork or Wholesale or Samples</Channel>
            <GiftCardTerminalId>string</GiftCardTerminalId>
            <CreditCardTerminalId>string</CreditCardTerminalId>
            <GiftEnabled>boolean</GiftEnabled>
            <StoreId>int</StoreId>
            <Store xsi:nil="true" />
            <Type>string</Type>
            <Access xsi:nil="true" />
            <RegisterNumber>string</RegisterNumber>
          </Device>
          <ReturnId>int</ReturnId>
          <Token>string</Token>
          <CalcToken>string</CalcToken>
          <AccountNumber>string</AccountNumber>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <CompanyName>string</CompanyName>
          <Phone1>string</Phone1>
          <Phone2>string</Phone2>
          <EmailAddress>string</EmailAddress>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <ZipCode>string</ZipCode>
          <Country>string</Country>
          <Comment>string</Comment>
          <BLoyalReferenceNumber>string</BLoyalReferenceNumber>
          <ReferenceNumber>string</ReferenceNumber>
          <CashierCode>string</CashierCode>
          <Channel>WebStore or Kiosk or Club or Phone or POS or Event or Other or OutsideSales or Mobile or SocialNetwork or Wholesale or Samples</Channel>
          <TotalShipping>decimal</TotalShipping>
          <TotalShippingTax>decimal</TotalShippingTax>
          <TransactionLevelDiscount>decimal</TransactionLevelDiscount>
          <DiscountCode>string</DiscountCode>
          <DiscountReasonCode>string</DiscountReasonCode>
          <CouponCode>string</CouponCode>
          <ReceiptEmail>string</ReceiptEmail>
          <TransactionLines>
            <TransactionLine xsi:nil="true" />
            <TransactionLine xsi:nil="true" />
          </TransactionLines>
          <TransactionPayments>
            <TransactionPayment xsi:nil="true" />
            <TransactionPayment xsi:nil="true" />
          </TransactionPayments>
        </Transaction>
      </GetAllTransactionsByCustomerResult>
    </GetAllTransactionsByCustomerResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /ws14/orderprocessing.asmx HTTP/1.1
Host: ws.bloyal.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetAllTransactionsByCustomer xmlns="http://bloyal.com/">
      <customerId>int</customerId>
      <associatedEntities>None or Properties or Customer or Lines or Payments or Order or Store or All</associatedEntities>
    </GetAllTransactionsByCustomer>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetAllTransactionsByCustomerResponse xmlns="http://bloyal.com/">
      <GetAllTransactionsByCustomerResult>
        <Transaction>
          <ExternalBatchId>string</ExternalBatchId>
          <ExternalTransactionId>string</ExternalTransactionId>
          <OrderId>int</OrderId>
          <CustomerId>int</CustomerId>
          <StoreId>int</StoreId>
          <Store>
            <Type>PhysicalStore or ExternalWebStore or InternalWebStore or VirtualStore or BackOffice</Type>
            <Code>string</Code>
            <Name>string</Name>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <City>string</City>
            <State>string</State>
            <ZipCode>string</ZipCode>
            <Country>string</Country>
            <WebStoreUrl>string</WebStoreUrl>
            <ReplicationLocationId>int</ReplicationLocationId>
            <DefaultShippingLocationId>int</DefaultShippingLocationId>
            <DefaultPickupLocationId>int</DefaultPickupLocationId>
            <Locations xsi:nil="true" />
            <StockOutHandling>Unknown or AcceptSales or AcceptSalesWithWarning or RejectSalesWithWarning or DoNotDisplay</StockOutHandling>
            <PickupType>Unknown or Standard or ShipToLocation</PickupType>
          </Store>
          <DeviceId>int</DeviceId>
          <Device>
            <Model>string</Model>
            <Title>string</Title>
            <Channel>WebStore or Kiosk or Club or Phone or POS or Event or Other or OutsideSales or Mobile or SocialNetwork or Wholesale or Samples</Channel>
            <GiftCardTerminalId>string</GiftCardTerminalId>
            <CreditCardTerminalId>string</CreditCardTerminalId>
            <GiftEnabled>boolean</GiftEnabled>
            <StoreId>int</StoreId>
            <Store xsi:nil="true" />
            <Type>string</Type>
            <Access xsi:nil="true" />
            <RegisterNumber>string</RegisterNumber>
          </Device>
          <ReturnId>int</ReturnId>
          <Token>string</Token>
          <CalcToken>string</CalcToken>
          <AccountNumber>string</AccountNumber>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <CompanyName>string</CompanyName>
          <Phone1>string</Phone1>
          <Phone2>string</Phone2>
          <EmailAddress>string</EmailAddress>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <ZipCode>string</ZipCode>
          <Country>string</Country>
          <Comment>string</Comment>
          <BLoyalReferenceNumber>string</BLoyalReferenceNumber>
          <ReferenceNumber>string</ReferenceNumber>
          <CashierCode>string</CashierCode>
          <Channel>WebStore or Kiosk or Club or Phone or POS or Event or Other or OutsideSales or Mobile or SocialNetwork or Wholesale or Samples</Channel>
          <TotalShipping>decimal</TotalShipping>
          <TotalShippingTax>decimal</TotalShippingTax>
          <TransactionLevelDiscount>decimal</TransactionLevelDiscount>
          <DiscountCode>string</DiscountCode>
          <DiscountReasonCode>string</DiscountReasonCode>
          <CouponCode>string</CouponCode>
          <ReceiptEmail>string</ReceiptEmail>
          <TransactionLines>
            <TransactionLine xsi:nil="true" />
            <TransactionLine xsi:nil="true" />
          </TransactionLines>
          <TransactionPayments>
            <TransactionPayment xsi:nil="true" />
            <TransactionPayment xsi:nil="true" />
          </TransactionPayments>
        </Transaction>
        <Transaction>
          <ExternalBatchId>string</ExternalBatchId>
          <ExternalTransactionId>string</ExternalTransactionId>
          <OrderId>int</OrderId>
          <CustomerId>int</CustomerId>
          <StoreId>int</StoreId>
          <Store>
            <Type>PhysicalStore or ExternalWebStore or InternalWebStore or VirtualStore or BackOffice</Type>
            <Code>string</Code>
            <Name>string</Name>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <City>string</City>
            <State>string</State>
            <ZipCode>string</ZipCode>
            <Country>string</Country>
            <WebStoreUrl>string</WebStoreUrl>
            <ReplicationLocationId>int</ReplicationLocationId>
            <DefaultShippingLocationId>int</DefaultShippingLocationId>
            <DefaultPickupLocationId>int</DefaultPickupLocationId>
            <Locations xsi:nil="true" />
            <StockOutHandling>Unknown or AcceptSales or AcceptSalesWithWarning or RejectSalesWithWarning or DoNotDisplay</StockOutHandling>
            <PickupType>Unknown or Standard or ShipToLocation</PickupType>
          </Store>
          <DeviceId>int</DeviceId>
          <Device>
            <Model>string</Model>
            <Title>string</Title>
            <Channel>WebStore or Kiosk or Club or Phone or POS or Event or Other or OutsideSales or Mobile or SocialNetwork or Wholesale or Samples</Channel>
            <GiftCardTerminalId>string</GiftCardTerminalId>
            <CreditCardTerminalId>string</CreditCardTerminalId>
            <GiftEnabled>boolean</GiftEnabled>
            <StoreId>int</StoreId>
            <Store xsi:nil="true" />
            <Type>string</Type>
            <Access xsi:nil="true" />
            <RegisterNumber>string</RegisterNumber>
          </Device>
          <ReturnId>int</ReturnId>
          <Token>string</Token>
          <CalcToken>string</CalcToken>
          <AccountNumber>string</AccountNumber>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <CompanyName>string</CompanyName>
          <Phone1>string</Phone1>
          <Phone2>string</Phone2>
          <EmailAddress>string</EmailAddress>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <ZipCode>string</ZipCode>
          <Country>string</Country>
          <Comment>string</Comment>
          <BLoyalReferenceNumber>string</BLoyalReferenceNumber>
          <ReferenceNumber>string</ReferenceNumber>
          <CashierCode>string</CashierCode>
          <Channel>WebStore or Kiosk or Club or Phone or POS or Event or Other or OutsideSales or Mobile or SocialNetwork or Wholesale or Samples</Channel>
          <TotalShipping>decimal</TotalShipping>
          <TotalShippingTax>decimal</TotalShippingTax>
          <TransactionLevelDiscount>decimal</TransactionLevelDiscount>
          <DiscountCode>string</DiscountCode>
          <DiscountReasonCode>string</DiscountReasonCode>
          <CouponCode>string</CouponCode>
          <ReceiptEmail>string</ReceiptEmail>
          <TransactionLines>
            <TransactionLine xsi:nil="true" />
            <TransactionLine xsi:nil="true" />
          </TransactionLines>
          <TransactionPayments>
            <TransactionPayment xsi:nil="true" />
            <TransactionPayment xsi:nil="true" />
          </TransactionPayments>
        </Transaction>
      </GetAllTransactionsByCustomerResult>
    </GetAllTransactionsByCustomerResponse>
  </soap12:Body>
</soap12:Envelope>