Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 3.23 KB

MemberstatusService.md

File metadata and controls

44 lines (29 loc) · 3.23 KB

MemberstatusService

A list of all methods in the MemberstatusService service. Click on the method name to view detailed information about that method.

Methods Description
MemberStatusV_Get Gets the first found member that matches the query. Operation to get member overview. Is usually called from POS after a member gives some identification information this method returns the status together with contactId (GUID) and memberNumber (if available). The contactId may be used to get detailed contact information. Common identification fields that may be used in the query: socialSecurityNumber, email, mobilePhone, memberNumber and externalId The language of the returned answer is controlled by the language setting of the user connected to the API-key.

MemberStatusV_Get

Gets the first found member that matches the query. Operation to get member overview. Is usually called from POS after a member gives some identification information this method returns the status together with contactId (GUID) and memberNumber (if available). The contactId may be used to get detailed contact information. Common identification fields that may be used in the query: socialSecurityNumber, email, mobilePhone, memberNumber and externalId The language of the returned answer is controlled by the language setting of the user connected to the API-key.

  • HTTP Method: GET
  • Endpoint: /api/v2/memberstatus

Parameters

Name Type Required Description
query string ✅ {fieldId}:{value}, e.g. email:[email protected]

Return Type

MemberStatusModel

Example Usage Code Snippet

import { VoyadoEngage } from 'voyado_engage';

(async () => {
  const voyadoEngage = new VoyadoEngage({
    token: 'YOUR_TOKEN',
  });

  const { data } = await voyadoEngage.memberstatus.memberStatusVGet({
    query: 'query',
  });

  console.log(data);
})();