GET api/campaign/calendar
Get campaigns as calendar events
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Start | date |
None. |
|
| End | date |
None. |
|
| Stores | Collection of integer |
None. |
|
| IncludePriceChange | boolean |
None. |
|
| IncludeComboDeals | boolean |
None. |
|
| IncludeSellingRules | boolean |
None. |
|
| IncludePools | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
List of events for period
Collection of CalendarEvent| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | Object |
None. |
|
| Title | string |
None. |
|
| Start | date |
None. |
|
| End | date |
None. |
|
| Url | string |
None. |
|
| AllDay | boolean |
None. |
|
| Color | string |
None. |
|
| BackgroundColor | string |
None. |
|
| BorderColor | string |
None. |
|
| TextColor | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"id": {
"$id": "2"
},
"title": "sample string 2",
"start": "2026-06-03T18:33:18.6338253",
"end": "2026-06-03T18:33:18.6338253",
"url": "sample string 5",
"allDay": true,
"color": "sample string 6",
"backgroundColor": "sample string 7",
"borderColor": "sample string 8",
"textColor": "sample string 9"
},
{
"$ref": "1"
}
]
application/xml, text/xml
Sample:
<ArrayOfCalendarEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.Common">
<CalendarEvent>
<AllDay>true</AllDay>
<BackgroundColor>sample string 7</BackgroundColor>
<BorderColor>sample string 8</BorderColor>
<Color>sample string 6</Color>
<End>2026-06-03T18:33:18.6338253+00:00</End>
<ID />
<Start>2026-06-03T18:33:18.6338253+00:00</Start>
<TextColor>sample string 9</TextColor>
<Title>sample string 2</Title>
<Url>sample string 5</Url>
</CalendarEvent>
<CalendarEvent>
<AllDay>true</AllDay>
<BackgroundColor>sample string 7</BackgroundColor>
<BorderColor>sample string 8</BorderColor>
<Color>sample string 6</Color>
<End>2026-06-03T18:33:18.6338253+00:00</End>
<ID />
<Start>2026-06-03T18:33:18.6338253+00:00</Start>
<TextColor>sample string 9</TextColor>
<Title>sample string 2</Title>
<Url>sample string 5</Url>
</CalendarEvent>
</ArrayOfCalendarEvent>
text/csv
Sample:
Sample not available.
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK )��\{yv� 5 xl/workbook.xml � (� ����0��&�C���� 8q����Ji�?ik��-%�x�3;��Գq��1/�Q���k������
��X�q7� D����3�[��e�9� H��(��+���A�1�iE)����!���.q�IFc�����!���l�H�hP��P���hhN��dn��e)�
���wXͶ��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
)��\��b�' ' _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="R093808a1ebde40ce" /></Relationships>PK )��\:��, Z xl/worksheets/sheet1.xml � (� ��A��0��
�{!$�Av�UW=uzh��0+�I���o��Jȸ���~_x����:�Eú)�]��l���e�-/Yzd�]ԔJG�)���M<O5ms���\�x�Ku�7����3V�[�IAH<N��T�D��8W{���q��z ��\�͛di٨��;�VS��O�8^�j�wC��f���/c溜U9P��^��?�S�*�o�/v\�fSK%)ԙ�m��t��8m����M)k5
\���$@E�)�B��O?�Y�G}�������}_�ȍ� ��@���~>������χO���yr�'�@������ɾq���y� "�B�n;��O�|�d~���ԧu��<K9;:\O���ѫ
}�ձ��r�`�Nٞ�>&�!�cL�!1xH��D0$c"oc��嘈��jL�Cb=&��)���j���-����v�7���FĐ5{�[۷� ���Y��҂;�� ��-Hd�������-��?��qtnil�� �b�� �b�� ���S��2��$���t����PK )��\o[֔� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8I�TM�a�m�{GM��v)=�����ĂMW��==i���c�}�J>�ζPd90�ҩ�v-��~X�v��Ӏ1M�O��Z01N+44b��D6u��#Ɣ��O(��/�\p?g�-�.����%=9y��?����1�쀾���O)�k(�D�S-�(�F��
+%*`�nj!^
�^��LF�K��u]c� �UƠ'�}���i^��-ʦx)�R?
U�R]���_l� 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 )��\��ۺ� l xl/sharedStrings.xml � (� }��N�0F_%�=M����H\q��Bc�@~���� B�N��9�>;N�=y'>��P��,�B�
m)����F
b�v1@)G )�UA�"�*e���*EM^S{ɼF�S���A� �;�����)�8N�)d�c��/H�*�z���B}W?���`
����!�):���;��z��]t��^7�-��y� �U5���8����7hf����t L��e}5��a�N�[���zYo��͟V�T_PK- )��\{yv� 5 xl/workbook.xmlPK- )��\���� � � [Content_Types].xmlPK-
)��\��b�' ' U _rels/.relsPK- )��\:��, Z � xl/worksheets/sheet1.xmlPK- )��\o[֔� P ? xl/_rels/workbook.xml.relsPK- )��\Ѓc'2 E
� xl/styles.xmlPK- )��\��ۺ� l � xl/sharedStrings.xmlPK � D
application/vnd.ms-excel
Sample:
PK )��\ /�� 5 xl/workbook.xml � (� ����0��&�C���)��x��?�4�.ik���'�x�3;���}';��/i�P0TV��]�ފ8I�b�4FA��m�Ev9�3�Ѡ�]i����A��Dۯ(+����@��=
�a���՝M���M��_,�8a������Ź�&���L���d�<���:I�����a�m��/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="R16f1b0d1949e4f57" /></Relationships>PK )��\:��, Z xl/worksheets/sheet1.xml � (� ��A��0��
�{!$�Av�UW=uzh��0+�I���o��Jȸ���~_x����:�Eú)�]��l���e�-/Yzd�]ԔJG�)���M<O5ms���\�x�Ku�7����3V�[�IAH<N��T�D��8W{���q��z ��\�͛di٨��;�VS��O�8^�j�wC��f���/c溜U9P��^��?�S�*�o�/v\�fSK%)ԙ�m��t��8m����M)k5
\���$@E�)�B��O?�Y�G}�������}_�ȍ� ��@���~>������χO���yr�'�@������ɾq���y� "�B�n;��O�|�d~���ԧu��<K9;:\O���ѫ
}�ձ��r�`�Nٞ�>&�!�cL�!1xH��D0$c"oc��嘈��jL�Cb=&��)���j���-����v�7���FĐ5{�[۷� ���Y��҂;�� ��-Hd�������-��?��qtnil�� �b�� �b�� ���S��2��$���t����PK )��\��� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;q�@*�n�R.��8�H��6�����W�E��H]t�j4��'�|���o�H����lUQA+�l��)�l7�=�<��`�9��bC&����
N<nF�:���ǔ���\y��.ˆ���Lr�����z����iB� �W�� F �{������HT ;��~��E[ &����-z7�/#�_��<�i��R�Z�Z2��]e��^�O�Ν�r�&���Jsd��W5z��/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 )��\��ۺ� l xl/sharedStrings.xml � (� }��N�0F_%�=M����H\q��Bc�@~���� B�N��9�>;N�=y'>��P��,�B�
m)����F
b�v1@)G )�UA�"�*e���*EM^S{ɼF�S���A� �;�����)�8N�)d�c��/H�*�z���B}W?���`
����!�):���;��z��]t��^7�-��y� �U5���8����7hf����t L��e}5��a�N�[���zYo��͟V�T_PK- )��\ /�� 5 xl/workbook.xmlPK- )��\���� � [Content_Types].xmlPK-
)��\�+�'' ' V _rels/.relsPK- )��\:��, Z � xl/worksheets/sheet1.xmlPK- )��\��� P @ xl/_rels/workbook.xml.relsPK- )��\Ѓc'2 E
� xl/styles.xmlPK- )��\��ۺ� l � xl/sharedStrings.xmlPK � C