OrderProcessing Web Service

OrderProcessing

Click here for a complete list of operations.

FindSuggestedDiscountsByAccountInfo

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/FindSuggestedDiscountsByAccountInfo"

<?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>
    <FindSuggestedDiscountsByAccountInfo xmlns="http://bloyal.com/">
      <accountInfo>string</accountInfo>
      <productAmount>decimal</productAmount>
      <productQuantity>decimal</productQuantity>
      <entities>None or Properties or Parent or ShippingAddresses or PaymentMethods or Lists or Clubs or Events or Groups or Notes or Programs or PickupOrders or Balances or Rules or PurchaseHistory or ActivityLog or ReferredBy or All</entities>
    </FindSuggestedDiscountsByAccountInfo>
  </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>
    <FindSuggestedDiscountsByAccountInfoResponse xmlns="http://bloyal.com/">
      <FindSuggestedDiscountsByAccountInfoResult>
        <Customers>
          <Customer>
            <Uid>guid</Uid>
            <AccountType>None or Email or UserName or Loyalty</AccountType>
            <AccountId>int</AccountId>
            <ParentUid>guid</ParentUid>
            <ParentId>int</ParentId>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <FirstName2>string</FirstName2>
            <LastName2>string</LastName2>
            <CompanyName>string</CompanyName>
            <BirthDate>dateTime</BirthDate>
            <Title>string</Title>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <City>string</City>
            <State>string</State>
            <ZipCode>string</ZipCode>
            <ZipPlus4>string</ZipPlus4>
            <Country>string</Country>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
            <MobilePhone>string</MobilePhone>
            <FaxNumber>string</FaxNumber>
            <PhoneExt1>string</PhoneExt1>
            <EmailAddress>string</EmailAddress>
            <WebAddress>string</WebAddress>
            <LoyaltyCardNumber>string</LoyaltyCardNumber>
            <LoyaltyPoints>int</LoyaltyPoints>
            <LoyaltyDollars>decimal</LoyaltyDollars>
            <SignupSource>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupSource>
            <Parent xsi:nil="true" />
            <AccountNumber>string</AccountNumber>
            <CreditBalance>decimal</CreditBalance>
            <CreditLimit>decimal</CreditLimit>
            <TotalSales>decimal</TotalSales>
            <TotalTransactions>int</TotalTransactions>
            <LastPurchase>dateTime</LastPurchase>
            <PriceLevel>Base or LevelA or LevelB or LevelC or MSRP</PriceLevel>
            <Type>Consumer or Family or Corporate or Wholesale or Employee or Supplier or Shareholder or NonRevenue or MarkOutOfStock or Partner</Type>
            <IsTaxExempt>boolean</IsTaxExempt>
            <PrimaryShippingAddressId>int</PrimaryShippingAddressId>
            <PrimaryShippingAddress xsi:nil="true" />
            <ShippingAddresses xsi:nil="true" />
            <PrimaryPaymentMethodId>int</PrimaryPaymentMethodId>
            <PrimaryPaymentMethod xsi:nil="true" />
            <PaymentMethods xsi:nil="true" />
            <ClubMemberships xsi:nil="true" />
            <EventMemberships xsi:nil="true" />
            <ListMemberships xsi:nil="true" />
            <GroupMemberships xsi:nil="true" />
            <ProgramMemberships xsi:nil="true" />
            <Notes xsi:nil="true" />
            <DiscountRules xsi:nil="true" />
            <PickupOrders xsi:nil="true" />
            <PurchaseHistory xsi:nil="true" />
            <CustomCode1>int</CustomCode1>
            <CustomCode2>int</CustomCode2>
            <CustomCode3>int</CustomCode3>
            <CustomCode4>int</CustomCode4>
            <CustomCode5>int</CustomCode5>
            <CustomCode6>int</CustomCode6>
            <CustomCode7>int</CustomCode7>
            <CustomCode8>int</CustomCode8>
            <ActivityLogs xsi:nil="true" />
            <AddressValidated>boolean</AddressValidated>
            <ReferredBy xsi:nil="true" />
            <ReferredBy2 xsi:nil="true" />
            <ActiveAlertNotificationCount>int</ActiveAlertNotificationCount>
            <EditAtPOS>boolean</EditAtPOS>
            <ExternalId>string</ExternalId>
            <Salutation>string</Salutation>
            <FacebookId>string</FacebookId>
            <TwitterId>string</TwitterId>
            <MobileDeviceId>string</MobileDeviceId>
            <GuestCustomer>boolean</GuestCustomer>
          </Customer>
          <Customer>
            <Uid>guid</Uid>
            <AccountType>None or Email or UserName or Loyalty</AccountType>
            <AccountId>int</AccountId>
            <ParentUid>guid</ParentUid>
            <ParentId>int</ParentId>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <FirstName2>string</FirstName2>
            <LastName2>string</LastName2>
            <CompanyName>string</CompanyName>
            <BirthDate>dateTime</BirthDate>
            <Title>string</Title>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <City>string</City>
            <State>string</State>
            <ZipCode>string</ZipCode>
            <ZipPlus4>string</ZipPlus4>
            <Country>string</Country>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
            <MobilePhone>string</MobilePhone>
            <FaxNumber>string</FaxNumber>
            <PhoneExt1>string</PhoneExt1>
            <EmailAddress>string</EmailAddress>
            <WebAddress>string</WebAddress>
            <LoyaltyCardNumber>string</LoyaltyCardNumber>
            <LoyaltyPoints>int</LoyaltyPoints>
            <LoyaltyDollars>decimal</LoyaltyDollars>
            <SignupSource>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupSource>
            <Parent xsi:nil="true" />
            <AccountNumber>string</AccountNumber>
            <CreditBalance>decimal</CreditBalance>
            <CreditLimit>decimal</CreditLimit>
            <TotalSales>decimal</TotalSales>
            <TotalTransactions>int</TotalTransactions>
            <LastPurchase>dateTime</LastPurchase>
            <PriceLevel>Base or LevelA or LevelB or LevelC or MSRP</PriceLevel>
            <Type>Consumer or Family or Corporate or Wholesale or Employee or Supplier or Shareholder or NonRevenue or MarkOutOfStock or Partner</Type>
            <IsTaxExempt>boolean</IsTaxExempt>
            <PrimaryShippingAddressId>int</PrimaryShippingAddressId>
            <PrimaryShippingAddress xsi:nil="true" />
            <ShippingAddresses xsi:nil="true" />
            <PrimaryPaymentMethodId>int</PrimaryPaymentMethodId>
            <PrimaryPaymentMethod xsi:nil="true" />
            <PaymentMethods xsi:nil="true" />
            <ClubMemberships xsi:nil="true" />
            <EventMemberships xsi:nil="true" />
            <ListMemberships xsi:nil="true" />
            <GroupMemberships xsi:nil="true" />
            <ProgramMemberships xsi:nil="true" />
            <Notes xsi:nil="true" />
            <DiscountRules xsi:nil="true" />
            <PickupOrders xsi:nil="true" />
            <PurchaseHistory xsi:nil="true" />
            <CustomCode1>int</CustomCode1>
            <CustomCode2>int</CustomCode2>
            <CustomCode3>int</CustomCode3>
            <CustomCode4>int</CustomCode4>
            <CustomCode5>int</CustomCode5>
            <CustomCode6>int</CustomCode6>
            <CustomCode7>int</CustomCode7>
            <CustomCode8>int</CustomCode8>
            <ActivityLogs xsi:nil="true" />
            <AddressValidated>boolean</AddressValidated>
            <ReferredBy xsi:nil="true" />
            <ReferredBy2 xsi:nil="true" />
            <ActiveAlertNotificationCount>int</ActiveAlertNotificationCount>
            <EditAtPOS>boolean</EditAtPOS>
            <ExternalId>string</ExternalId>
            <Salutation>string</Salutation>
            <FacebookId>string</FacebookId>
            <TwitterId>string</TwitterId>
            <MobileDeviceId>string</MobileDeviceId>
            <GuestCustomer>boolean</GuestCustomer>
          </Customer>
        </Customers>
        <AllowCoupons>boolean</AllowCoupons>
        <AvailableCoupons>
          <CustomerCoupon>
            <CustomerId>int</CustomerId>
            <Active>boolean</Active>
            <UsageCount>int</UsageCount>
            <UsageLimit>int</UsageLimit>
            <Used>dateTime</Used>
            <Coupon xsi:nil="true" />
          </CustomerCoupon>
          <CustomerCoupon>
            <CustomerId>int</CustomerId>
            <Active>boolean</Active>
            <UsageCount>int</UsageCount>
            <UsageLimit>int</UsageLimit>
            <Used>dateTime</Used>
            <Coupon xsi:nil="true" />
          </CustomerCoupon>
        </AvailableCoupons>
        <AvailableDiscounts>
          <DiscountRule>
            <Name>string</Name>
            <Code>string</Code>
            <Priority>int</Priority>
            <Scope>Undefined or AllCustomers or LoyaltyProgram or DiscountCoupon</Scope>
            <Status>Undefined or Active or Inactive</Status>
            <ReasonId>int</ReasonId>
            <Reason xsi:nil="true" />
            <Type>Undefined or SingleOrderDiscount or PurchaseHistoryDiscount or LoyaltyAccrualRule</Type>
            <TriggerType>Undefined or Amount or Weight or Points or Quantity</TriggerType>
            <TriggerTarget>Undefined or SingleOrder or SameProduct or AnyProduct or Points</TriggerTarget>
            <PointTrigger>int</PointTrigger>
            <AmountTrigger>decimal</AmountTrigger>
            <QuantityTrigger>decimal</QuantityTrigger>
          </DiscountRule>
          <DiscountRule>
            <Name>string</Name>
            <Code>string</Code>
            <Priority>int</Priority>
            <Scope>Undefined or AllCustomers or LoyaltyProgram or DiscountCoupon</Scope>
            <Status>Undefined or Active or Inactive</Status>
            <ReasonId>int</ReasonId>
            <Reason xsi:nil="true" />
            <Type>Undefined or SingleOrderDiscount or PurchaseHistoryDiscount or LoyaltyAccrualRule</Type>
            <TriggerType>Undefined or Amount or Weight or Points or Quantity</TriggerType>
            <TriggerTarget>Undefined or SingleOrder or SameProduct or AnyProduct or Points</TriggerTarget>
            <PointTrigger>int</PointTrigger>
            <AmountTrigger>decimal</AmountTrigger>
            <QuantityTrigger>decimal</QuantityTrigger>
          </DiscountRule>
        </AvailableDiscounts>
      </FindSuggestedDiscountsByAccountInfoResult>
    </FindSuggestedDiscountsByAccountInfoResponse>
  </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>
    <FindSuggestedDiscountsByAccountInfo xmlns="http://bloyal.com/">
      <accountInfo>string</accountInfo>
      <productAmount>decimal</productAmount>
      <productQuantity>decimal</productQuantity>
      <entities>None or Properties or Parent or ShippingAddresses or PaymentMethods or Lists or Clubs or Events or Groups or Notes or Programs or PickupOrders or Balances or Rules or PurchaseHistory or ActivityLog or ReferredBy or All</entities>
    </FindSuggestedDiscountsByAccountInfo>
  </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>
    <FindSuggestedDiscountsByAccountInfoResponse xmlns="http://bloyal.com/">
      <FindSuggestedDiscountsByAccountInfoResult>
        <Customers>
          <Customer>
            <Uid>guid</Uid>
            <AccountType>None or Email or UserName or Loyalty</AccountType>
            <AccountId>int</AccountId>
            <ParentUid>guid</ParentUid>
            <ParentId>int</ParentId>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <FirstName2>string</FirstName2>
            <LastName2>string</LastName2>
            <CompanyName>string</CompanyName>
            <BirthDate>dateTime</BirthDate>
            <Title>string</Title>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <City>string</City>
            <State>string</State>
            <ZipCode>string</ZipCode>
            <ZipPlus4>string</ZipPlus4>
            <Country>string</Country>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
            <MobilePhone>string</MobilePhone>
            <FaxNumber>string</FaxNumber>
            <PhoneExt1>string</PhoneExt1>
            <EmailAddress>string</EmailAddress>
            <WebAddress>string</WebAddress>
            <LoyaltyCardNumber>string</LoyaltyCardNumber>
            <LoyaltyPoints>int</LoyaltyPoints>
            <LoyaltyDollars>decimal</LoyaltyDollars>
            <SignupSource>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupSource>
            <Parent xsi:nil="true" />
            <AccountNumber>string</AccountNumber>
            <CreditBalance>decimal</CreditBalance>
            <CreditLimit>decimal</CreditLimit>
            <TotalSales>decimal</TotalSales>
            <TotalTransactions>int</TotalTransactions>
            <LastPurchase>dateTime</LastPurchase>
            <PriceLevel>Base or LevelA or LevelB or LevelC or MSRP</PriceLevel>
            <Type>Consumer or Family or Corporate or Wholesale or Employee or Supplier or Shareholder or NonRevenue or MarkOutOfStock or Partner</Type>
            <IsTaxExempt>boolean</IsTaxExempt>
            <PrimaryShippingAddressId>int</PrimaryShippingAddressId>
            <PrimaryShippingAddress xsi:nil="true" />
            <ShippingAddresses xsi:nil="true" />
            <PrimaryPaymentMethodId>int</PrimaryPaymentMethodId>
            <PrimaryPaymentMethod xsi:nil="true" />
            <PaymentMethods xsi:nil="true" />
            <ClubMemberships xsi:nil="true" />
            <EventMemberships xsi:nil="true" />
            <ListMemberships xsi:nil="true" />
            <GroupMemberships xsi:nil="true" />
            <ProgramMemberships xsi:nil="true" />
            <Notes xsi:nil="true" />
            <DiscountRules xsi:nil="true" />
            <PickupOrders xsi:nil="true" />
            <PurchaseHistory xsi:nil="true" />
            <CustomCode1>int</CustomCode1>
            <CustomCode2>int</CustomCode2>
            <CustomCode3>int</CustomCode3>
            <CustomCode4>int</CustomCode4>
            <CustomCode5>int</CustomCode5>
            <CustomCode6>int</CustomCode6>
            <CustomCode7>int</CustomCode7>
            <CustomCode8>int</CustomCode8>
            <ActivityLogs xsi:nil="true" />
            <AddressValidated>boolean</AddressValidated>
            <ReferredBy xsi:nil="true" />
            <ReferredBy2 xsi:nil="true" />
            <ActiveAlertNotificationCount>int</ActiveAlertNotificationCount>
            <EditAtPOS>boolean</EditAtPOS>
            <ExternalId>string</ExternalId>
            <Salutation>string</Salutation>
            <FacebookId>string</FacebookId>
            <TwitterId>string</TwitterId>
            <MobileDeviceId>string</MobileDeviceId>
            <GuestCustomer>boolean</GuestCustomer>
          </Customer>
          <Customer>
            <Uid>guid</Uid>
            <AccountType>None or Email or UserName or Loyalty</AccountType>
            <AccountId>int</AccountId>
            <ParentUid>guid</ParentUid>
            <ParentId>int</ParentId>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <FirstName2>string</FirstName2>
            <LastName2>string</LastName2>
            <CompanyName>string</CompanyName>
            <BirthDate>dateTime</BirthDate>
            <Title>string</Title>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <City>string</City>
            <State>string</State>
            <ZipCode>string</ZipCode>
            <ZipPlus4>string</ZipPlus4>
            <Country>string</Country>
            <Phone1>string</Phone1>
            <Phone2>string</Phone2>
            <MobilePhone>string</MobilePhone>
            <FaxNumber>string</FaxNumber>
            <PhoneExt1>string</PhoneExt1>
            <EmailAddress>string</EmailAddress>
            <WebAddress>string</WebAddress>
            <LoyaltyCardNumber>string</LoyaltyCardNumber>
            <LoyaltyPoints>int</LoyaltyPoints>
            <LoyaltyDollars>decimal</LoyaltyDollars>
            <SignupSource>None or Other or Console or WebSite or Kiosk or Handheld or POS or Import or Fax or Event or Email or Tour or Restaurant or Phone or Mobile or SocialNetwork</SignupSource>
            <Parent xsi:nil="true" />
            <AccountNumber>string</AccountNumber>
            <CreditBalance>decimal</CreditBalance>
            <CreditLimit>decimal</CreditLimit>
            <TotalSales>decimal</TotalSales>
            <TotalTransactions>int</TotalTransactions>
            <LastPurchase>dateTime</LastPurchase>
            <PriceLevel>Base or LevelA or LevelB or LevelC or MSRP</PriceLevel>
            <Type>Consumer or Family or Corporate or Wholesale or Employee or Supplier or Shareholder or NonRevenue or MarkOutOfStock or Partner</Type>
            <IsTaxExempt>boolean</IsTaxExempt>
            <PrimaryShippingAddressId>int</PrimaryShippingAddressId>
            <PrimaryShippingAddress xsi:nil="true" />
            <ShippingAddresses xsi:nil="true" />
            <PrimaryPaymentMethodId>int</PrimaryPaymentMethodId>
            <PrimaryPaymentMethod xsi:nil="true" />
            <PaymentMethods xsi:nil="true" />
            <ClubMemberships xsi:nil="true" />
            <EventMemberships xsi:nil="true" />
            <ListMemberships xsi:nil="true" />
            <GroupMemberships xsi:nil="true" />
            <ProgramMemberships xsi:nil="true" />
            <Notes xsi:nil="true" />
            <DiscountRules xsi:nil="true" />
            <PickupOrders xsi:nil="true" />
            <PurchaseHistory xsi:nil="true" />
            <CustomCode1>int</CustomCode1>
            <CustomCode2>int</CustomCode2>
            <CustomCode3>int</CustomCode3>
            <CustomCode4>int</CustomCode4>
            <CustomCode5>int</CustomCode5>
            <CustomCode6>int</CustomCode6>
            <CustomCode7>int</CustomCode7>
            <CustomCode8>int</CustomCode8>
            <ActivityLogs xsi:nil="true" />
            <AddressValidated>boolean</AddressValidated>
            <ReferredBy xsi:nil="true" />
            <ReferredBy2 xsi:nil="true" />
            <ActiveAlertNotificationCount>int</ActiveAlertNotificationCount>
            <EditAtPOS>boolean</EditAtPOS>
            <ExternalId>string</ExternalId>
            <Salutation>string</Salutation>
            <FacebookId>string</FacebookId>
            <TwitterId>string</TwitterId>
            <MobileDeviceId>string</MobileDeviceId>
            <GuestCustomer>boolean</GuestCustomer>
          </Customer>
        </Customers>
        <AllowCoupons>boolean</AllowCoupons>
        <AvailableCoupons>
          <CustomerCoupon>
            <CustomerId>int</CustomerId>
            <Active>boolean</Active>
            <UsageCount>int</UsageCount>
            <UsageLimit>int</UsageLimit>
            <Used>dateTime</Used>
            <Coupon xsi:nil="true" />
          </CustomerCoupon>
          <CustomerCoupon>
            <CustomerId>int</CustomerId>
            <Active>boolean</Active>
            <UsageCount>int</UsageCount>
            <UsageLimit>int</UsageLimit>
            <Used>dateTime</Used>
            <Coupon xsi:nil="true" />
          </CustomerCoupon>
        </AvailableCoupons>
        <AvailableDiscounts>
          <DiscountRule>
            <Name>string</Name>
            <Code>string</Code>
            <Priority>int</Priority>
            <Scope>Undefined or AllCustomers or LoyaltyProgram or DiscountCoupon</Scope>
            <Status>Undefined or Active or Inactive</Status>
            <ReasonId>int</ReasonId>
            <Reason xsi:nil="true" />
            <Type>Undefined or SingleOrderDiscount or PurchaseHistoryDiscount or LoyaltyAccrualRule</Type>
            <TriggerType>Undefined or Amount or Weight or Points or Quantity</TriggerType>
            <TriggerTarget>Undefined or SingleOrder or SameProduct or AnyProduct or Points</TriggerTarget>
            <PointTrigger>int</PointTrigger>
            <AmountTrigger>decimal</AmountTrigger>
            <QuantityTrigger>decimal</QuantityTrigger>
          </DiscountRule>
          <DiscountRule>
            <Name>string</Name>
            <Code>string</Code>
            <Priority>int</Priority>
            <Scope>Undefined or AllCustomers or LoyaltyProgram or DiscountCoupon</Scope>
            <Status>Undefined or Active or Inactive</Status>
            <ReasonId>int</ReasonId>
            <Reason xsi:nil="true" />
            <Type>Undefined or SingleOrderDiscount or PurchaseHistoryDiscount or LoyaltyAccrualRule</Type>
            <TriggerType>Undefined or Amount or Weight or Points or Quantity</TriggerType>
            <TriggerTarget>Undefined or SingleOrder or SameProduct or AnyProduct or Points</TriggerTarget>
            <PointTrigger>int</PointTrigger>
            <AmountTrigger>decimal</AmountTrigger>
            <QuantityTrigger>decimal</QuantityTrigger>
          </DiscountRule>
        </AvailableDiscounts>
      </FindSuggestedDiscountsByAccountInfoResult>
    </FindSuggestedDiscountsByAccountInfoResponse>
  </soap12:Body>
</soap12:Envelope>