How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

tread.io Orders API

The Orders API from tread.io — 47 operation(s) for orders.

tread.io Orders API is one of 58 APIs that tread.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 54 operations across 47 paths, and defines 91 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.tread-horizon.com.

54 operations 47 paths 91 schemas 3 DELETE20 GET2 PATCH8 POST21 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.tread-horizon.com
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

tread.io Orders API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 54

Across 47 paths, the API surfaces 54 operations — 3 DELETE, 20 GET, 2 PATCH, 8 POST, 21 PUT. Each is listed below with its method, path, parameters, and response codes.

Orders 54
POST
/v1/companies/{company-id}/orders
Create an Order for a Company
post-v1-companies-company-id-orders 2 params body → 201400401403404406415422
GET
/v1/companies/{company-id}/orders
Retrieve Orders that belong to a Company
get-v1-companies-company-id-orders 14 params → 200401404406
GET
/v1/companies/{company-id}/orders/dispatch
Retrieve Orders based on Jobs that belong to a Company
get-v1-companies-company-id-orders-dispatch 40 params → 200400401404406422
GET
/v1/companies/{company-id}/orders/dispatch_numbers/faceted_search
Search Dispatch Numbers based on the current Dispatch results
get-v1-companies-company-id-orders-dispatch_numbers-faceted_search 22 params → 200401404406422
GET
/v1/companies/{company-id}/orders/dispatch_numbers/typeahead
Typeahead search on Orders' Dispatch Number by Company
get-v1-companies-company-id-orders-dispatch_numbers-typeahead 6 params → 200401404406
POST
/v1/companies/{company-id}/orders/estimate
Generate estimated Order values
post-v1-companies-company-id-orders-estimate 2 params body → 200400401406415422
GET
/v1/companies/{company-id}/orders/invoicing
Retrieve Orders based on Invoices that belong to a Company
get-v1-companies-company-id-orders-invoicing 30 params → 200400401404406422
POST
/v1/companies/{company-id}/orders/simulate_order
Simulate an Order
post-v1-companies-company-id-orders-simulate_order 2 params body → 202400401403404406415422
GET
/v1/companies/{company-id}/orders/typeahead
Typeahead search on Orders by Company
get-v1-companies-company-id-orders-typeahead 6 params → 200401404406
GET
/v1/companies/{company-id}/orders/{id}
Retrieve a single Order for a Company
get-v1-companies-company-id-orders-id 3 params → 200401404406
PATCH
/v1/companies/{company-id}/orders/{id}
Update an Order for a Company
patch-v1-companies-company-id-orders-id 3 params body → 200400401403404406415422
PUT
/v1/companies/{company-id}/orders/{order-id}/accept
Accept an Order for a Company
put-v1-companies-company-id-orders-order-id-accept 3 params body → 200400401403404406409415
PUT
/v1/companies/{company-id}/orders/{order-id}/cancel
Cancel an Order for a Company
put-v1-companies-company-id-orders-order-id-cancel 3 params body → 200400401403404406409415
PUT
/v1/companies/{company-id}/orders/{order-id}/complete
Complete an Order for a Company
put-v1-companies-company-id-orders-order-id-complete 3 params body → 200400401403404406409415
POST
/v1/companies/{company-id}/orders/{order-id}/copy
Copy an Order
post-v1-companies-company-id-orders-order-id-copy 3 params body → 201401403404406415422
GET
/v1/companies/{company-id}/orders/{order-id}/default_sites/{waypoint-type}
Retrieve default sites for an order, given a waypoint type.
get-v1-companies-company-id-orders-order-id-default-sites 7 params → 200401403404406
PUT
/v1/companies/{company-id}/orders/{order-id}/default_sites/{waypoint-type}/{site-id}
Add a site to default site list on order
put-v1-companies-company-id-orders-order-id-default_sites-waypoint-type-site-id 5 params → 200400401403404406422
DELETE
/v1/companies/{company-id}/orders/{order-id}/default_sites/{waypoint-type}/{site-id}
Delete a single site from a default list of an order.
delete-v1-companies-company-id-orders-order-id-default_sites-waypoint-type-site-id 5 params → 204400401403404406
PUT
/v1/companies/{company-id}/orders/{order-id}/driver_sms
Send SMS to a driver of all the Jobs of an Order for a Company
put-v1-companies-company-id-orders-order-id-driver_sms 3 params body → 202400401403404406415422
PUT
/v1/companies/{company-id}/orders/{order-id}/hold
Hold an Order for a Company
put-v1-companies-company-id-orders-order-id-hold 3 params body → 200400401403404406409415
GET
/v1/companies/{company-id}/orders/{order-id}/materials/typeahead
Typeahead search on Materials that belong to Order's Company
get-v1-companies-company-id-orders-order-id-materials-typeahead 7 params → 200401404406
PUT
/v1/companies/{company-id}/orders/{order-id}/reject
Reject an Order for a Company
put-v1-companies-company-id-orders-order-id-reject 3 params body → 200400401403404406409415
PUT
/v1/companies/{company-id}/orders/{order-id}/request
Request an Order for a Company
put-v1-companies-company-id-orders-order-id-request 3 params body → 200400401403404406409415
GET
/v1/companies/{company-id}/orders/{order-id}/sites/typeahead
Typeahead search on Sites that belong to Order's Company
get-v1-companies-company-id-orders-order-id-sites-typeahead 8 params → 200401404406422
PUT
/v1/companies/{company-id}/orders/{order-id}/start
Start an Order for a Company
put-v1-companies-company-id-orders-order-id-start 3 params body → 200400401403404406409415
GET
/v1/companies/{company-id}/orders/{order-id}/tickets
Retrieve Tickets for an Order for a Company
get-v1-companies-company-id-orders-order-id-id-tickets 10 params → 200401404406422
GET
/v1/companies/{company-id}/orders/{order-id}/tickets/rollup_summary
Retrieve Ticket Rollup Summary for an Order for a Company
get-v1-companies-company-id-orders-order-id-id-tickets-rollup-summary 4 params → 200401404406422
PUT
/v1/companies/{company-id}/orders/{order-id}/weather_hold
Weather Hold an Order for a Company
put-v1-companies-company-id-orders-order-id-weather-hold 3 params body → 200400401403404406409415
POST
/v1/ordersdeprecated
Create an Order
post-v1-orders 1 param body → 201400401403404406415422
GET
/v1/ordersdeprecated
Retrieve Orders that belong to the current Company
get-v1-orders 14 params → 200401406
GET
/v1/orders/dispatchdeprecated
Retrieve Orders based on Jobs for the current Company
get-v1-orders-dispatch 35 params → 200400401406422
POST
/v1/orders/estimatedeprecated
Generate estimated Order values
post-v1-orders-estimate 1 param body → 200400401406415422
GET
/v1/orders/{id}deprecated
Retrieve a single Order
get-v1-orders-id 2 params → 200401404406
PATCH
/v1/orders/{id}deprecated
Update an Order
patch-v1-orders-id 2 params body → 200400401403404406415422
PUT
/v1/orders/{order-id}/acceptdeprecated
Accept an Order
put-v1-orders-order-id-accept 2 params body → 200400401403404406409415
PUT
/v1/orders/{order-id}/canceldeprecated
Cancel an Order
put-v1-orders-order-id-cancel 2 params body → 200400401403404406409415
PUT
/v1/orders/{order-id}/completedeprecated
Complete an Order
put-v1-orders-order-id-complete 2 params body → 200400401403404406409415
POST
/v1/orders/{order-id}/copydeprecated
Copy an Order
post-v1-orders-order-id-copy 2 params body → 201401403404406415422
GET
/v1/orders/{order-id}/default_sites/{waypoint-type}deprecated
Retrieve default sites for an order, given a waypoint type.
get-v1-orders-order-id-default-sites 6 params → 200401403404406
PUT
/v1/orders/{order-id}/default_sites/{waypoint-type}/{site-id}deprecated
Add a site to default site list on order
put-v1-orders-order-id-default_sites-waypoint-type-site-id 4 params → 200400401403404406422
DELETE
/v1/orders/{order-id}/default_sites/{waypoint-type}/{site-id}deprecated
Delete a single site from a default list of an order.
delete-v1-orders-order-id-default_sites-waypoint-type-site-id 4 params → 204400401403404406
PUT
/v1/orders/{order-id}/driver_smsdeprecated
Send SMS to a driver of all the Jobs of an Order
put-v1-orders-order-id-driver_sms 2 params body → 202400401403404406415422
PUT
/v1/orders/{order-id}/holddeprecated
Hold an Order
put-v1-orders-order-id-hold 2 params body → 200400401403404406409415
GET
/v1/orders/{order-id}/materials/typeaheaddeprecated
Typeahead search on Materials that belong to Order's Company
get-v1-orders-order-id-materials-typeahead 6 params → 200401404406
PUT
/v1/orders/{order-id}/rejectdeprecated
Reject an Order
put-v1-orders-order-id-reject 2 params body → 200400401403404406409415
PUT
/v1/orders/{order-id}/requestdeprecated
Request an Order
put-v1-orders-order-id-request 2 params body → 200400401403404406409415
GET
/v1/orders/{order-id}/sites/typeaheaddeprecated
Typeahead search on Sites that belong to Order's Company
get-v1-orders-order-id-sites-typeahead 7 params → 200401404406422
PUT
/v1/orders/{order-id}/startdeprecated
Start an Order
put-v1-orders-order-id-start 2 params body → 200400401403404406409415
GET
/v1/orders/{order-id}/ticketsdeprecated
Retrieve Tickets for an Order
get-v1-orders-order-id-id-tickets 9 params → 200401404406422
GET
/v1/orders/{order-id}/tickets/rollup_summarydeprecated
Retrieve Ticket Rollup Summary for an Order
get-v1-orders-order-id-id-tickets-rollup-summary 3 params → 200401404406422
PUT
/v1/orders/{order-id}/weather_holddeprecated
Weather Hold an Order
put-v1-orders-order-id-weather-hold 2 params body → 200400401403404406409415
PUT
/v1/projects/{project-id}/default_sites/{waypoint-type}/{site-id}
Add a site to default site list on order
put-v1-projects-project-id-default_sites-waypoint-type-site-id 4 params → 200400401403404406422
DELETE
/v1/projects/{project-id}/default_sites/{waypoint-type}/{site-id}
Delete a single site from a default list of an order.
delete-v1-projects-project-id-default_sites-waypoint-type-site-id 4 params → 204400401403404406
POST
/v1/route_estimate
Calculate estimated Route time and distance
get-v1-route_estimate 1 param body → 200401406415422

Schemas 91

The contract defines 91 schemas that model the data the API accepts and returns. The most detailed are Order-Create (77 properties), Order-Update (72 properties), OrderSummary-Read-Nested (27 properties), Address-Read (9 properties). Each schema is shown below with its type and property counts.

DeliveredQuantity-Read
object
5 properties 5 required
Foreman-Read-Nested
TicketState
DispatchNumber-Read-Nested
Contact-Update
object
3 properties
EquipmentType-Read-Nested
object
5 properties 5 required
Order-Read-Nested
RateCommission-Read-Nested
Destroyable
object
2 properties
DispatchNumber-Update
object
2 properties
AccountType
ModelError-Response
object
1 property 1 required
Geofence-Data
object
5 properties
Phase-Read
Order-Read-Typeahead
NullableRateType
stringnull
Order-Estimate-Create
object
6 properties 3 required
RateType
TicketStateEvent
Order-Update
object
Notes: - phase has been deprecated in favor of phases where "primary" == true - Only one associated Phase can be the primary
72 properties
OrderStateEvent
Phase-Create
object
3 properties 1 required
TicketRollupSummary-Read
object
7 properties 6 required
RouteEstimate-Create
object
4 properties 4 required
CompanyType
Company Type
Material-Read-Typeahead
OrderUnitOfMeasure
Order-Read
Notes: - phase has been deprecated in favor of phases where "primary" == true
DispatchNumber-Create
object
1 property 1 required
RateTime-Read-Nested
Ticket-Read
UnauthenticatedError-Response
object
1 property 1 required
Phase-Update
Company-Read-Nested
Compact Company model for nested reads.
ServiceClass-Read-Nested
User-Read-Nested
NullableGeofenceType
stringnull
Sms-Create
object
1 property
StateError-Item
GeofenceTag
Contact-Create
object
3 properties
RateFlatRate-Read-Nested
DispatchNumber-Read-Typeahead
Contact-Update-Destroyable
StateError
Material-Read-Nested
object
3 properties 3 required
TicketSource
Address-Read
object
9 properties 9 required
TreadId
object
1 property 1 required
Foreman-Read-Typeahead
ModelError-Item
object
3 properties 3 required
Equipment-Read-Typeahead
Ticket-Read-Nested
Site-Read-Nested
Contact-Read-Nested
Account-Read-Nested
WaypointType
UnauthenticatedError
Identifier
object
1 property 1 required
Equipment-Read-Nested
Discardable
object
1 property 1 required
Waypoint-Read-Nested
NextBillionGeofence-Read
User-Read-Typeahead
StateError-Response
object
1 property 1 required
Order-Copy
object
3 properties
Timestamps
object
2 properties 2 required
Order-Create
object
Notes: - phase has been deprecated in favor of phases where "primary" == true - Only one associated Phase can be the primary
77 properties 6 required
Waypoint-Update-Destroyable
NullableOrderUnitOfMeasure
stringnull
RatePerUnit-Read-Nested
Project-Read-Nested
Project-Read-Typeahead
GeofenceType
Error
object
An Error.
1 property 1 required
SimulateOrder-Create
object
3 properties
Order-Estimate-Read
object
6 properties
Address-Read-Nested
RateFlatCommission-Read-Nested
RouteEstimate-Read
object
2 properties 2 required
Department-Read-Nested
Site-Read-Typeahead
RequestedQuantityType
ModelError
A Model-specific error
OrderSummary-Read-Nested
object
Additional descriptions - materialgrossunitofmeasure: The associated unitofmeasure of the materialgrossdeliveredquantity
27 properties 25 required
Error-Response
object
1 property 1 required
Service-Read-Nested
CompanyShare-Read-Nested
NullableRequestedQuantityType
stringnull
Waypoint-Create
object
4 properties 3 required
OrderState

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

treadio-orders-api-openapi.yml Raw ↑

Other APIs tread.io publishes across the network.

tread.io AccountExternalTruckIdentifier API
tread.io Accounts API
tread.io AddOnCharges API
tread.io AddOns API
tread.io Agave API
tread.io ApprovalAssignments API
tread.io Authentication API
tread.io AutoAddOnAssignments API
tread.io Companies API
tread.io CompanyDayJobStats API
tread.io CompanyShares API
tread.io Compliance API
Where this information came from

This is an independent, third-party profile of tread.io Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.