Sign in
WAREHOUSE_SCHEDULE

List Series

List recurring series, optionally filtered by warehouse / instance.

get/warehouse/schedules/series

Query parameters

warehouse_namestring nullable
instance_idstring nullable

Headers

x-tenantstring required

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 1 of the 28 revisions of this API.2

  • 103580dad8162See the full diff
    • ●

      added the new active enum value to the items/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new cancelled enum value to the items/status response property for the response status 200

      response-property-enum-value-added