Campaign standard

Developers

Search…

Introduction

Integration

Spring Boot Starter

Custom Integration

General

Data object descriptions

Request & Responses

Campaign standard

Campaigns is separated into two groups:
Product based campaigns - provided with product data. 
Institution based campaigns - Periodical campaigns. Applies for whole invoice
​Campaign object contains three parameters – name, code and operation. 
​Campaign code contains data that can determine for who is the campaign valid and campaign type. Campaign operation is conditional operation written in Javascript.
Campaign code calculation
Campaign code = CLIENT_IDENTIFICATION (1 place) + CLIENT_CARD_IDENTIFICATION (8 places) + CAMPAIGN_CODE (3 places)
Client identifier
​
C
Only available for clients
U
Only available for unauthenticated clients
B
Available for clients and unauthenticated clients
Campaign codes
​
001
Amount modification campaign
002
Amount based unit price campaign
501
Invoice total sum campaign
502
​
campaign code starting with 0 is product based campaign
campaign code starting with 5 is institution based campaign
Client card identification calculation
00000000 – Available for all
00000SKP – Available only for clients who has customer card with machine readable code (SKP)
Example
1.Amount modification campaign available for all clients.    
Code:  B00000000001
2.Amount base unit price campaign available only clients who has SKP customer card
Code:  C00000SKP002
Campaign type descriptions
Amount modification campaign operation description (001)
Input parameters
Name
Type
Description
amount
Double
Initial amount
Output parameters
Name
Type
Description
amount
Double
Real amount that customer have to pay
Example
Client who has SKP client card will get every second piece for free.
1
{
2
    "name" : "Crazy days",
3
    "code" : "C00000SKP001"
4
    "operation" : "amount >= 2 ? amount - (Math.floor(amount / 2) * 1) : amount"
5
}
Copied!
Amount based unit price campaign (002)
Input parameters
Name
Type
Description
amount
Double
Product amount
unitPrice
Double
Initial unit price with addition and without VAT
Output parameters
Name
Type
Description
unitPrice
Double
Real product price that customer have to pay with addition and without VAT
Example
Customer will get 50 cent discount for each product if customer will buy at least 5 pieces of product
1
{
2
    "name" : "Crazy days",
3
    "code" : "B00000000002"
4
    "operation" : "amount >= 5 ? unitPrice – 0.5: unitPrice"
5
}
Copied!
Total modification campaign (501)
Input parameters
Name
Type
Description
total
Double
Total without VAT
Output parameters
Name
Type
Description
total
Double
Total without VAT
Example
Client will get 2% discount if their purchase is bigger than 50 euros.
1
{
2
    "name" : "Crazy days",
3
    "code" : "B00000000501"
4
    "operation" : "total >= 50 ? total * 0.98 : total"
5
}
Copied!

ProductSearchRequest

Last modified 2yr ago

Copy link

Contents

Campaign code calculation

Client card identification calculation

Campaign type descriptions

Amount modification campaign operation description (001)

Amount based unit price campaign (002)

Total modification campaign (501)