CustomerComponents Web Service
Method/GetLoyaltyCards
CustomerComponents Web Service > All Operations Resource Group : /GetLoyaltyCards (Method)
Description
The GetLoyaltyCards function returns all loyaltyCard records for the specified parameters.
Request (GetLoyaltyCardsSoapIn)

The request body is of type GetLoyaltyCards.

Request Body Parameters

NameDescriptionData Type
filter LoyaltyCardsFilter
offset xml:int
maxRecords xml:int
orderBy xml:string
skipItemId xml:int
skipItemId Element orderBy Element maxRecords Element offset Element OnlyWithEmailAddress Element AssociatedCardsOnly Element CardNumberTo Element CardNumberFrom Element LastTransactionModifiedDateTo Element LastTransactionModifiedDateFrom Element LastModifiedDateTo Element LastModifiedDateFrom Element MinimumPrintedPriceBalance Element MinimumPrintedPointsBalance Element RegistrationSentReminders Element LastRegistrationReminderSinceDaysOrMore Element LastPrintedDateFrom Element CustomerWithAddressOnly Element WithCustomerOnly Element IsSmartSearch Element CustomerGeneralName Element CustomerZipCode Element CustomerCity Element CustomerMiddleName Element CustomerLastName Element CustomerFirstName Element CustomerStreetNumberPart2 Element CustomerStreetNumberPart1 Element CustomerStreet Element CustomerNumber Element MinimumPointsWithdrawalMoneyBalance Element MinimumPointsBalance Element MinimumPriceBalance Element Status Element IsBlockedOnly Element VerificationCode Element IsTransferredOnly Element CustomerId Element LoyaltyCardTypeId Element DigitalOnly Element CardAlias Element CardNumber Element StoreId Element CompanyId Element ItemId Element Sequence filter Element Sequence GetLoyaltyCards Element

Overview

GetLoyaltyCards
Sequence
filter optional LoyaltyCardsFilter Complex Type
Sequence
ItemId xs:int
CompanyId xs:int
StoreId xs:int
CardNumber xs:long
CardAlias optional xs:string
DigitalOnly BooleanFilter Simple Type
LoyaltyCardTypeId xs:int
CustomerId xs:int
IsTransferredOnly BooleanFilter Simple Type
VerificationCode optional xs:string
IsBlockedOnly BooleanFilter Simple Type
Status LoyaltyCardStatus Simple Type
MinimumPriceBalance xs:decimal
MinimumPointsBalance xs:int
MinimumPointsWithdrawalMoneyBalance xs:decimal
CustomerNumber xs:long
CustomerStreet optional xs:string
CustomerStreetNumberPart1 xs:int
CustomerStreetNumberPart2 optional xs:string
CustomerFirstName optional xs:string
CustomerLastName optional xs:string
CustomerMiddleName optional xs:string
CustomerCity optional xs:string
CustomerZipCode optional xs:string
CustomerGeneralName optional xs:string
IsSmartSearch xs:boolean
WithCustomerOnly BooleanFilter Simple Type
CustomerWithAddressOnly BooleanFilter Simple Type
LastPrintedDateFrom xs:dateTime
LastRegistrationReminderSinceDaysOrMore xs:int
RegistrationSentReminders xs:int
MinimumPrintedPointsBalance xs:int
MinimumPrintedPriceBalance xs:decimal
LastModifiedDateFrom xs:dateTime
LastModifiedDateTo xs:dateTime
LastTransactionModifiedDateFrom xs:dateTime
LastTransactionModifiedDateTo xs:dateTime
CardNumberFrom xs:long
CardNumberTo xs:long
AssociatedCardsOnly BooleanFilter Simple Type
OnlyWithEmailAddress BooleanFilter Simple Type
offset xs:int
maxRecords xs:int
orderBy optional xs:string
skipItemId xs:int
Response (GetLoyaltyCardsSoapOut)

The response body is of type GetLoyaltyCardsResponse.

Response Body Parameters

NameDescriptionData Type
GetLoyaltyCardsResult ArrayOfViewLoyaltyCardInfo
CardNumberString Element GeneralName Element CustomerNumber Element LoyaltyCardType Element PointWithdrawPrice Element CurrentBalancePointsMoneyValue Element CurrentBalancePrice Element CurrentBalancePoints Element TotalWithdrawedPrice Element TotalWithdrawedPoints Element TotalSavedPrice Element TotalSavedPoints Element LoyaltyCardTypeDescription Element LastPrintedPriceBalance Element LastPrintedPointsBalance Element LastPrintedDateTime Element LastSentRegistrationEmail Element NumberOfSentRegistrationEmails Element RegistrationEmailAddress Element VerificationCode Element IsTransferred Element BlockedDescription Element Status Element CustomerId Element LoyaltyCardTypeId Element Digital Element CardNumber Element StoreId Element CompanyId Element LastModifiedDateTime Element LastModifiedByUserId Element CreatedDateTime Element CreatedByUserId Element ItemId Element Sequence ViewLoyaltyCardInfo Element Sequence GetLoyaltyCardsResult Element Sequence GetLoyaltyCardsResponse Element

Overview

GetLoyaltyCardsResponse
Sequence
GetLoyaltyCardsResult optional ArrayOfViewLoyaltyCardInfo Complex Type
Sequence
ViewLoyaltyCardInfo 0..∞ ViewLoyaltyCardInfo Complex Type
Sequence
ItemId xs:int
CreatedByUserId xs:int
CreatedDateTime xs:dateTime
LastModifiedByUserId xs:int
LastModifiedDateTime xs:dateTime
CompanyId xs:int
StoreId xs:int
CardNumber xs:long
Digital xs:boolean
LoyaltyCardTypeId xs:int
CustomerId xs:int
Status LoyaltyCardStatus Simple Type
BlockedDescription optional xs:string
IsTransferred xs:boolean
VerificationCode optional xs:string
RegistrationEmailAddress optional xs:string
NumberOfSentRegistrationEmails xs:int
LastSentRegistrationEmail xs:dateTime
LastPrintedDateTime xs:dateTime
LastPrintedPointsBalance xs:int
LastPrintedPriceBalance xs:decimal
LoyaltyCardTypeDescription optional xs:string
TotalSavedPoints xs:int
TotalSavedPrice xs:decimal
TotalWithdrawedPoints xs:int
TotalWithdrawedPrice xs:decimal
CurrentBalancePoints xs:int
CurrentBalancePrice xs:decimal
CurrentBalancePointsMoneyValue xs:decimal
PointWithdrawPrice xs:decimal
LoyaltyCardType LoyaltyCardTypes Simple Type
CustomerNumber xs:long
GeneralName optional xs:string
CardNumberString optional xs:string
See Also
All Operations Resource Group | CustomerComponents Web Service

 

 

© 2020 All Rights Reserved.

Send comments on this topic.