iSAMS Orders API


Click here for a complete list of operations.

AddOrderVoucher

Add a voucher to an order.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
authenticationToken:
orderID:
value:
recipientFirstName:
recipientLastName:
recipientEmail:
senderName:
message:
deliveryDate:

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 /global/api/Orders.asmx HTTP/1.1
Host: demo.viare.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.estaronline.com/api/orders/AddOrderVoucher"

<?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>
    <AddOrderVoucher xmlns="http://www.estaronline.com/api/orders">
      <authenticationToken>string</authenticationToken>
      <orderID>int</orderID>
      <value>decimal</value>
      <recipientFirstName>string</recipientFirstName>
      <recipientLastName>string</recipientLastName>
      <recipientEmail>string</recipientEmail>
      <senderName>string</senderName>
      <message>string</message>
      <deliveryDate>dateTime</deliveryDate>
    </AddOrderVoucher>
  </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>
    <AddOrderVoucherResponse xmlns="http://www.estaronline.com/api/orders">
      <AddOrderVoucherResult>
        <Data>
          <int>int</int>
          <int>int</int>
        </Data>
      </AddOrderVoucherResult>
    </AddOrderVoucherResponse>
  </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 /global/api/Orders.asmx HTTP/1.1
Host: demo.viare.io
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>
    <AddOrderVoucher xmlns="http://www.estaronline.com/api/orders">
      <authenticationToken>string</authenticationToken>
      <orderID>int</orderID>
      <value>decimal</value>
      <recipientFirstName>string</recipientFirstName>
      <recipientLastName>string</recipientLastName>
      <recipientEmail>string</recipientEmail>
      <senderName>string</senderName>
      <message>string</message>
      <deliveryDate>dateTime</deliveryDate>
    </AddOrderVoucher>
  </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>
    <AddOrderVoucherResponse xmlns="http://www.estaronline.com/api/orders">
      <AddOrderVoucherResult>
        <Data>
          <int>int</int>
          <int>int</int>
        </Data>
      </AddOrderVoucherResult>
    </AddOrderVoucherResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /global/api/Orders.asmx/AddOrderVoucher?authenticationToken=string&orderID=string&value=string&recipientFirstName=string&recipientLastName=string&recipientEmail=string&senderName=string&message=string&deliveryDate=string HTTP/1.1
Host: demo.viare.io

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

<?xml version="1.0" encoding="utf-8"?>
<IntegerArrayApiResponse xmlns="http://www.estaronline.com/api/orders">
  <Data>
    <int>int</int>
    <int>int</int>
  </Data>
</IntegerArrayApiResponse>

HTTP POST

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

POST /global/api/Orders.asmx/AddOrderVoucher HTTP/1.1
Host: demo.viare.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

authenticationToken=string&orderID=string&value=string&recipientFirstName=string&recipientLastName=string&recipientEmail=string&senderName=string&message=string&deliveryDate=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<IntegerArrayApiResponse xmlns="http://www.estaronline.com/api/orders">
  <Data>
    <int>int</int>
    <int>int</int>
  </Data>
</IntegerArrayApiResponse>