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": "fh/6fAg3C0+LJbnO3YceKw==",
"idempotentGuid": "7cfa1f7e-3708-4f0b-8b25-b9cedd871e2b",
"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>7cfa1f7e-3708-4f0b-8b25-b9cedd871e2b</IdempotentGuid> <IdempotentID>fh/6fAg3C0+LJbnO3YceKw==</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": "EC2VpNmRIU6MhgeJVGa2VQ==",
"idempotentGuid": "a4952d10-91d9-4e21-8c86-07895466b655",
"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>a4952d10-91d9-4e21-8c86-07895466b655</IdempotentGuid> <IdempotentID>EC2VpNmRIU6MhgeJVGa2VQ==</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 +3�\.�̷ 5 xl/workbook.xml � (� ����0D�&�C���H�N\�z��VhK��|o�vfg����kcz�Q�v�-h���3���Q��0V�Ҿ�B6X��P{�DQ�,�Ѯ���+��-B�:D���@jZ���S�����l���o�/��bQD�V��Ź��)���#β�zi��-��Bw��l�]~PK +3�\���� � [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
+3�\Mmm' ' _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="R3747ca248bfb4b97" /></Relationships>PK +3�\-��� � 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�@������a � � 0�d8 $�s0>,^���ԤӱV�@�a�w��Ǫ�m���}I|N�8��k�K�6q�%P��u �&�i�.����.A��C�`m�K�6��%D�x���ԗ���k���9�5�f�Gg�QW����Xy��<gn��y��<��n̳�ލyf=�1ϦG7�������ī��
|�A�:�z�y;��w��J��?���PK +3�\����� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�N+EM�aö���Q۲]�gc���V� �X��j4��'�|�lvo�D^0�ѻxŀ�Ӿ���)��v��'��D�cH���ԁ�9�S���Y��t�c|�U.ihP���5c��%���p��7f����iF�� �W��"f ����^*�Ǿ�=�R�+#j�k� �fj)�'L�^��B%r��Th�h����U��˥�N��B��F��Y��Y��ɋ����PK +3�\Ѓ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 +3�\� ��K � xl/sharedStrings.xml � (� ���N�0E%�>�CMHP�*-u�@*�A,�x�X�#x�B�w�Ը����̽cO���"8�A�UM�ELP�f\j��r$@K�B+�� ���B��+UX����6��@R\��#�6�Zw4�G�� `���8�#I�"A�'ek�:�I�� 6����Me�7=�Ʀ�lSEg�B���9�\Y����PvMU�i{�\н�����2�A���z�ݴ��v�xi�~Qî\�:3�t�5��-s���!G䨭�ۻ����=ק�\yvH�(�m�q�$׳�S{3�Ђ\�O�?�.�,eI� +�%�IXtE�7E�-�|�g��M!"���PK- +3�\.�̷ 5 xl/workbook.xmlPK- +3�\���� � [Content_Types].xmlPK-
+3�\Mmm' ' V _rels/.relsPK- +3�\-��� � � xl/worksheets/sheet1.xmlPK- +3�\����� P � xl/_rels/workbook.xml.relsPK- +3�\Ѓc'2 E
� xl/styles.xmlPK- +3�\� ��K � _ xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK +3�\��� 5 xl/workbook.xml � (� ����0��&�C���h�N\�z��"
�'m
>��o�vfg�>i;<��G�������`�5=JpmP�]���}1�u��Z7o�ʳ,I���^h�za]h���������h����f���2k��$l �����"*�@bIk�@ItnmISJl!�p?� I��Y���B+{�q����PK +3�\���� � [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
+3�\�'/�' ' _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="R9026f59ba624454a" /></Relationships>PK +3�\-��� � 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�@������a � � 0�d8 $�s0>,^���ԤӱV�@�a�w��Ǫ�m���}I|N�8��k�K�6q�%P��u �&�i�.����.A��C�`m�K�6��%D�x���ԗ���k���9�5�f�Gg�QW����Xy��<gn��y��<��n̳�ލyf=�1ϦG7�������ī��
|�A�:�z�y;��w��J��?���PK +3�\�V�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8�$�i7lؖ^`bO>jbG��l,8W�*�6]����������m��9?Z�@����(�G�7p
�]��fO�8�q�,�������W������κCL]�TG��i*�[3����C�]7*z��4� ���uG?`t=�~J�_B�D*�'��^��f�B��$����p���z}�+Jk�m��FQT��2:����K���啚���ʢj��Bɋ����PK +3�\Ѓ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 +3�\� ��K � xl/sharedStrings.xml � (� ���N�0E%�>�CMHP�*-u�@*�A,�x�X�#x�B�w�Ը����̽cO���"8�A�UM�ELP�f\j��r$@K�B+�� ���B��+UX����6��@R\��#�6�Zw4�G�� `���8�#I�"A�'ek�:�I�� 6����Me�7=�Ʀ�lSEg�B���9�\Y����PvMU�i{�\н�����2�A���z�ݴ��v�xi�~Qî\�:3�t�5��-s���!G䨭�ۻ����=ק�\yvH�(�m�q�$׳�S{3�Ђ\�O�?�.�,eI� +�%�IXtE�7E�-�|�g��M!"���PK- +3�\��� 5 xl/workbook.xmlPK- +3�\���� � � [Content_Types].xmlPK-
+3�\�'/�' ' U _rels/.relsPK- +3�\-��� � � xl/worksheets/sheet1.xmlPK- +3�\�V�� P � xl/_rels/workbook.xml.relsPK- +3�\Ѓc'2 E
� xl/styles.xmlPK- +3�\� ��K � _ xl/sharedStrings.xmlPK � �