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

URL Expired

The URL for this request expired after 30 days.

Schema

Carrier Information

• carrierId: string
  The carrier that was recommended for the LTL shipment.

Shipium LTL Cost IDs

• shipiumLtlCostIds: array of strings
  The Shipium-generated IDs of the LTL shipments.

Partner LTL Cost IDs

• partnerLtlCostIds: array of strings
  The partner-supplied IDs of the LTL shipments.

Origin and Destination Information

• originCountryCode: string
  The 2-character ISO 3166-1 alpha-2 country code where the shipment originated.
• originPostalCode: string
  The postal code where the shipment originated.
• destinationCountryCode: string
  The 2-character ISO 3166-1 alpha-2 country code where the shipment was delivered.
• destinationPostalCode: string
  The postal code where the shipment was delivered.

Tenant Information

• shipiumTenantId: string
  The Shipium-generated ID of the tenant associated with the LTL shipment.
• partnerTenantId: string
  The partner-supplied ID of the tenant associated with the LTL shipment.

Shipment Date Information

• fromCreateDateTime: date-time
  The earliest that the LTL shipment can have been created.
• toCreateDateTime: date-time
  The latest that the LTL shipment can have been created.
• fromPickupDate: 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.
• toPickupDate: 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.

Response Control

• 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).
• anchor: string
  Identifier for the current page of data.
• count: int32
  The number results to include on each page of the response.
• X-DELEGATED-PARTNER-ID: string

Response Example

200      LTL costs that match the parameters, with pagination.

Additional Information

• Updated 26 days ago
• Click Try It! to start a request and see the response here! Or choose an example:

Curl Example

curl --request GET \
     --url https://api.shipium.com/api/v1/ltl/shipment/costCompare \
     --header 'accept: application/json'