Skip to content

Get Fuel Orders

Query fuel orders from PDI with extensive filtering options including order status, date ranges, and multiple criteria.

getFuelOrders

order

ParameterTypeRequiredDefaultDescription
Order NumberstringNo-Filter by specific order number
Alternate Reference NumberstringNo-Filter by alternate reference number
Statuses to IncludemultiOptionsNoSee belowOrder statuses to include in the query
Records to IncludeoptionsNo3Which records to include based on change status

0, 1, 2, 3, 4, 5, 6, 10, 12, 13, 15, 16

ValueDescription
0Quote
1Open
2Picklist Printed
3Shipped
4Dispatched
5Released for Billing
6Billed
7Cancelled as Quote
8Cancelled as Order
9Expired Quote
10Released for Dispatch
11Credited
12Released for Picking
13Accepted by Site
14Rejected by Site
15Delivered
16Pending
ValueDescription
0New Only
1New and Changed
2Changed Only
3All Records (based on filter)
FilterTypeDescription
Purchase Order NumberstringFilter by purchase order number
Order KeystringFilter by PDI internal order key
Carrier IDstringFilter by carrier ID
DriverstringFilter by driver
VehiclestringFilter by vehicle
Scheduled Delivery FromdateTimeFilter by scheduled delivery date/time (from)
Scheduled Delivery TodateTimeFilter by scheduled delivery date/time (to)
Actual Delivery FromdateTimeFilter by actual delivery date/time (from)
Actual Delivery TodateTimeFilter by actual delivery date/time (to)
Sources to IncludemultiOptionsOrder sources to include
Include CODbooleanWhether to include COD/pricing information
Include Equipment Delivery NotesbooleanWhether to include equipment delivery notes (Ent 12.8+)
OptionTypeDefaultDescription
Include Debug InfobooleanfalseWhether to include raw request/response data for debugging
{
"success": true,
"orderCount": 2,
"orders": [
{
"OrderNo": "12345",
"CustomerID": "CUST001",
"SiteID": "SITE001",
"OrderStatus": 5,
"OrderDate": "2024-01-15",
"DeliveryDate": "2024-01-16",
"Products": [
{
"ProductID": "PROP001",
"Quantity": 500,
"UOM": "GAL"
}
]
}
],
"httpStatusCode": 200
}
{
"success": false,
"error": "Connection timeout",
"httpStatusCode": 408
}
  • 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