Freightcom Customer API (2.5.1)

Download OpenAPI specification:Download

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.

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

Content type
application/json
{
  • "services": [
    ],
  • "excluded_services": [
    ],
  • "details": {
    }
}

Response samples

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

Content type
application/json
{
  • "status": {
    },
  • "rates": [
    ]
}

Calculate freight class

Calculate freight class for pallet dimensions.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
object (Box)

Responses

Request samples

Content type
application/json
{
  • "box": {
    }
}

Response samples

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

Content type
application/json
{
  • "unique_id": "string",
  • "payment_method_id": "string",
  • "service_id": "string",
  • "details": {
    },
  • "customs_invoice": {
    },
  • "pickup_details": {
    },
  • "dispatch_details": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "previously_created": true
}

Retrieve details on a shipment.

Retrieve details on a shipment.

Authorizations:
ApiKeyAuth
path Parameters
shipment_id
required
string

The shipment ID to retrieve details on.

Responses

Response samples

Content type
application/json
{
  • "shipment": {
    }
}

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.

Retrieve tracking events for a shipment.

Authorizations:
ApiKeyAuth
path Parameters
shipment_id
required
string

The shipment ID to retrieve details on.

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

Get details on scheduling.

Get details on scheduling.

Authorizations:
ApiKeyAuth
path Parameters
shipment_id
required
string

The shipment ID to get the scheduling status.

Responses

Response samples

Content type
application/json
{
  • "status": "pending",
  • "error": "string",
  • "pickup_confirmation_number": "string"
}

Schedule a dispatch or pickup.

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

Content type
application/json
{
  • "pickup_details": {
    },
  • "dispatch_details": {
    }
}

Cancel a scheduling.

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

Content type
application/json
{
  • "id": "string",
  • "type": "credit-card",
  • "label": "string"
}

Get a list of documents in a date range.

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

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "number": "string",
  • "date": {
    },
  • "due_date": {
    },
  • "amount": {
    },
  • "owing": {
    }
}

Get a particular document with details.

Get a particular document with details.

Authorizations:
ApiKeyAuth
path Parameters
document_id
required
string

The document to retrieve details on.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "number": "string",
  • "date": {
    },
  • "due_date": {
    },
  • "amount": {
    },
  • "owing": {
    },
  • "urls": { },
  • "payments": [
    ],
  • "line_items": [
    ]
}

Get invoices for the shipment id

Get invoices for the shipment id

Authorizations:
ApiKeyAuth
path Parameters
shipment_id
required
string

The shipment id to retrieve invoices for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get invoices for the shipment transaction number

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

Content type
application/json
[
  • {
    }
]

service

Carrier service details.

Get the services available.

Get the services available.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "services": [
    ]
}

manifest

Initiate a manifest request.

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

Content type
application/json
{
  • "carrier_id": "string",
  • "manifest_data": {
    }
}

Response samples

Content type
application/json
{
  • "request_id": "string"
}

Get the results of a manifest request.

Get the results of a manifest request.

Authorizations:
ApiKeyAuth
path Parameters
manifest_id
required
string

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}