Sign in

v1

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

Retrieve an existing LTL shipment cost or cost comparison.

get/api/v1/ltl/shipment/cost/{ltlCostId}

Path parameters

ltlCostIdstring required

Headers

X-DELEGATED-PARTNER-IDstring

Response

LTL Cost retrieved.

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.