POST api/customer/{guid}/loyaltyPoints

Add or Remove a customer's loyalty points or available spend balance

Request Information

URI Parameters

Name	Description	Type	Additional information
guid	Identifier of customer to have points adjusted	globally unique identifier	Required

Body Parameters

Record of changes to occur

CustomerLoyaltyLedgerEntry

Name	Description	Type	Additional information
ID	Auto Increment ID	integer	None.
CustomerIdentifier	The byte[16] representation of the customer's identifier	Collection of byte	None.
CustomerIdentifierGuid	Guid of Customer this change happened/will happen to	globally unique identifier	None.
SaleHeaderID	StoreSaleHeader SaleHeaderID where points or available spend is adjusteed	integer	None.
SaleIdentifier	Sale Identifier of the referenced sale, where there is one	string	None.
TransactionDate	Time of points adjustment, or sale time	date	None.
Points	New Total Loyalty Points	integer	None.
AvailableSpend	New Total Available Spend Balance	integer	None.
PointsChange	Amount Loyalty Points will change by	integer	None.
AvailableSpendChange	Amount Available Spend Balance will change by	integer	None.
User	Name or email of user making adjustment, will be current logged in user if left blank	string	String length: inclusive between 0 and 255
Reason	Manual or Automatic adjustment, 0 for automatic (eg. pos-system), 1 for manual (eg. staff adjust) 2 for expired	integer	None.
AccruementMode	Mode that points are accrued in. Filled in by system using current settings	LoyaltyPointsAccruementMode	None.
StoreSalePaymentID	Store Sale payment identifier	integer	None.
IdempotentID	The byte[16] representation of the idempotent id	Collection of byte	None.
IdempotentGuid	Idempotent identifier	globally unique identifier	None.
Offline		boolean	None.
Updated	Time record changed	date	None.
ExternalTransNo		string	Relation. This field may not always be loaded or used for updates.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "customerIdentifier": "gM0xOZLqBkCvUHStW5m7qA==",
  "customerIdentifierGuid": "3931cd80-ea92-4006-af50-74ad5b99bba8",
  "saleHeaderID": 1,
  "saleIdentifier": "sample string 3",
  "transactionDate": "2025-06-14T07:18:43.0937213",
  "points": 1,
  "availableSpend": 1,
  "pointsChange": 1,
  "availableSpendChange": 1,
  "user": "sample string 4",
  "reason": 1,
  "accruementMode": 1,
  "storeSalePaymentID": 1,
  "idempotentID": "BVg+fY7PykCoMURsEm6rlw==",
  "idempotentGuid": "7d3e5805-cf8e-40ca-a831-446c126eab97",
  "offline": true,
  "updated": "2025-06-14T07:18:43.0937213",
  "externalTransNo": "sample string 7"
}

application/xml, text/xml

Sample:

<CustomerLoyaltyLedgerEntry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Customers">
  <AccruementMode>1</AccruementMode>
  <AvailableSpend>1</AvailableSpend>
  <AvailableSpendChange>1</AvailableSpendChange>
  <CustomerIdentifier>gM0xOZLqBkCvUHStW5m7qA==</CustomerIdentifier>
  <CustomerIdentifierGuid>3931cd80-ea92-4006-af50-74ad5b99bba8</CustomerIdentifierGuid>
  <ExternalTransNo>sample string 7</ExternalTransNo>
  <ID>1</ID>
  <IdempotentGuid>7d3e5805-cf8e-40ca-a831-446c126eab97</IdempotentGuid>
  <IdempotentID>BVg+fY7PykCoMURsEm6rlw==</IdempotentID>
  <Offline>true</Offline>
  <Points>1</Points>
  <PointsChange>1</PointsChange>
  <Reason>1</Reason>
  <SaleHeaderID>1</SaleHeaderID>
  <SaleIdentifier>sample string 3</SaleIdentifier>
  <StoreSalePaymentID>1</StoreSalePaymentID>
  <TransactionDate>2025-06-14T07:18:43.0937213+00:00</TransactionDate>
  <Updated>2025-06-14T07:18:43.0937213+00:00</Updated>
  <User>sample string 4</User>
</CustomerLoyaltyLedgerEntry>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.