Run Stops

GET run stops

Get a paginated list of run stops with optional filters.

get/run-stops

Request

  • Base URL: https://api.equipmentshare.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.equipmentshare.com/run-stops
  • Auth: HTTP bearer

Query parameters

run_idinteger

Filter by run ID

location_idinteger

Filter by location ID

run_stop_status_idinteger

Filter by run stop status ID

branch_idinteger

Filter by branch ID (via delivery order)

schedule_datestring date-time

Filter by scheduled date (ISO date string)

scheduled_date_fromstring date-time

Inclusive start of scheduled date range (ISO datetime). With include_overdue=true, optional inclusive lower bound on overdue deliveries. When omitted, server defaults to scheduled_date_to minus 180 days (clamped to the platform cutoff).

scheduled_date_tostring date-time

Inclusive end of scheduled date range (ISO datetime). With include_overdue=true, required exclusive upper bound: deliveries scheduled before this instant are overdue (pass the board day start in branch local time as UTC).

include_overdueboolean

When true, return branch-scoped delivery-backed overdue run stops. Requires branch_id and scheduled_date_to.

unassigned_onlyboolean

When true, return only run stops with no run_id. Intended for dispatch upcoming window calls.

include_deliveriesboolean

Include associated deliveries (default: false)

include_dispatch_delivery_detailsboolean

When include_deliveries=true, return the narrow dispatch-board delivery payload (see RunStopsListDispatchResponseSchema) instead of the standard delivery shape.

include_returnsboolean

When branch_id is provided, also include stops for pending return deliveries (final_return, partial_return, swap_return) with requested or confirmed status for that branch. final_return/swap_return require a post_on_rent rental; partial_return is included even when the rental is still On Rent (bulk partial off-rent). Default: false; has no effect without branch_id.

pageinteger

Page number for pagination (default: 1)

sizeinteger

Page size (default: 50, max: 200)

Response

Changes

No recorded changes to this operation across all 1 revision of this API.