Query fuel orders from PDI with extensive filtering options including order status, date ranges, and multiple criteria.
getFuelOrders
order
| Parameter | Type | Required | Default | Description |
|---|
| Order Number | string | No | - | Filter by specific order number |
| Alternate Reference Number | string | No | - | Filter by alternate reference number |
| Statuses to Include | multiOptions | No | See below | Order statuses to include in the query |
| Records to Include | options | No | 3 | Which records to include based on change status |
0, 1, 2, 3, 4, 5, 6, 10, 12, 13, 15, 16
| Value | Description |
|---|
0 | Quote |
1 | Open |
2 | Picklist Printed |
3 | Shipped |
4 | Dispatched |
5 | Released for Billing |
6 | Billed |
7 | Cancelled as Quote |
8 | Cancelled as Order |
9 | Expired Quote |
10 | Released for Dispatch |
11 | Credited |
12 | Released for Picking |
13 | Accepted by Site |
14 | Rejected by Site |
15 | Delivered |
16 | Pending |
| Value | Description |
|---|
0 | New Only |
1 | New and Changed |
2 | Changed Only |
3 | All Records (based on filter) |
| Filter | Type | Description |
|---|
| Purchase Order Number | string | Filter by purchase order number |
| Order Key | string | Filter by PDI internal order key |
| Carrier ID | string | Filter by carrier ID |
| Driver | string | Filter by driver |
| Vehicle | string | Filter by vehicle |
| Scheduled Delivery From | dateTime | Filter by scheduled delivery date/time (from) |
| Scheduled Delivery To | dateTime | Filter by scheduled delivery date/time (to) |
| Actual Delivery From | dateTime | Filter by actual delivery date/time (from) |
| Actual Delivery To | dateTime | Filter by actual delivery date/time (to) |
| Sources to Include | multiOptions | Order sources to include |
| Include COD | boolean | Whether to include COD/pricing information |
| Include Equipment Delivery Notes | boolean | Whether to include equipment delivery notes (Ent 12.8+) |
| Option | Type | Default | Description |
|---|
| Include Debug Info | boolean | false | Whether to include raw request/response data for debugging |
"OrderDate": "2024-01-15",
"DeliveryDate": "2024-01-16",
"error": "Connection timeout",
- Missing API URL: PDI credential is missing apiUrl
- Missing Password: PDI credential is missing password
- Missing Partner ID: PDI credential is missing partnerId
- SOAP Fault: Error returned from PDI SOAP service
- Parse Error: Failed to parse XML response