Format and content - WS-Gutscheindaten (from-Shop) (EN)

Owned by Jennifer Pusch
Last updated: Jul 04, 2023 by Rainer Biedermann
2 min read

General

This documentation describes the format and content of voucher data which can be collected from a shop.

Transfer of vouchers

The voucher data described below is transferred via SOAP. The transfer is described in the separate documentation "SOAP-from-Shop (EN)":

SOAP-from-Shop (EN)

If SOAP cannot be implemented on your system, you can alternatively export voucher data using the WEBSALE-OrderManager (WSOM). See separate documentation "WS-OrderManager-from-Shop (EN)":

WSOM-from-Shop (previous version) (EN)

Parameter description

Parameter

Description

Required field

Parameter

Description

Required field

Amount

Amount or percentage of the voucher

yes

AmountType

0: Amount contains an absolute amount (default)
1: Amount contains a percentage

yes

BasketProducts

The numbers of the products that should be automatically added to the basket when this coupon is redeemed (comma separated list).

no

Categories

Category indexes for which the coupon is valid (comma-separated list).

no

ChargeId

The batch ID of the voucher

yes

Currency

The currency

yes

IsTemplate

0: Normal voucher (default)
1: Voucher template for newsletter mailing

no

MinOrderValue

A minimum order value for redeeming the voucher

no

Products

Product indices or product numbers for which the voucher is valid (comma-separated list).

no

ProductsType

0: "Products" contains product indices
1: "Products" contains product numbers

no

State

The state of the coupon, the following two values are possible:
1: Active
0: Not active

By default a voucher is active

no

Subshop

Subshop for which the voucher should be valid. If this field is empty, the voucher can be redeemed in all subshops

no

Type

The type of the voucher. The following types are supported:
0: Remaining amount can be reused
1: Remaining amount expires
2: Universal voucher
3: Universal voucher (customer specific)
4: Universal voucher (for new customers only)

yes

Type2

Promotional/purchase voucher
1: Promotional voucher
2: Purchase voucher

yes

UsedAmount

The already redeemed amount of the voucher

no

ValidFrom

Date from which the voucher is valid, in the format "YYYY-MM-DD".

no

ValidFromDays

Only for voucher templates:
Valid only from "ValidFromDays" day(s) after sending the newsletter

no

ValidUntil

Date until which the voucher is valid, in the format "YYYY-MM-DD".

no

ValidUntilDays

Only for voucher templates:
Valid only in "ValidUntilDays" day(s) after newsletter mailing

no

VATIndex

The VAT code of the voucher. This can be either one of the values configured in shop.config under "<VATRates>" or one of the special values "-1" or "0".

"-1" means "Default", in this case the identifier configured under DeliveryVATRate will be used for the voucher.

"0" stands for "No VAT".

The default value is "-1".

no

VoucherNumber

The voucher number

yes

Example

<Amount>5.00</Amount> <AmountType>0</AmountType> <ChargeId>Test-Charge</ChargeId> <Currency>EUR</Currency> <State>0</State> <Type>0</Type> <Type2>2</Type2> <UsedAmount>0.00</UsedAmount> <ValidFrom/> <ValidUntil>2013-06-03</ValidUntil> <VATIndex>-1</VATIndex> <VoucherNumber>FSIZ-HG1Y-UTKR-G16B</VoucherNumber>