For AI agents: visit https://docs.shipium.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Get started Skip link to Get started

To use the LTL Shipment Cost API, you must first configure your account. Guidance can be found in the LTL (Less Than Truckload) Shipments documentation. This document provides instructions for using the API.

The LTL Shipment Cost API assumes you're using one of the authentication mechanisms detailed in our authentication documentation.

🔐

Authentication for API Calls Skip link to Authentication for API Calls

In the cURL example on this page, the environment variable AUTHSTRING is used to handle authorization. The recipe below shows how to set it correctly for both API Key and OAuth users.

🔐

Authenticating for Curl

Open Recipe

👍

Test mode Skip link to Test mode

Want to run some examples and not charge any real money against your account?

You can add testMode: "true" to the data passed to any label call to retrieve labels without charging money in a carrier-specific manner. Most carriers will mark their labels in a way to make clear that they are void, such as inserting "VOID" throughout the label or using a predefined ID.

The examples below contain the testMode flag to err on the side of caution; remove it to make production calls.

When to use the LTL Shipment Cost endpoint Skip link to When to use the LTL Shipment Cost endpoint

Use the LTL Shipment Cost API when you need LTL pricing and carrier selection for a freight shipment. This endpoint evaluates your configured LTL carriers, applies Shipium's LTL-specific selection logic, and returns the best available LTL rate.

This is the right endpoint when:

• You've decided to ship LTL and need a rate. The shipment is too large or otherwise unsuited for parcel, and you want Shipium to pick the best LTL carrier.
• You're building an LTL-only workflow. For example, a B2B portal or freight-only shipping experience where parcel isn't a consideration

If you want to compare LTL pricing against parcel pricing to determine the more economical option, use the LTL Shipment Cost Compare API instead.

Determine LTL shipment costing Skip link to Determine LTL shipment costing

The endpoint for determining the estimated cost for an LTL shipment is included in the following table.

Choose an input method Skip link to Choose an input method

The API supports three mutually exclusive (but combinable) methods for providing shipment data. At least one must be populated:

• shipments (inline). Use when you want to provide full package details in a single API call without pre-creating shipments. This is the most common starting point.
• packedShipments. Use when the load is already palletized or configured and you only need an LTL quote, with no package-level detail required.
• existingShipmentIds. Use when you've already created Shipium shipments and want to price them as a consolidated LTL load.

You can combine input methods in a single request if your scenario requires it. All items across the three inputs are consolidated into a unified LTL load for rating.

Request and response fields for API calls Skip link to Request and response fields for API calls

The following tables provide required, conditional, and optional fields for calling the LTL Shipment Cost API. Fields are organized by their parent objects to reflect the request structure. You can find additional support in the LTL Shipment Cost API Reference.

Top-level request fields Skip link to Top-level request fields

Required fields Skip link to Required fields

Conditional fields Skip link to Conditional fields

Optional fields Skip link to Optional fields

desiredDeliveryDateOptions fields Skip link to desiredDeliveryDateOptions fields

All fields in this object are optional. You can find more information about desired delivery date options in Desired, Exact, & Guaranteed Delivery Dates.

destinationAddress fields Skip link to destinationAddress fields

Required fields Skip link to Required fields

Conditional fields Skip link to Conditional fields

Optional fields Skip link to Optional fields

shipFromAddress fields Skip link to shipFromAddress fields

Required fields Skip link to Required fields

Optional fields Skip link to Optional fields

returnToAddress fields Skip link to returnToAddress fields

Conditional fields Skip link to Conditional fields

Optional fields Skip link to Optional fields

units fields Skip link to units fields

All fields in this object are required.

ltlShipmentParameters fields Skip link to ltlShipmentParameters fields

Required fields Skip link to Required fields

Optional fields Skip link to Optional fields

ltlShipmentParameters.billToContact fields Skip link to ltlShipmentParameters.billToContact fields

The bill-to-contact fields refer to the entity that should be billed for the LTL shipment; by default, the carrier contracts in the fulfillment context will be used for billing. Either the addressLineComponents or the other address fields should be provided.

Required fields Skip link to Required fields

Optional fields Skip link to Optional fields

ltlShipmentParameters.collectOnDelivery fields Skip link to ltlShipmentParameters.collectOnDelivery fields

Conditional fields Skip link to Conditional fields

ltlShipmentParameters.hazmatContact fields Skip link to ltlShipmentParameters.hazmatContact fields

Conditional fields Skip link to Conditional fields

Optional fields Skip link to Optional fields

ltlShipmentParameters.packagingOptions fields Skip link to ltlShipmentParameters.packagingOptions fields

Conditional fields Skip link to Conditional fields

packedShipments fields Skip link to packedShipments fields

Required fields Skip link to Required fields

Conditional fields Skip link to Conditional fields

Optional fields Skip link to Optional fields

shipments fields Skip link to shipments fields

Optional fields Skip link to Optional fields

shipments.packages fields Skip link to shipments.packages fields

Required fields Skip link to Required fields

Optional fields Skip link to Optional fields

shipments.packages.orderItemQuantities fields Skip link to shipments.packages.orderItemQuantities fields

Required fields Skip link to Required fields

Conditional fields Skip link to Conditional fields

Optional fields Skip link to Optional fields

shipments.packages.orderItemQuantities.hazmatInfo fields Skip link to shipments.packages.orderItemQuantities.hazmatInfo fields

For information on shipping hazmat items, see Hazardous Materials.

Conditional fields Skip link to Conditional fields

Optional fields Skip link to Optional fields

shipments.packages.packagingType fields Skip link to shipments.packages.packagingType fields

Conditional fields Skip link to Conditional fields

Optional fields Skip link to Optional fields

shipments.packages.totalWeight fields Skip link to shipments.packages.totalWeight fields

All fields in this object are optional.

shipments.packages.totalDeclaredValue fields Skip link to shipments.packages.totalDeclaredValue fields

All fields in this object are optional.

Response attributes Skip link to Response attributes

The primary response attributes of the LTL Shipment Cost API are described in the following table. Elements included in the above request table that are also returned in the API response are not included here.

Example cURL call Skip link to Example cURL call

cURL

curl --request POST
  --url https://api.shipium.com/api/v1/ltl/shipment/cost
  --header 'accept: application/json'
  --header $AUTHSTRING
  --header 'content-type: application/json'
  --data 'INSERT REQUEST BODY FROM BELOW'

Example request using shipments Skip link to Example request using ,[object Object]

This scenario includes sending full package details in a single API call without pre-creating shipments. Shipium will create shipment records as part of this call that you can reference later.

JSON

{
  "shipFromAddress": {
    "company": "Harbor Glass Works",
    "street1": "4120 Seaport Ave",
    "city": "Oakland",
    "state": "CA",
    "countryCode": "US",
    "postalCode": "94607",
    "addressType": "commercial"
  },
  "destinationAddress": {
    "company": "Rainier Retail Distribution",
    "street1": "8800 Cascade Blvd",
    "city": "Kent",
    "state": "WA",
    "countryCode": "US",
    "postalCode": "98032",
    "addressType": "commercial"
  },
  "shipments": [\
    {\
      "partnerShipmentId": "hgw-order-48201",\
      "packages": [\
        {\
          "packagingType": {\
            "packagingMaterial": "box",\
            "linearDimensions": {\
              "linearUnit": "in",\
              "length": 24,\
              "width": 18,\
              "height": 18\
            }\
          },\
          "totalWeight": {\
            "weightUnit": "lb",\
            "weight": 145.0\
          },\
          "orderItemQuantities": [\
            {\
              "productId": "HGW-VASE-LG-CLR",\
              "quantity": 12,\
              "nmfcFreightClass": "100",\
              "productDescription": "Large clear glass vases"\
            }\
          ]\
        }\
      ]\
    }\
  ],
  "ltlShipmentParameters": {
    "pickupDate": "2026-04-28",
    "pricingTypes": ["contractPallet"],
    "accessorialCodes": ["APTD"]
  },
  "partnerLtlCostId": "harborGlass-ltl-2026-04-20-002",
  "currencyCode": "usd",
  "units": {
    "currencyCode": "usd",
    "linearUnit": "in",
    "weightUnit": "lb"
  }
}

Example response using shipments Skip link to Example response using ,[object Object]

JSON

{
  "shipiumLtlCostId": "b8d4f932-6a5e-4c2a-ad9f-3e7f9b4c2f58",
  "partnerLtlCostId": "harborGlass-ltl-2026-04-20-002",
  "partnerTenantId": "harbor-glass-default",
  "shipiumTenantId": "9c2e4a18-0d83-4f29-8b71-3e6a5d9c1f04",
  "shipFromAddress": {
    "company": "Harbor Glass Works",
    "street1": "4120 Seaport Ave",
    "city": "Oakland",
    "state": "CA",
    "countryCode": "US",
    "postalCode": "94607",
    "addressType": "commercial"
  },
  "shipFromTimeZoneId": "America/Los_Angeles",
  "destinationAddress": {
    "company": "Rainier Retail Distribution",
    "street1": "8800 Cascade Blvd",
    "city": "Kent",
    "state": "WA",
    "countryCode": "US",
    "postalCode": "98032",
    "addressType": "commercial"
  },
  "destinationTimeZoneId": "America/Los_Angeles",
  "recommendedTransportationType": "ltlTransportation",
  "recommendedTransportationTypeCost": 298.50,
  "testMode": false,
  "currencyCode": "usd",
  "units": {
    "currencyCode": "usd",
    "linearUnit": "in",
    "weightUnit": "lb"
  },
  "allTransportationTypeCosts": [\
    {\
      "transportationType": "ltlTransportation",\
      "transportationTypeCost": 298.50\
    }\
  ],
  "ltlCostDetails": {
    "loadPackaging": [\
      {\
        "details": {\
          "loadPackagingType": "pallet",\
          "loadPackagingSize": {\
            "height": 24,\
            "length": 48,\
            "width": 40,\
            "linearUnit": "in",\
            "weight": 145.0,\
            "weightUnit": "lb"\
          },\
          "nmfcFreightClass": "100"\
        },\
        "shipments": [\
          {\
            "partnerShipmentId": "hgw-order-48201",\
            "shipiumShipmentId": "c9e5f043-7b6f-4d3b-be8f-4f8fac5d3a69"\
          }\
        ]\
      }\
    ],
    "evaluatedCarriers": [],
    "selectedCarrier": {
      "billableWeight": {
        "weightUnit": "lb",
        "weight": 145.0
      },
      "carrier": "R+L Carriers",
      "carrierAccountId": "rl-account-default",
      "carrierServiceMethodId": "rl-standard-ltl",
      "estimatedDeliveryDate": "2026-05-01T17:00:00Z",
      "lineItems": [\
        {\
          "name": "container",\
          "rate": 245.00,\
          "lineItemType": "base_rate",\
          "nmfcFreightClass": "100",\
          "weight": {\
            "weightUnit": "lb",\
            "weight": 145.0\
          }\
        },\
        {\
          "name": "Fuel Surcharge",\
          "rate": 38.50,\
          "carrierSurchargeId": "FSC",\
          "lineItemType": "surcharge"\
        },\
        {\
          "name": "Appointment Required at Delivery",\
          "rate": 15.00,\
          "carrierSurchargeId": "APTD",\
          "lineItemType": "surcharge"\
        }\
      ],
      "pickupDateTime": "2026-04-28T16:00:00Z",
      "pricingType": "contractPallet",
      "quoteId": "rl-quote-7f3e2d91-0428",
      "quoteEffectiveDateTime": "2026-04-20T18:30:00Z",
      "quoteExpirationDateTime": "2026-04-27T18:30:00Z",
      "scacCode": "RLCA",
      "serviceLevel": "standard",
      "totalCost": 298.50
    },
    "totalCost": 298.50
  },
  "ltlShipmentParameters": {
    "pickupDate": "2026-04-28",
    "pricingTypes": "contractPallet",
    "accessorialCodes": "APTD"
  },
  "packageCostDetails": null,
  "packageShipmentParameters": null,
  "shipments": [\
    {\
      "partnerShipmentId": "hgw-order-48201",\
      "shipiumShipmentId": "c9e5f043-7b6f-4d3b-be8f-4f8fac5d3a69"\
    }\
  ]
}

Example request using packedShipments Skip link to Example request using ,[object Object]

This scenario is useful when the load is already palletized or configured, and you only need an LTL quote without per-package detail. This is the leanest input method.

JSON

{
  "shipFromAddress": {
    "company": "Harbor Glass Works",
    "street1": "4120 Seaport Ave",
    "city": "Oakland",
    "state": "CA",
    "countryCode": "US",
    "postalCode": "94607",
    "addressType": "commercial"
  },
  "destinationAddress": {
    "company": "Rainier Retail Distribution",
    "street1": "8800 Cascade Blvd",
    "city": "Kent",
    "state": "WA",
    "countryCode": "US",
    "postalCode": "98032",
    "addressType": "commercial"
  },
  "packedShipments": [\
    {\
      "loadPackagingType": "pallet",\
      "loadPackagingSize": {\
        "height": 60,\
        "length": 48,\
        "width": 40,\
        "linearUnit": "in",\
        "weight": 680.0,\
        "weightUnit": "lb"\
      },\
      "nmfcFreightClass": "100",\
      "declaredValue": {\
        "amount": 4200.00,\
        "currency": "usd"\
      }\
    }\
  ],
  "ltlShipmentParameters": {
    "pickupDate": "2026-04-28",
    "pricingTypes": ["contractPallet"],
    "accessorialCodes": ["APTD"]
  },
  "partnerLtlCostId": "harborGlass-ltl-2026-04-20-003",
  "currencyCode": "usd",
  "units": {
    "currencyCode": "usd",
    "linearUnit": "in",
    "weightUnit": "lb"
  }
}

Example response using packedShipments Skip link to Example response using ,[object Object]

This example response shows fields specific to this scenario. The shipments example includes the complete response.

JSON

{
  "shipiumLtlCostId": "d0f6a154-8c7a-4e4c-cf9a-5a9fbc6e4b7a",
  "partnerLtlCostId": "harborGlass-ltl-2026-04-20-003",
  "recommendedTransportationType": "ltlTransportation",
  "recommendedTransportationTypeCost": 386.20,
  "currencyCode": "usd",
  "ltlCostDetails": {
    "selectedCarrier": {
      "carrier": "R+L Carriers",
      "carrierServiceMethodId": "rl-standard-ltl",
      "totalCost": 386.20,
      "estimatedDeliveryDate": "2026-05-01T17:00:00Z",
      "serviceLevel": "standard"
    },
    "evaluatedCarriers": [],
    "totalCost": 386.20
  },
  "packageCostDetails": null
}

Example request using existingShipmentIds Skip link to Example request using ,[object Object]

You can use this scenario when you've already created Shipium shipments and now want to price them as a consolidated LTL load.

JSON

{
  "shipFromAddress": {
    "company": "Harbor Glass Works",
    "street1": "4120 Seaport Ave",
    "city": "Oakland",
    "state": "CA",
    "countryCode": "US",
    "postalCode": "94607",
    "addressType": "commercial"
  },
  "destinationAddress": {
    "company": "Rainier Retail Distribution",
    "street1": "8800 Cascade Blvd",
    "city": "Kent",
    "state": "WA",
    "countryCode": "US",
    "postalCode": "98032",
    "addressType": "commercial"
  },
  "existingShipmentIds": [\
    "7bfef4f3-9e5e-4637-9213-5934f9f104e6",\
    "3a2c19d8-2e4b-4891-b1c2-8e3f7d9c5a01"\
  ],
  "ltlShipmentParameters": {
    "pickupDate": "2026-04-28",
    "pricingTypes": ["contractPallet"],
    "accessorialCodes": ["APTD"]
  },
  "partnerLtlCostId": "harborGlass-ltl-2026-04-20-001",
  "currencyCode": "usd",
  "units": {
    "currencyCode": "usd",
    "linearUnit": "in",
    "weightUnit": "lb"
  }
}

Example response using existingShipmentIds Skip link to Example response using ,[object Object]

This example response shows fields specific to this scenario. The shipments example includes the complete response.

JSON

{
  "shipiumLtlCostId": "a7c3e821-5f4d-4b19-9c8e-2d6f8a3b1e47",
  "partnerLtlCostId": "harborGlass-ltl-2026-04-20-001",
  "recommendedTransportationType": "ltlTransportation",
  "recommendedTransportationTypeCost": 412.85,
  "currencyCode": "usd",
  "ltlCostDetails": {
    "selectedCarrier": {
      "carrier": "R+L Carriers",
      "carrierServiceMethodId": "rl-standard-ltl",
      "totalCost": 412.85,
      "estimatedDeliveryDate": "2026-05-01T17:00:00Z",
      "serviceLevel": "standard"
    },
    "evaluatedCarriers": [],
    "totalCost": 412.85
  },
  "packageCostDetails": null
}

Retrieve existing LTL shipment cost information Skip link to Retrieve existing LTL shipment cost information

Path Skip link to Path

GET

https://api.shipium.com/api/v1/ltl/shipment/cost/{ltlCostId}

Required path element:ltlCostId

Example cURL call Skip link to Example cURL call

cURL

curl --request GET
  --url https://api.shipium.com/api/v1/ltl/shipment/cost/{ltlCostId}
  --header 'accept: application/json'
  --header $AUTHSTRING
  --header 'content-type: application/json'

Example response Skip link to Example response

JSON

{
  "shipiumLtlCostId": "fa2b839c-92e7-48bf-ba09-b0f5a0b0c475",
  "partnerLtlCostId": "myCustomPartnerLTLShipmentId123",
  "partnerTenantId": "acme-tenant34",
  "shipiumTenantId": "469696b8-731e-44bb-82d6-2c437d57f3ce",
  "shipFromAddress": {
    "name": "Wile E. Coyote",
    "phoneNumber": "505-662-7272",
    "phoneNumberCountryCode": "+1",
    "emailAddress": "wcoyote@acme.com",
    "company": "ACME",
    "street1": "123 Main St.",
    "street2": "Suite 42",
    "city": "Albuquerque",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "87121",
    "addressType": "commercial"
  },
  "shipFromTimeZoneId": "mst-gmt-7",
  "destinationAddress": {
    "name": "Rod Runner",
    "company": "ACME",
    "addressType": "commercial",
    "street1": "43 One Way Lane",
    "city": "Seattle",
    "state": "WA",
    "countryCode": "US",
    "postalCode": "14410",
    "phoneNumber": "206-123-4567",
    "phoneNumberCountryCode": "+1"
  },
  "destinationTimeZoneId": "cst-gmt-6",
  "returnToAddress": {
    "name": "Wile E. Coyote",
    "phoneNumber": "505-662-7272",
    "phoneNumberCountryCode": "+1",
    "emailAddress": "wcoyote@acme.com",
    "company": "ACME",
    "street1": "123 Main St.",
    "street2": "Suite 42",
    "city": "Albuquerque",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "87121",
    "addressType": "commercial"
  },
  "rawDesiredDeliveryDate": "2024-10-31T10:50:11.123456Z",
  "recommendedTransportationType": "ltlTransportation",
  "recommendedTransportationTypeCost": 0,
  "testMode": true,
  "units": {
    "currencyCode": "usd",
    "linearUnit": "in",
    "weightUnit": "lb"
  },
  "allTransportationTypeCosts": [\
    {\
      "transportationType": "ltlTransportation",\
      "transportationTypeCost": 0\
    }\
  ],
  "ltlCostDetails": {
    "loadPackaging": [\
      {\
        "details": {\
          "declaredValue": {\
            "amount": 12.34,\
            "currency": "usd"\
          },\
          "loadPackagingType": "overboxed",\
          "loadPackagingSize": {\
            "height": 84,\
            "length": 48,\
            "linearUnit": "in",\
            "weight": 850.25,\
            "weightUnit": "lb",\
            "width": 40\
          },\
          "nmfcFreightClass": "50"\
        },\
        "shipments": [\
          {\
            "partnerShipmentId": "myCustomPartnerShipmentId123",\
            "shipiumShipmentId": "7bfef4f3-9e5e-4637-9213-5934f9f104e6",\
            "packageReferenceIdentifier": "1of3"\
          }\
        ]\
      }\
    ],
    "evaluatedCarriers": [\
      {\
        "billableWeight": {\
          "weightUnit": "lb",\
          "weight": 50\
        },\
        "billToThirdPartyId": "acme-3rd-party-billing-fedex",\
        "carrier": "fedex",\
        "carrierAccountId": "acme-fedex-1234",\
        "carrierServiceMethodId": "fedex-smartpost-service-method",\
        "estimatedDeliveryDate": "2024-10-30T20:47:11.970Z",\
        "lineItems": [\
          {\
            "name": "base",\
            "rate": 2.3,\
            "carrierSurchargeId": "123451239874980",\
            "lineItemType": "surcharge",\
            "hiddenFromCarrierCompare": true,\
            "hiddenFromInvoice": true,\
            "hiddenFromOperational": true,\
            "nmfcFreightClass": "50",\
            "weight": {\
              "weightUnit": "lb",\
              "weight": 50\
            }\
          }\
        ],\
        "loadDeficitCost": {\
          "amount": 0,\
          "nmfcClass": "50",\
          "weight": {\
            "weightUnit": "lb",\
            "weight": 50\
          },\
          "rate": 0\
        },\
        "pickupDateTime": "2024-10-29T20:47:11.970Z",\
        "pricingType": "all",\
        "quoteId": "e635e871-103c-4a6d-9726-128a3ae51253",\
        "quoteEffectiveDateTime": "2024-10-28T20:47:11.970Z",\
        "quoteExpirationDateTime": "2024-10-31T20:47:11.970Z",\
        "scacCode": "fxsp",\
        "serviceLevel": "standard",\
        "accessorialCodes": "INS",\
        "totalCost": 0\
      }\
    ],
    "selectedCarrier": {
      "billableWeight": {
        "weightUnit": "lb",
        "weight": 50
      },
      "billToThirdPartyId": "acme-3rd-party-billing-ups",
      "carrier": "ups",
      "carrierAccountId": "ups-1234567",
      "carrierServiceMethodId": "ups-ground-service-method",
      "estimatedDeliveryDate": "2024-10-30T20:47:11.970Z",
      "lineItems": [\
        {\
          "name": "base",\
          "rate": 2.3,\
          "carrierSurchargeId": "123451239874980",\
          "lineItemType": "surcharge",\
          "hiddenFromCarrierCompare": true,\
          "hiddenFromInvoice": true,\
          "hiddenFromOperational": true,\
          "nmfcFreightClass": "50",\
          "weight": {\
            "weightUnit": "lb",\
            "weight": 50\
          }\
        }\
      ],
      "loadDeficitCost": {
        "amount": 0,
        "nmfcClass": "50",
        "weight": {
          "weightUnit": "lb",
          "weight": 50
        },
        "rate": 0
      },
      "pickupDateTime": "2024-10-29T20:47:11.970Z",
      "pricingType": "all",
      "quoteId": "20df5261-f0bc-492c-9f31-c580f360b8a7",
      "quoteEffectiveDateTime": "2024-10-28T20:47:11.970Z",
      "quoteExpirationDateTime": "2024-11-09T20:47:11.970Z",
      "scacCode": "UPSN-CG",
      "serviceLevel": "standard",
      "accessorialCodes": "INS",
      "totalCost": 0
    },
    "totalCost": 0
  },
  "ltlShipmentParameters": {
    "billToContact": {
      "addressType": "commercial",
      "city": "Albuquerque",
      "company": "ACME",
      "countryCode": "US",
      "emailAddress": "wcoyote@acme.com",
      "name": "Wile E. Coyote",
      "phoneNumber": "505-662-7272",
      "phoneNumberCountryCode": "+1",
      "postalCode": "87121",
      "state": "NM",
      "street1": "123 Main St.",
      "street2": "Suite 42",
      "thirdPartyBillingSetId": "acme-3rd-party-billing-set"
    },
    "carrierServiceMethodAllowList": [\
      "ups-ground-service-method",\
      "ups-standard-service-method"\
    ],
    "collectOnDelivery": {
      "amount": 12.34,
      "currency": "usd"
    },
    "fulfillmentContextIds": [\
      "ca037b83-6c47-4515-867e-aa890222c53b"\
    ],
    "fulfillmentType": "customer",
    "packagingOptions": [\
      {\
        "loadPackagingType": "overboxed",\
        "loadPackagingSize": {\
          "height": 84,\
          "length": 48,\
          "linearUnit": "in",\
          "maximumWeight": 850.25,\
          "packagingWeight": 10.125,\
          "weightUnit": "lb",\
          "width": 40\
        }\
      }\
    ],
    "paymentDetails": {
      "payerType": "consignee",
      "paymentTerms": "collect"
    },
    "pickupDate": "2024-10-31",
    "pricingTypes": ["contractPallet"],
    "serviceLevels": ["guaranteedMorning"],
    "accessorialCodes": ["INS"]
  },
  "packageCostDetails": {
    "totalCost": 0,
    "packageDetails": [\
      {\
        "status": "success",\
        "statusDetails": "success",\
        "carrierSelectionId": "911b488c-c620-4663-a554-bf9628e7ff43",\
        "shipiumShipmentId": "7bfef4f3-9e5e-4637-9213-5934f9f104e6",\
        "partnerShipmentId": "myCustomPartnerShipmentId123",\
        "partnerId": "acme007",\
        "carrierAccountId": "acme-ups-01",\
        "serviceMethodUrn": "c645ea83-d161-4e28-b8cb-39bf1a620cd3:4e14aaa3-198b-4861-b658-faf51031c84c:83fe5227-a765-45b2-bc2a-cb919ddce922:1",\
        "serviceMethodIdentifier": "1f19ca28-9798-42b2-9e8c-f9c3a72c9bab:ZmVkZXgtZXhwcmVzcy1zYXZlci1zZXJ2aWNlLW1ldGhvZDo6OGUzYmIxOGUtMTA3Ni00ODUxLWE4ZTYtZWViZTZmNWUwOTkwOjYyNWRiNjU4LWUwOTEtNGUxYi04ODhhLTMyMTI3MGM4ZTZhZjphOGVjYTRlYS1kMDcwLTRkZWMtOGZiMC0xNGNjMTQxMzJmNWQ6ZmVkZXg6NWExZWE3MjgtNGJhMi00Y2M2LTg5MmMtMWYxMjJmMzUwNzc1Ojo",\
        "carrier": "ups",\
        "carrierServiceMethodId": "ups-ground-service-method",\
        "serviceMethodName": "ground",\
        "costAdjustConfigId": "331de530-6a92-4238-9d3c-70083b19d94e",\
        "totalCost": 0,\
        "carrierCompareCost": 0,\
        "carrierInvoiceCost": 0,\
        "operationalCost": 2.7,\
        "thirdPartyBilling": true,\
        "carrierSelectionDateTime": "2024-10-27T20:47:11.970Z",\
        "carrierZoneId": "ups-zone-7",\
        "calculatedBillableWeight": {\
          "weightUnit": "lb",\
          "weight": 50\
        },\
        "laneMatch": {\
          "laneId": "asdqwdq-qwd123ds-123asdwd-123asd",\
          "partnerLaneId": "custom partner provided id"\
        },\
        "evaluatedServiceMethods": [\
          {\
            "carrier": "ups",\
            "carrierServiceMethodId": "ups-ground-service-method",\
            "serviceMethodName": "ground",\
            "carrierAccountId": "acme-ups-01",\
            "totalCost": 0,\
            "estimatedDeliveryDate": "2024-10-30T20:47:11.970Z",\
            "rateCurrency": "usd",\
            "lineItems": [\
              {\
                "name": "base",\
                "rate": 2.3,\
                "carrierSurchargeId": "123451239874980",\
                "lineItemType": "surcharge",\
                "hiddenFromCarrierCompare": true,\
                "hiddenFromInvoice": true,\
                "hiddenFromOperational": true\
              }\
            ]\
          }\
        ],\
        "cancellationDateTime": "2024-10-31T10:50:11.123456Z",\
        "effectiveShipDateTime": "2024-10-30T20:47:11.970Z"\
      }\
    ],
    "status": "success"
  },
  "packageShipmentParameters": {
    "carrierServiceMethodAllowList": [\
      "ups-ground-service-method",\
      "ups-standard-service-method"\
    ],
    "deliverySignatureOption": "resident_signature",
    "deliveryWindow": {
            "startWindow": "08:00:11",
            "endWindow": "16:00:11",
            "timeZone": "America/New_York"
        },
    "forceThirdPartyBilling": false,
    "fulfillmentContextIds": [\
      "ca037b83-6c47-4515-867e-aa890222c53b"\
    ],
    "fulfillmentType": "customer",
    "ignoreCarrierMinimumDimensions": false,
    "ignoreUpgradeSpendLimits": false,
    "includeInjectionProfiles": false,
    "lastMileDeliveryOptions": {
      "deliveryInstruction": "LEAVE_AT_DOOR",
      "undeliverableInstruction": "LEAVE_AT_DOOR",
      "tip": {
        "type": "FIXED",
        "value": 0,
        "currency": "usd"
      },
      "tipForLabelCreate": {
        "type": "FIXED",
        "value": 0,
        "currency": "usd"
      },
      "deliverableActionForLabelCreate": "RETURN",
      "undeliverableActionForLabelCreate": "RETURN"
    },
    "pickupWindow": {
            "startWindow": "08:00",
            "endWindow": "16:00",
            "timeZone": "America/New_York"
        },
    "preferredCarrierDeliveryDateTime": "2024-10-31T20:00:00Z",
    "saturdayDelivery": false,
    "shipOption": "Standard",
    "thirdPartyBillingSetId": "acme-3rd-party-billing-set"
  },
  "packedShipments": [\
    {\
      "declaredValue": {\
        "amount": 12.34,\
        "currency": "usd"\
      },\
      "loadPackagingType": "overboxed",\
      "loadPackagingSize": {\
        "height": 84,\
        "length": 48,\
        "linearUnit": "in",\
        "weight": 850.25,\
        "weightUnit": "lb",\
        "width": 40\
      },\
      "nmfcFreightClass": "50"\
    }\
  ],
  "shipments": [\
    {\
      "partnerShipmentId": "myCustomPartnerShipmentId123",\
      "shipiumShipmentId": "7bfef4f3-9e5e-4637-9213-5934f9f104e6"\
    }\
  ]
}

Resources Skip link to Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful:

• Terms and Definitions

• Troubleshooting Guide

• Contact Shipium Support

Updated 27 days ago

Did this page help you?

Yes

No

Copy Page

🦉

Recipe Title

Recipe Description

​x

1{"success":true}

Are you sure?