v5

latestOpenAPI 3.1.02026-08-081,0211,3082.1 MB

WAREHOUSE_SCHEDULE

Preview Series

Dry-run a recurring-series spec against existing schedules.

Returns how many occurrences the spec would materialize and which would be skipped as conflicts — creating nothing. Backs the create form's live conflict warning, so it is called on every form edit; the check runs one range query over the whole horizon rather than one per occurrence.

post/warehouse/schedules/series/preview

Headers

x-tenantstring required

Request body

warehouse_namestring required

instance_idstring required

schedule_type'manual' | 'block' required

One of: manual, block

days_of_weekstring[] required

start_time_localstring required

Local wall-clock "HH:MM"

duration_minutesinteger required

timezonestring required

IANA timezone, e.g. America/Los_Angeles

end_datestring date required

Required; at most 90 days from today

start_datestring date nullable

Anchor date (local calendar date in timezone) — always materializes an occurrence at create time, regardless of days_of_week. Not persisted; the occurrence set is fully materialized up front.

Response

Successful Response

total_occurrencesinteger required

conflict_countinteger required