Concepts

Concepts used in TruckMate BDK Book.

Truckmate order

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.

Field Name	Description	Type
pick_up_by	The date and time by which the pickup should be completed.	text
pick_up_by_end	The latest date and time by which the pickup can occur.	text
deliver_by	The expected delivery date and time.	text
deliver_by_end	The latest date and time for delivery to occur.	text
caller	The person or entity initiating the order.	optional[caller]
shipper	The entity or individual responsible for shipping the goods.	optional[shipper]
consignee	The recipient or destination entity for the goods.	optional[consignee]
other_contact	An additional contact for the shipment, if necessary.	optional[other_contact]
care_of	Specifies an intermediary responsible for taking care of the shipment on behalf of the consignee.	optional[care_of]
pickup_at	The location where the goods should be picked up.	optional[pickup_at]
details	Any extra details related to the order or shipment.	optional[list of details]
user_fields	Custom user-defined fields for extra information about the order.	optional[user_fields]
trace_numbers	A list of tracking numbers associated with the shipment.	optional[list of trace_numbers]
dangerous_goods	Indicates whether the shipment contains dangerous or hazardous materials.	optional[list of dangerous_goods]
custom_defs	Custom definitions or specifications applied to the order.	optional[list of custom_defs]
a_charges	Additional charges that may apply to the shipment.	optional[list of a_charges]
ship_instructs	Special instructions for the shipper regarding the handling or transportation of the goods.	optional[list of ship_instructs]
notes	Additional notes or remarks related to the order.	optional[list of notes]
xref_code	A cross-reference code for tracking or identifying the order in another system.	optional[xref_code]
intermodal	Indicates whether the shipment involves multiple modes of transport (e.g., rail, truck).	optional[intermodal]
pods	Proof of delivery documents related to the order.	optional[list of pods]
pick_up_appt_req	Specifies whether a pickup appointment is required.	optional[text]
pick_up_appt	The scheduled pickup appointment time.	optional[datetime]
pick_up_appt_made	Indicates whether the pickup appointment has been made.	optional[text]
delivery_appt	The scheduled delivery appointment time.	optional[datetime]
delivery_appt_made	Indicates whether the delivery appointment has been confirmed.	optional[text]
delivery_appt_req	Specifies whether a delivery appointment is required.	optional[text]
service_level	The level of service required for the shipment (e.g., standard, expedited).	optional[text]
start_zone	The starting zone or region for the shipment.	optional[text]
end_zone	The final destination zone or region for the shipment.	optional[text]
site_id	The unique identifier for the site related to this order.	optional[text]
op_code	The operation code associated with the order process.	optional[text]
bill_number	The billing number or invoice related to the order.	optional[text]
bill_to	The entity responsible for payment of the order.	optional[text]
bill_to_code	A code identifying the billing party.	optional[text]
declared_value	The declared monetary value of the shipment.	optional[number]
currency_code	The currency code used for monetary values (e.g., USD, EUR).	optional[text]
pickup_driver	The name or identifier of the driver responsible for picking up the shipment.	optional[text]
no_charge	Indicates whether the order is processed without charge.	optional[text]
interliners	Interline carriers involved in the shipment.	optional[list of interliners]
is_csa	Indicates whether the shipment is under a CSA (Customs Self Assessment) program.	optional[text]
is_tarped	Indicates whether the shipment is tarped for protection.	optional[text]
is_fast	Indicates whether the shipment qualifies for FAST (Free and Secure Trade) processing.	optional[text]
is_exclusive	Specifies whether the shipment requires exclusive use of the vehicle.	optional[text]
exclusive_override	Overrides the exclusive-use requirement if needed.	optional[text]
cod_amount	The cash-on-delivery amount required for the shipment.	optional[number]
delivery_driver_1	The primary driver responsible for delivering the shipment.	optional[text]
delivery_driver_2	A secondary driver for the delivery.	optional[text]
delivery_power_unit_1	The primary vehicle power unit for the delivery.	optional[text]
delivery_power_unit_2	A secondary vehicle power unit for the delivery.	optional[text]
delivery_trailer_1	The primary trailer used for the delivery.	optional[text]
delivery_trailer_2	A secondary trailer used for the delivery.	optional[text]
destination_spot_trailer	The trailer used for spotting at the delivery destination.	optional[text]
origin_spot_trailer	The trailer used for spotting at the pickup location.	optional[text]
pickup_driver_2	A secondary driver responsible for picking up the shipment.	optional[text]
pickup_power_unit_1	The primary vehicle power unit for the pickup.	optional[text]
pickup_power_unit_2	A secondary vehicle power unit for the pickup.	optional[text]
pickup_trailer_1	The primary trailer used for the pickup.	optional[text]
pickup_trailer_2	A secondary trailer used for the pickup.	optional[text]
is_approved	Specifies whether the order has been approved for processing.	optional[text]
additional_properties	Additional Properties for the order.	optional[json]

Caller

Field Name	Description	Type
client_id	None	optional[text]
name	None	optional[text]
address1	None	optional[text]
address2	None	optional[text]
city	None	optional[text]
province	None	optional[text]
postal_code	None	optional[text]
contact	None	optional[text]
phone	None	optional[text]
phone_ext	None	optional[text]
country	None	optional[text]
email	None	optional[text]
fax	None	optional[text]
cell	None	optional[text]
unit	None	optional[text]
additional_properties	None	optional[json]

Shipper

Field Name	Description	Type
client_id	None	optional[text]
name	None	optional[text]
address1	None	optional[text]
address2	None	optional[text]
city	None	optional[text]
province	None	optional[text]
postal_code	None	optional[text]
zone	None	optional[text]
zone_description	None	optional[text]
contact	None	optional[text]
phone	None	optional[text]
phone_ext	None	optional[text]
cell	None	optional[text]
country	None	optional[text]
email	None	optional[text]
fax	None	optional[text]
unit	None	optional[text]
additional_properties	None	optional[json]

Consignee

Field Name	Description	Type
client_id	None	optional[text]
name	None	optional[text]
address1	None	optional[text]
address2	None	optional[text]
city	None	optional[text]
province	None	optional[text]
postal_code	None	optional[text]
zone	None	optional[text]
zone_description	None	optional[text]
contact	None	optional[text]
phone	None	optional[text]
phone_ext	None	optional[text]
country	None	optional[text]
email	None	optional[text]
fax	None	optional[text]
cell	None	optional[text]
unit	None	optional[text]
additional_properties	None	optional[json]

Other_contact

Field Name	Description	Type
client_id	None	optional[text]
name	None	optional[text]
address1	None	optional[text]
address2	None	optional[text]
city	None	optional[text]
province	None	optional[text]
postal_code	None	optional[text]
contact	None	optional[text]
phone	None	optional[text]
phone_ext	None	optional[text]
country	None	optional[text]
email	None	optional[text]
fax	None	optional[text]
cell	None	optional[text]
unit	None	optional[text]
additional_properties	None	optional[json]

Care_of

Field Name	Description	Type
client_id	None	optional[text]
name	None	optional[text]
address1	None	optional[text]
address2	None	optional[text]
city	None	optional[text]
province	None	optional[text]
postal_code	None	optional[text]
zone	None	optional[text]
zone_description	None	optional[text]
contact	None	optional[text]
phone	None	optional[text]
phone_ext	None	optional[text]
country	None	optional[text]
email	None	optional[text]
fax	None	optional[text]
cell	None	optional[text]
unit	None	optional[text]
additional_properties	None	optional[json]

Pickup_at

Field Name	Description	Type
client_id	None	optional[text]
name	None	optional[text]
address1	None	optional[text]
address2	None	optional[text]
city	None	optional[text]
province	None	optional[text]
postal_code	None	optional[text]
zone	None	optional[text]
zone_description	None	optional[text]
contact	None	optional[text]
phone	None	optional[text]
phone_ext	None	optional[text]
cell	None	optional[text]
email	None	optional[text]
fax	None	optional[text]
country	None	optional[text]
unit	None	optional[text]
additional_properties	None	optional[json]

Details

Field Name	Description	Type
area	None	optional[number]
area_units	None	optional[text]
commodity	None	optional[text]
cube	None	optional[number]
cube_units	None	optional[text]
dangerous_goods	None	optional[text]
description	None	optional[text]
discount	None	optional[number]
distance	None	optional[number]
distance_units	None	optional[text]
field1	None	optional[text]
field2	None	optional[text]
field3	None	optional[text]
field4	None	optional[text]
field5	None	optional[text]
field6	None	optional[text]
field7	None	optional[text]
field8	None	optional[text]
field9	None	optional[text]
field10	None	optional[text]
field11	None	optional[number]
field12	None	optional[number]
field13	None	optional[number]
field14	None	optional[number]
field15	None	optional[number]
field16	None	optional[number]
field17	None	optional[number]
field18	None	optional[number]
field19	None	optional[number]
field20	None	optional[number]
field21	None	optional[text]
field22	None	optional[text]
field23	None	optional[text]
field24	None	optional[text]
field25	None	optional[text]
height	None	optional[number]
height_units	None	optional[text]
length	None	optional[number]
length_units	None	optional[text]
pallets	None	optional[number]
pallet_units	None	optional[text]
pieces	None	optional[number]
pieces_units	None	optional[text]
rate	None	optional[number]
rate_units	None	optional[text]
rate_per	None	optional[number]
requested_equipment	None	optional[text]
sub_cost	None	optional[number]
temperature_controlled	None	optional[text]
temperature	None	optional[number]
temperature_units	None	optional[text]
time	None	optional[number]
time_units	None	optional[text]
volume	None	optional[number]
volume_units	None	optional[text]
width	None	optional[number]
width_units	None	optional[text]
weight	None	optional[number]
weight_units	None	optional[text]
items	None	optional[number]
un_number	None	optional[text]
high_value	None	optional[text]
manually_rated	None	optional[text]
user_field_int_1	None	optional[number]
user_field_int_2	None	optional[number]
user_field_int_3	None	optional[number]
user_field_int_4	None	optional[number]
user_field_int_5	None	optional[number]
user_field_int_6	None	optional[number]
estimated_cube	None	optional[number]
estimated_height	None	optional[number]
estimated_length	None	optional[number]
estimated_pallets	None	optional[number]
estimated_pieces	None	optional[number]
estimated_weight	None	optional[number]
estimated_width	None	optional[number]
estimated_volume	None	optional[number]
perishable	None	optional[text]
as_rate	None	optional[number]
as_break	None	optional[number]
barcodes	None	optional[list of barcodes]
additional_properties	None	optional[json]

User_fields

Field Name	Description	Type
user1	None	optional[text]
user2	None	optional[text]
user3	None	optional[text]
user4	None	optional[text]
user5	None	optional[text]
user6	None	optional[text]
user7	None	optional[text]
user8	None	optional[text]
user9	None	optional[text]
user10	None	optional[text]
additional_properties	None	optional[json]

Trace_numbers

Field Name	Description	Type
trace_type	None	text
trace_number	None	text
ref_qualifier	None	optional[text]
user1	None	optional[text]
user2	None	optional[text]
user3	None	optional[text]
user4	None	optional[text]
user5	None	optional[text]
user6	None	optional[text]
user7	None	optional[text]
user8	None	optional[text]
user9	None	optional[text]
user10	None	optional[text]
additional_properties	None	optional[json]

Dangerous_goods

Field Name	Description	Type
un_number	None	text
class_	None	optional[text]
sub_class	None	optional[text]
compatibility_group	None	optional[text]
packing_group	None	optional[text]
volume	None	optional[number]
volume_units	None	optional[text]
mass	None	optional[number]
mass_units	None	optional[text]
explosive_quantity	None	optional[number]
explosive_units	None	optional[text]
containers	None	optional[number]
control_temp	None	optional[number]
emergency_temp	None	optional[number]
marine_pollutant	None	optional[text]
required_quantity	None	optional[text]
marine_pollutant_print_req	None	optional[text]
limited_quantity	None	optional[text]
inhalation_hazard_zone	None	optional[text]
inhalation_hazard_zone_type	None	optional[text]
actual_name	None	optional[text]
contact_name	None	optional[text]
contact_number	None	optional[text]
country_code	None	optional[text]
additional_properties	None	optional[json]

Custom_defs

Field Name	Description	Type
custom_label	None	text
custom_value	None	number or text
custom_def_id	None	optional[number]
additional_properties	None	optional[json]

A_charges

Field Name	Description	Type
a_charge_code	None	text
quantity	None	optional[number]
rate	None	optional[number]
threshold	None	optional[number]
increment	None	optional[number]
user1	None	optional[text]
user2	None	optional[text]
user3	None	optional[text]
user4	None	optional[text]
user5	None	optional[text]
user6	None	optional[text]
user7	None	optional[text]
user8	None	optional[text]
user9	None	optional[text]
user10	None	optional[text]
additional_properties	None	optional[json]

Ship_instructs

Field Name	Description	Type
instruction_id	None	number
additional_properties	None	optional[json]

Notes

Field Name	Description	Type
note_type	None	text
the_note	None	text
additional_properties	None	optional[json]

Xref_code

Field Name	Description	Type
shipper_id	None	optional[text]
shipper_qualifier	None	optional[text]
consignee_id	None	optional[text]
consignee_qualifier	None	optional[text]
other_contact_id	None	optional[text]
other_contact_qualifier	None	optional[text]
care_of_id	None	optional[text]
care_of_qualifier	None	optional[text]
pickup_at_id	None	optional[text]
pickup_at_qualifier	None	optional[text]
additional_properties	None	optional[json]

Intermodal

Field Name	Description	Type
movement_type	None	text
container_code	None	optional[text]
container_number	None	optional[text]
container_size	None	optional[text]
container_type	None	optional[text]
container_owner	None	optional[text]
container_iso	None	optional[text]
pickup	None	optional[text]
delivery	None	optional[text]
bill_to_code	None	optional[text]
chassis_termination	None	optional[text]
chassis_pickup	None	optional[text]
empty_disposition	None	optional[text]
empty_origin	None	optional[text]
card_number	None	optional[text]
seal_number	None	optional[text]
vessel	None	optional[text]
voyage	None	optional[text]
booking_number	None	optional[text]
export_destination	None	optional[text]
empty_notify_date	None	optional[text]
loaded_date	None	optional[text]
check_digit	None	optional[text]
user_date_time_1	None	optional[text]
user_date_time_2	None	optional[text]
user_date_time_3	None	optional[text]
user_date_time_4	None	optional[text]
user_date_time_5	None	optional[text]
user_string_1	None	optional[text]
user_string_2	None	optional[text]
user_string_3	None	optional[text]
user_string_4	None	optional[text]
user_string_5	None	optional[text]
user_string_6	None	optional[text]
user_string_7	None	optional[text]
user_string_8	None	optional[text]
user_string_9	None	optional[text]
user_string_10	None	optional[text]
user_int_1	None	optional[number]
user_int_2	None	optional[number]
user_int_3	None	optional[number]
user_int_4	None	optional[number]
user_int_5	None	optional[number]
user_double_1	None	optional[number]
user_double_2	None	optional[number]
user_double_3	None	optional[number]
user_double_4	None	optional[number]
user_double_5	None	optional[number]
user_trace_1	None	optional[text]
user_trace_2	None	optional[text]
vessel_ata	None	optional[text]
chassis_billing_delivery_date	None	optional[text]
chassis_billing_dispatch_date	None	optional[text]
chassis_billing_end_date	None	optional[text]
chassis_billing_fb_pickup_date	None	optional[text]
chassis_billing_start_date	None	optional[text]
chassis_billing_trip_date	None	optional[text]
export_vessel_cutoff	None	optional[text]
delivery_order_date	None	optional[text]
vessel_eta	None	optional[text]
containerlast_free_date	None	optional[text]
container_available_date	None	optional[text]
rail_eta	None	optional[text]
container_return_date	None	optional[text]
job_number	None	optional[text]
shipment_number	None	optional[text]
supplier	None	optional[text]
wo_reference	None	optional[text]
bol	None	optional[text]
customer_order	None	optional[text]
deramp	None	optional[text]
pickup_number	None	optional[text]
port_of_exit	None	optional[text]
container_pool_client	None	optional[text]
in_bond	None	optional[text]
obl_hold	None	optional[text]
agriculture_hold	None	optional[text]
additional_properties	None	optional[json]

Pods

Field Name	Description	Type
tx_type	None	text
description	None	optional[text]
driver_counted	None	optional[text]
receiver_signed	None	optional[text]
signed_clean	None	optional[text]
copy_received	None	optional[text]
trace_no	None	optional[text]
signed_by	None	optional[text]
signed_on	None	optional[text]
driver	None	optional[text]
driver_external	None	optional[text]
interliner	None	optional[text]
interliner_external	None	optional[text]
additional_properties	None	optional[json]

Interliners

Field Name	Description	Type
interliner_id	None	text
movement_type	None	optional[text]
from_zone	None	optional[text]
to_zone	None	optional[text]
currency	None	optional[text]
probill	None	optional[text]
charges_type	None	optional[text]
additional_properties	None	optional[json]

Additional_properties

No description