OrderProcessing Web Service

OrderProcessing

Click here for a complete list of operations.

SaveCoupon

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

<?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>
    <SaveCoupon xmlns="http://bloyal.com/">
      <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>
            <Title>string</Title>
            <Code>string</Code>
            <Type>ReturnToMainInventory or ReturnToOfflineInventory or ManualInventoryAdjustment or OfflineInventoryAdjustment or CustomerDiscount or NoSale or TaxChange or AccountAdjustment or Drop or Payout or CustomerCancel</Type>
            <StartTime>dateTime</StartTime>
            <EndTime>dateTime</EndTime>
          </Reason>
          <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>
      <queueExceptions>boolean</queueExceptions>
      <createNeededEntities>boolean</createNeededEntities>
    </SaveCoupon>
  </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>
    <SaveCouponResponse xmlns="http://bloyal.com/">
      <SaveCouponResult>
        <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>
            <Title>string</Title>
            <Code>string</Code>
            <Type>ReturnToMainInventory or ReturnToOfflineInventory or ManualInventoryAdjustment or OfflineInventoryAdjustment or CustomerDiscount or NoSale or TaxChange or AccountAdjustment or Drop or Payout or CustomerCancel</Type>
            <StartTime>dateTime</StartTime>
            <EndTime>dateTime</EndTime>
          </Reason>
          <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>
      </SaveCouponResult>
      <problems>
        <ProblemReport>
          <Number>int</Number>
          <Code>string</Code>
          <Message>string</Message>
        </ProblemReport>
        <ProblemReport>
          <Number>int</Number>
          <Code>string</Code>
          <Message>string</Message>
        </ProblemReport>
      </problems>
    </SaveCouponResponse>
  </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>
    <SaveCoupon xmlns="http://bloyal.com/">
      <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>
            <Title>string</Title>
            <Code>string</Code>
            <Type>ReturnToMainInventory or ReturnToOfflineInventory or ManualInventoryAdjustment or OfflineInventoryAdjustment or CustomerDiscount or NoSale or TaxChange or AccountAdjustment or Drop or Payout or CustomerCancel</Type>
            <StartTime>dateTime</StartTime>
            <EndTime>dateTime</EndTime>
          </Reason>
          <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>
      <queueExceptions>boolean</queueExceptions>
      <createNeededEntities>boolean</createNeededEntities>
    </SaveCoupon>
  </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>
    <SaveCouponResponse xmlns="http://bloyal.com/">
      <SaveCouponResult>
        <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>
            <Title>string</Title>
            <Code>string</Code>
            <Type>ReturnToMainInventory or ReturnToOfflineInventory or ManualInventoryAdjustment or OfflineInventoryAdjustment or CustomerDiscount or NoSale or TaxChange or AccountAdjustment or Drop or Payout or CustomerCancel</Type>
            <StartTime>dateTime</StartTime>
            <EndTime>dateTime</EndTime>
          </Reason>
          <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>
      </SaveCouponResult>
      <problems>
        <ProblemReport>
          <Number>int</Number>
          <Code>string</Code>
          <Message>string</Message>
        </ProblemReport>
        <ProblemReport>
          <Number>int</Number>
          <Code>string</Code>
          <Message>string</Message>
        </ProblemReport>
      </problems>
    </SaveCouponResponse>
  </soap12:Body>
</soap12:Envelope>