Serialized Coupons

Interface

Couponing Service - Couponing API - 01090101118

General

This interface is used to connect to a couponing service. For communication between the POS Server and the Couponing Service, the following services are integrated:

  • returnCoupons
  • cancelCouponRedemptions
  • cancelCheckoutCoupons

Agent

Couponing Agent - 01280200004

General

This agent scans the document data for serialized couponing transactions that have not been posted on the Couponing Service yet (due to offline situations), and subsequently posts the data to the Couponing Service.

The following use cases exist:

Subsequent posting of:

  • offline redeemed coupons
  • offline canceled coupon registrations/redemptions to unblock coupons
  • offline voided coupon redemptions
  • offline voided coupon creations (checkout coupons)

Configuration

  • at global level:

Configuration file transaction-bulk-exporter.properties: 

 ################################################################################
# Couponing Agent
 ################################################################################
# Property for enabling/disabling the agent
 gkr.tx-export.couponingAgent.transactionBulkExporter.enabled=false

To enable the couponing agent, set 'gkr.tx-export.couponingAgent.transactionBulkExporter.enabled=true'.

Configuration file security.properties 

# Serialized Coupons Agent - allowed authentication types NONE,BASIC
 core.common.security.client.http.auth.group.couponingAgent.type=NONE
 core.common.security.client.http.auth.group.couponingAgent.BASIC.username=
 core.common.security.client.http.auth.group.couponingAgent.BASIC.password=
  • at store level:

Configuration file transaction-bulk-exporter.properties: 

 ################################################################################
# Serialized Coupons Agent
 ################################################################################
# Couponing service webservice URL
gkr.tx-export.couponingAgent.webservice.url=
# Timeout to establish TCP connection
 gkr.tx-export.couponingAgent.webservice.connectionTimeout=30s
# Timeout to get reponse from webservice
gkr.tx-export.couponingAgent.webservice.receiveTimeout=40s
# Authentication client group code identifier, the value is used as a part of property key in global security.properties
 gkr.tx-export.couponingAgent.webservice.auth.group=couponingAgent
# Specifies the code of the retailer
gkr.tx-export.couponingAgent.webservice.companyId=GK

The couponing service web service URL can be configured in 'gkr.tx-export.couponingAgent.webservice.url'.