POST posSupportAPI/loyalty/membersearch

The Loyalty Member Search method. This request initiates a Loyalty Member Search Event. Clients should make this request to initiate a Loyalty Member search.

Request Information

URI Parameters

None.

Body Parameters

The Loyalty Member Search request context.

LoyaltyMemberSearchRequest

Name	Description	Type	Additional information
mobilePhone	The phone number of Loyalty Member .	string	Required

Request Formats

application/json, text/json

Sample:

{
  "mobilePhone": "sample string 1"
}

application/xml, text/xml

Sample:

<LoyaltyMemberSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <MobilePhone>sample string 1</MobilePhone>
</LoyaltyMemberSearchRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'LoyaltyMemberSearchRequest'.

Response Information

Resource Description

A Loyalty Member Search response object.

LoyaltyMemberSearchResponse

Name	Description	Type	Additional information
loyaltyMembers	The loyalty member's available rewards list.	Collection of LoyaltyMemberInfo	Required
result	The result object.	Result	Required

Response Formats

application/json, text/json

Sample:

{
  "loyaltyMembers": [
    {
      "loyaltyNumber": "sample string 1",
      "pointsEarned": 2,
      "balancePoints": 3,
      "balanceDollar": 4.1,
      "member": {
        "id": 1,
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "phoneNumber": "sample string 4",
        "addressZip": "sample string 5",
        "status": "sample string 6",
        "birthday": "sample string 7",
        "memberUuid": "sample string 8"
      },
      "rewards": [
        {
          "promotionId": 1,
          "promotionCode": "sample string 2",
          "promotionPublicName": "sample string 3",
          "promotionPublicDescription": "sample string 4",
          "promotionPublicRestrictions": "sample string 5",
          "promotionExpiration": "sample string 6",
          "promotionValue": 7.0,
          "rewardUuid": "sample string 8"
        },
        {
          "promotionId": 1,
          "promotionCode": "sample string 2",
          "promotionPublicName": "sample string 3",
          "promotionPublicDescription": "sample string 4",
          "promotionPublicRestrictions": "sample string 5",
          "promotionExpiration": "sample string 6",
          "promotionValue": 7.0,
          "rewardUuid": "sample string 8"
        }
      ]
    },
    {
      "loyaltyNumber": "sample string 1",
      "pointsEarned": 2,
      "balancePoints": 3,
      "balanceDollar": 4.1,
      "member": {
        "id": 1,
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "phoneNumber": "sample string 4",
        "addressZip": "sample string 5",
        "status": "sample string 6",
        "birthday": "sample string 7",
        "memberUuid": "sample string 8"
      },
      "rewards": [
        {
          "promotionId": 1,
          "promotionCode": "sample string 2",
          "promotionPublicName": "sample string 3",
          "promotionPublicDescription": "sample string 4",
          "promotionPublicRestrictions": "sample string 5",
          "promotionExpiration": "sample string 6",
          "promotionValue": 7.0,
          "rewardUuid": "sample string 8"
        },
        {
          "promotionId": 1,
          "promotionCode": "sample string 2",
          "promotionPublicName": "sample string 3",
          "promotionPublicDescription": "sample string 4",
          "promotionPublicRestrictions": "sample string 5",
          "promotionExpiration": "sample string 6",
          "promotionValue": 7.0,
          "rewardUuid": "sample string 8"
        }
      ]
    }
  ],
  "result": {
    "statusCode": 1,
    "description": "sample string 2",
    "exceptionTrackingMoniker": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<LoyaltyMemberSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <LoyaltyMembers>
    <LoyaltyMemberInfo>
      <BalanceDollar>4.1</BalanceDollar>
      <BalancePoints>3</BalancePoints>
      <LoyaltyNumber>sample string 1</LoyaltyNumber>
      <Member>
        <AddressZip>sample string 5</AddressZip>
        <Birthday>sample string 7</Birthday>
        <FirstName>sample string 2</FirstName>
        <Id>1</Id>
        <LastName>sample string 3</LastName>
        <MemberUuid>sample string 8</MemberUuid>
        <PhoneNumber>sample string 4</PhoneNumber>
        <Status>sample string 6</Status>
      </Member>
      <PointsEarned>2</PointsEarned>
      <Rewards>
        <Reward>
          <PromotionCode>sample string 2</PromotionCode>
          <PromotionExpiration>sample string 6</PromotionExpiration>
          <PromotionId>1</PromotionId>
          <PromotionPublicDescription>sample string 4</PromotionPublicDescription>
          <PromotionPublicName>sample string 3</PromotionPublicName>
          <PromotionPublicRestrictions>sample string 5</PromotionPublicRestrictions>
          <PromotionValue>7</PromotionValue>
          <RewardUuid>sample string 8</RewardUuid>
        </Reward>
        <Reward>
          <PromotionCode>sample string 2</PromotionCode>
          <PromotionExpiration>sample string 6</PromotionExpiration>
          <PromotionId>1</PromotionId>
          <PromotionPublicDescription>sample string 4</PromotionPublicDescription>
          <PromotionPublicName>sample string 3</PromotionPublicName>
          <PromotionPublicRestrictions>sample string 5</PromotionPublicRestrictions>
          <PromotionValue>7</PromotionValue>
          <RewardUuid>sample string 8</RewardUuid>
        </Reward>
      </Rewards>
    </LoyaltyMemberInfo>
    <LoyaltyMemberInfo>
      <BalanceDollar>4.1</BalanceDollar>
      <BalancePoints>3</BalancePoints>
      <LoyaltyNumber>sample string 1</LoyaltyNumber>
      <Member>
        <AddressZip>sample string 5</AddressZip>
        <Birthday>sample string 7</Birthday>
        <FirstName>sample string 2</FirstName>
        <Id>1</Id>
        <LastName>sample string 3</LastName>
        <MemberUuid>sample string 8</MemberUuid>
        <PhoneNumber>sample string 4</PhoneNumber>
        <Status>sample string 6</Status>
      </Member>
      <PointsEarned>2</PointsEarned>
      <Rewards>
        <Reward>
          <PromotionCode>sample string 2</PromotionCode>
          <PromotionExpiration>sample string 6</PromotionExpiration>
          <PromotionId>1</PromotionId>
          <PromotionPublicDescription>sample string 4</PromotionPublicDescription>
          <PromotionPublicName>sample string 3</PromotionPublicName>
          <PromotionPublicRestrictions>sample string 5</PromotionPublicRestrictions>
          <PromotionValue>7</PromotionValue>
          <RewardUuid>sample string 8</RewardUuid>
        </Reward>
        <Reward>
          <PromotionCode>sample string 2</PromotionCode>
          <PromotionExpiration>sample string 6</PromotionExpiration>
          <PromotionId>1</PromotionId>
          <PromotionPublicDescription>sample string 4</PromotionPublicDescription>
          <PromotionPublicName>sample string 3</PromotionPublicName>
          <PromotionPublicRestrictions>sample string 5</PromotionPublicRestrictions>
          <PromotionValue>7</PromotionValue>
          <RewardUuid>sample string 8</RewardUuid>
        </Reward>
      </Rewards>
    </LoyaltyMemberInfo>
  </LoyaltyMembers>
  <Result>
    <Description>sample string 2</Description>
    <ExceptionTrackingMoniker>sample string 3</ExceptionTrackingMoniker>
    <StatusCode>1</StatusCode>
  </Result>
</LoyaltyMemberSearchResponse>