Sign in
WAREHOUSE_SCHEDULE

Create Series

Create a recurring schedule series and materialize its occurrences.

The configuration is resolved the same way a one-off schedule's is (caller size or warehouse default, plus any QAS override, and the requested-axes marker), so occurrences conflict-check against existing schedules on the same axes they touch. Occurrences whose windows conflict are reported in skipped — they never fail the series.

post/warehouse/schedules/series

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

series_idinteger required
warehouse_namestring required
instance_idstring nullable
schedule_type'manual' | 'block' required
days_of_weekstring[] required
start_time_localstring required
duration_minutesinteger required
timezonestring required
end_datestring date nullable
status'active' | 'cancelled' required

Lifecycle of a recurring warehouse-schedule series.

A series that would materialize zero occurrences is never persisted (creation fails with 400), so there is no rejected state here.

created_byinteger required
created_atstring date-time nullable
updated_atstring date-time nullable

Changes

Changed in 2 of the 28 revisions of this API.22

  • 6aa0788aa5dc1See the full diff
    • ○

      added the optional property created/items/series_timezone to the response with the 201 status

      response-optional-property-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 103580dad81621See the full diff
    • ●

      added the new active enum value to the status response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new cancelled enum value to the status response property for the response status 201

      response-property-enum-value-added

    • ○

      added the optional property skipped/items/conflict to the response with the 201 status

      response-optional-property-added