| Parameter | Example | Description |
|---|---|---|
| trafficSourceNumber | 2 | If you haven't already, you will receive the traffic source number from your Sovendus account manager. |
| trafficMediumNumber | 1 | If you haven't already, you will receive the traffic medium number from your Sovendus account manager. |
| iframeContainerId | sovendus-container-1 | This determines at which position on the page the generated iframe should be implemented. |
| Parameter | Example | Description |
|---|---|---|
| sessionID | 098f6b4e83262 | The session-Id of the customer is mandatory and is used to recognize accidental multiple requests. For security reasons the session-Id should be hashed beforehand. |
| Timestamp | 1643374320 | The timestamp is mandatory and is used to deny requests after a certain time period. Please transfer the UNIX timestamp (seconds after the 1.1.1970). |
| usedCouponCode | ABC123 | The code of the redeemed voucher is used to track the success rate and enables automated invoicing. This field is mandatory to track which of our vouchers have been redeemed. While not mandatory for CPL billing, it greatly aids in optimizing the redemption rate. |
| orderId | 124578 | This field is mandatory and is a unique identifier for your orders and helps us recognize multiple requests to our server-system. This data is also needed for questions about billing. |
| orderCurrency | EUR | Order currency according to ISO 4217 (http://en.wikipedia.org/wiki/ISO_4217). This field is optional but becomes necessary when we are compensated based on a percentage of the purchase value |
| orderValue | 123.43 | This field is optional but becomes necessary when we are compensated based on a percentage of the purchase value. Please transfer this value with two decimal places and a point as decimal separator (e.g. 8.50). This value is the net shopping cart value, i.e. the amount that the customer has paid (without VAT). See calculation example below. |
| Parameter | Example | Description |
|---|---|---|
| consumerSalutation | "Mr." / "Mrs." | Used to display appropriate offers and prefill forms. Submit data for the invoice address. |
| consumerFirstName, consumerLastName | John Doe | Prefills forms such as newsletter sign-ups. Transmitted only when the customer submits the form. Submit data for the invoice address. |
| consumerEmail | John@abc.com | Usage: The email address is used to prefill input forms and should be transmitted as plain text. Sovendus will hash the email address to address any objections to advertising, allowing us to recognize returning users and provide them with diverse offers. Alternatively, you can transmit a md5 pre-hashed email in the consumerEmailHash field. Please note that pre-hashed emails must be activated by Sovendus before use. More Details:When our integration loads, we create an MD5 hash of the email address on the client side, transmitting only this hash to our server via a TLS-encrypted HTTPS connection. Once received, this hash is further protected by hashing it again on the server side using a secure hashing algorithm with a unique secret, ensuring that we cannot reverse-engineer the original email address. The clear (unhashed) email address is only transmitted to our servers when a customer actively interacts with our product, such as clicking a banner or completing a checkout. At that point, the email address is securely stored in an encrypted format. |
| consumerStreet, consumerStreetNumber | Main St, 2 | Used exclusively to prefill forms (e.g., newspaper sign-ups), and transmitted only upon form submission. If unable to separate Street and Number, leave both fields empty. Submit data for the invoice address. |
| consumerCity | Karlsruhe | Utilized solely to prefill forms (e.g., newspaper sign-ups) and transmitted upon form submission. Submit data for the invoice address. |
| consumerZipcode | 12345 | Used to display localized advertisements and to prefill forms. Submit data for the invoice address. |
| consumerCountry | DE | Used to display country-specific offers. Submit the country code according to ISO 3166-1 alpha-2 format. Refer to ISO standards. |
| consumerPhone | 0753/123456 | Utilized solely to prefill forms (e.g., newspaper sign-ups) and transmitted upon form submission. |
| consumerYearOfBirth | 1950 | Used to display age-appropriate offers. Submit data for the invoice address. |
| consumerDateOfBirth | 01.12.2000 | Prefills forms such as credit card applications, transmitted only upon form submission. Accepted formats: ISO |
