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
AccrueLoyaltyPointsName | 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": "zRh5ujjDM0mZfRqRzVC57g==", "idempotentGuid": "ba7918cd-c338-4933-997d-1a91cd50b9ee", "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>ba7918cd-c338-4933-997d-1a91cd50b9ee</IdempotentGuid> <IdempotentID>zRh5ujjDM0mZfRqRzVC57g==</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
AccrueLoyaltyPointsName | 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": "aDeRBFIXtk6wvJeM76faZQ==", "idempotentGuid": "04913768-1752-4eb6-b0bc-978cefa7da65", "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>04913768-1752-4eb6-b0bc-978cefa7da65</IdempotentGuid> <IdempotentID>aDeRBFIXtk6wvJeM76faZQ==</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 7 E[:�6� 5 xl/workbook.xml � (� ���� ��M��(j�?=y鵇�Q�B0@c��Ѥ��vfg�:Y����KWa�X�; ����ĝ�N��{+�꠱�[� $K�3q0����R���X~t��� A+J3ep}< D�fO�_d4�����"�)����E!�4T�a�a�8w^�#W�8<x��▶�h��z����a�l��/PK 7 E[���� � [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 7 E[��F' ' _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="Rb0947206aeaa4651" /></Relationships>PK 7 E[Eo�� � xl/worksheets/sheet1.xml � (� ���r�@�_��~aN��RSI�9���b���1Pƚ����Q�������4�w�㫯b|JmrUNB�0��B-��}n��^M�;�?L&eX�4#= ��ڌ��,2Y�&RY��J�"��~��j�/�L-��,�@c-�ieoe�|c�C���2-�e]B�>�*Ҽ��en���\M�k8zCaO�5�;�;㜃���U�c�f�<�o�SK�J����=��=�l��Z�PkSE�o]�W��˗UfO$b A9g����T��ӄ�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��b�9�I��@�� B�=����[:K�t:�j�:l��O��h�ݶ�j�K�s ���^�7]���.��ĬK�6q�%H��w��M�w �&�k�]����.!��sOǼ��� ^W_{��o=ȹ��5��8:;��"��7G���[7�8sc^�;7�7wc�e�n�3���y6=�1Ϡ��x%=� ^e/=�W�k���փ��������K=W��������?PK 7 E[R'^� P xl/_rels/workbook.xml.rels � (� ��Kn� ���f_��N'�n�Mscc�HӜ���W(J�֑��&+4���O3|�lvo�H^����҄A#�L��9tO 춛�<�^�'��-��5�^j��O�&v:�&b�z:sy�=Ҍ���%��x��?D�u��g+����^�;y����1��yz;�$R��UU��\���+�:B���uD���]/d��X-�TyYȒ=TFs��%����2^�IԍJ� s��75z�/�_PK 7 E[Ѓ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 7 E[�^l�K � xl/sharedStrings.xml � (� ���N�0�_%�=MZڤ�$UZ����qp�Mc�?�������E=�wg��b��dt���L')�@3Å>��u�/I��jN��P� �VU��"_��$�s�]� �@Q���'���:��{�c�Lfi�%� M"f�J2��l~o!��Uof�m���H�҅�5�8h�c�b�v8V7���ݚJ��i}�B�F�Ώt�w�32 �:��`74�R��f����%�� �G~2<Ȼ���Cъ�<Q�qo��f��\��V �!U�� �/G4�����4���d}r��1���vz�g�x�/f��,n҆ŷ��AKsN�E�M!���PK- 7 E[:�6� 5 xl/workbook.xmlPK- 7 E[���� � [Content_Types].xmlPK- 7 E[��F' ' V _rels/.relsPK- 7 E[Eo�� � � xl/worksheets/sheet1.xmlPK- 7 E[R'^� P � xl/_rels/workbook.xml.relsPK- 7 E[Ѓc'2 E � xl/styles.xmlPK- 7 E[�^l�K � a xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK 7 E[sg� 5 xl/workbook.xml � (� ����0D�&�C����N\�z��VhK��|�o�vfg����kcz�Q�v�-h���3���Q�;a�?K�bF�`e��B�YE)�8��F�N����Xn����V��iy<fO��r6���I�b�)`�EPD�V����ۂ�)����Gr�/I��$��Z���;���w�PK 7 E[���� � [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 7 E[{vT^' ' _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="Rc6d3e7b6dc024076" /></Relationships>PK 7 E[Eo�� � xl/worksheets/sheet1.xml � (� ���r�@�_��~aN��RSI�9���b���1Pƚ����Q�������4�w�㫯b|JmrUNB�0��B-��}n��^M�;�?L&eX�4#= ��ڌ��,2Y�&RY��J�"��~��j�/�L-��,�@c-�ieoe�|c�C���2-�e]B�>�*Ҽ��en���\M�k8zCaO�5�;�;㜃���U�c�f�<�o�SK�J����=��=�l��Z�PkSE�o]�W��˗UfO$b A9g����T��ӄ�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��b�9�I��@�� B�=����[:K�t:�j�:l��O��h�ݶ�j�K�s ���^�7]���.��ĬK�6q�%H��w��M�w �&�k�]����.!��sOǼ��� ^W_{��o=ȹ��5��8:;��"��7G���[7�8sc^�;7�7wc�e�n�3���y6=�1Ϡ��x%=� ^e/=�W�k���փ��������K=W��������?PK 7 E[�o�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8M줩�vÆm�gGM��v���G� XE�Tb�������4����ݿM#yAg��Z����Q?�a��p�1M3́��� �A�d�܌6u��)�=��:�i���K�2��2��N�A�S� m�L_�?����1 �)z �,Q�<u�)J�j�+Y����л��x1�z}���D��]s���2Fz잣O�^:-�K�����s� ͪR_���_� PK 7 E[Ѓ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 7 E[�^l�K � xl/sharedStrings.xml � (� ���N�0�_%�=MZڤ�$UZ����qp�Mc�?�������E=�wg��b��dt���L')�@3Å>��u�/I��jN��P� �VU��"_��$�s�]� �@Q���'���:��{�c�Lfi�%� M"f�J2��l~o!��Uof�m���H�҅�5�8h�c�b�v8V7���ݚJ��i}�B�F�Ώt�w�32 �:��`74�R��f����%�� �G~2<Ȼ���Cъ�<Q�qo��f��\��V �!U�� �/G4�����4���d}r��1���vz�g�x�/f��,n҆ŷ��AKsN�E�M!���PK- 7 E[sg� 5 xl/workbook.xmlPK- 7 E[���� � [Content_Types].xmlPK- 7 E[{vT^' ' V _rels/.relsPK- 7 E[Eo�� � � xl/worksheets/sheet1.xmlPK- 7 E[�o�� P � xl/_rels/workbook.xml.relsPK- 7 E[Ѓc'2 E � xl/styles.xmlPK- 7 E[�^l�K � a xl/sharedStrings.xmlPK � �