PointOfSaleClient Class

Simplicity Loyalty Web Service API Documentation for Point of Sale End Point

The Point of Sale provides a collection of Methods to manage:

Transactions
Vouchers
Members

Syntax

public class PointOfSaleClient

The PointOfSaleClient type exposes the following members.

Methods

	Name	Description
	AdjustmentTransaction	Submit a Adjustment Transaction. An Adjustment Transaction can be used to correct the Points Balance for a Customer Service function. The updated Card Ponts Balance is returned. Remarks The Transaction generated requires to be approved. Approval is completed via the Service Method: ApproveTransaction TransactionID is optional. If no TransactionID is submitted, then a unique TransactionID is returned by the Service Transaction Value must be between a configurable Minimum and Maximum value The submitted Transaction Date must be Less Than or Equal to the current Date and Time
	Authenticate	Authenticate POS Client Credentials. Returns a Token that enables access to the Point Of Sale End Point secure resources.
	CreateMemberForInStoreCard	Assign an existing Physical Card to a New Member. The Card Status is set to "ACTIVE. Remarks CardStatus must be "PENDINGACTIVATION" Check the CardStatus using the method: ValidateInStoreCard CardNumber and Access code is validated ProgramMembership.ProgramRSN and ProgramMembership.PointsBalance cannot be modified using this method ProgramMembership.PersonRSN does not need to be populated when using this method ProgramMembership.Cards and ProgramMembership.Vouchers should not be populated for this method
	LinkMemberToInStoreCard	Assign an existing Physical Card to an existing Member. The Card Status is set to "ACTIVE. Remarks CardStatus must be "PENDINGACTIVATION" Check the CardStatus using the method: ValidateInStoreCard CardNumber and Access code is validated ProgramMembership.ProgramRSN and ProgramMembership.PointsBalance cannot be modified using this method ProgramMembership.PersonRSN does not need to be populated when using this method
	MultiVoucherRedemptionTransaction	Submit a Voucher Redemption Transaction with mutiple Vouchers. Voucher redemption will not alter the Cards Points Balance, but will deliver a Reward at the POS. Remarks TransactionID is optional. If no TransactionID is submitted, then a unique TransactionID is returned by the Service The submitted Transaction Date must be Less Than or Equal to the current Date and Time
	NonSaleTransaction	Submit a Non Sale Transaction. A Non Sale Transaction can result in the Member earning Points, where the Transaction is not generated from a Sale. The updated Card Ponts Balance is returned. Remarks TransactionID is optional. If no TransactionID is submitted, then a unique TransactionID is returned by the Service The submitted Transaction Date must be Less Than or Equal to the current Date and Time
	PointsRedemptionTransaction	Submit a Transaction to Redeem Points that are available for Redemption on the submitted Card Number. The updated Card Ponts Balance is returned. Remarks The Transaction generated requires to be approved. Approval is completed via the Administration End Point Service Method: ApproveTransaction TransactionID is optional. If no TransactionID is submitted, then a unique TransactionID is returned by the Service The submitted Transaction Date must be Greater Than or Equal to the current Date and Time
	QueryTransaction	Returns the number of potential points the Member would earn from a particular Transaction that contains a combination of submitted Transaction Properties.
	SaleTransaction	Submit a Sale Transaction. The updated Card Ponts Balance is returned. Remarks TransactionID is optional. If no TransactionID is submitted, then a unique TransactionID is returned by the Service The submitted Transaction Date must be Greater Than or Equal to the current Date and Time
	SelectMemberByCardNumber	Return the Member Details from the submitted Card Number.
	SelectMemberByMemberRSN	Return the Member Details from the submitted Member RSN.
	SelectMembers	Return a collection of Members, filtered from the submitted values. Pagination parameters are available to format the response. Remarks If a Card or Voucher Number is submitted, then this takes precendence over the other Filter Fields.
	SelectVouchers	Returns a Paged Collection of Vouchers linked to the submitted Card Number and Access Code. Paging parameters can be defined in the request.
	UpdateMember	Update a Member Detail, from the submitted values.
	ValidateInStoreCard	Returns the Card Status for the submitted Card Number and Access Code. Access Code may be configured to be an optional parameter.
	VoucherDetails	Returns the details of the Voucher for the submitted Voucher Number.
	VoucherRedemptionTransaction	Submit a Voucher Redemption Transaction with a single Voucher. Voucher redemption will not alter the Cards Points Balance, but will deliver a Reward at the POS. Remarks TransactionID is optional. If no TransactionID is submitted, then a unique TransactionID is returned by the Service The submitted Transaction Date must be Less Than or Equal to the current Date and Time
	VoucherStatus	Returns the Voucher Status for the supplied Voucher Code. Card Number is an optional parameter. If the Card Number is supplied, then the the method will check the Voucher is liked to the Card Number.

Top

Reference

PointOfSaleService