POST api/customer/{id}/accrueLoyaltyPoints

Perform a Loyalty transaction

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

AccrueLoyaltyPoints
NameDescriptionTypeAdditional 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

Sample:
{
  "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": "rXJYaqYWdU+ok740YhWbog==",
  "idempotentGuid": "6a5872ad-16a6-4f75-a893-be3462159ba2",
  "offline": true
}

application/xml, text/xml

Sample:
<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>6a5872ad-16a6-4f75-a893-be3462159ba2</IdempotentGuid>
  <IdempotentID>rXJYaqYWdU+ok740YhWbog==</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:

Sample not available.

Response Information

Resource Description

AccrueLoyaltyPoints
NameDescriptionTypeAdditional 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

Sample:
{
  "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": "iCfDHG5HrEWD/VW+/ZJNFA==",
  "idempotentGuid": "1cc32788-476e-45ac-83fd-55befd924d14",
  "offline": true
}

application/xml, text/xml

Sample:
<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>1cc32788-476e-45ac-83fd-55befd924d14</IdempotentGuid>
  <IdempotentID>iCfDHG5HrEWD/VW+/ZJNFA==</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

Sample:
PK<�Z��+i�5xl/workbook.xml �(�����0��&�C��H�N\�z��6П�5���H�yۙ��v�`}W[ۑ��M�}Ae�.g,���:4㮵^C�1۶J`e�[��,M��y�!*k�T.Ѕ�+8���u��4(C���>5{*�,Gc�;��-!���3l��1���D�dv�MA���\��Cԙ���
��9����`����/PK<�Z����	�[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
<�Z�tp'''_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="R693f23bb5b2c4812" /></Relationships>PK<�Z"����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�@������a1`�#���| �q!����a��-��&�����ۼ�ӵ=V�n�u��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�H]�����PK<�Z8��Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞�I�j�
�nK/`�q5�#�-�l,8W�*�6]����������m����� �4Ҫ����~h`�Y�q!N�a\<�+�w0��<R�倳�]�Ď�n!�����G�#-��Kp�$�˂�!Z�G�OV�f4�0}����� \������אg�
d�:�˗Jb-
و���B���eB����'2�ך՜5y������ ����S����)��R��e
/���ћ��|PK<�ZЃc'2E
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<�Z��/:K�xl/sharedStrings.xml �(����N�0�_%�=M��m@I�������ڛƒ��)��1��E=�wg��r��dt��芤�)�@3Å>V�e$BG5��h���D��Dt�/�X�ι�6I�u�(NLړ�XE�?�c��ʱpJ&�t�H�D��U$�l~o!��կf�m���L~�Dq������p�nkA�5�T3��D��	;?B�q�Y���4�'�����,e.xi�|R˯\b��|�GÃ�;*a�=�_������o�0����m�ЁR�K��`�rD����M���@M�go�c�26˖E���������<����,�i|�E���i�
PK-<�Z��+i�5xl/workbook.xmlPK-<�Z����	��[Content_Types].xmlPK-
<�Z�tp'''U_rels/.relsPK-<�Z"�����xl/worksheets/sheet1.xmlPK-<�Z8��P�xl/_rels/workbook.xml.relsPK-<�ZЃc'2E
�xl/styles.xmlPK-<�Z��/:K�_	xl/sharedStrings.xmlPK��

application/vnd.ms-excel

Sample:
PK<�Z���5xl/workbook.xml �(�����0D�&�C��h)��x��})[i�-ik��-H�yۙ�};|��o���G���]c��j�';��;i���{1+�X[��hK����5�S��+��B�;Ġ��AZ���S�����l���o�/��bQĀƒ���Ź�%=S�
�G*n��2�������8�~W_PK<�Z����	�[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
<�Z07�''_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="R2c2c80befb2e4617" /></Relationships>PK<�Z"����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�@������a1`�#���| �q!����a��-��&�����ۼ�ӵ=V�n�u��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�H]�����PK<�Zk׬��Pxl/_rels/workbook.xml.rels �(���Mn� F������FN�M7ݦ��ۊ
�!ms�.z�^�(�ZGꢛ��|Oo4|�lvo��^0���UQr�N{3�^�S�w-�m7{� �4��X~�H�!�� �g��t�c}�!�2�"�>B��.˕�K�f��9����Q�ק]�,^}<Ҁ�8;@�1)���U���=���n���Yi�I��㋛�Q:OH�^��B�j@W�,%J+׍����s�y�K�e�Pkۮ^�Z#��\��տ�~PK<�ZЃc'2E
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<�Z��/:K�xl/sharedStrings.xml �(����N�0�_%�=M��m@I�������ڛƒ��)��1��E=�wg��r��dt��芤�)�@3Å>V�e$BG5��h���D��Dt�/�X�ι�6I�u�(NLړ�XE�?�c��ʱpJ&�t�H�D��U$�l~o!��կf�m���L~�Dq������p�nkA�5�T3��D��	;?B�q�Y���4�'�����,e.xi�|R˯\b��|�GÃ�;*a�=�_������o�0����m�ЁR�K��`�rD����M���@M�go�c�26˖E���������<����,�i|�E���i�
PK-<�Z���5xl/workbook.xmlPK-<�Z����	��[Content_Types].xmlPK-
<�Z07�''U_rels/.relsPK-<�Z"�����xl/worksheets/sheet1.xmlPK-<�Zk׬��P�xl/_rels/workbook.xml.relsPK-<�ZЃc'2E
�xl/styles.xmlPK-<�Z��/:K�`	xl/sharedStrings.xmlPK��