API Reference
Start typing to search…

Retrieve a single page of LTL costs, or LTL cost comparisons, that match the supplied parameters.

get
https://api.shipium.com/api/v1/ltl/shipment/costCompare
Query Params
string

The carrier that was recommended for the LTL shipment.

shipiumLtlCostIds
array of strings

The Shipium-generated IDs of the LTL shipments.

shipiumLtlCostIds
partnerLtlCostIds
array of strings

The partner-supplied IDs of the LTL shipments.

partnerLtlCostIds
string

The 2-character ISO 3166-1 alpha-2 country code where the shipment originated.

string

The postal code where the shipment originated.

string

The 2-character ISO 3166-1 alpha-2 country code where the shipment was delivered.

string

The postal code where the shipment was delivered.

string

The Shipium-generated ID of the tenant associated with the LTL shipment.

string

The partner-supplied ID of the tenant associated with the LTL shipment.

date-time

The earliest that the LTL shipment can have been created.

date-time

The latest that the LTL shipment can have been created.

date

The earliest that the LTL shipment can have been requested to be picked-up. This is based on what the client supplied in their request, not what the carrier returned.

date

The latest that the LTL shipment can have been requested to be picked-up.This is based on what the client supplied in their request, not what the carrier returned.

include
array of strings

All fields that should be included in the response. If this is not provided, all fields will be returned (other parameters may still filter fields).

include
string

Identifier for the current page of data.

int32

The number results to include on each page of the response

Headers
string
Response

Updated 5 months ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago