GET api/loyalty2/member/shop/{shopId}/term/{searchTerm}

Provides member(s) of a club, given shop id and search term. The search is run against the properties of a member. It's possible to have a concatenated search term, containing multiple property-values of a member, seperated by space (' '). Properties can be omitted, but in case of multiple values they must be present in the order CustomerNumber, FirstName, LastName, Address, PostalCode, City, Country ,Phone, Email.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
shopId

The id of the shop.

 integer

Required
searchTerm

The search term.

 string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of MemberSearchResult
NameDescriptionTypeAdditional information
Id

Id for this loyalty member

 integer

None.
CustomerNumber

The customer number of the member.

 integer

None.
CreationShop

Shop of creation

 string

Max length: 30
User

User name

 string

None.
Password

Password

 string

None.
Modified

The date and time of the last change to the member in Coordinated Universal Time (UTC)

 date

None.
IsDeleted

boolean

None.
RANK

integer

None.
DiscountPoints

decimal number

None.
DiscountMoney

decimal number

None.
BonusPoints

decimal number

None.
BonusMoney

decimal number

None.
ClubId

The ID of the club.

 integer

Required

Range: inclusive between 1 and 2147483647
EngineId

The ID of the Loyalty engine, to which the member shall be assigned. See "...api/loyalty2/engine/club/engines" for fetching all engines of a club. Also see "...Help/ResourceModel?modelName=EngineTypeIdentifier" to understand the type identifiers of engines.

 integer

Required

Range: inclusive between 1 and 2147483647
FirstName

First name

 string

Max length: 450
LastName

Last name

 string

Max length: 450
Address

Address

 string

Max length: 500
PostalCode

Postal code

 string

Max length: 50
City

City

 string

Max length: 500
Country

Country

 string

Max length: 500
Gender

Gender

 string

Max length: 1

Valid values: "M","F",null
BirthDate

Date of birth. Date-only / no UTC.

 date

None.
Email

Email

 string

Max length: 200
Phone

Phone number

 string

Max length: 50
ReceiptByEmail

0 = Receive nothing 1 = Receive by both email and mobile 2 = Receive by email only 3 = Receive by mobile only

 integer

None.
Notes

Additional notes

 string

Max length: -1
IsActive

(Not)active identifier

 boolean

Range: inclusive between false and true
Created

The creation date and time of the member in Coordinated Universal Time (UTC) Set by the system, if left empty.

 date

None.
SignedUp

The sign-up date and time of the member in Coordinated Universal Time (UTC)

 date

None.
DefaultShop

Default store

 integer

None.
SocialSecurityNr

Social and serurity number

 string

None.
TermsConditionsApproved

boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "CustomerNumber": 2,
    "CreationShop": "sample string 3",
    "User": "sample string 4",
    "Password": "sample string 5",
    "Modified": "2025-05-04T06:51:44.5389192+02:00",
    "IsDeleted": true,
    "RANK": 7,
    "DiscountPoints": 8.0,
    "DiscountMoney": 9.0,
    "BonusPoints": 10.0,
    "BonusMoney": 11.0,
    "ClubId": 12,
    "EngineId": 13,
    "FirstName": "sample string 14",
    "LastName": "sample string 15",
    "Address": "sample string 16",
    "PostalCode": "sample string 17",
    "City": "sample string 18",
    "Country": "sample string 19",
    "Gender": "sample string 20",
    "BirthDate": "2025-05-04T06:51:44.5389192+02:00",
    "Email": "sample string 21",
    "Phone": "sample string 22",
    "ReceiptByEmail": 23,
    "Notes": "sample string 24",
    "IsActive": true,
    "Created": "2025-05-04T06:51:44.5389192+02:00",
    "SignedUp": "2025-05-04T06:51:44.5389192+02:00",
    "DefaultShop": 1,
    "SocialSecurityNr": "sample string 25",
    "TermsConditionsApproved": true
  },
  {
    "Id": 1,
    "CustomerNumber": 2,
    "CreationShop": "sample string 3",
    "User": "sample string 4",
    "Password": "sample string 5",
    "Modified": "2025-05-04T06:51:44.5389192+02:00",
    "IsDeleted": true,
    "RANK": 7,
    "DiscountPoints": 8.0,
    "DiscountMoney": 9.0,
    "BonusPoints": 10.0,
    "BonusMoney": 11.0,
    "ClubId": 12,
    "EngineId": 13,
    "FirstName": "sample string 14",
    "LastName": "sample string 15",
    "Address": "sample string 16",
    "PostalCode": "sample string 17",
    "City": "sample string 18",
    "Country": "sample string 19",
    "Gender": "sample string 20",
    "BirthDate": "2025-05-04T06:51:44.5389192+02:00",
    "Email": "sample string 21",
    "Phone": "sample string 22",
    "ReceiptByEmail": 23,
    "Notes": "sample string 24",
    "IsActive": true,
    "Created": "2025-05-04T06:51:44.5389192+02:00",
    "SignedUp": "2025-05-04T06:51:44.5389192+02:00",
    "DefaultShop": 1,
    "SocialSecurityNr": "sample string 25",
    "TermsConditionsApproved": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfMemberSearchResultViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models">
  <MemberSearchResultViewModel>
    <Address>sample string 16</Address>
    <BirthDate>2025-05-04T06:51:44.5389192+02:00</BirthDate>
    <City>sample string 18</City>
    <ClubId>12</ClubId>
    <Country>sample string 19</Country>
    <Created>2025-05-04T06:51:44.5389192+02:00</Created>
    <DefaultShop>1</DefaultShop>
    <Email>sample string 21</Email>
    <EngineId>13</EngineId>
    <FirstName>sample string 14</FirstName>
    <Gender>sample string 20</Gender>
    <IsActive>true</IsActive>
    <LastName>sample string 15</LastName>
    <Notes>sample string 24</Notes>
    <Phone>sample string 22</Phone>
    <PostalCode>sample string 17</PostalCode>
    <ReceiptByEmail>23</ReceiptByEmail>
    <SignedUp>2025-05-04T06:51:44.5389192+02:00</SignedUp>
    <SocialSecurityNr>sample string 25</SocialSecurityNr>
    <TermsConditionsApproved>true</TermsConditionsApproved>
    <BonusMoney>11</BonusMoney>
    <BonusPoints>10</BonusPoints>
    <CreationShop>sample string 3</CreationShop>
    <CustomerNumber>2</CustomerNumber>
    <DiscountMoney>9</DiscountMoney>
    <DiscountPoints>8</DiscountPoints>
    <Id>1</Id>
    <IsDeleted>true</IsDeleted>
    <Modified>2025-05-04T06:51:44.5389192+02:00</Modified>
    <Password>sample string 5</Password>
    <RANK>7</RANK>
    <User>sample string 4</User>
  </MemberSearchResultViewModel>
  <MemberSearchResultViewModel>
    <Address>sample string 16</Address>
    <BirthDate>2025-05-04T06:51:44.5389192+02:00</BirthDate>
    <City>sample string 18</City>
    <ClubId>12</ClubId>
    <Country>sample string 19</Country>
    <Created>2025-05-04T06:51:44.5389192+02:00</Created>
    <DefaultShop>1</DefaultShop>
    <Email>sample string 21</Email>
    <EngineId>13</EngineId>
    <FirstName>sample string 14</FirstName>
    <Gender>sample string 20</Gender>
    <IsActive>true</IsActive>
    <LastName>sample string 15</LastName>
    <Notes>sample string 24</Notes>
    <Phone>sample string 22</Phone>
    <PostalCode>sample string 17</PostalCode>
    <ReceiptByEmail>23</ReceiptByEmail>
    <SignedUp>2025-05-04T06:51:44.5389192+02:00</SignedUp>
    <SocialSecurityNr>sample string 25</SocialSecurityNr>
    <TermsConditionsApproved>true</TermsConditionsApproved>
    <BonusMoney>11</BonusMoney>
    <BonusPoints>10</BonusPoints>
    <CreationShop>sample string 3</CreationShop>
    <CustomerNumber>2</CustomerNumber>
    <DiscountMoney>9</DiscountMoney>
    <DiscountPoints>8</DiscountPoints>
    <Id>1</Id>
    <IsDeleted>true</IsDeleted>
    <Modified>2025-05-04T06:51:44.5389192+02:00</Modified>
    <Password>sample string 5</Password>
    <RANK>7</RANK>
    <User>sample string 4</User>
  </MemberSearchResultViewModel>
</ArrayOfMemberSearchResultViewModel>