Sign in

v1

latestOpenAPI 3.0.12026-07-2481208369.3 KB
ltl-shipment-cost

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

get/api/v1/ltl/shipment/cost

Query parameters

carrierIdstring

The carrier that was recommended for the LTL shipment.

shipiumLtlCostIdsstring[]

The Shipium-generated IDs of the LTL shipments.

partnerLtlCostIdsstring[]

The partner-supplied IDs of the LTL shipments.

originCountryCodestring

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

originPostalCodestring

The postal code where the shipment originated.

destinationCountryCodestring

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

destinationPostalCodestring

The postal code where the shipment was delivered.

shipiumTenantIdstring

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

partnerTenantIdstring

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

fromCreateDateTimestring date-time

The earliest that the LTL shipment can have been created.

toCreateDateTimestring date-time

The latest that the LTL shipment can have been created.

fromPickupDatestring 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.

toPickupDatestring 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.

includestring[]

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).

anchorstring

Identifier for the current page of data.

countinteger

The number results to include on each page of the response

Headers

X-DELEGATED-PARTNER-IDstring

Response

LTL costs that match the parameters, with pagination.

shipiumLtlCostIdstring required

Shipium-generated unique id of the LTL cost, for later lookup.

partnerLtlCostIdstring

An optional unique identifier that may be used for this LTL cost.

partnerTenantIdstring

The partner provided tenant ID. When present, this is used to indicate the tenant associated with the LTL shipment.

shipiumTenantIdstring

The shipium generated tenant ID. When present, this is used to indicate the tenant associated with the LTL shipment.

shipFromTimeZoneIdstring
destinationTimeZoneIdstring
rawDesiredDeliveryDatestring

The timestamp passed in by you (or your fulfillment partner) for the intended date the package will arrive to the customer. The timestamp must be a valid ISO 8601 timestamp.

recommendedTransportationType'ltlTransportation' | 'packageTransportation' required

Whether using LTL or parcel shipping will be less expensive, and able to meet the request parameters.

recommendedTransportationTypeCostnumber float required

The cost of using the recommended transportation type for this shipment.

testModeboolean required

Indicates that a testMode LTL cost and shipment will be created. LTL costing and package carrier selection will consider carriers and service methods in test mode, and label generation will generate a test label.

currencyCodestring

ISO-4217 currency code for all the rates for shipping.