Getting Started

Integrate with the Routeware SmartCity Public API to manage waste collection operations — including customers, locations, service contracts, jobs, route templates, vehicles, and reporting data.

Prerequisites

Obtain an API key from the SmartCity Portal. This key is required to authenticate all API requests.
Include your API key in the X-Api-Key header with every request:

curl -H "X-Api-Key: YOUR_API_KEY" \
  https://haulerpublic-api.prod.smartcity.routeware.com/api/accesstest/authenticated

Base URLs

Environment	URL
US Production	`https://haulerpublic-api.prod.smartcity.routeware.com`
US Staging 2	`https://haulerpublic-api.qa.smartcity.routeware.com`
US Staging	`https://haulerpublic-api.dev.smartcity.routeware.com`
UK Production	`https://haulerpublic-api.prod.smartcity.routeware.uk`
UK Staging	`https://haulerpublic-api.dev.smartcity.routeware.uk`

Verify your connection

Confirm your API key is valid by calling the access test endpoint:

curl -H "X-Api-Key: YOUR_API_KEY" \
  https://haulerpublic-api.prod.smartcity.routeware.com/api/accesstest/authenticated

A 200 OK response confirms your key is authenticated and you're ready to make API calls.

What you can do

Customers

Create, update, and retrieve customer records and account information.

Locations

Manage customer locations, addresses, and location alerts.

Service Contracts

Set up and manage service contracts including equipment types, waste materials, and pickup schedules.

Jobs

Create, search, and track collection jobs. Assign jobs to routes or leave them unassigned for dispatch.

Route Templates

Configure route templates, manage stops, and assign service contracts to routes.

Vehicles & Telematics

Retrieve vehicle details, trip inspections, fault codes, fuel efficiency, fleet tracking, and real-time vehicle positions.

Reporting

Access route tracker data, route exceptions, percentage completion, snow plow reporting, and disposal summaries.

Options & Lookups

Retrieve reference data such as vehicle types, pickup types, waste types, service types, and scheduler days.

Common response format

All API responses follow a consistent structure:

{
  "payload": { },
  "errors": [],
  "isValid": true
}

Field	Type	Description
`payload`	object or array	The response data. Structure varies by endpoint.
`errors`	array	Contains error details when `isValid` is `false`. Each error includes a `reasonCode` and `reasonDescription`.
`isValid`	boolean	`true` when the request succeeded, `false` when errors occurred.

Pagination

List endpoints support pagination with two query parameters:

Parameter	Type	Default	Description
`page`	integer	`1`	The page number to retrieve.
`limit`	integer	`50`	The number of results per page.

Paginated responses include nextPageUrl, prevPageUrl, total, and lastPage fields to help you navigate through results.

Need help?

Contact the Routeware SmartCity support team at [email protected].