OrderProcessing Web Service

OrderProcessing

Click here for a complete list of operations.

GetAllActiveCouponsByChannel

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

<?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>
    <GetAllActiveCouponsByChannel xmlns="http://bloyal.com/">
      <channelFilter>WebStore or Kiosk or Club or Phone or POS or Event or Other or OutsideSales or Mobile or SocialNetwork or Wholesale</channelFilter>
      <associatedEntites>None or Properties or DiscountRule or All</associatedEntites>
    </GetAllActiveCouponsByChannel>
  </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>
    <GetAllActiveCouponsByChannelResponse xmlns="http://bloyal.com/">
      <GetAllActiveCouponsByChannelResult>
        <Coupon>
          <Name>string</Name>
          <Code>string</Code>
          <Active>boolean</Active>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <Description>string</Description>
          <Type>None or Standard or Awarded</Type>
          <PrimaryDiscount>
            <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>
          </PrimaryDiscount>
        </Coupon>
        <Coupon>
          <Name>string</Name>
          <Code>string</Code>
          <Active>boolean</Active>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <Description>string</Description>
          <Type>None or Standard or Awarded</Type>
          <PrimaryDiscount>
            <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>
          </PrimaryDiscount>
        </Coupon>
      </GetAllActiveCouponsByChannelResult>
    </GetAllActiveCouponsByChannelResponse>
  </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>
    <GetAllActiveCouponsByChannel xmlns="http://bloyal.com/">
      <channelFilter>WebStore or Kiosk or Club or Phone or POS or Event or Other or OutsideSales or Mobile or SocialNetwork or Wholesale</channelFilter>
      <associatedEntites>None or Properties or DiscountRule or All</associatedEntites>
    </GetAllActiveCouponsByChannel>
  </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>
    <GetAllActiveCouponsByChannelResponse xmlns="http://bloyal.com/">
      <GetAllActiveCouponsByChannelResult>
        <Coupon>
          <Name>string</Name>
          <Code>string</Code>
          <Active>boolean</Active>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <Description>string</Description>
          <Type>None or Standard or Awarded</Type>
          <PrimaryDiscount>
            <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>
          </PrimaryDiscount>
        </Coupon>
        <Coupon>
          <Name>string</Name>
          <Code>string</Code>
          <Active>boolean</Active>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <Description>string</Description>
          <Type>None or Standard or Awarded</Type>
          <PrimaryDiscount>
            <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>
          </PrimaryDiscount>
        </Coupon>
      </GetAllActiveCouponsByChannelResult>
    </GetAllActiveCouponsByChannelResponse>
  </soap12:Body>
</soap12:Envelope>