WAREHOUSE_SCHEDULE

Cancel Series

Changed on

Cancel a series and soft-reject its future, not-yet-started occurrences.

Active and past occurrences are left untouched.

post/warehouse/schedules/series/{series_id}/cancel

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/{series_id}/cancel
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

series_idinteger required

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

  • a1870d258a3aRevision changes
    • info

      added the optional property / to the response with the status

  • 103580dad816Revision changes
    • warning

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

    • warning

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