Freightcom Customer API (2.5.2)

Download OpenAPI specification:Download

Freightcom Inc.: contact@freightcom.com URL: https://www.freightcom.com

API for use by Freightcom customers. This API uses polling for some long running requests. In those cases the initial request will return a 202 Accepted status.

rate

Obtain estimated rates based upon a small number of details.

Request a rate estimate.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

services	Array of strings List of service IDs for which to get rates. If not provided then all services will be queried for rates.
excluded_services	Array of strings Excluded list of service IDs for which to ignore rates from.
	object (ShippingDetails) Details on a shipment.

Responses

Request samples

Payload

Content type

application/json

{"services": ["string"
],
"excluded_services": ["string"
],
"details": {"origin": {"name": "Philip J Fry",
"address": {"address_line_1": "200 University Avenue West",
"address_line_2": "string",
"unit_number": "42a",
"city": "Waterloo",
"region": "ON",
"country": "CA",
"postal_code": "string"
},
"residential": true,
"tailgate_required": true,
"instructions": "string",
"contact_name": "string",
"phone_number": {"number": "5554447777",
"extension": "123"
},
"email_addresses": ["user@example.com"
],
"receives_email_updates": true
},
"destination": {"name": "Philip J Fry",
"address": {"address_line_1": "200 University Avenue West",
"address_line_2": "string",
"unit_number": "42a",
"city": "Waterloo",
"region": "ON",
"country": "CA",
"postal_code": "string"
},
"residential": true,
"tailgate_required": true,
"instructions": "string",
"contact_name": "string",
"phone_number": {"number": "5554447777",
"extension": "123"
},
"email_addresses": ["user@example.com"
],
"receives_email_updates": true,
"ready_at": {"hour": 15,
"minute": 6
},
"ready_until": {"hour": 15,
"minute": 6
},
"signature_requirement": "not-required"
},
"expected_ship_date": {"year": 2006,
"month": 6,
"day": 7
},
"packaging_type": "pallet",
"packaging_properties": {"pallet_type": "ltl",
"has_stackable_pallets": true,
"dangerous_goods": "limited-quantity",
"dangerous_goods_details": {"packaging_group": "string",
"goods_class": "string",
"description": "string",
"united_nations_number": "string",
"emergency_contact_name": "string",
"emergency_contact_phone_number": {"number": "5554447777",
"extension": "123"
}
},
"pallets": [{"measurements": {"weight": {"unit": "lb",
"value": 2.95
},
"cuboid": {"unit": "ft",
"l": 5,
"w": 5,
"h": 5
}
},
"description": "string",
"freight_class": "string",
"nmfc": "string",
"contents_type": "string",
"num_pieces": 0
}
],
"pallet_service_details": {"limited_access_delivery_type": "construction-site",
"limited_access_delivery_other_name": "string",
"in_bond": true,
"in_bond_details": {"type": "immediate-exportation",
"name": "string",
"address": "string",
"contact_method": "email-address",
"contact_email_address": "string",
"contact_phone_number": {"number": "5554447777",
"extension": "123"
}
},
"appointment_delivery": true,
"protect_from_freeze": true,
"threshold_pickup": true,
"threshold_delivery": true
}
},
"insurance": {"type": "internal",
"total_cost": {"currency": "CAD",
"value": "4250"
}
},
"reference_codes": ["string"
]
}
}

Response samples

202

Content type

application/json

{"request_id": "string"
}

Retrieve a requested rate. Also includes details o

Retrieve a requested rate. Also includes details on the number of pending rate lookups to perform if any.

Authorizations:

ApiKeyAuth

path Parameters

rate_id

required

string

The rate ID to retrieve details on.

Responses

Response samples

200

Content type

application/json

{"status": {"done": true,
"total": 0,
"complete": 0
},
"rates": [{"carrier_name": "string",
"service_name": "string",
"service_id": "string",
"valid_until": {"year": 2006,
"month": 6,
"day": 7
},
"total": {"currency": "CAD",
"value": "4250"
},
"base": {"currency": "CAD",
"value": "4250"
},
"surcharges": [{"type": "fuel",
"amount": {"currency": "CAD",
"value": "4250"
}
}
],
"taxes": [{"type": "fuel",
"amount": {"currency": "CAD",
"value": "4250"
}
}
],
"transit_time_days": 5,
"transit_time_not_available": true
}
]
}

Calculate freight class

Calculate freight class for pallet dimensions.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

object (Box)

Responses

Request samples

Payload

Content type

application/json

{"box": {"weight": {"unit": "lb",
"value": 2.95
},
"cuboid": {"unit": "ft",
"l": 5,
"w": 5,
"h": 5
}
}
}

Response samples

200

Content type

application/json

{"freight_class": "50"
}

shipment

Retrieving and booking shipments.

shipment-book

Book a shipment.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

unique_id required	string Maximum length of 128 characters. Uppercase and lowercase characters are considered equal for comparisons. Used to uniquely identify a shipment. If the unique_id matches a previously created shipment that is in the process of booking or booked successfully then a new shipment will NOT be created and the ID for the previously created shipment will be returned. If the previously created shipment had an error during booking or was cancelled then a new shipment with the unique_id will be created and unique_id will be associated with this new shipment.
payment_method_id required	string Payment method to use, obtained from /finance/payment-methods.
service_id required	string Service to book with.
required	object (ShippingDetails) Details on a shipment.
	object Customs invoice info. Required for international shipments.
	object (PickupDetails) Courier pickup details, required if courier service utilized.
	object (DispatchDetails) LTL dispatch details, required if dispatch service utilized.

Responses

Request samples

Payload

Content type

application/json

{"unique_id": "string",
"payment_method_id": "string",
"service_id": "string",
"details": {"origin": {"name": "Philip J Fry",
"address": {"address_line_1": "200 University Avenue West",
"address_line_2": "string",
"unit_number": "42a",
"city": "Waterloo",
"region": "ON",
"country": "CA",
"postal_code": "string"
},
"residential": true,
"tailgate_required": true,
"instructions": "string",
"contact_name": "string",
"phone_number": {"number": "5554447777",
"extension": "123"
},
"email_addresses": ["user@example.com"
],
"receives_email_updates": true
},
"destination": {"name": "Philip J Fry",
"address": {"address_line_1": "200 University Avenue West",
"address_line_2": "string",
"unit_number": "42a",
"city": "Waterloo",
"region": "ON",
"country": "CA",
"postal_code": "string"
},
"residential": true,
"tailgate_required": true,
"instructions": "string",
"contact_name": "string",
"phone_number": {"number": "5554447777",
"extension": "123"
},
"email_addresses": ["user@example.com"
],
"receives_email_updates": true,
"ready_at": {"hour": 15,
"minute": 6
},
"ready_until": {"hour": 15,
"minute": 6
},
"signature_requirement": "not-required"
},
"expected_ship_date": {"year": 2006,
"month": 6,
"day": 7
},
"packaging_type": "pallet",
"packaging_properties": {"pallet_type": "ltl",
"has_stackable_pallets": true,
"dangerous_goods": "limited-quantity",
"dangerous_goods_details": {"packaging_group": "string",
"goods_class": "string",
"description": "string",
"united_nations_number": "string",
"emergency_contact_name": "string",
"emergency_contact_phone_number": {"number": "5554447777",
"extension": "123"
}
},
"pallets": [{"measurements": {"weight": {"unit": "lb",
"value": 2.95
},
"cuboid": {"unit": "ft",
"l": 5,
"w": 5,
"h": 5
}
},
"description": "string",
"freight_class": "string",
"nmfc": "string",
"contents_type": "string",
"num_pieces": 0
}
],
"pallet_service_details": {"limited_access_delivery_type": "construction-site",
"limited_access_delivery_other_name": "string",
"in_bond": true,
"in_bond_details": {"type": "immediate-exportation",
"name": "string",
"address": "string",
"contact_method": "email-address",
"contact_email_address": "string",
"contact_phone_number": {"number": "5554447777",
"extension": "123"
}
},
"appointment_delivery": true,
"protect_from_freeze": true,
"threshold_pickup": true,
"threshold_delivery": true
}
},
"insurance": {"type": "internal",
"total_cost": {"currency": "CAD",
"value": "4250"
}
},
"reference_codes": ["string"
]
},
"customs_invoice": {"source": "details",
"broker": {"use_carrier": true,
"name": "string",
"account_number": "string",
"phone_number": {"number": "5554447777",
"extension": "123"
},
"fax_number": {"number": "5554447777",
"extension": "123"
},
"email_address": "string",
"usmca_number": "string",
"fda_number": "string"
},
"details": {"tax_recipient": {"type": "shipper",
"shipper_tax_identifier": "string",
"receiver_tax_identifier": "string",
"third_party_tax_identifier": "string",
"other_tax_identifier": "string",
"name": "string",
"address": {"address_line_1": "200 University Avenue West",
"address_line_2": "string",
"unit_number": "42a",
"city": "Waterloo",
"region": "ON",
"country": "CA",
"postal_code": "string"
},
"phone_number": {"number": "5554447777",
"extension": "123"
},
"reason_for_export": "gift",
"additional_remarks": "string",
"comments": "string"
},
"products": [{"product_name": "string",
"weight": {"unit": "lb",
"value": 2.95
},
"hs_code": "string",
"country_of_origin": "CA",
"num_units": 1,
"unit_price": {"currency": "CAD",
"value": "4250"
},
"description": "string"
}
]
}
},
"pickup_details": {"pre_scheduled_pickup": true,
"date": {"year": 2006,
"month": 6,
"day": 7
},
"ready_at": {"hour": 15,
"minute": 6
},
"ready_until": {"hour": 15,
"minute": 6
},
"pickup_location": "string",
"contact_name": "string",
"contact_phone_number": {"number": "5554447777",
"extension": "123"
}
},
"dispatch_details": {"date": {"year": 2006,
"month": 6,
"day": 7
},
"ready_at": {"hour": 15,
"minute": 6
},
"ready_until": {"hour": 15,
"minute": 6
}
}
}

Response samples

202

Content type

application/json

{"id": "string",
"previously_created": true
}

Retrieve details on a shipment.

Authorizations:

ApiKeyAuth

path Parameters

shipment_id

required

string

The shipment ID to retrieve details on.

Responses

Response samples

200

Content type

application/json

{"shipment": {"id": "string",
"unique_id": "string",
"state": "draft",
"transaction_number": "string",
"primary_tracking_number": "string",
"tracking_numbers": ["string"
],
"tracking_url": "string",
"return_tracking_number": "string",
"bol_number": "string",
"pickup_confirmation_number": "string",
"details": {"origin": {"name": "Philip J Fry",
"address": {"address_line_1": "200 University Avenue West",
"address_line_2": "string",
"unit_number": "42a",
"city": "Waterloo",
"region": "ON",
"country": "CA",
"postal_code": "string"
},
"residential": true,
"tailgate_required": true,
"instructions": "string",
"contact_name": "string",
"phone_number": {"number": "5554447777",
"extension": "123"
},
"email_addresses": ["user@example.com"
],
"receives_email_updates": true
},
"destination": {"name": "Philip J Fry",
"address": {"address_line_1": "200 University Avenue West",
"address_line_2": "string",
"unit_number": "42a",
"city": "Waterloo",
"region": "ON",
"country": "CA",
"postal_code": "string"
},
"residential": true,
"tailgate_required": true,
"instructions": "string",
"contact_name": "string",
"phone_number": {"number": "5554447777",
"extension": "123"
},
"email_addresses": ["user@example.com"
],
"receives_email_updates": true,
"ready_at": {"hour": 15,
"minute": 6
},
"ready_until": {"hour": 15,
"minute": 6
},
"signature_requirement": "not-required"
},
"expected_ship_date": {"year": 2006,
"month": 6,
"day": 7
},
"packaging_type": "pallet",
"packaging_properties": {"pallet_type": "ltl",
"has_stackable_pallets": true,
"dangerous_goods": "limited-quantity",
"dangerous_goods_details": {"packaging_group": "string",
"goods_class": "string",
"description": "string",
"united_nations_number": "string",
"emergency_contact_name": "string",
"emergency_contact_phone_number": {"number": "5554447777",
"extension": "123"
}
},
"pallets": [{"measurements": {"weight": {"unit": "lb",
"value": 2.95
},
"cuboid": {"unit": "ft",
"l": 5,
"w": 5,
"h": 5
}
},
"description": "string",
"freight_class": "string",
"nmfc": "string",
"contents_type": "string",
"num_pieces": 0
}
],
"pallet_service_details": {"limited_access_delivery_type": "construction-site",
"limited_access_delivery_other_name": "string",
"in_bond": true,
"in_bond_details": {"type": "immediate-exportation",
"name": "string",
"address": "string",
"contact_method": "email-address",
"contact_email_address": "string",
"contact_phone_number": {"number": "5554447777",
"extension": "123"
}
},
"appointment_delivery": true,
"protect_from_freeze": true,
"threshold_pickup": true,
"threshold_delivery": true
}
},
"insurance": {"type": "internal",
"total_cost": {"currency": "CAD",
"value": "4250"
}
},
"reference_codes": ["string"
]
},
"transport_data": { },
"labels": [{"size": "letter",
"format": "pdf",
"url": "string",
"padded": true
}
],
"customs_invoice_url": "string",
"rate": {"carrier_name": "string",
"service_name": "string",
"service_id": "string",
"valid_until": {"year": 2006,
"month": 6,
"day": 7
},
"total": {"currency": "CAD",
"value": "4250"
},
"base": {"currency": "CAD",
"value": "4250"
},
"surcharges": [{"type": "fuel",
"amount": {"currency": "CAD",
"value": "4250"
}
}
],
"taxes": [{"type": "fuel",
"amount": {"currency": "CAD",
"value": "4250"
}
}
],
"transit_time_days": 5,
"transit_time_not_available": true
},
"order_source": "string"
}
}

Cancel a shipment. Will also remove any unique_id

Cancel a shipment. Will also remove any unique_id association with the shipment.

Authorizations:

ApiKeyAuth

path Parameters

shipment_id

required

string

The shipment ID to cancel.

Responses

Retrieve tracking events for a shipment.

Authorizations:

ApiKeyAuth

path Parameters

shipment_id

required

string

The shipment ID to retrieve details on.

Responses

Response samples

200

Content type

application/json

{"events": [{"type": "label-created",
"when": "string",
"where": {"city": "string",
"region": "string",
"country": "string"
},
"message": "string"
}
]
}

Get details on scheduling.

Authorizations:

ApiKeyAuth

path Parameters

shipment_id

required

string

The shipment ID to get the scheduling status.

Responses

Response samples

200

Content type

application/json

{"status": "pending",
"error": "string",
"pickup_confirmation_number": "string"
}

Schedule a dispatch or pickup.

Authorizations:

ApiKeyAuth

path Parameters

shipment_id

required

string

The shipment ID to schedule.

Request Body schema: application/json

	object (PickupDetails) Courier pickup details, required if courier service utilized.
	object (DispatchDetails) LTL dispatch details, required if dispatch service utilized.

Responses

Request samples

Payload

Content type

application/json

{"pickup_details": {"pre_scheduled_pickup": true,
"date": {"year": 2006,
"month": 6,
"day": 7
},
"ready_at": {"hour": 15,
"minute": 6
},
"ready_until": {"hour": 15,
"minute": 6
},
"pickup_location": "string",
"contact_name": "string",
"contact_phone_number": {"number": "5554447777",
"extension": "123"
}
},
"dispatch_details": {"date": {"year": 2006,
"month": 6,
"day": 7
},
"ready_at": {"hour": 15,
"minute": 6
},
"ready_until": {"hour": 15,
"minute": 6
}
}
}

Cancel a scheduling.

Authorizations:

ApiKeyAuth

path Parameters

shipment_id

required

string

The shipment ID to cancel scheduling for.

Responses

finance

Retrieve financial details.

Get the payment methods available for your account

Get the payment methods available for your account.

Authorizations:

ApiKeyAuth

Responses

Response samples

200

Content type

application/json

{"id": "string",
"type": "credit-card",
"label": "string"
}

Get a list of documents in a date range.

Authorizations:

ApiKeyAuth

query Parameters

start_date required	string Example: start_date=2021-07-01 The start date in UTC to search in.
end_date required	string Example: end_date=2021-07-31 The end date in UTC.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"type": "string",
"number": "string",
"date": {"year": 2006,
"month": 6,
"day": 7
},
"due_date": {"year": 2006,
"month": 6,
"day": 7
},
"amount": {"currency": "CAD",
"value": "4250"
},
"owing": {"currency": "CAD",
"value": "4250"
}
}

Get a particular document with details.

Authorizations:

ApiKeyAuth

path Parameters

document_id

required

string

The document to retrieve details on.

Responses

Response samples

200

Content type

application/json

{"id": "string",
"type": "string",
"number": "string",
"date": {"year": 2006,
"month": 6,
"day": 7
},
"due_date": {"year": 2006,
"month": 6,
"day": 7
},
"amount": {"currency": "CAD",
"value": "4250"
},
"owing": {"currency": "CAD",
"value": "4250"
},
"urls": { },
"payments": [{"id": "string",
"type": "string",
"amount": {"currency": "CAD",
"value": "4250"
},
"data": {"credit_card_auth": "string",
"credit_card_number": "string",
"credit_card_reference": "string"
}
}
],
"line_items": [{"id": "string",
"type": "base",
"sub_type": "string",
"payment_id": "string",
"amount": {"currency": "CAD",
"value": "4250"
},
"message": "string"
}
]
}

Get invoices for the shipment id

Authorizations:

ApiKeyAuth

path Parameters

shipment_id

required

string

The shipment id to retrieve invoices for.

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"type": "string",
"number": "string",
"date": {"year": 2006,
"month": 6,
"day": 7
},
"due_date": {"year": 2006,
"month": 6,
"day": 7
},
"amount": {"currency": "CAD",
"value": "4250"
},
"owing": {"currency": "CAD",
"value": "4250"
},
"urls": { },
"payments": [{"id": "string",
"type": "string",
"amount": {"currency": "CAD",
"value": "4250"
},
"data": {"credit_card_auth": "string",
"credit_card_number": "string",
"credit_card_reference": "string"
}
}
],
"line_items": [{"id": "string",
"type": "base",
"sub_type": "string",
"payment_id": "string",
"amount": {"currency": "CAD",
"value": "4250"
},
"message": "string"
}
]
}
]

Get invoices for the shipment transaction number

Authorizations:

ApiKeyAuth

path Parameters

transaction_number

required

string

The transaction number to retrieve invoices for.

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"type": "string",
"number": "string",
"date": {"year": 2006,
"month": 6,
"day": 7
},
"due_date": {"year": 2006,
"month": 6,
"day": 7
},
"amount": {"currency": "CAD",
"value": "4250"
},
"owing": {"currency": "CAD",
"value": "4250"
},
"urls": { },
"payments": [{"id": "string",
"type": "string",
"amount": {"currency": "CAD",
"value": "4250"
},
"data": {"credit_card_auth": "string",
"credit_card_number": "string",
"credit_card_reference": "string"
}
}
],
"line_items": [{"id": "string",
"type": "base",
"sub_type": "string",
"payment_id": "string",
"amount": {"currency": "CAD",
"value": "4250"
},
"message": "string"
}
]
}
]

service

Carrier service details.

Get the services available.

Authorizations:

ApiKeyAuth

Responses

Response samples

200

Content type

application/json

{"services": [{"id": "string",
"carrier_name": "string",
"service_name": "string"
}
]
}

manifest

Initiate a manifest request.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

carrier_id	string
	object Contains additional data that can be used to filter or limit the manifest request. Specific fields required depending upon the carrier.

Responses

Request samples

Payload

Content type

application/json

{"carrier_id": "string",
"manifest_data": {"tracking_numbers": ["string"
],
"manifest_date": {"year": 2006,
"month": 6,
"day": 7
},
"origin_postal_code": "string"
}
}

Response samples

202

Content type

application/json

{"request_id": "string"
}

Get the results of a manifest request.

Authorizations:

ApiKeyAuth

path Parameters

manifest_id

required

string

Responses

Response samples

200

Content type

application/json

{"url": "string"
}