Skip to main content
GET
/
v1
/
orders
/
{id}
Retrieve a single Order
curl --request GET \
  --url https://api.tread-horizon.com/v1/orders/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "discarded_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "account_types": [
        "customer"
      ],
      "external_id": "<string>",
      "accounting_id": "<string>",
      "company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "schedule_on": true,
      "billing_address": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "thoroughfare": "<string>",
        "premise": "<string>",
        "locality": "<string>",
        "administrative_area": "<string>",
        "postal_code": "<string>",
        "country": "US",
        "lat": "<string>",
        "lon": "<string>",
        "place_id": "<string>"
      },
      "connected_company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tread_id": "ABC123",
        "legal_name": "<string>",
        "company_type": "hauler"
      },
      "billing_contact": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "email": "<string>",
        "phone": "+18885551234"
      }
    },
    "job_time": 123,
    "equipment_type": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "system": true,
      "external_id": "<string>",
      "accounting_id": "<string>"
    },
    "name": "<string>",
    "po_job_number": "<string>",
    "zone": "<string>",
    "notes": "<string>",
    "charge_to_account": "<string>",
    "state": "created",
    "editable": true,
    "geofence_delay_seconds": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "load_at": "2023-11-07T05:31:56Z",
    "truck_count": 123,
    "truck_delay": 123,
    "unit_of_measure": "Load",
    "load_unit_of_measure": "Load",
    "service": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "quantity": "<string>",
    "waypoints": [
      {
        "type": "pickup",
        "ordinality": 123,
        "site": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "lat": "<string>",
          "lon": "<string>",
          "full_address": "<string>",
          "routable": true,
          "discarded_at": "2023-11-07T05:31:56Z",
          "address": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "thoroughfare": "<string>",
            "premise": "<string>",
            "locality": "<string>",
            "administrative_area": "<string>",
            "postal_code": "<string>",
            "country": "US",
            "lat": "<string>",
            "lon": "<string>",
            "place_id": "<string>"
          },
          "next_billion_geofence": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "geofence": {
              "name": "<string>",
              "type": "<string>",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "geojson": {
                "type": "<string>",
                "coordinates": [
                  [
                    [
                      "<unknown>"
                    ]
                  ]
                ]
              },
              "circle_center": {
                "lat": 123,
                "lon": 123
              },
              "circle_radius": 123,
              "tag": "pickup"
            },
            "moving_geofence": false,
            "tag": "scaling",
            "geofence_type": "moving"
          }
        },
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contact": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "email": "<string>",
          "phone": "+18885551234"
        }
      }
    ],
    "company": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tread_id": "ABC123",
      "legal_name": "<string>",
      "company_type": "hauler"
    },
    "copyable": true,
    "load_cycle_avg": 123,
    "action_required": true,
    "foremen": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "company": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "tread_id": "ABC123",
          "legal_name": "<string>",
          "company_type": "hauler"
        },
        "discarded_at": "2023-11-07T05:31:56Z",
        "company_share": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "external_id": "<string>",
          "ticket_match_id": "<string>",
          "sender_company": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "tread_id": "ABC123",
            "legal_name": "<string>",
            "company_type": "hauler"
          },
          "dispatchable": true,
          "schedule_on": true,
          "rate_override": true,
          "expires_at": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "collaborators": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "discarded_at": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "phone": "<string>",
        "external_id": "<string>",
        "schedule_on": true
      }
    ],
    "salespeople": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "discarded_at": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "phone": "<string>",
        "external_id": "<string>",
        "schedule_on": true
      }
    ],
    "external_id": "<string>",
    "hauler_rate_type": "RatePerHour",
    "job_notes": "<string>",
    "units_per_hour": 123,
    "job_quantity": "<string>",
    "sending_accounts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "discarded_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "account_types": [
          "customer"
        ],
        "external_id": "<string>",
        "accounting_id": "<string>",
        "company": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "schedule_on": true,
        "billing_address": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "thoroughfare": "<string>",
          "premise": "<string>",
          "locality": "<string>",
          "administrative_area": "<string>",
          "postal_code": "<string>",
          "country": "US",
          "lat": "<string>",
          "lon": "<string>",
          "place_id": "<string>"
        },
        "connected_company": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "tread_id": "ABC123",
          "legal_name": "<string>",
          "company_type": "hauler"
        },
        "billing_contact": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "email": "<string>",
          "phone": "+18885551234"
        }
      }
    ],
    "job_start_at": "2023-11-07T05:31:56Z",
    "trucks_per_delay": 123,
    "loads_pickup_time_minutes_avg": 123,
    "loads_dropoff_time_minutes_avg": 123,
    "phases": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "code": "<string>",
        "primary": true,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "equipment_type_gross_capacity": "<string>",
    "pickup_onsite_minutes": 123,
    "dropoff_onsite_minutes": 123,
    "pickup_to_dropoff_time_minutes": 123,
    "pickup_to_dropoff_distance_meters": "<string>",
    "expected_total_loads": 123,
    "cycle_time_minutes": 123,
    "loads_per_truck": 123,
    "state_events": [
      "accept"
    ],
    "recurring_loads": true,
    "material_rate_unit_of_measure": "Load",
    "material_rate_sell_price": "<string>",
    "material_rate_buy_price": "<string>",
    "material_rate_itemized": true,
    "order_id": "<string>",
    "dispatch_number": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "default_digital_ticket_view": false,
    "project": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "external_id": "<string>",
      "po_job_number": "<string>",
      "internal_notes": "<string>",
      "job_notes": "<string>",
      "notes": "<string>",
      "order_notes": "<string>"
    },
    "material": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "external_id": "<string>"
    },
    "equipment": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "equipment_type": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "system": true,
        "external_id": "<string>",
        "accounting_id": "<string>"
      },
      "external_id": "<string>",
      "equipment_id": "<string>",
      "license_number": "<string>",
      "zone": "<string>",
      "accounting_id": "<string>",
      "company_share": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "<string>",
        "ticket_match_id": "<string>",
        "sender_company": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "tread_id": "ABC123",
          "legal_name": "<string>",
          "company_type": "hauler"
        },
        "dispatchable": true,
        "schedule_on": true,
        "rate_override": true,
        "expires_at": "2023-11-07T05:31:56Z"
      }
    },
    "customer_rate": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "RatePerHour",
      "time_rate": 123
    },
    "vendor_rate": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "RatePerHour",
      "time_rate": 123
    },
    "phase": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "code": "<string>",
      "primary": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "sales_contact": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "<string>",
      "phone": "+18885551234"
    },
    "foreman_contact": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "<string>",
      "phone": "+18885551234"
    },
    "supervisor_contact": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "<string>",
      "phone": "+18885551234"
    },
    "collaborator_contact": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "<string>",
      "phone": "+18885551234"
    },
    "department": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "service_class": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "customer_rate_value": "<string>",
    "customer_rate_type": "RatePerHour",
    "vendor_rate_value": "<string>",
    "vendor_rate_type": "RatePerHour",
    "driver_rate": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "RatePerHour",
      "time_rate": 123
    },
    "driver_rate_value": "<string>",
    "driver_rate_type": "RatePerHour",
    "requester": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>",
      "discarded_at": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "phone": "<string>",
      "external_id": "<string>",
      "schedule_on": true
    },
    "order_summary": {
      "accepted_jobs_count": 123,
      "assigned_jobs_count": 123,
      "delivered_loads_count": 123,
      "jobs_count": 123,
      "loads_count": 123,
      "sent_jobs_count": 123,
      "started_jobs_count": 123,
      "file_attachments_count": 123,
      "delivered_quantities": [
        {
          "delivered": "<string>",
          "unit_of_measure": "Load",
          "material_name": "<string>",
          "total": "<string>",
          "ticketed": true
        }
      ],
      "actionable_jobs_count": 123,
      "approved_loads_count": 123,
      "approved_payables": 1,
      "total_payables": 1,
      "approved_receivables": 1,
      "total_receivables": 1,
      "calculated_loads_count": 123,
      "material_gross_delivered_quantity": "<string>",
      "material_gross_ticketed_delivered_quantity": "<string>",
      "material_gross_unit_of_measure": "Load",
      "material_gross_requested_quantity": "<string>",
      "total_tickets_count": 123,
      "total_tickets_quantity": "<string>",
      "first_load_unloaded_at": "2023-11-07T05:31:56Z",
      "first_ticket_at": "2023-11-07T05:31:56Z",
      "travelled_distance_meters": "<string>",
      "estimated_delivered_quantity": "<string>",
      "estimated_delivered_unit_of_measure": "Load"
    },
    "requested_quantity_type": "truck",
    "material_rate_site": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "lat": "<string>",
      "lon": "<string>",
      "full_address": "<string>",
      "routable": true,
      "discarded_at": "2023-11-07T05:31:56Z",
      "address": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "thoroughfare": "<string>",
        "premise": "<string>",
        "locality": "<string>",
        "administrative_area": "<string>",
        "postal_code": "<string>",
        "country": "US",
        "lat": "<string>",
        "lon": "<string>",
        "place_id": "<string>"
      },
      "next_billion_geofence": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "geofence": {
          "name": "<string>",
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "geojson": {
            "type": "<string>",
            "coordinates": [
              [
                [
                  "<unknown>"
                ]
              ]
            ]
          },
          "circle_center": {
            "lat": 123,
            "lon": 123
          },
          "circle_radius": 123,
          "tag": "pickup"
        },
        "moving_geofence": false,
        "tag": "scaling",
        "geofence_type": "moving"
      }
    },
    "reject_reason": "<string>",
    "rejected_by": "<string>",
    "rejected_at": "2023-11-07T05:31:56Z",
    "equipment_type_gross_capacity_unit_of_measure": "Load",
    "tax_rate": "<string>",
    "tax_freight": false,
    "tax_material": false,
    "tax_add_ons": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.tread.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Path Parameters

​
id
string
required

Order ID

Response

OK

​
data
Order-Read · object
required

Notes:

  • phase has been deprecated in favor of phases where "primary" == true