WAREHOUSE_SCHEDULE

Preview Series

Changed on

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

Request

  • Base URL: https://api.myaltimate.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.myaltimate.com/warehouse/schedules/series/preview
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

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

Changes

  • a1870d258a3aRevision changes
    • info

      added the new optional request property //

  • 103580dad816Revision changes
    • info

      added the optional property // to the response with the status