--- updatedAt: 2026-06-11T22:02:16.000Z agentTools: projectIndex: https://docs.shipium.com/llms.txt --- # Retrieve an existing LTL shipment cost or cost comparison. # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Shipium API", "version": "1.0.0" }, "servers": [ { "url": "https://api.shipium.com", "description": "Generated server url" } ], "security": [ { "oauth2Scheme": [ "delivery-experience-service" ] } ], "paths": { "/api/v1/ltl/shipment/cost/{ltlCostId}": { "get": { "tags": [ "ltl-shipment-cost" ], "summary": "Retrieve an existing LTL shipment cost or cost comparison.", "operationId": "getLtlCostV1", "parameters": [ { "name": "ltlCostId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "X-DELEGATED-PARTNER-ID", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LTL Cost retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LtlCostResponse" } } } }, "404": { "description": "Unable to find LTL Cost", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LtlCostResponse" } } } } } } } }, "components": { "schemas": { "AddressLineComponents": { "type": "object", "properties": { "streetName": { "type": "string", "description": "The name of the street.", "example": "U.H. Fovisste Fuentes Brotantes" }, "primaryAddressNumber": { "type": "string", "description": "The primary, or external, address number.", "example": "12" }, "secondaryAddressNumber": { "type": "string", "description": "The secondary, or internal, address number.", "example": "302" }, "district": { "type": "string", "description": "The district, or municipality, for the address.", "example": "Iztacalco" }, "neighborhood": { "type": "string", "description": "The neighborhood for the address.", "example": "Agrícola Pantitlán" } }, "description": "The components extracted from street1 and street2" }, "CSAddress": { "required": [ "countryCode", "postalCode" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name associated with the address.", "example": "Wile E. Coyote" }, "phoneNumber": { "type": "string", "description": "Phone number of the contact." }, "phoneNumberCountryCode": { "type": "string", "description": "Phone Number Country Code of the contact.", "example": "+2" }, "emailAddress": { "type": "string", "description": "Email address of the contact." }, "company": { "type": "string", "description": "The company name for the address.", "example": "ACME" }, "street1": { "type": "string", "description": "The first address line.", "example": "123 Main St." }, "street2": { "type": "string", "description": "The second address line.", "example": "Suite 42" }, "city": { "type": "string", "description": "The name of the city for the address.", "example": "Albuquerque" }, "state": { "type": "string", "description": "The name of the state for the address.", "example": "NM" }, "countryCode": { "type": "string", "description": "The ISO 3166-1 country code for the address.", "example": "US" }, "postalCode": { "type": "string", "description": "A countryCode-appropriate postal code for the address.", "example": "\"87121\"" }, "addressType": { "type": "string", "description": "The type of location for this address.", "example": "commercial", "enum": [ "commercial", "residential" ] }, "addressLineComponents": { "$ref": "#/components/schemas/AddressLineComponents" } }, "description": "Address details of the sold to party for customs purposes" }, "CubicVolume": { "type": "object", "properties": { "cubicVolumeUnit": { "type": "string", "description": "The unit for the cubic volume", "example": "ft", "enum": [ "in", "ft", "cm", "m" ] }, "cubicVolume": { "type": "number", "description": "The value of the cubic volume.", "format": "float", "example": 0.8 } }, "description": "Cubic volume that was used to generate the rate" }, "LaneMatch": { "type": "object", "properties": { "laneId": { "type": "string", "description": "The laneId that was matched on and used.", "example": "asdqwdq-qwd123ds-123asdwd-123asd" }, "partnerLaneId": { "type": "string", "description": "The lane sort match name that was configured on the lane.", "example": "custom partner provided id" } }, "description": "The matched lane for the carrier that was selected. This will be empty if nothing is configured for lanes." }, "Tip": { "type": "object", "properties": { "type": { "type": "string", "description": "Define the type of tip", "example": "FIXED", "enum": [ "FIXED", "PERCENTAGE" ] }, "value": { "type": "number", "description": "Fix amount or percentage value for the tip", "format": "float" }, "currency": { "type": "string" } }, "description": "Field passed to carriers like Uber to specify the tip" }, "Weight": { "type": "object", "properties": { "weightUnit": { "type": "string", "description": "The unit that weight values are provided in. g for grams kg for kilograms oz for ounces lb for pounds", "example": "lb", "enum": [ "g", "kg", "oz", "lb" ] }, "weight": { "type": "number", "description": "The value of the weight.", "format": "float", "example": 50 } }, "description": "The weight of this type of packaging empty." }, "InjectionParameter": { "type": "object", "properties": { "injectionProfileId": { "type": "string", "description": "The shipium ID or the partner-provided ID of an InjectionProfile that should be considered during carrier selection." }, "injectionSiteId": { "type": "string", "description": "The shipium ID or the partner-provided ID of an InjectionSite that should be considered during carrier selection. If an injectionSiteId is specified, it must be accompanied by an injectionProfileId" } }, "description": "A list of Injection Profile and/or Injection Profile/Site tuples that should be considered during carrier selection. If an InjectionSite is specified, it must be accompanied by an InjectionProfile" }, "LastMileDeliveryOptions": { "type": "object", "properties": { "deliveryInstruction": { "type": "string", "description": "Instructions passed to the carrier on how to handle on delivery.", "enum": [ "LEAVE_AT_DOOR", "MEET_AT_DOOR" ] }, "undeliverableInstruction": { "type": "string", "description": "Instructions passed to the carrier on how to handle packages that go undelivered", "enum": [ "LEAVE_AT_DOOR", "RETURN", "DESTROY" ] }, "tip": { "$ref": "#/components/schemas/Tip" }, "tipForLabelCreate": { "$ref": "#/components/schemas/Tip" }, "deliverableActionForLabelCreate": { "type": "string", "enum": [ "RETURN", "LEAVE_AT_DOOR", "DISCARD", "MEET_AT_DOOR" ] }, "undeliverableActionForLabelCreate": { "type": "string", "enum": [ "RETURN", "LEAVE_AT_DOOR", "DISCARD", "MEET_AT_DOOR" ] } }, "description": "A collection of fields used for instructing carriers on how to handle last mile delivery." }, "TimeWindow": { "required": [ "endWindow", "startWindow" ], "type": "object", "properties": { "startWindow": { "type": "string", "description": "A time without any date or timezone", "example": "10:15:30" }, "endWindow": { "type": "string", "description": "A time without any date or timezone", "example": "10:15:30" }, "timeZone": { "type": "string" } }, "description": "A string passed to carriers for a delivery window." }, "CarrierSelectionExpansion": { "type": "object", "properties": { "carrier": { "type": "string", "description": "The carrier that was used for delivering the package to your customer." }, "carrierServiceMethodId": { "type": "string", "description": "carrier service method id for the service method." }, "serviceMethodName": { "type": "string", "description": "Name of the carrier service method selected during the carrier selection process." }, "carrierAccountId": { "type": "string", "description": "Unique id of the carrier account selected for shipping." }, "totalCost": { "type": "number", "description": "Cost used for carrier selection.", "format": "float" }, "estimatedDeliveryDate": { "type": "string", "description": "The estimated date that the shipment will arrive at its destinations.", "format": "date-time" }, "injectionDetails": { "$ref": "#/components/schemas/InjectionDetails" }, "rateCurrency": { "type": "string", "description": "The currency that the rate is in, which also applies to line items.", "example": "usd" }, "lineItems": { "type": "array", "description": "List of rate modifications that were used to calculate the rate", "items": { "$ref": "#/components/schemas/RateLineItem" } }, "estimatedDeliveryDateLocal": { "type": "string", "description": "A ISO-8601 date-time without a time-zone", "example": "2007-12-03T10:15:30" } }, "description": "An optional expansion of what carrier service methods were eligible but went unselected." }, "CarrierSelectionSummary": { "type": "object", "properties": { "status": { "type": "string", "description": "Defines the result of the carrier selection call. Values returned will be success, or no_decision", "enum": [ "success", "uncosted", "no_decision" ] }, "statusDetails": { "type": "string", "description": "Details explaining the result status. Pertinent when the status is \"no_decision\"." }, "carrierSelectionId": { "type": "string", "description": "Unique id of the carrier selection for later lookup." }, "shipiumShipmentId": { "type": "string", "description": "The unique identifier for this shipment." }, "partnerShipmentId": { "type": "string", "description": "The optional unique identifier that may be used for this shipment." }, "partnerId": { "type": "string", "description": "Unique id of the partner." }, "carrierAccountId": { "type": "string", "description": "Unique id of the carrier account selected for shipping." }, "serviceMethodUrn": { "type": "string", "description": "Specific version of the service level of the shipping carrier selected" }, "serviceMethodIdentifier": { "type": "string", "description": "Identifier of the specific version of the service method of the shipping carrier selected" }, "carrier": { "type": "string", "description": "The carrier that was used for delivering the package to your customer." }, "carrierServiceMethodId": { "type": "string", "description": "Maps to the unique internal Shipium ID which represents a carrier service method definition." }, "serviceMethodName": { "type": "string", "description": "Name of the carrier service method selected during the carrier selection process." }, "costAdjustConfigId": { "type": "string", "description": "If specified, this is the dynamic costing config applied for the carrier selection" }, "totalCost": { "type": "number", "description": "Cost used for carrier selection.", "format": "float" }, "carrierCompareCost": { "type": "number", "description": "Expected cost from the carrier label create.", "format": "float" }, "carrierInvoiceCost": { "type": "number", "description": "Expected cost that carrier will charge at billing time.", "format": "float" }, "operationalCost": { "type": "number", "description": "Carrier invoice cost plus operational costs like injection line haul.", "format": "float", "example": 2.7 }, "thirdPartyBilling": { "type": "boolean", "description": "Indicates if the selected service method will be billed to a third party." }, "carrierSelectionDateTime": { "type": "string", "description": "ISO-8601 formatted date when the carrier selection decision was made.", "format": "date-time" }, "injectionDetails": { "$ref": "#/components/schemas/InjectionSummary" }, "carrierZoneId": { "type": "string", "description": "The carrier zone that is being considered." }, "calculatedBillableWeight": { "$ref": "#/components/schemas/Weight" }, "calculatedBillableCubicVolume": { "$ref": "#/components/schemas/CubicVolume" }, "laneMatch": { "$ref": "#/components/schemas/LaneMatch" }, "evaluatedServiceMethods": { "type": "array", "description": "An optional expansion of what carrier service methods were eligible but went unselected.", "items": { "$ref": "#/components/schemas/CarrierSelectionExpansion" } }, "cancellationDateTime": { "type": "string", "description": "The timestamp for when a carrier selection was cancelled. This field will default to null when the carrier selection is not cancelled. A carrier selection cannot be cancelled if it is associated with an active label", "format": "date-time", "example": "2024-10-31T10:50:11.123456Z" }, "effectiveShipDateTime": { "type": "string", "description": "Shipium's calculation for the effective ship date time that a shipment will ship out. This date time will be used for the carrier label and for limits.", "format": "date-time" }, "currencyCode": { "type": "string", "description": "Currency in which all the rates for shipping carrier selection costs were calculated in.", "example": "USD" } }, "description": "If shipment has had the carrier selection process run, this is the summary info and link to the more detailed summary." }, "InjectionCostDetails": { "type": "object", "properties": { "injectionLineItemRate": { "type": "number", "description": "The amount of the rate modification", "format": "float", "example": 2.3 }, "injectionLineItemCurrencyCode": { "type": "string", "description": "The currency that the rate is in.", "example": "usd" }, "injectionRateModifier": { "$ref": "#/components/schemas/InjectionRateModifier" } }, "description": "Injection cost details" }, "InjectionDetails": { "type": "object", "properties": { "requestInjectionProfileId": { "type": "string", "description": "The partner can provide either partnerInjectionProfileId or shipiumInjectionProfileId in the request and this attribute records / indicates the injectionProfile identifier provided by the partner in the request." }, "partnerInjectionProfileId": { "type": "string", "description": "Unique to the partner asset ID that is provided by the partner to the injectionProfile." }, "shipiumInjectionProfileId": { "type": "string", "description": "InjectionProfile identifier." }, "requestInjectionSiteId": { "type": "string", "description": "The partner can provide either partnerInjectionSiteId or shipiumInjectionSiteId in the request and this attribute records / indicates the injectionSite identifier provided by the partner in the request." }, "partnerInjectionSiteId": { "type": "string", "description": "Unique to the partner asset ID that is provided by the partner to the injectionSite." }, "shipiumInjectionSiteId": { "type": "string", "description": "InjectionSite identifier" }, "injectionCostDetails": { "$ref": "#/components/schemas/InjectionCostDetails" } }, "description": "InjectionProfile and InjectionSite details" }, "InjectionRateModifier": { "type": "object", "properties": { "modifierType": { "type": "string", "description": "The type of the injection rate modifier.", "enum": [ "flat", "percentage" ] }, "modifierValue": { "type": "number", "description": "The value of the modification.", "format": "float" } }, "description": "The RateModifier to be applied if the service method is for Injection" }, "InjectionSummary": { "type": "object", "properties": { "requestInjectionProfileId": { "type": "string", "description": "The partner can provide either partnerInjectionProfileId or shipiumInjectionProfileId in the request and this attribute records / indicates the injectionProfile identifier provided by the partner in the request." }, "partnerInjectionProfileId": { "type": "string", "description": "Unique to the partner asset ID that is provided by the partner to the injectionProfile." }, "shipiumInjectionProfileId": { "type": "string", "description": "InjectionProfile identifier." }, "requestInjectionSiteId": { "type": "string", "description": "The partner can provide either partnerInjectionSiteId or shipiumInjectionSiteId in the request and this attribute records / indicates the injectionProfile address provided by the partner in the request." }, "partnerInjectionSiteId": { "type": "string", "description": "Unique to the partner asset ID that is provided by the partner to the injectionSite." }, "shipiumInjectionSiteId": { "type": "string", "description": "InjectionSite identifier" } }, "description": "InjectionProfile and InjectionSite details" }, "RateLineItem": { "required": [ "name", "rate" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the rate modification", "example": "base" }, "rate": { "type": "number", "description": "The amount of the rate modification", "format": "float", "example": 2.3 }, "carrierSurchargeId": { "type": "string", "description": "The identifier for the carrier surcharge", "example": "123451239874980" }, "surchargeType": { "type": "string", "description": "The type of surcharge for this item. Null value for non-surcharges", "example": "extended_delivery_residential_ground", "deprecated": true, "enum": [ "additional_handling_weight", "additional_handling_volume", "additional_handling_length", "additional_handling_extra_length", "additional_handling_width", "additional_handling_packaging", "alaska_delivery_commercial_air", "alaska_delivery_commercial_ground", "alaska_delivery_residential_air", "alaska_delivery_residential_ground", "base", "delivery_commercial_air", "delivery_commercial_ground", "delivery_residential_air", "delivery_residential_ground", "extended_delivery_commercial_air", "extended_delivery_commercial_ground", "extended_delivery_residential_air", "extended_delivery_residential_ground", "fuel_air_domestic", "fuel_air_international_export", "fuel_air_international_import", "fuel_ground", "hawaii_delivery_commercial_air", "hawaii_delivery_commercial_ground", "hawaii_delivery_residential_air", "hawaii_delivery_residential_ground", "hazmat", "incentive", "international_delivery_area", "international_extended_delivery_area", "large_package_commercial", "large_package_residential", "peak", "peak_additional_handling", "peak_residential_delivery_air", "peak_residential_delivery_ground", "peak_large_package", "remote_delivery_commercial_air", "remote_delivery_commercial_ground", "remote_delivery_residential_air", "remote_delivery_residential_ground", "residential_air", "residential_ground", "saturday_delivery", "signature", "signature_resident", "signature_adult", "signature_adult_resident", "surcharge", "zone_weight" ] }, "lineItemType": { "type": "string", "description": "The type of rate line item for this rate modification", "example": "surcharge" }, "hiddenFromCarrierCompare": { "type": "boolean", "description": "Indicates line item exclusion from the `carrierCompareCost`." }, "hiddenFromInvoice": { "type": "boolean", "description": "Indicates line item exclusion from the `carrierInvoiceCost`." }, "hiddenFromOperational": { "type": "boolean", "description": "Indicates line item exclusion in the `operationalCost`." } }, "description": "List of summaries of the rate modifications that were used to calculate the rate" }, "CurrencyAmount": { "required": [ "amount" ], "type": "object", "properties": { "amount": { "type": "number", "description": "The amount of money.", "format": "float", "example": 12.34 }, "currency": { "type": "string", "description": "The ISO-4217 currency code that the amount is in. This is required unless a default currency unit is supplied elsewhere. If this and a default are both supplied, this will take priority.", "example": "USD" } }, "description": "The amount that should be paid by the recipient upon delivery of the package." }, "LoadPackagingDetails": { "required": [ "loadPackagingSize", "nmfcFreightClass" ], "type": "object", "properties": { "declaredValue": { "$ref": "#/components/schemas/CurrencyAmount" }, "loadPackagingType": { "type": "string", "description": "How the parcels in the load are packaged together.", "example": "overboxed", "default": "pallet", "enum": [ "loose", "overboxed", "piece", "wrapped", "pallet" ] }, "loadPackagingSize": { "$ref": "#/components/schemas/LoadPackagingSize" }, "nmfcFreightClass": { "type": "string", "description": "A string representing the broad class of products being shipped in this load. This should be the largest (i.e. 51 > 50) NMFC class of any of the products in the load. For example, both bricks and steel pipes have a NMFC class of `50`", "externalDocs": { "url": "https://nmfta.org/nmfc/" } } }, "description": "The already packed LTL shipments that should be included in this LTL shipment. Items in this list are used for LTL costing and do not have their packaging modified, nor are eligible for package carrier selection. Items in this list do not have corresponding Shipium shipments." }, "LoadPackagingDetailsRequest": { "required": [ "loadPackagingSize" ], "type": "object", "properties": { "loadPackagingType": { "type": "string", "description": "How the parcels in the load will be packaged together.", "example": "overboxed", "default": "pallet", "enum": [ "loose", "overboxed", "piece", "wrapped", "pallet" ] }, "loadPackagingSize": { "$ref": "#/components/schemas/LoadPackagingSizeRequest" } }, "description": "How the LTL shipment can be packaged. This is required if there are any existingShipmentIds or shipments in the LtlCostRequest." }, "LoadPackagingSize": { "required": [ "height", "length", "weight", "width" ], "type": "object", "properties": { "height": { "type": "number", "description": "The height that parcels are stacked within the packaging.", "format": "float", "example": 84 }, "length": { "type": "number", "description": "The longer horizontal dimension that parcels occupy within the packaging.", "format": "float", "example": 48 }, "linearUnit": { "type": "string", "description": "The unit of measure for linear dimensions (length, width, height). 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.", "example": "in", "enum": [ "in", "cm" ] }, "weight": { "type": "number", "description": "The total weight of parcels within the packaging.", "format": "float", "example": 850.25 }, "weightUnit": { "type": "string", "description": "The unit of measure for weight of parcels within the packaging. 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.", "example": "lb", "enum": [ "g", "kg", "oz", "lb" ] }, "width": { "type": "number", "description": "The shorter horizontal dimension that parcels occupy within the packaging.", "format": "float", "example": 40 } }, "description": "Dimensions for packaging containing the parcels." }, "LoadPackagingSizeRequest": { "required": [ "height", "length", "width" ], "type": "object", "properties": { "height": { "type": "number", "description": "The maximum height that parcels can be stacked within the packaging.", "format": "float", "example": 84 }, "length": { "type": "number", "description": "The longer horizontal dimension that parcels can occupy within the packaging.", "format": "float", "example": 48 }, "linearUnit": { "type": "string", "description": "The unit of measure for linear dimensions (length, width, height). 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.", "example": "in", "enum": [ "in", "cm" ] }, "maximumWeight": { "type": "number", "description": "The maximum weight of parcels within the packaging. If not specified, no maximum weight will be used when determining how to pack parcels.", "format": "float", "example": 850.25 }, "packagingWeight": { "type": "number", "description": "The weight of the packaging without any parcels.", "format": "float", "example": 10.125 }, "weightUnit": { "type": "string", "description": "The unit of measure for maximum weight of parcels within the packaging, and the packaging itself. 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.", "example": "lb", "enum": [ "g", "kg", "oz", "lb" ] }, "width": { "type": "number", "description": "The shorter horizontal dimension that parcels can occupy within the packaging.", "format": "float", "example": 40 } }, "description": "Dimensions for packaging containing the parcels, used to estimate how parcels could be packed together." }, "LtlBillToContact": { "required": [ "countryCode", "postalCode", "thirdPartyBillingSetId" ], "type": "object", "properties": { "addressLineComponents": { "$ref": "#/components/schemas/AddressLineComponents" }, "addressType": { "type": "string", "description": "The type of location for this address.", "example": "commercial", "enum": [ "commercial", "residential" ] }, "city": { "type": "string", "description": "The name of the city for the address.", "example": "Albuquerque" }, "company": { "type": "string", "description": "The company name for the address.", "example": "ACME" }, "countryCode": { "type": "string", "description": "The ISO 3166-1 country code for the address.", "example": "US" }, "emailAddress": { "type": "string", "description": "Email address of the contact." }, "name": { "type": "string", "description": "The name associated with the address.", "example": "Wile E. Coyote" }, "phoneNumber": { "type": "string", "description": "Phone number of the contact." }, "phoneNumberCountryCode": { "type": "string", "description": "Phone Number Country Code of the contact.", "example": "+2" }, "postalCode": { "type": "string", "description": "A countryCode-appropriate postal code for the address.", "example": "\"87121\"" }, "state": { "type": "string", "description": "The name of the state for the address.", "example": "NM" }, "street1": { "type": "string", "description": "The first address line.", "example": "123 Main St." }, "street2": { "type": "string", "description": "The second address line.", "example": "Suite 42" }, "thirdPartyBillingSetId": { "type": "string", "description": "Either the Shipium-generated or the partner-provided third party billing set ID. Used to look up the account number each LTL carrier uses to determine pricing agreement." } }, "description": "Whom should be billed for the LTL shipment. By default, the carrier contracts in the fulfillment context will be used for billing." }, "LtlHazmatContact": { "required": [ "contactName", "phoneNumber" ], "type": "object", "properties": { "contactName": { "type": "string", "description": "Name of the contact." }, "phoneNumber": { "type": "string", "description": "Phone number of the contact." }, "phoneNumberCountryCode": { "type": "string", "description": "Optional country code for the phone number of the contact." }, "email": { "type": "string", "description": "Email address of the contact." } }, "description": "Who the carrier should contact if they have a question regarding hazmat in the shipment. If this is not supplied, and their are hazardous materials in the shipment, the contact information in either the `shipFromAddress`, or the Fulfillment Context's Origin, will be used for this purpose." }, "LtlPaymentDetails": { "required": [ "payerType", "paymentTerms" ], "type": "object", "properties": { "payerType": { "type": "string", "description": "Who is paying the carrier to deliver the shipment.", "enum": [ "consignee", "shipper", "thirdParty" ] }, "paymentTerms": { "type": "string", "description": "How the shipment is being paid for.", "enum": [ "collect", "prePaid", "thirdParty" ] } }, "description": "How the LTL shipment will be paid for." }, "LtlShipmentParameters": { "required": [ "paymentDetails", "pickupDate" ], "type": "object", "properties": { "billToContact": { "$ref": "#/components/schemas/LtlBillToContact" }, "carrierServiceMethodAllowList": { "type": "array", "description": "A list of carrierServiceMethodIds, and/or SCAC codes, and/or carriers that should be considered for LTL carrier selection.", "items": { "type": "string", "description": "A list of carrierServiceMethodIds, and/or SCAC codes, and/or carriers that should be considered for LTL carrier selection." } }, "collectOnDelivery": { "$ref": "#/components/schemas/CurrencyAmount" }, "fulfillmentContextIds": { "type": "array", "description": "A collection of Shipium generated IDs or partner provided aliases for the fulfillment context that are eligible to be used for LTL carrier selection.There must be exactly one fulfillment context that can ship from the origin to the destination, for the specified tenant, regardless of whether or not this list is populated.", "items": { "type": "string", "description": "A collection of Shipium generated IDs or partner provided aliases for the fulfillment context that are eligible to be used for LTL carrier selection.There must be exactly one fulfillment context that can ship from the origin to the destination, for the specified tenant, regardless of whether or not this list is populated." } }, "originId": { "type": "string", "description": "A shipiumOriginId or partnerOriginId to identify which originthe shipment will be processed at." }, "fulfillmentType": { "type": "string", "description": "Fulfillment methodology of the shipment.", "default": "customer", "enum": [ "customer", "at_large", "returns", "hundredweight", "reship", "unknown" ] }, "hazmatContact": { "$ref": "#/components/schemas/LtlHazmatContact" }, "packagingOptions": { "type": "array", "description": "How the LTL shipment can be packaged. This is required if there are any existingShipmentIds or shipments in the LtlCostRequest.", "items": { "$ref": "#/components/schemas/LoadPackagingDetailsRequest" } }, "paymentDetails": { "$ref": "#/components/schemas/LtlPaymentDetails" }, "pickupDate": { "type": "string", "description": "Date when LTL shipment will be picked up by the carrier.", "format": "date", "example": "1970-12-31" }, "pricingTypes": { "type": "array", "description": "The pricing types that should be eligible for LTL carrier selection.", "items": { "type": "string", "description": "The pricing types that should be eligible for LTL carrier selection.", "enum": [ "all", "contract", "contractPallet", "dynamic", "volume", "unknown" ] } }, "serviceLevels": { "type": "array", "description": "The time-definite delivery options that should be eligible for LTL carrier selection.", "items": { "type": "string", "description": "The time-definite delivery options that should be eligible for LTL carrier selection.", "enum": [ "all", "guaranteedMorning", "guaranteedNoon", "guaranteedEndOfDay", "standard", "unknown" ] } }, "accessorialCodes": { "type": "array", "description": "A list of codes representing the accessorial codes applicable for the shipment.", "items": { "type": "string", "description": "AIRD = Airport Delivery, AIRP = Airport Pickup, APTD = Appointment Required at Delivery, APTP = Appointment Required at Pickup, CFSD = Container Freight Station Delivery, CFSP = Container Freight Station Pickup, COD = Collect on Delivery, FSC = Fuel Surcharge, GTD = Guaranteed Service, HAZ = Hazardous Material, HCDA = High Cost Delivery Area, HCPA = High Cost Pickup Area, INS = Additional Insurance Excess Value, LTDAD = Limited Access Delivery, LTDAP = Limited Access Pickup, MISC = Miscellaneous Charge, MNC = Must Notify Consignee, OVR = Over Dimension or Excessive Length, PPD = Perishables Food, PSN = Poisonous Material, REP = Residential Pickup, RES = Residential Delivery, SLTDAD = Secured Limited Access Delivery, SLTDAP = Secured Limited Access Pickup, SS = Single Shipment, WGDL = White Glove Delivery, WGDU = White Glove Pickup", "enum": [ "AIRD", "AIRP", "APTD", "APTP", "CFSD", "CFSP", "COD", "FSC", "GTD", "HAZ", "HCDA", "HCPA", "INS", "LTDAD", "LTDAP", "MISC", "MNC", "OVR", "PPD", "PSN", "REP", "RES", "SLTDAD", "SLTDAP", "SS", "WGDL", "WGDU" ] } } }, "description": "Request parameters that informed LTL costing and carrier selection." }, "Units": { "required": [ "currencyCode", "linearUnit", "weightUnit" ], "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The ISO-4217 currency code that monetary amounts are represented in.", "example": "USD" }, "linearUnit": { "type": "string", "description": "The unit that linear dimensions are represented in.", "example": "in", "enum": [ "in", "cm" ] }, "weightUnit": { "type": "string", "description": "The unit that the weights are represented in.", "example": "lb", "enum": [ "g", "kg", "oz", "lb" ] } }, "description": "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." }, "LtlCarrierCost": { "required": [ "billableWeight", "carrier", "carrierServiceMethodId", "scacCode", "serviceLevel" ], "type": "object", "properties": { "billableWeight": { "$ref": "#/components/schemas/Weight" }, "billToThirdPartyId": { "type": "string", "description": "Either the Shipium-generated or the partner-provided third party billing ID. Used to look up the account number each LTL carrier uses to determine pricing agreement." }, "carrier": { "type": "string", "description": "The carrier who provided this quote." }, "carrierAccountId": { "type": "string", "description": "Unique id of the carrier account used for this cost." }, "carrierServiceMethodId": { "type": "string", "description": "The carrier's service method that would be used for transporting the load in this quote." }, "estimatedDeliveryDate": { "type": "string", "description": "The carrier's estimate for when the load will be delivered. This will be missing if the carrier service method does not meet the request's requirements.", "format": "date-time" }, "lineItems": { "type": "array", "description": "The components of the carrier's cost estimate. This will be missing or empty if the carrier service method does not meet the request's requirements, or the carrier does not return the costing details. Requires `includeLineItemsInEvaluatedServiceMethods` to be true in the request.", "items": { "$ref": "#/components/schemas/LtlRateLineItem" } }, "loadDeficitCost": { "$ref": "#/components/schemas/LtlLoadDeficitCost" }, "pickupDateTime": { "type": "string", "description": "When the carrier can pick up the shipment. Some carriers may specify an exact time, whereas others will only specify the date and leave the time as 00:00:00.000", "format": "date-time" }, "pricingType": { "type": "string", "description": "The pricing type used by the carrier for this quote.", "enum": [ "all", "contract", "contractPallet", "dynamic", "volume", "unknown" ] }, "quoteId": { "type": "string", "description": "The carrier-provided identifier for the quote." }, "quoteEffectiveDateTime": { "type": "string", "description": "When the carrier's quote is valid until.", "format": "date-time" }, "quoteExpirationDateTime": { "type": "string", "description": "When the carrier's quote is valid until.", "format": "date-time" }, "scacCode": { "type": "string", "description": "The SCAC code for the carrier and service method." }, "serviceLevel": { "type": "string", "description": "The service level, or time-definite delivery option, that will be used by the carrier.", "default": "standard", "enum": [ "all", "guaranteedMorning", "guaranteedNoon", "guaranteedEndOfDay", "standard", "unknown" ] }, "totalCost": { "type": "number", "description": "The quoted cost of the shipment.", "format": "float" } }, "description": "Information about the selected carrier." }, "LtlCarrierSelection": { "required": [ "loadPackaging" ], "type": "object", "properties": { "loadPackaging": { "type": "array", "description": "How the parcels in the LTL shipment are packaged or should be packaged.", "items": { "$ref": "#/components/schemas/LtlLoadPackagingRecommendation" } }, "evaluatedCarriers": { "type": "array", "description": "Information about the other carriers considered, but rejected because they either: cannot meet the desired delivery date, cannot carry the shipment, cannot pick up the shipment on the requested date, or cost more than the selected carrier. Requires `includeEvaluatedServiceMethodsInResponse` to be true in the request.", "items": { "$ref": "#/components/schemas/LtlCarrierCost" } }, "selectedCarrier": { "$ref": "#/components/schemas/LtlCarrierCost" }, "totalCost": { "type": "number", "description": "The least expensive quoted cost of the shipment, using LTL. This will be zero in case no carrier could be selected", "format": "float" } }, "description": "The costing details of using LTL to transport this shipment." }, "LtlCostResponse": { "required": [ "allTransportationTypeCosts", "destinationAddress", "ltlCostDetails", "ltlShipmentParameters", "recommendedTransportationType", "recommendedTransportationTypeCost", "shipFromAddress", "shipiumLtlCostId", "testMode" ], "type": "object", "properties": { "shipiumLtlCostId": { "type": "string", "description": "Shipium-generated unique id of the LTL cost, for later lookup." }, "partnerLtlCostId": { "type": "string", "description": "An optional unique identifier that may be used for this LTL cost.", "example": "myCustomPartnerLTLShipmentId123" }, "partnerTenantId": { "type": "string", "description": "The partner provided tenant ID. When present, this is used to indicate the tenant associated with the LTL shipment." }, "shipiumTenantId": { "type": "string", "description": "The shipium generated tenant ID. When present, this is used to indicate the tenant associated with the LTL shipment." }, "shipFromAddress": { "$ref": "#/components/schemas/CSAddress" }, "shipFromTimeZoneId": { "type": "string" }, "destinationAddress": { "$ref": "#/components/schemas/CSAddress" }, "destinationTimeZoneId": { "type": "string" }, "returnToAddress": { "$ref": "#/components/schemas/CSAddress" }, "rawDesiredDeliveryDate": { "type": "string", "description": "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.", "example": "2019-10-31T10:50:11.123456Z" }, "recommendedTransportationType": { "type": "string", "description": "Whether using LTL or parcel shipping will be less expensive, and able to meet the request parameters.", "enum": [ "ltlTransportation", "packageTransportation" ] }, "recommendedTransportationTypeCost": { "type": "number", "description": "The cost of using the recommended transportation type for this shipment.", "format": "float" }, "testMode": { "type": "boolean", "description": "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." }, "currencyCode": { "type": "string", "description": "ISO-4217 currency code for all the rates for shipping.", "example": "USD" }, "units": { "$ref": "#/components/schemas/Units" }, "allTransportationTypeCosts": { "type": "array", "description": "The cost of all transportation types considered by costing. Sorted from least expensive to most expensive.", "items": { "$ref": "#/components/schemas/LtlCostSummary" } }, "ltlCostDetails": { "$ref": "#/components/schemas/LtlCarrierSelection" }, "ltlShipmentParameters": { "$ref": "#/components/schemas/LtlShipmentParameters" }, "packageCostDetails": { "$ref": "#/components/schemas/LtlParcelCarrierSelection" }, "packageShipmentParameters": { "$ref": "#/components/schemas/LtlParcelShipmentParameters" }, "packedShipments": { "type": "array", "description": "The already packed LTL shipments that should be included in this LTL shipment. Items in this list are used for LTL costing and do not have their packaging modified, nor are eligible for package carrier selection. Items in this list do not have corresponding Shipium shipments.", "items": { "$ref": "#/components/schemas/LoadPackagingDetails" } }, "shipments": { "type": "array", "description": "The shipment ids of all package shipments in this LTL shipment.", "items": { "$ref": "#/components/schemas/LtlShipmentItemSummary" } } } }, "LtlCostSummary": { "required": [ "transportationType", "transportationTypeCost" ], "type": "object", "properties": { "transportationType": { "type": "string", "description": "The transportation type used for this cost estimate.", "enum": [ "ltlTransportation", "packageTransportation" ] }, "transportationTypeCost": { "type": "number", "description": "The cost of using this transportation type for the shipment. {This will be zero if no carrier could be found for this shipment.", "format": "float" } }, "description": "The cost of all transportation types considered by costing. Sorted from least expensive to most expensive." }, "LtlLoadDeficitCost": { "required": [ "amount", "rate", "weight" ], "type": "object", "properties": { "amount": { "type": "number", "description": "The difference in cost between the current shipment and a shipment at the optimal weight.", "format": "float" }, "nmfcClass": { "type": "string", "description": "The NMFC class of product being shipped. For example, both bricks and steel pipes have a NMFC class of `50`", "externalDocs": { "url": "https://nmfta.org/nmfc/" } }, "weight": { "$ref": "#/components/schemas/Weight" }, "rate": { "type": "number", "description": "The best rate (e.g. cost per hundredweight) for a shipment at or above the shipment's weight.", "format": "float" } }, "description": "If the LTL carrier has a cheaper rate that would require adding weight to the load, this contains the details about the amount of weight needed and the cheaper rate." }, "LtlLoadPackagingItem": { "type": "object", "properties": { "partnerShipmentId": { "type": "string", "description": "An optional unique identifier that may be used for this shipment.", "example": "myCustomPartnerShipmentId123" }, "shipiumShipmentId": { "type": "string", "description": "The Shipium-generated unique identifier for this shipment.", "readOnly": true, "example": "7bfef4f3-9e5e-4637-9213-5934f9f104e6" }, "packageReferenceIdentifier": { "type": "string", "description": "Used to differentiate parcels in a multiparcel shipment. Required when the shipment is multiparcel." } }, "description": "The shipments that are included in this load. This will be empty or null if this corresponds to a item in `packedShipments` in the request." }, "LtlLoadPackagingRecommendation": { "required": [ "details" ], "type": "object", "properties": { "details": { "$ref": "#/components/schemas/LoadPackagingDetails" }, "shipments": { "type": "array", "description": "The shipments that are included in this load. This will be empty or null if this corresponds to a item in `packedShipments` in the request.", "items": { "$ref": "#/components/schemas/LtlLoadPackagingItem" } } }, "description": "How the parcels in the LTL shipment are packaged or should be packaged." }, "LtlParcelCarrierSelection": { "required": [ "packageDetails", "status", "totalCost" ], "type": "object", "properties": { "totalCost": { "type": "number", "description": "How much it would cost to ship all of the parcels individually.", "format": "float" }, "packageDetails": { "type": "array", "description": "Information about each package's carrier selection.", "items": { "$ref": "#/components/schemas/CarrierSelectionSummary" } }, "status": { "type": "string", "description": "Summary of what happened during package carrier selection:\n- `success` indicates that all packages had a carrier eligible to ship them.\n- `failure` indicates that one or more packages had no carriers eligible to ship them.\n- `timeout` indicates that one or more carrier selections could not be completed due\n to the amount of time required to process them.", "enum": [ "success", "failure", "timeout" ] } }, "description": "The costing details of using package shipping to transport this shipment. Only present if package costing was compared to LTL costing, or used for a subset of packages." }, "LtlParcelShipmentParameters": { "type": "object", "properties": { "carrierServiceMethodAllowList": { "type": "array", "description": "A list of carrierServiceMethodIds and/or carriers that should be considered for parcel carrier selection.", "items": { "type": "string", "description": "A list of carrierServiceMethodIds and/or carriers that should be considered for parcel carrier selection." } }, "deliverySignatureOption": { "type": "string", "description": "Whether the recipient's signature should be required.", "example": "ResidentSignature", "default": "None", "enum": [ "None", "Signature", "ResidentSignature", "AdultSignature", "AdultResidentSignature", "Unknown" ] }, "deliveryWindow": { "$ref": "#/components/schemas/TimeWindow" }, "forceThirdPartyBilling": { "type": "boolean", "description": "Indicates that third party billing is a requirement for this shipment, no service method should be selected that does not support third party billing", "default": false }, "fulfillmentContextIds": { "type": "array", "description": "A collection of Shipium generated IDs or partner provided aliases for the fulfillment context that are eligible to be used for parcel carrier selection.There must be exactly one fulfillment context that can ship from the origin to the destination, for the specified tenant, regardless of whether or not this list is populated.", "items": { "type": "string", "description": "A collection of Shipium generated IDs or partner provided aliases for the fulfillment context that are eligible to be used for parcel carrier selection.There must be exactly one fulfillment context that can ship from the origin to the destination, for the specified tenant, regardless of whether or not this list is populated." } }, "originId": { "type": "string", "description": "A shipiumOriginId or partnerOriginId to identify which originthe shipment will be processed at." }, "fulfillmentType": { "type": "string", "description": "Fulfillment methodology of the shipment.", "default": "customer", "enum": [ "customer", "at_large", "returns", "hundredweight", "reship", "unknown" ] }, "ignoreCarrierMinimumDimensions": { "type": "boolean", "description": "When \"true\", the minimum dimensions of carriers will effectively be ignored when deciding if a carrier service method is eligible to be considered during carrier selection.", "default": false }, "ignoreUpgradeSpendLimits": { "type": "boolean", "description": "Indicates that this shipment can ignore all the partner-configured upgrade limits for the potential upgrade required to deliver the shipment by the desired delivery date.", "default": false }, "includeInjectionProfiles": { "type": "boolean", "description": "When \"true\", service methods from the configured InjectionProfiles will be considered during carrier selection.", "default": true }, "injectionParameters": { "type": "array", "description": "A list of Injection Profile and/or Injection Profile/Site tuples that should be considered during parcel carrier selection. If an InjectionSite is specified, it must be accompanied by an InjectionProfile", "items": { "$ref": "#/components/schemas/InjectionParameter" } }, "lastMileDeliveryOptions": { "$ref": "#/components/schemas/LastMileDeliveryOptions" }, "pickupWindow": { "$ref": "#/components/schemas/TimeWindow" }, "preferredCarrierDeliveryDateTime": { "type": "string", "description": "The string representation of either an ISO-8601 date. The datetime the package is intended to arrive to the customer. This will be passed through to the carrier.", "format": "date-time", "example": "2019-10-31T20:00:00Z" }, "saturdayDelivery": { "type": "boolean", "description": "Indicates that this shipment is marked for Saturday delivery. Does not guarantee delivery on Saturday", "default": false }, "desktopDelivery": { "type": "boolean", "description": "When \"true\", carrier selection is narrowed to service methods that support desktop (desk/office) delivery. On a lane where no such method is available, selection fails rather than routing to a non-supporting carrier.", "default": false }, "serviceMethodPoBoxAllowList": { "type": "array", "description": "A list of serviceMethodIds that will be considered for USPS PO box delivery that otherwise would be filtered out as they don't support USPS PO box delivery for the shipment.", "items": { "type": "string", "description": "A list of serviceMethodIds that will be considered for USPS PO box delivery that otherwise would be filtered out as they don't support USPS PO box delivery for the shipment." } }, "shipOption": { "type": "string", "description": "A high-level shipping option shown to or selected by a customer. This is only applicable when calculating the parcel carrier selection for this item.", "example": "Standard" }, "thirdPartyBillingSetId": { "type": "string", "description": "Either the shipium third party billing set ID or the partner provided third party billing set ID. When present, this is used to indicate the third party billing set that should be used for the billing of the shipment." } }, "description": "Request parameters that informed package shipments and carrier selection. Only present if these parameters were in the cost request." }, "LtlRateLineItem": { "type": "object", "description": "The components of the carrier's cost estimate. This will be missing or empty if the carrier service method does not meet the request's requirements, or the carrier does not return the costing details. Requires `includeLineItemsInEvaluatedServiceMethods` to be true in the request.", "allOf": [ { "$ref": "#/components/schemas/RateLineItem" }, { "type": "object", "properties": { "nmfcFreightClass": { "type": "string", "description": "For LTL container line items, a string representing the most costly class of product being shipped in the container. For example, both bricks and steel pipes have a NMFC class of `50`", "externalDocs": { "url": "https://nmfta.org/nmfc/" } }, "weight": { "$ref": "#/components/schemas/Weight" } } } ] }, "LtlShipmentItemSummary": { "type": "object", "properties": { "partnerShipmentId": { "type": "string", "description": "An optional unique identifier that may be used for this shipment.", "example": "myCustomPartnerShipmentId123" }, "shipiumShipmentId": { "type": "string", "description": "The Shipium-generated unique identifier for this shipment.", "readOnly": true, "example": "7bfef4f3-9e5e-4637-9213-5934f9f104e6" } }, "description": "The shipment ids of all package shipments in this LTL shipment." } }, "securitySchemes": { "oauth2Scheme": { "type": "oauth2", "flows": { "password": { "tokenUrl": "https://auth.shipium.com/oauth/token", "scopes": { "delivery-experience-service": "Access to the Shipium API" } } } } } } } ```