memberships > Membership Points

Get Points Balance

Changed on

Retrieves the current loyalty point balance for a specific membership.

get/{tenant}/{environment}/{company}/membership/{membershipId}/points

Request

  • Base URL
    https://api.npretail.app
  • Auth
    API key in header x-np-api-key

Path parameters

tenantstring required

Your Entra Tenant ID. More details.

environmentstring required

Your Business Central Environment. More details.

companystring required

Your Business Central Company. More details.

membershipIdstring uuid required

Unique identifier for a membership.

Headers

x-api-versionstring date

Used for API versioning. More details.

Response

Response with status 200

balanceinteger required
valueAsCurrencyinteger required
currencyCodestring required

Changes

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter x-np-api-key

    • info

      the endpoint scheme security NPApiKeyAuthScheme was added to the API

    • info

      for the path request parameter membershipId, the type was generalized from no type to string, and format from no format to uuid

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      api operation id get-points-balance removed and replaced with memberships_servicePoints_getPointsBalance