API Reference

Retrieve the cost for a LTL shipment.

post
https://api.shipium.com/api/v1/ltl/shipment/cost
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32

Indicates the number of business days from the ship time by when the shipment needs to be delivered.

string

ISO-4217 currency code in which all the rates for shipping will be calculated and returned. This will override the value configured in the root level units object. If the root level units object is not provided, this field will be required.

string

The string representation of either an ISO-8601 date or a LocalDate: yyyy-mm-dd. The date or datetime the package is intended to arrive to the customer. This will be used to determine the most appropriate service method when generating a label

desiredDeliveryDateOptions
object

Options for how the system will use the desiredDeliveryDate

destinationAddress
object
required

Address details of the sold to party for customs purposes

existingShipmentIds
array of strings

The Shipium or partner shipment IDs that should be included in this LTL shipment. These must be IDs for shipments created using the /api/v1/deliveryexperience/shipment endpoint, or an equivalent endpoint. These cannot be LTL shipments, must have nmfcFreightClass configured, and must have the same ship from and destination addresses as this LTL shipment. This can be used in conjunction with shipments and/or packedShipments. At least one of existingShipmentIds, shipments, and packedShipments must not be empty or null.

existingShipmentIds
boolean
Defaults to false

When "true" a request will expand information on the response to include unselected carriers and service methods that made it through filtering.

boolean

When "true" a response will include line item information for the returned evaluated service methods, provided that includeEvaluatedServiceMethodsInResponse is also set to true.

ltlShipmentParameters
object
required

Request parameters that informed LTL costing and carrier selection.

packedShipments
array of objects

The already packed LTL shipments that should be included in this LTL shipment. Items in this list will only be used for LTL costing and will not have their packaging modified, nor be eligible for parcel carrier selection. Items in this list do not require corresponding Shipium shipments, nor will they create shipments. This can be used in conjunction with existingShipmentIds and/or shipments. At least one of existingShipmentIds, shipments, and packedShipments must not be empty or null.

packedShipments
string

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

returnToAddress
object

Address details of the sold to party for customs purposes

shipFromAddress
object
required

Address details of the sold to party for customs purposes

date-time

The timestamp for when you (or your fulfillment partner) shipped the product from your (or their) warehouse. The timestamp must be a valid ISO 8601 timestamp.

shipments
array of objects

The shipments that should be included in this LTL shipment. This can be used in conjunction with existingShipmentIds and/or packedShipments. At least one of existingShipmentIds, shipments, and packedShipments must not be empty or null.

shipments
string

Either the Shipium tenant ID or the partner-provided tenant ID that the shipment is for. If this is not supplied, the shipment will be associated with the partner, and only partner-wide fulfillment contexts will be considered.

boolean
Defaults to false

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

units
object

The units that all dimensions and currencies in the response are in, unless overridden in a narrower scope. If units was supplied in the request, this will use the same units.

Headers
string
Responses

Updated 6 months ago

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

Updated 6 months ago