Skip to main content

Blackout period requirements

Blackout periods allow retailers to temporarily disable product availability for a specific interval of time, for example, when the deli is closed.

ColumnData TypeDescriptionExample
blackout_timesJSONThe periods when a product is unavailable.See Example.

JSON data

Field DefinitionsRequiredTypeDescriptionExample
weekdayYesstringThe day the blackout is in effect. Possible values:
monday
tuesday
wednesday
thursday
friday
saturday
sunday
monday
start_hourYestimestampThe blackout start time. Timestamps are inclusive.119:00:00:00+0000
end_hourYestimestampThe blackout end time. Timestamps are inclusive.124:00:00:00+0000+0000
start_dateYesdate (no timestamp)The date the blackout period begins, in the format MM/DD/YYYY.02/01/2019
end_dateNodate (no timestamp)The date the blackout rule ends, in the format MM/DD/YYYY.02/28/2019

Footnotes

  1. Time zone must be in local time (not UTC). The period must be within store hours. For example, if a store's operating hours are 7AM - 5PM, the blackout period could be 7AM - 10AM, but not 12AM - 10AM. 2

Before you send your files, consider using a JSON validator.

Example

note

When you include a JSON object in a CSV file, you must use double quotes.

In this example, a deli item is unavailable for purchase between 6 AM to 10 AM, and 9 PM to midnight.

"[
{
""weekday"":""Monday"",
""start_hour"":""6:00:00:00+0000"",
""end_hour"":""10:00:00:00+0000"",
""start_date"":""02/01/2019"",
""end_date"":""05/31/2019""
},
{
""weekday"":""Monday"",
""start_hour"":""21:00:00:00+0000"",
""end_hour"":""24:00:00:00+0000"",
""start_date"":""02/01/2019"",
""end_date"":""05/31/2019""
},
]"