CommunitySupport PortalYouTubeStart a free trial

Redeem Options Management

Retrieving redemption options

get

Retrieves all available reward points redemption options configured for customers to use.

Note: This public API endpoint is accessible to all customers.

Authorizations
Path parameters
tenantstringRequired

Tenant name.

Responses
200
Returns all configured reward points redemption options
application/json
get
GET /reward-points/{tenant}/redeemOptions HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "5f905280df6b3b0013b6c541",
    "type": "coupon",
    "name": "10 Euro Gutschein",
    "description": "Für 90 Punkte können Sie sich einen Gutschein über 10 Euro generieren lassen. Diesen Gutschein können Sie auch an Freunde und Bekannte weitergeben.",
    "points": 90,
    "coupon": {
      "name": "Gutschein über 10 Euro (eingelöste Bonuspunkte)",
      "description": "Gutschein über 10 Euro aus 1000 Bonuspunkte",
      "discountType": "ABSOLUTE",
      "discountAbsolute": {
        "amount": 10,
        "currency": "EUR"
      },
      "allowAnonymous": true,
      "maxRedemptions": 1,
      "status": "VALID"
    },
    "metadata": {
      "version": 1,
      "createdAt": "2023-07-25T13:28:25.960Z",
      "modifiedAt": "2023-07-25T13:28:25.960Z"
    }
  }
]

Creating redemption options

post

Sets up a reward points redemption option that contains instructions for transforming these points into a coupon. Customers are required to choose this option to convert the reward points and create a coupon based on the pre-established rules.

Note: Only employees have the authority to configure the redemption options.

Required scopes

  • rewardspoints.rewardpoints_manage

Authorizations
Path parameters
tenantstringRequired

Tenant name.

Body
idstringOptional

ID of the redemption option to be used at reward points exchange

typestringRequired

Option type, typically 'coupon'.

namestringRequired

Name of the redeem option that can be presented to customer

descriptionstringOptional

Description of the redeem option that can be presented to customer

pointsintegerRequired

Points to deduct from customer's account at coupon creation

pointsAfterCouponintegerOptional
Responses
200Success
application/json
post
POST /reward-points/{tenant}/redeemOptions HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 489

{
  "type": "coupon",
  "name": "10 Euro Gutschein",
  "description": "Für 90 Punkte können Sie sich einen Gutschein über 10 Euro generieren lassen. Diesen Gutschein können Sie auch an Freunde und Bekannte weitergeben.",
  "points": 90,
  "coupon": {
    "name": "Gutschein über 10 Euro (eingelöste Bonuspunkte)",
    "description": "Gutschein über 10 Euro aus 1000 Bonuspunkte",
    "discountType": "ABSOLUTE",
    "discountAbsolute": {
      "amount": 10,
      "currency": "EUR"
    },
    "allowAnonymous": true,
    "maxRedemptions": 1,
    "status": "VALID"
  }
}
[
  {
    "points": 30,
    "type": "coupon",
    "name": "persönlicher 20 Euro Gutschein",
    "description": "Ein persönlicher Gutschein zum einlösen auf Lieferladen.de (nur gültig im Lieferladen.de Stuttgart Shop)"
  }
]

Updating redemption options

put

Updates a reward points redemption option for a given tenant.

Note: Only employees have the authority to update the redemption options.

Required scopes

  • rewardspoints.rewardpoints_manage

Authorizations
Path parameters
redeemOptionIdstringRequired

Unique identifier of a redeem option.

tenantstringRequired

Tenant name.

Body
idstringOptional

ID of the redemption option to be used at reward points exchange

typestringRequired

Option type, typically 'coupon'.

namestringRequired

Name of the redeem option that can be presented to customer

descriptionstringOptional

Description of the redeem option that can be presented to customer

pointsintegerRequired

Points to deduct from customer's account at coupon creation

pointsAfterCouponintegerOptional
Responses
200
Updates given redeem option by id
put
PUT /reward-points/{tenant}/redeemOptions/{redeemOptionId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 514

{
  "type": "coupon",
  "name": "10 Euro Gutschein",
  "description": "Für 90 Punkte können Sie sich einen Gutschein über 10 Euro generieren lassen. Diesen Gutschein können Sie auch an Freunde und Bekannte weitergeben.",
  "points": 90,
  "coupon": {
    "name": "Gutschein über 10 Euro (eingelöste Bonuspunkte)",
    "description": "Gutschein über 10 Euro aus 1000 Bonuspunkte",
    "discountType": "ABSOLUTE",
    "discountAbsolute": {
      "amount": 10,
      "currency": "EUR"
    },
    "allowAnonymous": true,
    "maxRedemptions": 1,
    "status": "VALID"
  },
  "metadata": {
    "version": 1
  }
}
No content

Deleting redemption options

delete

Deletes a reward points redemption option for a given tenant.

Note: Only employees have the authority to delete the redemption options.

Required scopes

  • rewardspoints.rewardpoints_manage

Authorizations
Path parameters
redeemOptionIdstringRequired

Unique identifier of a redeem option.

tenantstringRequired

Tenant name.

Responses
204
Deletes given redeem option by id
delete
DELETE /reward-points/{tenant}/redeemOptions/{redeemOptionId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousAPI ReferenceNextReward Points Management

Was this helpful?