Signed In Customer Reward Points | Documentation Portal

Retrieving reward points of a signed-in customer

get

Fetches the number of reward points of a currently signed-in customer.

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

Authorizations

Responses

200Success

application/json

Responseinteger

401Error

application/json

403

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

application/json

500

Internal error

application/json

get

GET /reward-points/public/customer HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Retrieving a reward points summary of a signed-in customer

get

Retrieves a detailed summary of added and redeemed reward points of a signed-in customer.

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

Authorizations

Responses

200Success

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

GET /reward-points/public/customer/summary HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "customerId": "123",
  "activePoints": 1153,
  "summary": {
    "addedPointsList": [
      {
        "id": "zzpscd12uimlmybtthb",
        "reference-id": "B7011746",
        "description": "Bonuspunkte für Bestellung B7011746",
        "points": 209,
        "createdAt": "2020-09-03T09:45:02.248+00:00",
        "allPointsAfterCreation": 209,
        "usedPoints": 209,
        "validUntil": "2023-09-02T22:00:00.000+00:00",
        "usedWith": [
          "e7522b99-2448-44b5-8f68-8bffcc207d18"
        ]
      },
      {
        "id": "c9joe623gl4obochkrmy8i",
        "reference-id": "B7011745",
        "description": "Bonuspunkte für Bestellung B7011745",
        "points": 209,
        "createdAt": "2020-09-03T09:45:02.318+00:00",
        "allPointsAfterCreation": 418,
        "usedPoints": 209,
        "validUntil": "2023-09-02T22:00:00.000+00:00",
        "usedWith": [
          "e7522b99-2448-44b5-8f68-8bffcc207d18"
        ]
      }
    ],
    "redeemedPointsList": [
      {
        "id": "e7522b99-2448-44b5-8f68-8bffcc207d18",
        "description": "Für 600 Punkte können Sie sich einen Gutschein über 5 Euro generieren lassen. Diesen Gutschein können Sie auch an Freunde und Bekannte weitergeben.",
        "points": 600,
        "createdAt": "2020-09-03T12:44:22.747+00:00",
        "allPointsAfterCreation": 2953
      }
    ]
  }
}

Redeeming a logged-in customer's reward points for a coupon code

post

Gets the logged-in customer's reward points, swaps them for a coupon code by using the given redemption option ID, and returns a coupon code.

Note: This public API endpoint is accessible to all customers and is meant to be used on the storefront.

Authorizations

Query parameters

siteCodestringOptional

Site code, defined when a site is created.

Default: main

Body

idstringRequired

The ID of the redeem option used to convert points into a coupon.

Responses

200Success

application/json

400

Request syntactically incorrect. Any details will be provided within the response payload.

application/json

403

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

application/json

404

Entity not found.

application/json

500

Internal error

application/json

post

POST /reward-points/public/customer/redeem HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "id": "575937654bf757001d8496c9"
}

{
  "code": "LLS-232394"
}