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": "/ltVHBrB0Eq7vAZJxGSHvw==", "idempotentGuid": "1c555bfe-c11a-4ad0-bbbc-0649c46487bf", "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>1c555bfe-c11a-4ad0-bbbc-0649c46487bf</IdempotentGuid> <IdempotentID>/ltVHBrB0Eq7vAZJxGSHvw==</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": "UqPmaoIUl0C9nqq9t9WTgQ==", "idempotentGuid": "6ae6a352-1482-4097-bd9e-aabdb7d59381", "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>6ae6a352-1482-4097-bd9e-aabdb7d59381</IdempotentGuid> <IdempotentID>UqPmaoIUl0C9nqq9t9WTgQ==</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 �[�;�{� 5 xl/workbook.xml � (� ����0D�&�C���#)��x��})�m�-ik��-H�yۙ�};|��o���G���2��`���Ɏh⮳NC�ҽ��:%����vN��9 (k�T��+��B�%b�ÊҠ��B���p��Vw6 [C�7��~�(b@cIk@���ے���B��ш�& ͲK�dx�ѝ��8�~W_PK �[���� � [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 �[6�͆' ' _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="Raa702fe747ea42e8" /></Relationships>PK �[���� � xl/worksheets/sheet1.xml � (� ��]s�0�� ��B�ȇ�v�Zk?gg/v�Y������o@���h��''�=A�7_���ˢLU>�a |O�K�J��ܿ����,)�g�?�z; �r��,.�����U���<�Z�ӥ���.�� 4,�&�f�2I�����\嶐�.!�Seq����*5٫�B�'�-�#������Ci���$����V�l���?o%��n���B��6M�j�Rm����Ҫu���_��!]�ĬH�"@ $�r�LU�]�U�� ����ѣ��B1 A$��q��g� E�u���n�����E�\�G�>���"��@ ��i��= �@ � �C��F���ܼ��˾4 !(e�⁺E�g=B���E�����i`��82M�܌Fb�x9k梀"�i���4tК:PN0�Q3x �i��e� DX �iu�����{�NjW��Y���P���&o��5˲��準�%���q��� q�%`����M̺n]���y����c��mb�%X�x��M<w �&^z:�4��q��փ8m}�A.} ��g���q�9��;!=V��1�ęsr>�1Ǹ�s,{�c�Y;���d���{Z��҃8��� N�o=�S�{"C�'��]s��,�;~��1�PK �[h�/� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞ئ����tö��=��&vd����G� XE�Tb�������4����M#9���-�A+�l��)����G�D0�HZ����Di�'27�M��$bJ}Og!��G��XI���Lr�����z��s�4������`#���=�~J�^�ȳja�ɲ�����c9V z7�/#�_��|)S2.�f�:�uuW#<���ӥ�N��B�� ��n����WW5z��/PK �[Ѓ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 �[���JI � xl/sharedStrings.xml � (� ���N�0E%�>M�nQ�*-u�@ja�XL�icɏ�q �{� R�"����=cM��V2:�%atΆ��E�kÅ>��u�/XD4i4��ĢU��ȷj�Y�\{�$T7���E���X��1��"pj���(Mg��YT�N���|j��g��߂�E�7���m��"K.��2�D⨑����Q���E�� A�ا� ��J�Ώ��o,Rcd Ju��-��*g�v��uX��߸TC啟|w q�=��'�5������A��� ��T+�o��� o��Ӕ3�ɡ���?�p8��t'�Q<I���K�*^��t9^�+���i�PK- �[�;�{� 5 xl/workbook.xmlPK- �[���� � � [Content_Types].xmlPK- �[6�͆' ' U _rels/.relsPK- �[���� � � xl/worksheets/sheet1.xmlPK- �[h�/� P � xl/_rels/workbook.xml.relsPK- �[Ѓc'2 E � xl/styles.xmlPK- �[���JI � ^ xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK �[���� 5 xl/workbook.xml � (� ����0��&�C��H QR8q���{-�4П�5���H�yۙ��v�l��4fD5i_�!؊/Pܟ�w�q��(���Z#� t y����ă4��z���ay�w~ jZQ�K���!�4{H�}����.&"k���X��I!�Ը�c��[W�3F��q���J�x��.�,:��w#���PK �[���� � [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 �[:�' ' _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="Rf16d18c4b0954213" /></Relationships>PK �[���� � xl/worksheets/sheet1.xml � (� ��]s�0�� ��B�ȇ�v�Zk?gg/v�Y������o@���h��''�=A�7_���ˢLU>�a |O�K�J��ܿ����,)�g�?�z; �r��,.�����U���<�Z�ӥ���.�� 4,�&�f�2I�����\嶐�.!�Seq����*5٫�B�'�-�#������Ci���$����V�l���?o%��n���B��6M�j�Rm����Ҫu���_��!]�ĬH�"@ $�r�LU�]�U�� ����ѣ��B1 A$��q��g� E�u���n�����E�\�G�>���"��@ ��i��= �@ � �C��F���ܼ��˾4 !(e�⁺E�g=B���E�����i`��82M�܌Fb�x9k梀"�i���4tК:PN0�Q3x �i��e� DX �iu�����{�NjW��Y���P���&o��5˲��準�%���q��� q�%`����M̺n]���y����c��mb�%X�x��M<w �&^z:�4��q��փ8m}�A.} ��g���q�9��;!=V��1�ęsr>�1Ǹ�s,{�c�Y;���d���{Z��҃8��� N�o=�S�{"C�'��]s��,�;~��1�PK �[N���� P xl/_rels/workbook.xml.rels � (� ��An� E��f_�8�5U�l��6�0Ɗ ��9[=R�P�J-���&+4��i������m���0:���(���N�v���]��f����F0�HzbC&��� �"nA�:��Y�T��.Bŀ�*ˆ���Lr8/���z����iF� �W�� F ���D�^�U��@�T��q�d_լlYS+ �fj!�'�^�u&��9�%Wl-+���2FxT�ѧM�Ny��Um_]�O[s��ѫ��PK �[Ѓ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 �[���JI � xl/sharedStrings.xml � (� ���N�0E%�>M�nQ�*-u�@ja�XL�icɏ�q �{� R�"����=cM��V2:�%atΆ��E�kÅ>��u�/XD4i4��ĢU��ȷj�Y�\{�$T7���E���X��1��"pj���(Mg��YT�N���|j��g��߂�E�7���m��"K.��2�D⨑����Q���E�� A�ا� ��J�Ώ��o,Rcd Ju��-��*g�v��uX��߸TC啟|w q�=��'�5������A��� ��T+�o��� o��Ӕ3�ɡ���?�p8��t'�Q<I���K�*^��t9^�+���i�PK- �[���� 5 xl/workbook.xmlPK- �[���� � [Content_Types].xmlPK- �[:�' ' V _rels/.relsPK- �[���� � � xl/worksheets/sheet1.xmlPK- �[N���� P � xl/_rels/workbook.xml.relsPK- �[Ѓc'2 E � xl/styles.xmlPK- �[���JI � b xl/sharedStrings.xmlPK � �