API Hub/Quoting
    Shipntel

    Quoting API

    Access Shipntel's discounted real-time carrier rates.

    Overview

    The Quoting API lets you programmatically fetch available shipping rates for a given origin, destination, and package set. Rates reflect the contracted pricing tied to your Shipntel customer profile.

    Access required: You must have a Shipntel-issued API key to use this endpoint. Email api@shipntel.com to request one.

    Your Credentials

    When Shipntel sets up your account you'll receive two values, both are required on every request:

    CredentialWhere it goesExample
    API KeyAuthorization headerAuthorization: RSIS <apiKey>
    Customer IDURL path parameter/customers/TEST00002/quote

    REST Endpoint

    POSThttps://webship.shipntel.com/restapi/v1/customers/:customerId/quote

    Replace :customerId with your assigned Customer ID (e.g. TEST00002).

    Request Content Type

    Content-Type: application/json

    Request Fields

    FieldTypeRequiredDescription
    carrierCodestringNoThe carrier code (e.g. "ups", "fedex"). Omit to return all carriers.
    serviceCodestringNoThe service code. Omit along with packageTypeCode to get all available rates.
    packageTypeCodestringNoThe package type code.
    sender.countrystringYesISO two-character country code
    sender.zipstring or nullYesZip or postal code
    receiver.citystringNoDestination city/town
    receiver.countrystringYesISO two-character country code
    receiver.zipstring or nullYesZip or postal code
    receiver.emailstringNoReceiver email address
    residentialbooleanNoSet to true if the receiver address is residential
    signatureOptionCodestring or nullNoSignature option code. Null for no signature.
    uspsExpressAmDeliverybooleanNo10:30 AM Delivery
    saturdayDeliverybooleanNoSaturday Delivery
    contentTypestringNoCarrier-specific content type. Defaults to carrier's default if omitted.
    contentDescriptionstringNoContent description. Often required for international shipments.
    weightUnitstringYes"lb", "oz", "kg", or "g"
    dimUnitstring or nullYes"in" or "cm", or null if packageType has preset dimensions
    currencystringYesCurrency for insuranceAmount, declaredValue, customsValue (USD, GBP, CAD, EUR)
    customsCurrencystringYesCurrency for customsValue if present (USD, GBP, CAD, EUR)
    pieces[n].weightdecimalYesNumeric weight as a JSON string
    pieces[n].lengthdecimal or nullYesLength as a JSON string. Null if packageType has preset dimensions.
    pieces[n].widthdecimal or nullYesWidth as a JSON string. Null if packageType has preset dimensions.
    pieces[n].heightdecimal or nullYesHeight as a JSON string. Null if packageType has preset dimensions.
    pieces[n].insuranceAmountdecimal or nullYesInsurance value as a JSON string. Null for no insurance.
    pieces[n].declaredValuedecimal or nullYesDeclared value for international shipments. Null for domestic.
    billing.partystringNo"sender", "receiver", or "third_party"
    providerAccountIdstring or nullNoProvider Account ID from the List Provider Accounts endpoint
    Allowed serviceCode values
    UPS
    ups_next_day_airups_next_day_air_early_amups_next_day_air_saverups_second_day_airups_second_day_air_amups_three_day_selectups_ground
    FedEx
    fedex_priority_overnightfedex_first_overnightfedex_standard_overnightfedex_two_dayfedex_express_saverfedex_groundfedex_ground_home_delivery
    DHL
    dhl_express_worldwide: outbound from US
    dhl_inbound: inbound to US
    Allowed signatureOptionCode values
    noneNo signature required
    DIRECTDirect signature
    ADULTAdult signature (21+)

    Request JSON Example

    POST https://webship.shipntel.com/restapi/v1/customers/YOUR_CUSTOMER_ID/quote
    Authorization: RSIS YOUR_API_KEY
    Content-Type: application/json
    
    {
      "carrierCode": "ups",
      "serviceCode": "ups_ground",
      "packageTypeCode": "ups_custom_package",
      "sender": {
        "country": "US",
        "zip": "33101"
      },
      "receiver": {
        "city": "Los Angeles",
        "country": "US",
        "zip": "90001",
        "email": "customer@example.com"
      },
      "residential": false,
      "signatureOptionCode": null,
      "contentType": "goods",
      "contentDescription": "merchandise",
      "weightUnit": "lb",
      "dimUnit": "in",
      "currency": "USD",
      "customsCurrency": "USD",
      "pieces": [
        {
          "weight": "10.0",
          "length": "12",
          "width": "10",
          "height": "8",
          "insuranceAmount": null,
          "declaredValue": null
        }
      ],
      "billing": {
        "party": "sender"
      },
      "providerAccountId": null
    }

    Response Fields

    FieldTypeDescription
    carrierCodestringThe carrier code
    serviceCodestringThe service code
    serviceDescriptionstringService description (only present when getting multiple quotes)
    packageTypeCodestringThe package type code
    currencystring3-character currency code
    customsCurrencystring3-character currency code
    totalAmountdecimalTotal quote amount (base charge + all surcharges)
    baseAmountdecimalBase charge amount
    surcharges[n].descriptionstringHuman-readable surcharge description
    surcharges[n].amountdecimalSurcharge amount
    zonestringThe zone used to compute shipping cost
    quotedWeightstringThe weight value used in the quote
    quotedWeightTypestringWeight type (e.g. "Actual" or "Dimensional")
    pieces[n].totalAmountdecimalUSPS Multipiece only: total amount for piece
    pieces[n].baseAmountdecimalUSPS Multipiece only: base charge for piece
    pieces[n].surcharges[n].descriptionstringUSPS Multipiece only: piece surcharge description
    pieces[n].surcharges[n].amountdecimalUSPS Multipiece only: piece surcharge amount

    Response JSON Example

    Single-service quote (when serviceCode is specified):

    {
      "carrierCode": "ups",
      "serviceCode": "ups_ground",
      "packageTypeCode": "ups_custom_package",
      "currency": "USD",
      "customsCurrency": "USD",
      "totalAmount": "16.27",
      "baseAmount": "12.15",
      "surcharges": [
        {
          "description": "Residential surcharge",
          "amount": "4.12"
        }
      ],
      "zone": "2",
      "quotedWeight": "10",
      "quotedWeightType": "Actual"
    }

    Quote Multiple Services

    To retrieve all available rates, set serviceCode and packageTypeCode to empty strings (""). The carrierCode is optional, include it to filter to one carrier, or omit for all. Results are wrapped in a quotes array, each with a serviceDescription.

    // Set serviceCode and packageTypeCode to "" to get all available rates:
    POST https://webship.shipntel.com/restapi/v1/customers/YOUR_CUSTOMER_ID/quote
    Authorization: RSIS YOUR_API_KEY
    Content-Type: application/json
    
    {
      "carrierCode": "",
      "serviceCode": "",
      "packageTypeCode": "",
      "sender": { "country": "US", "zip": "33101" },
      "receiver": {
        "city": "Los Angeles",
        "country": "US",
        "zip": "90001",
        "email": "customer@example.com"
      },
      "residential": false,
      "signatureOptionCode": null,
      "contentType": "goods",
      "contentDescription": "merchandise",
      "weightUnit": "lb",
      "dimUnit": "in",
      "currency": "USD",
      "customsCurrency": "USD",
      "pieces": [{ "weight": "10.0", "length": "12", "width": "10", "height": "8", "insuranceAmount": null, "declaredValue": null }],
      "billing": { "party": "sender" },
      "providerAccountId": null
    }
    
    // Response wraps results in a "quotes" array:
    {
      "quotes": [
        {
          "carrierCode": "ups",
          "serviceCode": "ups_ground",
          "serviceDescription": "UPS® Ground",
          "packageTypeCode": "ups_custom_package",
          "currency": "USD",
          "totalAmount": "16.27",
          "baseAmount": "12.15",
          "surcharges": [{ "description": "Residential surcharge", "amount": "4.12" }],
          "zone": "2",
          "quotedWeight": "10",
          "quotedWeightType": "Actual"
        },
        {
          "carrierCode": "ups",
          "serviceCode": "ups_second_day_air",
          "serviceDescription": "UPS 2nd Day Air®",
          "packageTypeCode": "ups_custom_package",
          "currency": "USD",
          "totalAmount": "41.72",
          "baseAmount": "22.66",
          "surcharges": [{ "description": "ResidentialExpress", "amount": "5.15" }],
          "zone": "202",
          "quotedWeight": "10",
          "quotedWeightType": "Actual"
        }
      ]
    }

    Ready to get started?

    Request your API key from the Shipntel team and start quoting in minutes.

    Email api@shipntel.com