# Trimble Orders API

**Canonical:** https://apis.io/apis/trimble/trimble-orders-api/  
**Provider:** Trimble — https://apis.io/providers/trimble/  
**Base URL:** https://pcmiler.alk.com/APIs/REST/v1.0/Service.svc  
**Documentation:** https://developer.trimble.com/docs/pc-miler

Trimble Orders API is one of 402 APIs that [Trimble](https://apis.io/providers/trimble/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

The TruckMate Orders API allows access to TruckMate orders, rate quotes and pickup requests. Orders refers to the freight bills created and managed by TruckMate for dispatch operations, billing, collections, and the General Ledger. Orders contain details about pickup, delivery, routing, load details, dangerous goods information, status history, trace numbers, rates, charges, extra charges, quotes, and more. Orders and rate quotes can be viewed in the TruckMate Customer Service application where you can enter and manage additional information about costs and expenses related to the freight bill. These include interliner charges, COD on freight, and freight bill based driver pay. Pickup requests are viewed in the TruckMate Order Preprocessor application. Child resources of the orders, rate quotes and pickup requests are found on their individual tabs within the associated Windows applications. The endpoints, methods and features available are dependent on the authorization methods used.

## Operations (60 of 88)

| Method | Path | Summary |
|---|---|---|
| GET | `/orders` | Retrieve orders, pickup requests or rate quotes |
| POST | `/orders` | Create a new order, pickup request or rate quote |
| GET | `/orders/{orderId}` | Retrieve an order, pickup request, or rate quote |
| PUT | `/orders/{orderId}` | Update an order, pickup request or rate quote |
| GET | `/orders/{orderId}/aCharges` | Retrieve order accessorial charges |
| POST | `/orders/{orderId}/aCharges` | Add order accessorial charges |
| GET | `/orders/{orderId}/aCharges/{aChargeId}` | Retrieve an order accessorial charge |
| PUT | `/orders/{orderId}/aCharges/{aChargeId}` | Update an order assessorial charge |
| GET | `/orders/{orderId}/aCharges/{aChargeId}/aChargeCurrencyRates` | Retrieve order accessorial charge currency rates |
| GET | `/orders/{orderId}/billing` | Retrieve billing information for orders |
| GET | `/orders/{orderId}/billToCustomer` | Retrieve order bill to information |
| GET | `/orders/{orderId}/caller` | Retrieve order caller information |
| GET | `/orders/{orderId}/careOf` | Retrieve order care of delivery information |
| GET | `/orders/{orderId}/checklist` | Retrieve order checklist items |
| GET | `/orders/{orderId}/checklist/{checklistId}` | Retrieve an order checklist item |
| GET | `/orders/{orderId}/consignee` | Retrieve order consignee information |
| GET | `/orders/{orderId}/customDefs` | Retrieve order custom defined fields |
| POST | `/orders/{orderId}/customDefs` | Set an order custom defined field |
| DELETE | `/orders/{orderId}/customDefs` | Delete order custom defined fields |
| GET | `/orders/{orderId}/customDefs/{customDefId}` | Retrieve an order custom defined field |
| PUT | `/orders/{orderId}/customDefs/{customDefId}` | Update an order custom defined field |
| DELETE | `/orders/{orderId}/customDefs/{customDefId}` | Delete an order custom defined field |
| GET | `/orders/{orderId}/dangerousGoods` | Retrieve dangerous goods |
| POST | `/orders/{orderId}/dangerousGoods` | Add dangerous goods |
| DELETE | `/orders/{orderId}/dangerousGoods` | Delete dangerous goods |
| GET | `/orders/{orderId}/dangerousGoods/{dgId}` | Retrieve a dangerous good |
| PUT | `/orders/{orderId}/dangerousGoods/{dgId}` | Update a dangerous good |
| DELETE | `/orders/{orderId}/dangerousGoods/{dgId}` | Delete a dangerous good |
| GET | `/orders/{orderId}/details` | Retrieve order detail lines |
| POST | `/orders/{orderId}/details` | Add an order detail line |
| GET | `/orders/{orderId}/details/{orderDetailId}` | Retrieve an order detail line |
| PUT | `/orders/{orderId}/details/{orderDetailId}` | Update an order detail line |
| DELETE | `/orders/{orderId}/details/{orderDetailId}` | Delete an order detail line |
| GET | `/orders/{orderId}/details/{orderDetailId}/barcodes` | Retrieve order detail line barcode items |
| POST | `/orders/{orderId}/details/{orderDetailId}/barcodes` | Add an order detail line barcode item |
| GET | `/orders/{orderId}/details/{orderDetailId}/barcodes/{barcodeId}` | Retrieve an order detail line barcode item |
| PUT | `/orders/{orderId}/details/{orderDetailId}/barcodes/{barcodeId}` | Update an order detail line barcode item |
| DELETE | `/orders/{orderId}/details/{orderDetailId}/barcodes/{barcodeId}` | Delete an order detail line barcode item |
| GET | `/orders/{orderId}/details/{orderDetailId}/ratesheetCurrencyRates` | Retrieve order detail rate sheets |
| GET | `/orders/{orderId}/interliners` | Retrieve order interliners |
| POST | `/orders/{orderId}/interliners` | Add an order interliner |
| GET | `/orders/{orderId}/interliners/{orderInterlinerId}` | Retrieve an order interliner |
| PUT | `/orders/{orderId}/interliners/{orderInterlinerId}` | Update an order interliner |
| GET | `/orders/{orderId}/intermodal` | Retrieve order intermodal transportation information |
| POST | `/orders/{orderId}/intermodal` | Add order intermodal transportation information |
| PUT | `/orders/{orderId}/intermodal` | Update order intermodal transportation information |
| GET | `/orders/{orderId}/notes` | Retrieve order notes |
| POST | `/orders/{orderId}/notes` | Add order notes |
| DELETE | `/orders/{orderId}/notes` | Delete order notes |
| GET | `/orders/{orderId}/notes/{noteType}` | Retrieve order notes based on note type |
| PUT | `/orders/{orderId}/notes/{noteType}` | Update an order note based on note type |
| DELETE | `/orders/{orderId}/notes/{noteType}` | Delete note records of one note type |
| GET | `/orders/{orderId}/osds` | Retrieve order OS&D claims |
| POST | `/orders/{orderId}/osds` | Add an order OS&D claim |
| GET | `/orders/{orderId}/osds/{osdId}` | Retrieve an order OS&D claim |
| PUT | `/orders/{orderId}/osds/{osdId}` | Update an order OS&D claim |
| DELETE | `/orders/{orderId}/osds/{osdId}` | Delete an order OS&D claim |
| GET | `/orders/{orderId}/otherContact` | Retrieve order other contact information |
| GET | `/orders/{orderId}/pickupAt` | Retrieve order pickup at information |
| GET | `/orders/{orderId}/pods` | Retrieve order PODs |

…and 28 more operations. They are listed in full on the page.

## Machine-readable artifacts (21)

- **OpenAPI** — https://artifacts.apis.io/trimble/openapi/trimble-orders-api-openapi.yml
- **Documentation** — https://developer.trimble.com/docs/connect/reference/openapi/core/v2
- **Documentation** — https://developer.trimble.com/docs/connect/reference/openapi/core
- **Documentation** — https://developer.trimble.com/docs/connect/reference/openapi/issues
- **Documentation** — https://developer.trimble.com/docs/connect/reference/openapi/model
- **Documentation** — https://developer.trimble.com/docs/connect/reference/openapi/model-feature
- **Documentation** — https://developer.trimble.com/docs/connect/reference/openapi/organizer
- **Documentation** — https://developer.trimble.com/docs/connect/reference/openapi/property-set
- **Documentation** — https://developer.trimble.com/docs/connect/reference/openapi/topics
- **Documentation** — https://developer.trimble.com/docs/mobile-manager/reference/openapi/v1/
- **Documentation** — https://developer.trimble.com/docs/tmt/reference/openapi/v1/
- **Documentation** — https://developer.trimble.com/docs/truckmate/reference/openapi/truckmate
- **Documentation** — https://developer.trimble.com/docs/truckmate/reference/openapi/finance
- **Documentation** — https://developer.trimble.com/docs/truckmate/reference/openapi/master-data
- **Documentation** — https://direct-api.xchange.trimble.com/reference
- **JSONSchema** — https://artifacts.apis.io/trimble/json-schema/trimble-order-schema.json
- **JSONSchema** — https://artifacts.apis.io/trimble/json-schema/trimble-intermodal-schema.json
- **JSONSchema** — https://artifacts.apis.io/trimble/json-schema/trimble-barcode-schema.json
- **JSONSchema** — https://artifacts.apis.io/trimble/json-schema/trimble-detail-schema.json
- **JSONSchema** — https://artifacts.apis.io/trimble/json-schema/trimble-order-intermodal-post-body-schema.json
- **JSONSchema** — https://artifacts.apis.io/trimble/json-schema/trimble-order-intermodal-put-body-schema.json

## Other Trimble APIs (12)

- [Trimble PC*MILER API](https://apis.io/apis/trimble/trimble-pcmiler/)
- [Tekla API](https://apis.io/apis/trimble/trimble-tekla/)
- [SketchUp API](https://apis.io/apis/trimble/trimble-sketchup/)
- [ProjectSight API](https://apis.io/apis/trimble/trimble-projectsight/)
- [CoPilot Navigation API](https://apis.io/apis/trimble/trimble-copilot/)
- [Trimble Identity API](https://apis.io/apis/trimble/trimble-identity/)
- [Trimble 2D Views API](https://apis.io/apis/trimble/trimble-2d-views-api/)
- [Trimble Accessorial Charge Codes API](https://apis.io/apis/trimble/trimble-accessorial-charge-codes-api/)
- [Trimble Accidents API](https://apis.io/apis/trimble/trimble-accidents-api/)
- [Trimble Account Parts API](https://apis.io/apis/trimble/trimble-account-parts-api/)
- [Trimble Accounts Payable Invoices API](https://apis.io/apis/trimble/trimble-accounts-payable-invoices-api/)
- [Trimble Accounts Receivables API](https://apis.io/apis/trimble/trimble-accounts-receivables-api/)

## Tags

Order

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/trimble/trimble-orders-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/trimble/.
