...
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:ns="http://www.websale.de/">
<SOAP-ENV:Body>
<ns:GetVoucherChargesResponse>
<response>
<MsgID>123</MsgID>
<ChargeList>
<ChargeData>
<ChargeId>Charge1</ChargeId>
<Amount>10.0</Amount>
<AmountType>0</AmountType>
<Currency>EUR</Currency>
<Type>0</Type>
<Type2>1</Type2>
</ChargeData>
<ChargeData>
<ChargeId>Charge2</ChargeId>
<Amount>5.0</Amount>
<AmountType>0</AmountType>
<Currency>EUR</Currency>
<MinOrderValue>50.00</MinOrderValue>
<Subshop>Subshop1</Subshop>
<Type>0</Type>
<Type2>1</Type2>
</ChargeData>
</ChargeList>
</response>
</ns:GetVoucherChargesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |
...
Retrieve all information
...
of a specific voucher batch
Requirements
The external system must transfer the ShopID, password and ChargeId for each call.
...
Transfer of the response by the WEBSALE system (Step 2, "GetVoucherCodes-Response")
Parameter | Superior element | Description | Required field |
|---|---|---|---|
MsgID | As an option, the external system can specify an MsgID, which the WEBSALE system uses in the response is returned. For processing the request the MsgID has no meaning. | No | |
VoucherList | Contains a "VoucherData" sub-element for each code. | Yes | |
VoucherData | VoucherList | Contains the data of a single charge | Yes |
Num | VoucherData | The value given in the request or determined from the template-batch. | Yes |
Amount | VoucherData | Yes | |
AmountType | VoucherData | Yes | |
Currency | VoucherData | Yes | |
MinOrderValue | VoucherData | No | |
Subshop | VoucherData | No | |
Type | VoucherData | Yes | |
Type2 | VoucherData | Yes | |
ValidFrom | VoucherData | No | |
ValidUntil | VoucherData | No | |
VATIndex | VoucherData | Yes | |
CustomerFilter | VoucherData | No | |
CatProdFilterSetBehavior | VoucherData | No | |
CatProdFilter | VoucherData | No | |
AmountMultiCurrency | VoucherData | No | |
MinOrderValueMultiCurrency | VoucherData | No | |
MaxDiscountValueMultiCurrency | VoucherData | No | |
ChargeLabel | VoucherData | No | |
NextPageToken | If the number of codes is greater than 1000, Response sends only the first 1000 codes (sorted alphabetically) and the NextPageToken parameter. To get the next 1000 codes, another request must be executed; NextPageToken is a required parameter in this request. | No | |
LastPage | Value: true/false (This parameter shows whether all codes have been sent) | Yes |
...
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:ns="http://www.websale.de/">
<SOAP-ENV:Body>
<ns:GetVoucherPoolInfoResponse>
<response>
<MsgID>123</MsgID>
<VoucherCount>99999</VoucherCount>
</response>
</ns:GetVoucherPoolInfoResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |
Retrieving information about a specific voucher batch
Requirements
The external system must transfer the ShopID, password and ChargeId for each call.
...