Click or drag to resize

LoyaltyPartnerClient Methods

The LoyaltyPartnerClient type exposes the following members.

Methods
  NameDescription
Public methodCode exampleCancelSaleTransactionBatch

Cancel the processing of a queued batch of Transactions, from the submitted Batch RSN. A batch cannot be cancelled after it has been processed.

This method is a step in the workflow for Transaction File Batch submission.

Remarks
Transaction File Batch submission workflow:
  • Initialise Batch - call service: OpenSaleTransactionBatch
  • Submit Transaction File(s) - call service: LoadSaleTransactionBatch
  • Monitor submitted Transaction Batch Progress - call service: QuerySaleTransactionBatch
  • Stop The Transaction Batch Processing - call service: CancelSaleTransactionBatch
Public methodCode exampleDeletePartnerCategory

Delete a Partner Category from the submitted Partner Category RSN.

The Partner Category RSN can be fetched from the Web Service Method: SelectPartnerCategoryList

Public methodCode exampleInsertLoyaltyPartner

Create a new Loyalty Partner, from the submitted values.

Public methodCode exampleInsertLoyaltyPartnerOutlet

Create a new Loyalty Outlet, from the submitted values.

Public methodCode exampleInsertPartnerCategory

Create a new Partner Category, from the submitted values.

Public methodCode exampleLoadSaleTransactionBatch

Submitting a single file or multiple files containing Transactions.

If more than 1 file is being submitted, the set the value for BatchOfOldSalesTransaction.Final = 1

Optimum number of Transaction rows per file is 20.

This method is a step in the workflow for Transaction File Batch submission.

Remarks
Transaction File Batch submission workflow:
  • Initialise Batch - call service: OpenSaleTransactionBatch
  • Submit Transaction File(s) - call service: LoadSaleTransactionBatch
  • Monitor submitted Transaction Batch Progress - call service: QuerySaleTransactionBatch
  • Stop The Transaction Batch Processing - call service: CancelSaleTransactionBatch
Public methodCode exampleOpenSaleTransactionBatch

Initialise the Batch for submitting file(s) containing Transactions. The service returns the Batch Details, containing a key for calling the subsequent workflow Transaction Batch methods.

This method is a step in the workflow for Transaction File Batch submission.

Remarks
Transaction File Batch submission workflow:
  • Initialise Batch - call service: OpenSaleTransactionBatch
  • Submit Transaction File(s) - call service: LoadSaleTransactionBatch
  • Monitor submitted Transaction Batch Progress - call service: QuerySaleTransactionBatch
  • Stop The Transaction Batch Processing - call service: CancelSaleTransactionBatch
Public methodCode exampleQuerySaleTransactionBatch

Returns the Batch Details metadata that enables monitoring the submitted Transaction Batch Progress.

This method is an optional step in the workflow for Transaction File Batch submission.

Remarks
Transaction File Batch submission workflow:
  • Initialise Batch - call service: OpenSaleTransactionBatch
  • Submit Transaction File(s) - call service: LoadSaleTransactionBatch
  • Monitor submitted Transaction Batch Progress - call service: QuerySaleTransactionBatch
  • Stop The Transaction Batch Processing - call service: CancelSaleTransactionBatch
Public methodCode exampleSelectLoyaltyPartner

Return the Loyalty Partner Details from the submitted Loyalty Partner RSN.

The Loyalty Partner RSN can be fetched from the Web Service Method: SelectLoyaltyPartnerList

Public methodCode exampleSelectLoyaltyPartnerList

Return a Paged Collection of Loyalty Partners, filtered from the submitted values.

Paging parameters can be defined in the request.

Public methodCode exampleSelectLoyaltyPartnerOutlet

Return the Loyalty Partner Outlet Details from the submitted Loyalty Partner Outlet RSN.

The Loyalty Partner Outlet RSN can be fetched from the Web Service Method: SelectLoyaltyPartnerOutletList

Public methodCode exampleSelectLoyaltyPartnerOutletList

Return a Paged Collection of Loyalty Partner Outlets, filtered from the submitted values.

Paging parameters can be defined in the request.

Public methodCode exampleSelectPartnerCategory

Return the Partner Category Details from the submitted Partner Category RSN.

The Partner Category RSN can be fetched from the Web Service Method: SelectPartnerCategoryList

Public methodCode exampleSelectPartnerCategoryList

Return a Paged Collection of Partner Category Details, filtered from the submitted values.

Paging parameters can be defined in the request.

Public methodCode exampleSelectRegionList

Return a Paged Collection of all the Region Details.

Paging parameters can be defined in the request.

Public methodCode exampleTransaction

Submit a Partner Reward Transaction.

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
  • 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
Public methodCode exampleUpdateLoyaltyPartner

Update a Loyalty Detail, from the submitted values.

Public methodCode exampleUpdateLoyaltyPartnerOutlet

Update a Loyalty Partner Outlet, from the submitted values.

Public methodCode exampleUpdatePartnerCategory

Update a Partner Category, from the submitted values.

Top
See Also