Referral Coupon Service

Download OpenAPI specification:Download

Manage / generate a referral coupon for referring a friend.

Key Features:

  • Generate a referral coupon
  • Track the usage of the coupon
  • Redeem referral coupons

Key Benefits:

  • Win new customers with a referral program in which your customers can recommend you to someone they know and get rewarded for it

Referral Coupon

Retrieving customer's referral coupon code

Retrieves the referral coupon code of a specific customer in the database.

When the existing customer shares the referral code with a potential customer, the referred customer can benefit from the discount in a form of a fixed monetary amount.

SecurityOAuth2
Request
path Parameters
customerId
required
string

Identifier of a customer

Responses
200
204

No content if there is no referral coupon

401

Example response

500

Internal error

get/ReferralCouponCode/{customerId}
Request samples 
Response samples 
application/json
{
  • "allowAnonymous": true,
  • "code": "EEDJ8W",
  • "deleted": false,
  • "description": "A referral Coupon",
  • "discountAbsolute": {
    },
  • "discountType": "ABSOLUTE",
  • "issuedTo": "61443563",
  • "maxRedemptions": -1,
  • "maxRedemptionsPerCustomer": -1,
  • "name": "Empfehlungsgutschein John Doe (Emporix)",
  • "redemptionCount": 0,
  • "restrictions": {
    },
  • "status": "VALID"
}
Creating a referral coupon code for a specific customer
Creates a referral coupon code for a specific customer in the database. If the coupon code exists, returns it without creating a new coupon.


Note: There can only be one referral coupon generated per customer.


When the existing customer shares the referral code with a potential customer, the referred customer can benefit from the discount in a form of a fixed monetary amount.


SecurityOAuth2 
Request 
path Parameters
customerId
required
string
Identifier of a customer


 
Responses 
200
204
No content if there is no referral coupon


401
Example response


500
Internal error


post/ReferralCouponCode/{customerId}
Request samples 
Response samples 
application/json
{
  • "allowAnonymous": true,
  • "code": "EEDJ8W",
  • "deleted": false,
  • "description": "A referral Coupon",
  • "discountAbsolute": {
    },
  • "discountType": "ABSOLUTE",
  • "issuedTo": "61443563",
  • "maxRedemptions": -1,
  • "maxRedemptionsPerCustomer": -1,
  • "name": "Empfehlungsgutschein John Doe (Emporix)",
  • "redemptionCount": 0,
  • "restrictions": {
    },
  • "status": "VALID"
}