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-04-03T06:26:08.8267743",
"end": "2026-04-03T06:26:08.8267743",
"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-04-03T06:26:08.8267743+00:00</End>
<ID />
<Start>2026-04-03T06:26:08.8267743+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-04-03T06:26:08.8267743+00:00</End>
<ID />
<Start>2026-04-03T06:26:08.8267743+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 D3�\�4
�� 5 xl/workbook.xml � (� ����0��&�C����B
'.^=x�e�
�'m
>��7o;���������KWa�- �\�b�`,��S,D�^�t����V�I�ǜ8X�F{!�����X�@PÂRLj\�wѩ�C��g���d"���o�ΰ�bVH3nX`�έ�� #W�8�/ �s��5��,�����(Y�_PK D3�\���� � [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
D3�\)�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="R866bee7da5834d67" /></Relationships>PK D3�\�F�f+ Z xl/worksheets/sheet1.xml � (� ��K��0F�
��@�XHW�����f1�f �B�$j�� ��m��P9߽�$���g����S��X��iQ��)؋�G^��H����[>aSP ��8�+�dܦ;�ʹ��&�mZ�uNf4�7��0t�fB��U���T�Z|�HV�%4�S�&�[�&E-�w��)��՝�=`9i��?59����?J?��U1P��^�濘U�2�o�oz\�zS ))P��n�����S�&�T�Ǻ��6�]�
0�Q�"`�{.h�>W9�Q�G��(�>t}�q���>�]�Ȏ�8!B8������d>������|x�c��a������ɾq������1
c7���m|?��<~���~��s:���2�� �G��iY���!Wg\[.,�&Ρ���ۘp���1���lLxCb>&�!���x�X��hH��D<$�c_G
�XFW�h�P�l@t�gD� ]7���"k:g��sCcm�D��n@�
\mWD�µ������k�D��=��qtnh��7 ���7 ���7 ���Sɗ2aJa�t����PK D3�\R�l� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞� vҢ�ݰa[z��Q;�]�gc���V���X��j4��'�|�lvo�D^Ї��ʂA�\?ڡ�S�w+�m7{�dL��K iņL���A�e(܂6u��)�]�:�i�XM}k&9���i=*|t�4������`#����~J�^BY$*����}S)�_�5_՚!�Л��x�0�z}癌*+l��U�u���2Fz쟣O�Ν�r�&���uø*%�*vQ�W��PK D3�\Ѓ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 D3�\��ۺ� 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- D3�\�4
�� 5 xl/workbook.xmlPK- D3�\���� � [Content_Types].xmlPK-
D3�\)�f' ' V _rels/.relsPK- D3�\�F�f+ Z � xl/worksheets/sheet1.xmlPK- D3�\R�l� P ? xl/_rels/workbook.xml.relsPK- D3�\Ѓc'2 E
� xl/styles.xmlPK- D3�\��ۺ� l � xl/sharedStrings.xmlPK � D
application/vnd.ms-excel
Sample:
PK D3�\��n�� 5 xl/workbook.xml � (� ����0��&�C�p)Q4�p��Ճ�i�-ik���'�x�3;���Ѻ���c�����!)��Z��Ov 3��4�I�ئQ�zk2�(J�Q�AY�[5x���a��־%
�_Q��������=�~���՝Mk~Sr���b5e����-νθ�̥j(nuR^�빤���&a��PK D3�\���� � [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
D3�\�XȤ' ' _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="R20f651bc064247cf" /></Relationships>PK D3�\�F�f+ Z xl/worksheets/sheet1.xml � (� ��K��0F�
��@�XHW�����f1�f �B�$j�� ��m��P9߽�$���g����S��X��iQ��)؋�G^��H����[>aSP ��8�+�dܦ;�ʹ��&�mZ�uNf4�7��0t�fB��U���T�Z|�HV�%4�S�&�[�&E-�w��)��՝�=`9i��?59����?J?��U1P��^�濘U�2�o�oz\�zS ))P��n�����S�&�T�Ǻ��6�]�
0�Q�"`�{.h�>W9�Q�G��(�>t}�q���>�]�Ȏ�8!B8������d>������|x�c��a������ɾq������1
c7���m|?��<~���~��s:���2�� �G��iY���!Wg\[.,�&Ρ���ۘp���1���lLxCb>&�!���x�X��hH��D<$�c_G
�XFW�h�P�l@t�gD� ]7���"k:g��sCcm�D��n@�
\mWD�µ������k�D��=��qtnh��7 ���7 ���7 ���Sɗ2aJa�t����PK D3�\=�}�� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;q�*6�R.���8"�#۴�l]�H�B�"�����h~OO����Zo?������-TE �tj�}�����ݬ�8��&��@Ҋ
-��gJ�48�P�m�h�'S�{:y=Һ,�s�3��<��N�A���ӄ6�����A�@��[���
U��@^T{Q-U�-tUV�uX�S�<b�y]�L���RJ�����x���k��ҹS^���J4��%CD&������PK D3�\Ѓ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 D3�\��ۺ� 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- D3�\��n�� 5 xl/workbook.xmlPK- D3�\���� � [Content_Types].xmlPK-
D3�\�XȤ' ' V _rels/.relsPK- D3�\�F�f+ Z � xl/worksheets/sheet1.xmlPK- D3�\=�}�� P ? xl/_rels/workbook.xml.relsPK- D3�\Ѓc'2 E
� xl/styles.xmlPK- D3�\��ۺ� l � xl/sharedStrings.xmlPK � B