...
| Scroll ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Copyright © WEBSALE AG 2019
- Confidential -
Transfer to third parties only allowed with written permission of WEBSALE AG.
General
This document describes the SOAP-based generation and retrieval of vouchers through an external system.
...
The external system sends the request (Step 1,"CreateVouchers")
With this request, the external system transfers the voucher data or the ID of the template batch from which the coupon data is to be transferred, as well as the number of vouchers that are to be generated.
...
Retrieving information about a specific voucher batch
Requirements
...
The external system
...
sends the request (Step 1, "GetVoucherCodes-Request")
Parameter | Description | Required field |
|---|---|---|
ShopID | The Shop-ID | Yes |
Password | The password for the SOAP interface. The password can be obtained from WEBSALE AG. | Yes |
MsgID | Optionally, the external system can enter an MsgID, which the WEBSALE system has entered in the response is returned. For processing the request the MsgID has no meaning. | No |
ChargeId | The ID of the batch from which the data of the voucher (code) should be transferred. | Yes |
PageSize | Determines the number of voucher codes per request (maximum and default value is 1000). | No |
NextPageToken | If the number of codes is greater than 1000, Response only sends the first 1000 codes (sorted alphabetically) and the NextPageToken parameter. To get the next 1000 codes, another request must be executed, in this request NextPageToken of Response is a required parameter. | No |
...
Please note that this URL may change in the future. So make sure that you can change it without much effort.
| Include Page | ||||
|---|---|---|---|---|
|