Home » NOVA Coupon

Domain NOVA Coupon

[Planned Breaking Changes] [Diagrams] [Artifacts] [Dependencies] [Provided REST Endpoints / Services] [Deprecations] [Maven Artifacts]


Diagrams

NOVA Coupon Data Types NOVA Coupon Service Model NOVA Coupon Master Data NOVA Coupon Master Data
- Coupon Data Types - OpenAPI - Coupon Domain Extension
- Coupon Service Model - Domain
- Coupon Service Model - OpenAPI
- Coupon Service Model - Service 		- Coupon Master Data - Data Unit
- Coupon Master Data - Dependencies
- Coupon Master Data - Domain
- Coupon Master Data - Domain (Supplement Coupon)
- Coupon Master Data - OpenAPI 		- Coupon Events
- Coupon Events - OpenAPI

Artifacts

Artifact Icon Maturity Level since
NOVA Coupon Data Types 🐦 Early Bird 2.0.0
NOVA Coupon Service Model 🐦 Early Bird 2.0.0
NOVA Coupon Master Data 🐦 Early Bird 2.0.0
NOVA Coupon Events 🐦 Early Bird 2.0.0

Dependencies

Artifact Outgoing Dependencies Incoming Dependencies
NOVA Coupon Data Types - NOVA Coupon Master Data
- NOVA Coupon Events
- NOVA Coupon Service Model
NOVA Coupon Service Model - NOVA Booking Data Types
- NOVA Common Data Types
- NOVA Contract Data Types
- NOVA Coupon Data Types
- NOVA Customer Data Types
- NOVA Master Data Data Types
- NOVA Payment Data Types
- NOVA Reseller Data Types
- NOVA Service Point Data Types
- NOVA System Management Service Model
- NOVA System Problem 		- NOVA Coupon Events
NOVA Coupon Master Data - NOVA Checkout Data Types
- NOVA Common Data Types
- NOVA Contract Data Types
- NOVA Coupon Data Types
- NOVA Master Data Data Types
- NOVA Tariff Data Types
NOVA Coupon Events - NOVA Common Data Types
- NOVA Common Events
- NOVA Coupon Data Types
- NOVA Coupon Service Model
- NOVA Reseller Data Types
- NOVA Service Point Data Types

Provided REST Endpoints / Services

CouponService


REST Path / Operation Description
/coupons/{couponCode} [GET]

getCoupon(CouponCode, CouponContext) 		Operation can be used to get the coupon with the passed coupon code.
/coupons [GET]

queryCoupons(CouponQuery, CouponContext) 		Operation can be used to query for coupons. As the operation returns a rather small amount of coupons as result, paging is not supported / required here.
/coupons/{couponCode}:block [POST]

blockCoupon(CouponBlockRequest, CouponContext) 		Operation to block coupon. After that the corresponding change log entry must be generated and it won't be possible to use Coupon anymore.
/coupons/{couponCode}:unblock [POST]

unblockCoupon(CouponUnblockRequest, CouponContext) 		Operation to unblock coupon. After that the corresponding change log entry must be generated and it will be possible to use Coupon again.


Planned Breaking Changes

No breaking changes planned.

Deprecations

Package ch.voev.nova.coupon.datatypes

No deprecations published.


Package ch.voev.nova.coupon.servicemodel


Classes with Deprecations


Type Attribute Description Deprecated since Planned to be removed
Coupon
crypticCode This property is just a temporary workaround. Please switch to couponCode instead. 1.10.4 2025-09-08
cumulative Attribute is obsolete since this info should be taken / calculated by clients from masterdata (redemptionPolicy) by themselves. 4.0.0 2025-11-24
CouponContext
pointOfSale Property was deprecated as the name does not really fit from a business perspective. Please use property servicePoint / http header Service-Point instead. 3.6.0 2025-11-24


Package ch.voev.nova.coupon.masterdata


Classes with Deprecations


Type Attribute Description Deprecated since Planned to be removed
CouponReceiptAttributes
couponCodeAttribute Will be replaced by ReceiptAttributeDefinition. 3.3.0 2025-09-08
couponValidFromAttribute Will be replaced by ReceiptAttributeDefinition. 3.3.0 2025-09-08
couponValidThroughAttribute Will be replaced by ReceiptAttributeDefinition. 3.3.0 2025-09-08
couponValuePercentageAttribute Will be replaced by ReceiptAttributeDefinition. 3.3.0 2025-09-08
couponValueChfAttribute Will be replaced by ReceiptAttributeDefinition. 3.3.0 2025-09-08


Package ch.voev.nova.coupon.events

No deprecations published.


Maven Artifacts

The following table shows the Maven modules that might be used by integrators.

Module Type [1] NOVA Coupon Data Types NOVA Coupon Service Model NOVA Coupon Master Data NOVA Coupon Events
OpenAPI 
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-datatypes-api-openapi</artifactId>
</dependency>
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-servicemodel-api-openapi</artifactId>
</dependency>
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-masterdata-api-openapi</artifactId>
</dependency>
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-events-api-openapi</artifactId>
</dependency>
Java 
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-datatypes-api-java</artifactId>
</dependency>
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-servicemodel-api-java</artifactId>
</dependency>
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-masterdata-api-java</artifactId>
</dependency>
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-events-api-java</artifactId>
</dependency>
Java Runtime 
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-datatypes-api-java-runtime</artifactId>
</dependency>
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-servicemodel-api-java-runtime</artifactId>
</dependency>
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-masterdata-api-java-runtime</artifactId>
</dependency>
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-events-api-java-runtime</artifactId>
</dependency>
Services 
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-servicemodel-api-services</artifactId>
</dependency>
REST Client 
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-servicemodel-api-rest-client</artifactId>
</dependency>
REST Client Starter 
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-servicemodel-api-rest-client-starter</artifactId>
</dependency>
Jackson Starter 
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-masterdata-api-starter</artifactId>
</dependency>
<dependency>
    <groupId>ch.voev.nova.coupon.api</groupId>
    <artifactId>nova-coupon-events-api-starter</artifactId>
</dependency>

[1] For further details about the different module types please see: