ecourier_get_order
Get order
One delivery order with everything e-Courier holds: status (N new, A assigned, X deleted), customer, stops and their pickup/delivery times and POD names, pieces, jobs and drivers, fees, events and notifications. Give exactly one of order_number, order_id, auth (the customer's authorization code) or reference (a piece reference; add customer_code to narrow it). Signature images are not returned. GetJsonOrder.
Parametersauthorder_idreferenceorder_numbercustomer_code
ecourier_get_order_fees
Get order fees
The fee lines (what was charged for the delivery: base rate, fuel, waiting time and so on) of one order, by internal order id. GetOrderFees.
Parametersorder_idrequired
ecourier_quote_order
Quote an order
Price and availability for a delivery WITHOUT creating it: e-Courier applies the customer's rates to the stops and pieces and returns the order with the quoted amount. Supply a customer code, pickup/delivery stops and optional pieces. Nothing is saved and nobody is notified. QuoteOrder.
Parametersauthstopsrequiredcallerpiecesservicedescriptioncaller_phonecustomer_coderequiredother_reference
ecourier_get_customer_by_code
Get customer by code
A customer (billing account) by its e-Courier customer code: id, name and address. GetCustomerByCode.
Parameterscustomer_coderequired
ecourier_get_customer
Get customer by id
The full customer record by internal customer id: contact, address, credit status and limit, balance, billing settings. Card numbers and passwords are never returned. GetCustomerById.
Parameterscustomer_idrequired
ecourier_find_customer_by_phone
Find customer by phone
Look up a customer by phone number (useful when a caller rings in): id, name and address. GetCustomerInfoFromPhoneNumber.
Parametersphonerequired
ecourier_list_customer_ship_tos
List customer ship-to addresses
The saved ship-to (stop) addresses of a customer, by internal customer id, or one ship-to by its id. Give exactly one. GetCustomerShipTo.
Parametersship_to_idcustomer_id
ecourier_list_drivers
List active drivers
Every active driver: id, code, name and site. Optionally only one site (multi-site accounts). GetDrivers.
Parameterssite_id
ecourier_get_driver
Get driver
Driver records with their vehicles and file names (never SSN or tax ids). With driver_id or driver_code one driver; with neither, every active and inactive driver. GetDriver.
Parametersdriver_iddriver_code
ecourier_get_driver_orders
Get a driver's current orders
What a driver is carrying right now: the open orders on the driver's manifest (customer, pickup and delivery names, delivery zip, ready and due times), found by driver code or by the driver's phone number. Give exactly one. GetDriverInfoFromDriverCode / GetDriverInfoFromDriverPhone.
Parametersdriver_codedriver_phone
ecourier_list_skills
List driver skills
The master list of active driver skills (for example HAZMAT) with ids. GetSkills.
Takes no parameters.
ecourier_get_driver_skills
Get a driver's skills
The skills assigned to one driver, by driver id or driver code (give exactly one). GetDriverSkills.
Parametersdriver_iddriver_code
ecourier_get_manifest
Get manifest
One driver manifest (the route a driver runs for a day) with all its job stops: sequence, addresses, status, pieces and weight. GetManifest.
Parametersmanifest_driver_idrequired
ecourier_list_driver_manifests
List a driver's manifests
The manifests of one driver between two dates, with their job stops. Default status filter is active (A). GetManifestsByDriver.
Parameterssite_idend_daterequireddriver_idrequiredstart_daterequiredmanifest_status
ecourier_list_invoices
List invoices
Invoices in an invoice date range (invoice_start_date and invoice_end_date are both required, at most 31 days apart: e-Courier rejects anything else). Optionally narrow by customer code and by a last-changed range. GetInvoice.
Parameterscustomer_codechanged_end_dateinvoice_end_daterequiredchanged_start_dateinvoice_start_daterequired
ecourier_get_invoice_fees
Get invoice fees
The fee lines of one invoice, by invoice id (the id from ecourier_list_invoices). GetInvoiceFees.
Parametersinvoice_idrequired
ecourier_list_payments
List payments
Customer payments received in a payment date range (payment_start_date and payment_end_date are both required, at most 10 days apart: e-Courier rejects anything else). Optionally narrow by customer code, check number or payment id. GetPayment.
Parameterspayment_idcheck_numbercustomer_codepayment_end_daterequiredpayment_start_daterequired