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

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

• : Nedeed to view reward points information
• : Needed to manage reward points

Path parameters

tenantstringRequired

Tenant name.

Responses

200

Returns all configured reward points redemption options

application/json

401Error

application/json

403

Given authorization scopes are not sufficient and do not match required scopes.

application/json

500

Internal error

application/json

get

/reward-points/{tenant}/redeemOptions

HTTPcURLJavaScriptPython

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.

Authorizations

CustomerAccessTokenOAuth2

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tenantstringRequired

Tenant name.

Body

application/json

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

400

Request syntactically incorrect. Details of the error are included in the response payload.

application/json

401Error

application/json

403

Given authorization scopes are not sufficient and do not match required scopes.

application/json

500

Internal error

application/json

post

/reward-points/{tenant}/redeemOptions

HTTPcURLJavaScriptPython

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.

Authorizations

CustomerAccessTokenOAuth2

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

redeemOptionIdstringRequired

Unique identifier of a redeem option.

tenantstringRequired

Tenant name.

Body

application/json

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

400

Request syntactically incorrect. Details of the error are included in the response payload.

application/json

401Error

application/json

403

Given authorization scopes are not sufficient and do not match required scopes.

application/json

409

The resource requested for update has changed.

application/json

500

Internal error

application/json

put

/reward-points/{tenant}/redeemOptions/{redeemOptionId}

HTTPcURLJavaScriptPython

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.

Authorizations

CustomerAccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

redeemOptionIdstringRequired

Unique identifier of a redeem option.

tenantstringRequired

Tenant name.

Responses

204

Deletes given redeem option by id

401Error

application/json

403

Given authorization scopes are not sufficient and do not match required scopes.

application/json

500

Internal error

application/json

delete

/reward-points/{tenant}/redeemOptions/{redeemOptionId}

HTTPcURLJavaScriptPython

DELETE /reward-points/{tenant}/redeemOptions/{redeemOptionId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content