memberships > Membership Points

Registers a sale, with points being added to membership based on the contents of it. Reservations on the membership can be finalized.

post/{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.

Request body

requestIdstring uuid required

A unique identifier for the request. If you send the same requestId twice, it will be guaranteed to only trigger once.

externalReferenceNostring required

Your external reference number, such as a POS Receipt number, invoice number etc.

externalSystemIdentifierstring required

An identifier of your external system. This together with the entra app name identifies the external system that is making the operation.

externalSystemUserIdentifierstring required

An identifier for the user in the external system, e.g. a POS UnitId, a salesperson code in an external POS or a user ID in a customer support tool.

externalBusinessUnitIdentifierstring required

An identifier for the business unit of the external system.

Response

Response with status 200

pointsEarnedinteger required

The total points earned by the transaction

pointsCapturedinteger required

the total amount of points captured by the transaction

newBalanceinteger required

The points balance on the membership after the transaction

Changes

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • 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

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • 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 register-sale removed and replaced with memberships_servicePoints_registerSale