Referral Coupon Management

Retrieving customer's referral coupon

get

Retrieves the referral coupon of a given 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.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Available scopes:
  • : Needed to read coupons.
  • : Needed to manage coupons.
  • : Needed to redeem coupons.
  • : Needed to redeem coupons on behalf of another customer.
Path parameters
customerNumberstringRequired

Customer number (ID) of customer.

tenantstring · min: 3 · max: 16Required

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

Responses
get
/coupon/{tenant}/referral-coupons/{customerNumber}

Creating a referral coupon code for a given customer

post

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.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Available scopes:
  • : Needed to read coupons.
  • : Needed to manage coupons.
  • : Needed to redeem coupons.
  • : Needed to redeem coupons on behalf of another customer.
Path parameters
customerNumberstringRequired

Customer number (ID) of customer.

tenantstring · min: 3 · max: 16Required

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

Responses
post
/coupon/{tenant}/referral-coupons/{customerNumber}

Last updated

Was this helpful?