{ "opencollection": "1.0.0", "info": { "name": "Horizon API V1 AccountExternalTruckIdentifier Orders API", "version": "1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Orders that belong to a Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" }, { "name": "search[datagrid]", "value": "", "type": "query", "description": "Search string for datagrid queries" }, { "name": "filter[states]", "value": "", "type": "query", "description": "States based on the resource (e.g. Order states or Job states)" }, { "name": "filter[start_date]", "value": "", "type": "query", "description": "Start date range" }, { "name": "filter[end_date]", "value": "", "type": "query", "description": "End date range" }, { "name": "filter[requester_ids]", "value": "", "type": "query", "description": "The associated Requester IDs" }, { "name": "filter[foreman_ids]", "value": "", "type": "query", "description": "The associated Foreman IDs" }, { "name": "filter[collaborator_ids]", "value": "", "type": "query", "description": "The associated Collaborator IDs" }, { "name": "filter[salesperson_ids]", "value": "", "type": "query", "description": "The associated Salesperson IDs" }, { "name": "filter[department_ids]", "value": "", "type": "query", "description": "The associated Department IDs. Use 'none' to filter for records without a Department." } ] }, "docs": "Retrieve `Orders` for a `Company`.\n\nDatagrid search (`search[datagrid]`) queries against the following properties:\n * `company_name`\n * `account_name`\n * `project_name`\n * `order_id`\n * `project_external_id`\n * `dispatch_number`" }, { "info": { "name": "Create an Order for a Company", "type": "http" }, "http": { "method": "POST", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new `Order`\n\nThis endpoint requires the `create_order` permission" }, { "info": { "name": "Retrieve Orders based on Jobs that belong to a Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/dispatch", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" }, { "name": "search[datagrid]", "value": "", "type": "query", "description": "Search string for datagrid queries" }, { "name": "filter[job][states]", "value": "", "type": "query", "description": "Job states" }, { "name": "filter[job][start_date]", "value": "", "type": "query", "description": "Start date range for Job.job_start_at" }, { "name": "filter[job][end_date]", "value": "", "type": "query", "description": "End date range for Job.job_start_at" }, { "name": "filter[job][customer_account_ids]", "value": "", "type": "query", "description": "The associated Customer Account IDs for the Job" }, { "name": "filter[job][vendor_account_ids]", "value": "", "type": "query", "description": "The associated Vendor Account IDs for the Job" }, { "name": "filter[job][driver_ids]", "value": "", "type": "query", "description": "The assigned Driver IDs for the Job" }, { "name": "filter[job][pickup_site_ids]", "value": "", "type": "query", "description": "The associated Pickup Site IDs for the Job" }, { "name": "filter[job][dropoff_site_ids]", "value": "", "type": "query", "description": "The associated Dropoff Site IDs for the Job" }, { "name": "filter[job][equipment_ids]", "value": "", "type": "query", "description": "The associated Equipment IDs for the Job" }, { "name": "filter[job][material_ids]", "value": "", "type": "query", "description": "The associated Material IDs for the Job" }, { "name": "filter[job][project_ids]", "value": "", "type": "query", "description": "The associated Project IDs for the Job" }, { "name": "filter[job][service_ids]", "value": "", "type": "query", "description": "The associated Service IDs for the Job" }, { "name": "filter[equipment_type_ids]", "value": "", "type": "query", "description": "The associated EquipmentType IDs" }, { "name": "filter[states]", "value": "", "type": "query", "description": "States based on the resource (e.g. Order states or Job states)" }, { "name": "search[job][datagrid]", "value": "", "type": "query", "description": "Search string for datagrid queries" }, { "name": "filter[job][company_ids]", "value": "", "type": "query", "description": "The associated Company IDs for the Job" }, { "name": "filter[dispatch_number_ids]", "value": "", "type": "query", "description": "The associated DispatchNumber IDs" }, { "name": "filter[job][external_ids]", "value": "", "type": "query", "description": "The associated External Project IDs for the Job" }, { "name": "filter[requester_ids]", "value": "", "type": "query", "description": "The associated Requester IDs" }, { "name": "filter[job][site_types]", "value": "", "type": "query", "description": "SiteType enum filters for the Job (see SiteType enum for the list of values)" }, { "name": "filter[job][foreman_ids]", "value": "", "type": "query", "description": "The associated Foreman IDs for the Job" }, { "name": "filter[job][collaborator_ids]", "value": "", "type": "query", "description": "The associated Collaborator IDs for the Job" }, { "name": "filter[job][salesperson_ids]", "value": "", "type": "query", "description": "The associated Salesperson IDs for the Job" }, { "name": "filter[department_ids]", "value": "", "type": "query", "description": "The associated Department IDs. Use 'none' to filter for records without a Department." }, { "name": "filter[collaborator_ids]", "value": "", "type": "query", "description": "The associated Collaborator IDs" }, { "name": "filter[salesperson_ids]", "value": "", "type": "query", "description": "The associated Salesperson IDs" }, { "name": "sort[created_at]", "value": "", "type": "query", "description": "Sort by Created At timestamp `asc` or `desc`" }, { "name": "sort[load_at]", "value": "", "type": "query", "description": "Sort by Load At timestamp `asc` or `desc`" }, { "name": "sort[friendly_order_id]", "value": "", "type": "query", "description": "Sort by Friendly Order ID `asc` or `desc`" }, { "name": "sort[dispatch_number][name]", "value": "", "type": "query", "description": "Sort by DispatchNumber name `asc` or `desc`" }, { "name": "sort[account][name]", "value": "", "type": "query", "description": "Sort by the associated Account's Name `asc` or `desc`" }, { "name": "sort[company][legal_name]", "value": "", "type": "query", "description": "Sort by the associated Company's Legal Name `asc` or `desc`" }, { "name": "filter[job][receivable_invoice][states]", "value": "", "type": "query", "description": "States based on the Job Receivable Invoice" }, { "name": "filter[job][payable_invoice][states]", "value": "", "type": "query", "description": "States based on the Job Payable Invoice" } ] }, "docs": "Retrieve `Orders` based on `Jobs` grouped by `Orders` that belong to `Company`\n\nDatagrid search (`search[datagrid]`) queries against the following properties:\n * `company_name`\n * `account_name`\n * `project_name`\n * `order_id`\n * `project_external_id`" }, { "info": { "name": "Search Dispatch Numbers based on the current Dispatch results", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/dispatch_numbers/faceted_search", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "filter[job][company_ids]", "value": "", "type": "query", "description": "The associated Company IDs for the Job" }, { "name": "filter[job][customer_account_ids]", "value": "", "type": "query", "description": "The associated Customer Account IDs for the Job" }, { "name": "filter[dispatch_number_ids]", "value": "", "type": "query", "description": "The associated DispatchNumber IDs" }, { "name": "filter[job][driver_ids]", "value": "", "type": "query", "description": "The assigned Driver IDs for the Job" }, { "name": "filter[job][dropoff_site_ids]", "value": "", "type": "query", "description": "The associated Dropoff Site IDs for the Job" }, { "name": "filter[job][end_date]", "value": "", "type": "query", "description": "End date range for Job.job_start_at" }, { "name": "filter[job][equipment_ids]", "value": "", "type": "query", "description": "The associated Equipment IDs for the Job" }, { "name": "filter[job][external_ids]", "value": "", "type": "query", "description": "The associated External Project IDs for the Job" }, { "name": "filter[job][material_ids]", "value": "", "type": "query", "description": "The associated Material IDs for the Job" }, { "name": "filter[job][pickup_site_ids]", "value": "", "type": "query", "description": "The associated Pickup Site IDs for the Job" }, { "name": "filter[job][project_ids]", "value": "", "type": "query", "description": "The associated Project IDs for the Job" }, { "name": "filter[job][service_ids]", "value": "", "type": "query", "description": "The associated Service IDs for the Job" }, { "name": "filter[job][site_types]", "value": "", "type": "query", "description": "SiteType enum filters for the Job (see SiteType enum for the list of values)" }, { "name": "filter[job][start_date]", "value": "", "type": "query", "description": "Start date range for Job.job_start_at" }, { "name": "filter[job][states]", "value": "", "type": "query", "description": "Job states" }, { "name": "filter[job][vendor_account_ids]", "value": "", "type": "query", "description": "The associated Vendor Account IDs for the Job" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "facet[search][query]", "value": "", "type": "query", "description": "The typeahead search query. Matches on the models's `name` field" } ] }, "docs": "Searches `DispatchNumbers` in a typeahead style but instead of all `DispatchNumbers` for a `Company` this returns all `DispatchNumbers` that are associated to the dispatch list, where the dispatch list is defined by the `filter` and `search` inputs that belong to a `Company`." }, { "info": { "name": "Typeahead search on Orders' Dispatch Number by Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/dispatch_numbers/typeahead", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" }, { "name": "search[query]", "value": "", "type": "query", "description": "Search string for queries" } ] }, "docs": "Typeahead search against the `dispatch_number` property on `Orders` by current `Company`." }, { "info": { "name": "Generate estimated Order values", "type": "http" }, "http": { "method": "POST", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/estimate", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates estimated `Order` values.\n\nOne of `total_loads`, `total_units`, or `truck_quantity` must be set in the request." }, { "info": { "name": "Retrieve Orders based on Invoices that belong to a Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/invoicing", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" }, { "name": "search[datagrid]", "value": "", "type": "query", "description": "Search string for datagrid queries" }, { "name": "search[invoice][datagrid]", "value": "", "type": "query", "description": "Search string for invoice datagrid queries" }, { "name": "filter[states]", "value": "", "type": "query", "description": "States based on the resource (e.g. Order states or Job states)" }, { "name": "filter[department_ids]", "value": "", "type": "query", "description": "The associated Department IDs. Use 'none' to filter for records without a Department." }, { "name": "filter[collaborator_ids]", "value": "", "type": "query", "description": "The associated Collaborator IDs" }, { "name": "filter[salesperson_ids]", "value": "", "type": "query", "description": "The associated Salesperson IDs" }, { "name": "filter[requester_ids]", "value": "", "type": "query", "description": "The associated Requester IDs" }, { "name": "sort[created_at]", "value": "", "type": "query", "description": "Sort by Created At timestamp `asc` or `desc`" }, { "name": "sort[friendly_order_id]", "value": "", "type": "query", "description": "Sort by Friendly Order ID `asc` or `desc`" }, { "name": "sort[account][name]", "value": "", "type": "query", "description": "Sort by the associated Account's Name `asc` or `desc`" }, { "name": "sort[company][legal_name]", "value": "", "type": "query", "description": "Sort by the associated Company's Legal Name `asc` or `desc`" }, { "name": "filter[invoice][start_date]", "value": "", "type": "query", "description": "Start date range for Invoice" }, { "name": "filter[invoice][end_date]", "value": "", "type": "query", "description": "End date range for Invoice" }, { "name": "filter[invoice][invoice_category]", "value": "", "type": "query", "description": "The Invoice category filter. See InvoiceCategoryFilter for accepted values." }, { "name": "filter[invoice][grouped]", "value": "", "type": "query", "description": "Only show Invoices that are part of a Settlement" }, { "name": "filter[invoice][invoiceable_type]", "value": "", "type": "query", "description": "InvoiceableType enum filter (e.g. Job, DriverDay)" }, { "name": "filter[invoice][states]", "value": "", "type": "query", "description": "States based on the Invoice" }, { "name": "filter[invoice][rate_types]", "value": "", "type": "query", "description": "Array of rate types to filter by for Invoice" }, { "name": "filter[invoice][vendor_account_ids]", "value": "", "type": "query", "description": "The associated Vendor Account IDs for the Invoice" }, { "name": "filter[invoice][customer_account_ids]", "value": "", "type": "query", "description": "The associated Customer Account IDs for the Invoice" }, { "name": "filter[invoice][pickup_site_ids]", "value": "", "type": "query", "description": "The associated Pickup Site IDs for Invoice" }, { "name": "filter[invoice][dropoff_site_ids]", "value": "", "type": "query", "description": "The associated Dropoff Site IDs for the Invoice" }, { "name": "filter[invoice][driver_ids]", "value": "", "type": "query", "description": "The assigned Driver IDs for the Invoice" }, { "name": "filter[invoice][company_id]", "value": "", "type": "query", "description": "The associated Company ID of the Invoice" }, { "name": "filter[project_ids]", "value": "", "type": "query", "description": "The associated Project IDs" } ] }, "docs": "Retrieve `Orders` based on `Invoices` grouped by `Orders` that belong to `Company`\n\nDatagrid search (`search[datagrid]`) queries against the following properties:\n * `company_name`\n * `account_name`\n * `project_name`\n * `order_id`\n * `project_external_id`\n\nInvoice datagrid search (`search[invoice][datagrid]`) queries against the following properties:\n * `job_id`\n * `customer_account_name`\n * `vendor_account_name`\n * `driver_name`\n * `order_id`\n * `order_external_id`\n * `order_name`\n * `project_n" }, { "info": { "name": "Simulate an Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/simulate_order", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Simulate an `Order` being dispatched and completed" }, { "info": { "name": "Typeahead search on Orders by Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/typeahead", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" }, { "name": "search[query]", "value": "", "type": "query", "description": "Search string for queries" } ] }, "docs": "Typeahead search against the `order_id` property for `Orders` visible to the currently authenticated `Company`." }, { "info": { "name": "Retrieve a single Order for a Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "id", "value": "", "type": "path", "description": "Order ID" } ] }, "docs": "Retrieve `Order` by ID" }, { "info": { "name": "Update an Order for a Company", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update `Order` by ID\n\nThis endpoint requires the `edit_order` permission _or_ the `edit_order_pre_accept` permission, which only allows editing if the Order is in `created`, `pending_request` or `rejected` state" }, { "info": { "name": "Accept an Order for a Company", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/accept", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Accept an `Order`.\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Cancel an Order for a Company", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/cancel", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel an `Order`.\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Complete an Order for a Company", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/complete", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Complete an `Order`.\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Copy an Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/copy", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Copy an existing `Order`.\n\nThis endpoint required the `create_order` `IamPermission`." }, { "info": { "name": "Retrieve default sites for an order, given a waypoint type.", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/default_sites/:waypoint-type", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" }, { "name": "waypoint-type", "value": "", "type": "path", "description": "Waypoint type" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" } ] }, "docs": "Retrieve the `Sites` that belong to the default list of an `Order`, given a particular 'WaypointType'.\n" }, { "info": { "name": "Add a site to default site list on order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/default_sites/:waypoint-type/:site-id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" }, { "name": "waypoint-type", "value": "", "type": "path", "description": "Waypoint type" }, { "name": "site-id", "value": "", "type": "path", "description": "Site ID" } ] }, "docs": "Add a `Site` to the default_site list for an `Order`, given a particular 'WaypointType'.\n\nNote: The underlying site grouping will be created automatically when the first \nsite is added for a given order. " }, { "info": { "name": "Delete a single site from a default list of an order.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/default_sites/:waypoint-type/:site-id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" }, { "name": "waypoint-type", "value": "", "type": "path", "description": "Waypoint type" }, { "name": "site-id", "value": "", "type": "path", "description": "Site ID" } ] }, "docs": "Delete a `Site` to the default_site list for an `Order`, given a particular 'WaypointType'." }, { "info": { "name": "Send SMS to a driver of all the Jobs of an Order for a Company", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/driver_sms", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Send sms text to `driver` of all `Job`s of an `Order`." }, { "info": { "name": "Hold an Order for a Company", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/hold", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Hold an `Order`\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Typeahead search on Materials that belong to Order's Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/materials/typeahead", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" }, { "name": "search[query]", "value": "", "type": "query", "description": "Search string for queries" } ] }, "docs": "Typeahead search against the `name` property for `Materials` that belong to the `Order`'s `Company`" }, { "info": { "name": "Reject an Order for a Company", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/reject", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reject an `Order`.\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Request an Order for a Company", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/request", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Request an `Order`\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Typeahead search on Sites that belong to Order's Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/sites/typeahead", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" }, { "name": "search[query]", "value": "", "type": "query", "description": "Search string for queries" }, { "name": "filter[states]", "value": "", "type": "query", "description": "States based on the resource (e.g. Order states or Job states)" } ] }, "docs": "Typeahead search against the `name`, or `external_id` property for `Sites` that belong to the `Order`'s `Company`" }, { "info": { "name": "Start an Order for a Company", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/start", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Start an `Order`.\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Retrieve Tickets for an Order for a Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/tickets", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" }, { "name": "filter[from_date]", "value": "", "type": "query", "description": "Start range of ticket.created_at" }, { "name": "filter[to_date]", "value": "", "type": "query", "description": "End range of ticket.created_at" }, { "name": "filter[flagged]", "value": "", "type": "query", "description": "Filter to only flagged or un-flagged Tickets" }, { "name": "filter[sources]", "value": "", "type": "query", "description": "Array of sources (Tickets)" } ] }, "docs": "Retrive `Tickets` for an `Order`.\nFilter usage:\n* to filter a from date: `filter[from_date]`\n* to filter a to date: `filter[to_date]`\n" }, { "info": { "name": "Retrieve Ticket Rollup Summary for an Order for a Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/tickets/rollup_summary", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" }, { "name": "filter[sources]", "value": "", "type": "query", "description": "Array of sources (Tickets)" } ] }, "docs": "Retrive `TicketRollupSummary` for an `Order`.\nFilter usage:\n* filter on ticket source: `filter[sources]`\n" }, { "info": { "name": "Weather Hold an Order for a Company", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/companies/:company-id/orders/:order-id/weather_hold", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company-id", "value": "", "type": "path", "description": "Company ID" }, { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Weather Hold an `Order`\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Retrieve Orders that belong to the current Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/orders", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" }, { "name": "search[datagrid]", "value": "", "type": "query", "description": "Search string for datagrid queries" }, { "name": "filter[states]", "value": "", "type": "query", "description": "States based on the resource (e.g. Order states or Job states)" }, { "name": "filter[start_date]", "value": "", "type": "query", "description": "Start date range" }, { "name": "filter[end_date]", "value": "", "type": "query", "description": "End date range" }, { "name": "ids", "value": "", "type": "query", "description": "Order IDs" }, { "name": "filter[requester_ids]", "value": "", "type": "query", "description": "The associated Requester IDs" }, { "name": "filter[foreman_ids]", "value": "", "type": "query", "description": "The associated Foreman IDs" }, { "name": "filter[collaborator_ids]", "value": "", "type": "query", "description": "The associated Collaborator IDs" }, { "name": "filter[salesperson_ids]", "value": "", "type": "query", "description": "The associated Salesperson IDs" }, { "name": "filter[department_ids]", "value": "", "type": "query", "description": "The associated Department IDs. Use 'none' to filter for records without a Department." } ] }, "docs": "Retrieve `Orders` visible to the currently authenticated `Company`\n\nDatagrid search (`search[datagrid]`) queries against the following properties:\n * `company_name`\n * `account_name`\n * `project_name`\n * `order_id`\n * `project_external_id`\n * `dispatch_number`" }, { "info": { "name": "Create an Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.tread-horizon.com/v1/orders", "headers": [ { "name": "Accept-Language", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new `Order`\n\nThis endpoint requires the `create_order` permission" }, { "info": { "name": "Retrieve Orders based on Jobs for the current Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/orders/dispatch", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" }, { "name": "search[datagrid]", "value": "", "type": "query", "description": "Search string for datagrid queries" }, { "name": "filter[job][states]", "value": "", "type": "query", "description": "Job states" }, { "name": "filter[job][start_date]", "value": "", "type": "query", "description": "Start date range for Job.job_start_at" }, { "name": "filter[job][end_date]", "value": "", "type": "query", "description": "End date range for Job.job_start_at" }, { "name": "filter[job][customer_account_ids]", "value": "", "type": "query", "description": "The associated Customer Account IDs for the Job" }, { "name": "filter[job][vendor_account_ids]", "value": "", "type": "query", "description": "The associated Vendor Account IDs for the Job" }, { "name": "filter[job][driver_ids]", "value": "", "type": "query", "description": "The assigned Driver IDs for the Job" }, { "name": "filter[job][pickup_site_ids]", "value": "", "type": "query", "description": "The associated Pickup Site IDs for the Job" }, { "name": "filter[job][dropoff_site_ids]", "value": "", "type": "query", "description": "The associated Dropoff Site IDs for the Job" }, { "name": "filter[job][equipment_ids]", "value": "", "type": "query", "description": "The associated Equipment IDs for the Job" }, { "name": "filter[job][material_ids]", "value": "", "type": "query", "description": "The associated Material IDs for the Job" }, { "name": "filter[job][project_ids]", "value": "", "type": "query", "description": "The associated Project IDs for the Job" }, { "name": "filter[job][service_ids]", "value": "", "type": "query", "description": "The associated Service IDs for the Job" }, { "name": "filter[equipment_type_ids]", "value": "", "type": "query", "description": "The associated EquipmentType IDs" }, { "name": "filter[states]", "value": "", "type": "query", "description": "States based on the resource (e.g. Order states or Job states)" }, { "name": "search[job][datagrid]", "value": "", "type": "query", "description": "Search string for datagrid queries" }, { "name": "filter[dispatch_number_ids]", "value": "", "type": "query", "description": "The associated DispatchNumber IDs" }, { "name": "filter[job][external_ids]", "value": "", "type": "query", "description": "The associated External Project IDs for the Job" }, { "name": "filter[job][company_ids]", "value": "", "type": "query", "description": "The associated Company IDs for the Job" }, { "name": "filter[requester_ids]", "value": "", "type": "query", "description": "The associated Requester IDs" }, { "name": "filter[job][site_types]", "value": "", "type": "query", "description": "SiteType enum filters for the Job (see SiteType enum for the list of values)" }, { "name": "filter[job][foreman_ids]", "value": "", "type": "query", "description": "The associated Foreman IDs for the Job" }, { "name": "filter[job][collaborator_ids]", "value": "", "type": "query", "description": "The associated Collaborator IDs for the Job" }, { "name": "filter[job][salesperson_ids]", "value": "", "type": "query", "description": "The associated Salesperson IDs for the Job" }, { "name": "filter[department_ids]", "value": "", "type": "query", "description": "The associated Department IDs. Use 'none' to filter for records without a Department." }, { "name": "sort[created_at]", "value": "", "type": "query", "description": "Sort by Created At timestamp `asc` or `desc`" }, { "name": "sort[load_at]", "value": "", "type": "query", "description": "Sort by Load At timestamp `asc` or `desc`" }, { "name": "sort[friendly_order_id]", "value": "", "type": "query", "description": "Sort by Friendly Order ID `asc` or `desc`" }, { "name": "sort[dispatch_number][name]", "value": "", "type": "query", "description": "Sort by DispatchNumber name `asc` or `desc`" }, { "name": "sort[account][name]", "value": "", "type": "query", "description": "Sort by the associated Account's Name `asc` or `desc`" }, { "name": "sort[company][legal_name]", "value": "", "type": "query", "description": "Sort by the associated Company's Legal Name `asc` or `desc`" } ] }, "docs": "Retrieve `Orders` based on `Jobs` grouped by `Orders` for the current `Company`\n\nDatagrid search (`search[datagrid]`) queries against the following properties:\n * `company_name`\n * `account_name`\n * `project_name`\n * `order_id`\n * `project_external_id`" }, { "info": { "name": "Generate estimated Order values", "type": "http" }, "http": { "method": "POST", "url": "https://api.tread-horizon.com/v1/orders/estimate", "headers": [ { "name": "Accept-Language", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates estimated `Order` values.\n\nOne of `total_loads`, `total_units`, or `truck_quantity` must be set in the request." }, { "info": { "name": "Retrieve a single Order", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/orders/:id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Order ID" } ] }, "docs": "Retrieve `Order` by ID" }, { "info": { "name": "Update an Order", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.tread-horizon.com/v1/orders/:id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update `Order` by ID\n\nThis endpoint requires the `edit_order` permission _or_ the `edit_order_pre_accept` permission, which only allows editing if the Order is in `created`, `pending_request` or `rejected` state" }, { "info": { "name": "Accept an Order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/orders/:order-id/accept", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Accept an `Order`.\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Cancel an Order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/orders/:order-id/cancel", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel an `Order`.\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Complete an Order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/orders/:order-id/complete", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Complete an `Order`.\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Copy an Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.tread-horizon.com/v1/orders/:order-id/copy", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Copy an existing `Order`.\n\nThis endpoint required the `create_order` `IamPermission`." }, { "info": { "name": "Retrieve default sites for an order, given a waypoint type.", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/orders/:order-id/default_sites/:waypoint-type", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order ID" }, { "name": "waypoint-type", "value": "", "type": "path", "description": "Waypoint type" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" } ] }, "docs": "Retrieve the `Sites` that belong to the default list of an `Order`, given a particular 'WaypointType'.\n" }, { "info": { "name": "Add a site to default site list on order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/orders/:order-id/default_sites/:waypoint-type/:site-id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order id" }, { "name": "waypoint-type", "value": "", "type": "path", "description": "Waypoint type" }, { "name": "site-id", "value": "", "type": "path", "description": "Site id" } ] }, "docs": "Add a `Site` to the default_site list for an `Order`, given a particular 'WaypointType'.\n\nNote: The underlying site grouping will be created automatically when the first \nsite is added for a given order. " }, { "info": { "name": "Delete a single site from a default list of an order.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tread-horizon.com/v1/orders/:order-id/default_sites/:waypoint-type/:site-id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order id" }, { "name": "waypoint-type", "value": "", "type": "path", "description": "Waypoint type" }, { "name": "site-id", "value": "", "type": "path", "description": "Site id" } ] }, "docs": "Delete a `Site` to the default_site list for an `Order`, given a particular 'WaypointType'." }, { "info": { "name": "Send SMS to a driver of all the Jobs of an Order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/orders/:order-id/driver_sms", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order Id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Send sms text to `driver` of all `Job`s of an `Order`." }, { "info": { "name": "Hold an Order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/orders/:order-id/hold", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Hold an `Order`\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Typeahead search on Materials that belong to Order's Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/orders/:order-id/materials/typeahead", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order ID" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" }, { "name": "search[query]", "value": "", "type": "query", "description": "Search string for queries" } ] }, "docs": "Typeahead search against the `name` property for `Materials` that belong to the `Order`'s `Company`" }, { "info": { "name": "Reject an Order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/orders/:order-id/reject", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reject an `Order`.\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Request an Order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/orders/:order-id/request", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Request an `Order`\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Typeahead search on Sites that belong to Order's Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/orders/:order-id/sites/typeahead", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order ID" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" }, { "name": "search[query]", "value": "", "type": "query", "description": "Search string for queries" }, { "name": "filter[states]", "value": "", "type": "query", "description": "States based on the resource (e.g. Order states or Job states)" } ] }, "docs": "Typeahead search against the `name`, or `external_id` property for `Sites` that belong to the `Order`'s `Company`" }, { "info": { "name": "Start an Order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/orders/:order-id/start", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order Id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Start an `Order`.\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Retrieve Tickets for an Order", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/orders/:order-id/tickets", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order ID" }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of paginated results to return" }, { "name": "page[after]", "value": "", "type": "query", "description": "The cursor to start paginating after" }, { "name": "page[before]", "value": "", "type": "query", "description": "The cursor to stop paginating at" }, { "name": "filter[from_date]", "value": "", "type": "query", "description": "Start range of ticket.created_at" }, { "name": "filter[to_date]", "value": "", "type": "query", "description": "End range of ticket.created_at" }, { "name": "filter[flagged]", "value": "", "type": "query", "description": "Filter to only flagged or un-flagged Tickets" }, { "name": "filter[sources]", "value": "", "type": "query", "description": "Array of sources (Tickets)" } ] }, "docs": "Retrive `Tickets` for an `Order`.\nFilter usage:\n* to filter a from date: `filter[from_date]`\n* to filter a to date: `filter[to_date]`\n" }, { "info": { "name": "Retrieve Ticket Rollup Summary for an Order", "type": "http" }, "http": { "method": "GET", "url": "https://api.tread-horizon.com/v1/orders/:order-id/tickets/rollup_summary", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order ID" }, { "name": "filter[sources]", "value": "", "type": "query", "description": "Array of sources (Tickets)" } ] }, "docs": "Retrive `TicketRollupSummary` for an `Order`.\nFilter usage:\n* filter on ticket source: `filter[sources]`\n" }, { "info": { "name": "Weather Hold an Order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/orders/:order-id/weather_hold", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "order-id", "value": "", "type": "path", "description": "Order ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Weather Hold an `Order`\n\nThis endpoint requires the `edit_order` `IamPermission`." }, { "info": { "name": "Add a site to default site list on order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.tread-horizon.com/v1/projects/:project-id/default_sites/:waypoint-type/:site-id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "waypoint-type", "value": "", "type": "path", "description": "Waypoint type" }, { "name": "site-id", "value": "", "type": "path", "description": "Site id" }, { "name": "project-id", "value": "", "type": "path", "description": "Project id" } ] }, "docs": "Add a `Site` to the default_site list for an `Project`, given a particular 'WaypointType'.\n\nNote: The underlying site grouping will be created automatically when the first \nsite is added for a given project. " }, { "info": { "name": "Delete a single site from a default list of an order.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.tread-horizon.com/v1/projects/:project-id/default_sites/:waypoint-type/:site-id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "waypoint-type", "value": "", "type": "path", "description": "Waypoint type" }, { "name": "site-id", "value": "", "type": "path", "description": "Site id" }, { "name": "project-id", "value": "", "type": "path", "description": "Project id" } ] }, "docs": "Delete a `Site` to the default_site list for an `Order`, given a particular 'WaypointType'." }, { "info": { "name": "Calculate estimated Route time and distance", "type": "http" }, "http": { "method": "POST", "url": "https://api.tread-horizon.com/v1/route_estimate", "headers": [ { "name": "Accept-Language", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Calculate estimated `Route` `time` and `distance`" } ] } ], "bundled": true }