Get Member Points

Gets all active and pending (excluding expired) member points along with the points breakdown.

GET /v1/inquire/{profileId}/member-points

Get Member Points

cURL

curl --request GET \
  --url https://vanilla-dev02-loyalty.fabric.zone/api/v1/inquire/{profileId}/member-points \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://vanilla-dev02-loyalty.fabric.zone/api/v1/inquire/{profileId}/member-points"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://vanilla-dev02-loyalty.fabric.zone/api/v1/inquire/{profileId}/member-points', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://vanilla-dev02-loyalty.fabric.zone/api/v1/inquire/{profileId}/member-points",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://vanilla-dev02-loyalty.fabric.zone/api/v1/inquire/{profileId}/member-points"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://vanilla-dev02-loyalty.fabric.zone/api/v1/inquire/{profileId}/member-points")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://vanilla-dev02-loyalty.fabric.zone/api/v1/inquire/{profileId}/member-points")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "status": 200,
  "message": "",
  "errors": {},
  "data": [
    {
      "totalPoints": 300,
      "pointsByType": [
        {
          "pointType": "Base",
          "points": 300,
          "subType": null
        }
      ],
      "pointsBalance": {
        "memberPointsEarned": 600,
        "memberPointsDeducted": 100,
        "memberPointsUsed": 100,
        "memberPointsExpired": 100,
        "memberPointsAvailable": 300,
        "memberPointsLocked": 100
      },
      "breakdown": {
        "totalPoints": 300,
        "totalCurrencyValue": 150,
        "unrestrictedPoints": {
          "totalCurrencyValue": 100,
          "totalPoints": 200,
          "unrestrictedPointsItems": [
            {
              "points": 200,
              "pointType": "Base"
            }
          ]
        },
        "restrictedPoints": {
          "totalPoints": 100,
          "totalCurrencyValue": 50,
          "restrictedPointsItems": [
            {
              "points": 100,
              "pointType": "Base",
              "restrictedLocation": "4321"
            }
          ]
        }
      }
    }
  ]
}

{
  "message": "Error message string",
  "errors": {
    "ExceptionString": [
      "Invalid Field"
    ]
  },
  "data": null,
  "status": 400
}

{
  "detail": "Authentication Failed"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

profileId · string · required

Profile ID. It is generated in the response of the Enroll Member endpoint - POST /v1/members.

Response

200

application/json

OK

Response of the Get Member Points endpoint

status · integer<int32>

Status of the call

Example:

200

message · string · default: Exception message

Message corresponding to the call

Example:

""

errors · Errors · object

Error details, if applicable

Example:

{}

data · Data · object[]

Show child attributes