| Name | Description | Type | Additional information |
|---|---|---|---|
| SpecialEventId |
Special event's id |
integer |
Required |
| SpecialEventName |
Name of special event |
string |
Required Max length: 200 Min length: 1 |
| SpecialEventStartDate |
Start date of the special event. Time offset relative to Coordinated Universal Time is expected to check if the date provided is in the past. Expected Format [mm/dd/yyyy +/- offset]. |
date |
Required |
| SpecialEventEndDate |
End date of the special event. Time offset relative to Coordinated Universal Time is expected to check if the date provided is in the past. Expected Format [mm/dd/yyyy +/- offset]. |
date |
Required |
| SpecialEventPurpose |
Purpose of the special event |
string |
Required Max length: 128 Min length: 1 |
| IsSiteClosed |
Is the site that the special event is happening closed for the whole day. If this is true, SiteOpeningTime and SiteClosingTime fields should not be set, also IsSiteClosedForDelivery should be set to true. |
boolean |
None. |
| SiteOpeningTime |
[Nullable] The opening time of the site. Expected Format [hh:mm AM/PM] or [hh:mm]. |
date |
None. |
| SiteClosingTime |
[Nullable] The closing time of the site. Expected Format [hh:mm AM/PM] or [hh:mm]. |
date |
None. |
| IsSiteClosedForDelivery |
Is the site that the special event is happening closed for delivery for the whole day. If this is set to true, Delivery Periods should not be set. |
boolean |
None. |
| DeliveryPeriod1StartTime |
[Nullable] The start of the first delivery shift. Expected Format [hh:mm AM/PM] or [hh:mm]. |
date |
None. |
| DeliveryPeriod1EndTime |
[Nullable] The end of the first delivery shift. Expected Format [hh:mm AM/PM] or [hh:mm]. |
date |
None. |
| DeliveryPeriod2StartTime |
[Nullable] The start of the second delivery shift. Expected Format [hh:mm AM/PM] or [hh:mm]. |
date |
None. |
| DeliveryPeriod2EndTime |
[Nullable] The end of the second delivery shift. Expected Format [hh:mm AM/PM] or [hh:mm]. |
date |
None. |
| Sites |
The sites where this Special Event is happening |
Collection of integer |
None. |