POST api/customer/{id}/accrueLoyaltyPoints
Perform a Loyalty transaction
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
AccrueLoyaltyPoints| Name | Description | Type | Additional information |
|---|---|---|---|
| Voucher |
When AccruementMode=AssignVoucher, this is loaded from the DeliQs Settings table. |
string |
Required |
| VouchersAssigned |
When AccruementMode=AssignVoucher, this is set to the total vouchers assigned in a transaction. |
integer |
None. |
| Points | integer |
Required |
|
| CurrentBalance |
The value of Customer.LoyaltyPoints after the accruement transaction. |
integer |
None. |
| AvailableSpend |
Customer.AvailableSpend |
integer |
None. |
| Threshold |
When AccruementMode=TransferToAvailableSpend, this is set to the amount to be added to Customer.AvailableSpend when LoyaltyPoints reaches the Threshold |
integer |
None. |
| Amount |
When AccruementMode=TransferToAvailableSpend, this is set to the amount to be added to Customer.AvailableSpend when LoyaltyPoints reaches the Threshold |
integer |
None. |
| PointsSubtracted |
When AccruementMode=TransferToAvailableSpend, this is set to the total points subtracted from Customer.LoyaltyPoints |
integer |
None. |
| AvailableSpendAwarded |
When AccruementMode=TransferToAvailableSpend, this is set to the total awarded to Customer.AvailableSpend |
integer |
None. |
| AccruementMode |
AccruementMode Setting |
LoyaltyPointsAccruementMode |
None. |
| SaleIdentifier |
Sale identifier of sale associated with loyalty point accruement |
string |
None. |
| IdempotentID |
The byte[16] representation of the idempotent id |
Collection of byte |
None. |
| IdempotentGuid |
Idempotent identifier |
globally unique identifier |
None. |
| Offline | boolean |
None. |
Request Formats
application/json, text/json
{
"voucher": "sample string 1",
"vouchersAssigned": 2,
"points": 3,
"currentBalance": 4,
"availableSpend": 5,
"threshold": 6,
"amount": 7,
"pointsSubtracted": 8,
"availableSpendAwarded": 9,
"accruementMode": 0,
"saleIdentifier": "sample string 10",
"idempotentID": "TxLBmKTuWUe2luM5rjOGNw==",
"idempotentGuid": "98c1124f-eea4-4759-b696-e339ae338637",
"offline": true
}
application/xml, text/xml
<AccrueLoyaltyPoints xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Customers"> <AccruementMode>Accrue</AccruementMode> <Amount>7</Amount> <AvailableSpend>5</AvailableSpend> <AvailableSpendAwarded>9</AvailableSpendAwarded> <CurrentBalance>4</CurrentBalance> <IdempotentGuid>98c1124f-eea4-4759-b696-e339ae338637</IdempotentGuid> <IdempotentID>TxLBmKTuWUe2luM5rjOGNw==</IdempotentID> <Offline>true</Offline> <Points>3</Points> <PointsSubtracted>8</PointsSubtracted> <SaleIdentifier>sample string 10</SaleIdentifier> <Threshold>6</Threshold> <Voucher>sample string 1</Voucher> <VouchersAssigned>2</VouchersAssigned> </AccrueLoyaltyPoints>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
AccrueLoyaltyPoints| Name | Description | Type | Additional information |
|---|---|---|---|
| Voucher |
When AccruementMode=AssignVoucher, this is loaded from the DeliQs Settings table. |
string |
Required |
| VouchersAssigned |
When AccruementMode=AssignVoucher, this is set to the total vouchers assigned in a transaction. |
integer |
None. |
| Points | integer |
Required |
|
| CurrentBalance |
The value of Customer.LoyaltyPoints after the accruement transaction. |
integer |
None. |
| AvailableSpend |
Customer.AvailableSpend |
integer |
None. |
| Threshold |
When AccruementMode=TransferToAvailableSpend, this is set to the amount to be added to Customer.AvailableSpend when LoyaltyPoints reaches the Threshold |
integer |
None. |
| Amount |
When AccruementMode=TransferToAvailableSpend, this is set to the amount to be added to Customer.AvailableSpend when LoyaltyPoints reaches the Threshold |
integer |
None. |
| PointsSubtracted |
When AccruementMode=TransferToAvailableSpend, this is set to the total points subtracted from Customer.LoyaltyPoints |
integer |
None. |
| AvailableSpendAwarded |
When AccruementMode=TransferToAvailableSpend, this is set to the total awarded to Customer.AvailableSpend |
integer |
None. |
| AccruementMode |
AccruementMode Setting |
LoyaltyPointsAccruementMode |
None. |
| SaleIdentifier |
Sale identifier of sale associated with loyalty point accruement |
string |
None. |
| IdempotentID |
The byte[16] representation of the idempotent id |
Collection of byte |
None. |
| IdempotentGuid |
Idempotent identifier |
globally unique identifier |
None. |
| Offline | boolean |
None. |
Response Formats
application/json, text/json
{
"voucher": "sample string 1",
"vouchersAssigned": 2,
"points": 3,
"currentBalance": 4,
"availableSpend": 5,
"threshold": 6,
"amount": 7,
"pointsSubtracted": 8,
"availableSpendAwarded": 9,
"accruementMode": 0,
"saleIdentifier": "sample string 10",
"idempotentID": "wPOiDF9+I0qS7+Z+ZZ5J+Q==",
"idempotentGuid": "0ca2f3c0-7e5f-4a23-92ef-e67e659e49f9",
"offline": true
}
application/xml, text/xml
<AccrueLoyaltyPoints xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Customers"> <AccruementMode>Accrue</AccruementMode> <Amount>7</Amount> <AvailableSpend>5</AvailableSpend> <AvailableSpendAwarded>9</AvailableSpendAwarded> <CurrentBalance>4</CurrentBalance> <IdempotentGuid>0ca2f3c0-7e5f-4a23-92ef-e67e659e49f9</IdempotentGuid> <IdempotentID>wPOiDF9+I0qS7+Z+ZZ5J+Q==</IdempotentID> <Offline>true</Offline> <Points>3</Points> <PointsSubtracted>8</PointsSubtracted> <SaleIdentifier>sample string 10</SaleIdentifier> <Threshold>6</Threshold> <Voucher>sample string 1</Voucher> <VouchersAssigned>2</VouchersAssigned> </AccrueLoyaltyPoints>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK K��\c�J� 5 xl/workbook.xml � (� ���� D�M��(�6����zGX
Q� ���"F��zۙ�};�l��[;����\�eSE�g4�';��;a��!J�"VŠ���rβq0Ҡ��RM��X~r@�� A�+JSep{< T/͞
f�d4�����"��:��������@1JΝ78��U*(x��g��� ���a5�~�_PK K��\���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d�
�d�k��<�H���V���=
��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ
�1Z�$�8z�R��3
tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b
��%#H'�2}���e�B)��~j/F�t��PK
K��\���L' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R77cba60959e841ae" /></Relationships>PK K��\�0٫� � xl/worksheets/sheet1.xml � (� ���r�@�_��~aN��RSI�9���b���1P�Ƙ��Q�������4�w�㫯b|J]媜�0a ˅Z���$ܚ�^M�;�?�LJX��Fzf�lFq\-2Y�U�6�����Ej�~��j�/�L-��,M� ������[UY���C���6Z�˺�b}HU�yN���f�Wh����p�� ��k�w.w�s�O�W�����r���;��O,�*ݮ�/�{��{fl��Z�P���|ߺ0(ү�{�/MfO$b A9g��Ŷ2��ӄ�Yz���Y�" �� �����^D� ���:��[��%PP�B.�F��zN��L ������ӳD�r G á�Y�g��ܼ���}iDBP� �u�F/Nz�"ơ��"k���� �qd����@�4r��%'$p�:1T�q�3u8��`J�v�@������a1L bv
��@�� B�=����[:KM:k�t�y��k{��ݶ�Zٗ����Ͻ�!n�l�]��Y��m�K�61�I����M<t �&�oO]B��瞎yM}�A���� ^[�z�s_ck��qtvuE^�o�H���n�3q�Ƽ�wn�3n��<��ݘgփ�lztc�AO=-�Jz�A��^z���ī��������q�z���������?PK K��\�2vX� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞؆��n7ݰ-��k����m�n�gc���V� �X��j4��'�|�,�o�HN��^1 �7��$���^-�8�\&R?�DʊK��ÂҤ{�T�|@W:��I�Ǝ��Cz�XC��L�;��[;h�x}���?����C�3���f ?�D/�W�
��Hآ0��v�X[�@���R>��~�����鑉��[-n*ӫ��%�r�Ӽ<S�X��U�a��������PK K��\Ѓc'2 E
xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK K��\���I � xl/sharedStrings.xml � (� ���N�0E%�>M��JR�E�.H-l�7���п�l�Z��=��w쩖_J&G�(���x��43�Ї�����������h�� �$˦BtI(�X��6ː��(�� :n��.�!���pJfE��3E�& 3^����k��a�+�T�y5>4�U�*���dl�ACwɟ��/յ��[QI5�K���t/aF�:�z��V���`���R���f�'�ݕK�Y*D~4]�wK%l� ���������\�8�BGvH� !l�
ˑ��g��(�f8�5Z���_тOX�.`��)-&iY Oa�����i����BdaO�oPK- K��\c�J� 5 xl/workbook.xmlPK- K��\���� � � [Content_Types].xmlPK-
K��\���L' ' U _rels/.relsPK- K��\�0٫� � � xl/worksheets/sheet1.xmlPK- K��\�2vX� P � xl/_rels/workbook.xml.relsPK- K��\Ѓc'2 E
� xl/styles.xmlPK- K��\���I � ^ xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK K��\�k=�� 5 xl/workbook.xml � (� ����0��J}�(P��
&���pJIP��>~!�n�|����u]em�>�7>s9oC2 _����@f�I�4�I�X)UM��ߚL�S���Ǡ��<_h������/(���b�cL�͞�F�d�ug���ߔ���"*fPS�K�Yt�MΏ��LM�C��U�^k����-�{� X_PK K��\���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d�
�d�k��<�H���V���=
��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ
�1Z�$�8z�R��3
tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b
��%#H'�2}���e�B)��~j/F�t��PK
K��\h���' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R3cd13a3d14344236" /></Relationships>PK K��\�0٫� � xl/worksheets/sheet1.xml � (� ���r�@�_��~aN��RSI�9���b���1P�Ƙ��Q�������4�w�㫯b|J]媜�0a ˅Z���$ܚ�^M�;�?�LJX��Fzf�lFq\-2Y�U�6�����Ej�~��j�/�L-��,M� ������[UY���C���6Z�˺�b}HU�yN���f�Wh����p�� ��k�w.w�s�O�W�����r���;��O,�*ݮ�/�{��{fl��Z�P���|ߺ0(ү�{�/MfO$b A9g��Ŷ2��ӄ�Yz���Y�" �� �����^D� ���:��[��%PP�B.�F��zN��L ������ӳD�r G á�Y�g��ܼ���}iDBP� �u�F/Nz�"ơ��"k���� �qd����@�4r��%'$p�:1T�q�3u8��`J�v�@������a1L bv
��@�� B�=����[:KM:k�t�y��k{��ݶ�Zٗ����Ͻ�!n�l�]��Y��m�K�61�I����M<t �&�oO]B��瞎yM}�A���� ^[�z�s_ck��qtvuE^�o�H���n�3q�Ƽ�wn�3n��<��ݘgփ�lztc�AO=-�Jz�A��^z���ī��������q�z���������?PK K��\��g*� P xl/_rels/workbook.xml.rels � (� ��An� E�����;v'�n�Ms�1���9[=R�P�J-���&+4�鍆�����m���0Y�Ѳ���v����STw
�m7{�!�AO.��Ą���cAj\ ֡Ie�1�~d�Fd�����z�$�����R��G+O����Z1Rr ?b��O��(�D��i��^��}]���h���fj!�g�^�u&Û��U -/[��me4x��O�Ν�8S��.�����/PK K��\Ѓc'2 E
xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK K��\���I � xl/sharedStrings.xml � (� ���N�0E%�>M��JR�E�.H-l�7���п�l�Z��=��w쩖_J&G�(���x��43�Ї�����������h�� �$˦BtI(�X��6ː��(�� :n��.�!���pJfE��3E�& 3^����k��a�+�T�y5>4�U�*���dl�ACwɟ��/յ��[QI5�K���t/aF�:�z��V���`���R���f�'�ݕK�Y*D~4]�wK%l� ���������\�8�BGvH� !l�
ˑ��g��(�f8�5Z���_тOX�.`��)-&iY Oa�����i����BdaO�oPK- K��\�k=�� 5 xl/workbook.xmlPK- K��\���� � � [Content_Types].xmlPK-
K��\h���' ' U _rels/.relsPK- K��\�0٫� � � xl/worksheets/sheet1.xmlPK- K��\��g*� P � xl/_rels/workbook.xml.relsPK- K��\Ѓc'2 E
� xl/styles.xmlPK- K��\���I � _ xl/sharedStrings.xmlPK � �