v1
latestOpenAPI 3.0.12026-07-2481208369.3 KBRetrieve the cost for a LTL shipment.
Headers
Request body
Indicates the number of business days from the ship time by when the shipment needs to be delivered.
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.
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
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.
When "true" a request will expand information on the response to include unselected carriers and service methods that made it through filtering.
When "true" a response will include line item information for the returned evaluated service methods, provided that includeEvaluatedServiceMethodsInResponse is also set to true.
An optional unique identifier that may be used for this LTL cost.
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.
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.
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.
Response
The estimated cost of the LTL shipment.
Shipium-generated unique id of the LTL cost, for later lookup.
An optional unique identifier that may be used for this LTL cost.
The partner provided tenant ID. When present, this is used to indicate the tenant associated with the LTL shipment.
The shipium generated tenant ID. When present, this is used to indicate the tenant associated with the LTL shipment.
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.
Whether using LTL or parcel shipping will be less expensive, and able to meet the request parameters.
The cost of using the recommended transportation type for this shipment.
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.
ISO-4217 currency code for all the rates for shipping.