SHshipium
ltl-shipment-cost

Retrieve the costs for a shipment using either LTL or parcel shipping.

Changed on
post/api/v1/ltl/shipment/costCompare

Request

Request body

businessDaysOfTransitinteger

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

currencyCodestring

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.

desiredDeliveryDatestring

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

existingShipmentIdsstring[]

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.

includeEvaluatedServiceMethodsInResponseboolean

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

includeLineItemsInEvaluatedServiceMethodsboolean

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

partnerLtlCostIdstring

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

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

tenantIdstring

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.

testModeboolean

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 with a comparison to using parcel shipping.

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.

Changes

  • 3edfc3693c7bRevision changes
    • warning

      deleted the header request parameter X-DELEGATED-PARTNER-ID

    • info

      added the new optional request property //////////

    • info

      added the new optional request property /////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property //

    • info

      added the new gal enum value to the request property ////////////

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status