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.
Your Credentials
When Shipntel sets up your account you'll receive two values, both are required on every request:
| Credential | Where it goes | Example |
|---|---|---|
| API Key | Authorization header | Authorization: RSIS <apiKey> |
| Customer ID | URL path parameter | /customers/TEST00002/quote |
REST Endpoint
Replace :customerId with your assigned Customer ID (e.g. TEST00002).
Request Content Type
Content-Type: application/json
Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
| carrierCode | string | No | The carrier code (e.g. "ups", "fedex"). Omit to return all carriers. |
| serviceCode | string | No | The service code. Omit along with packageTypeCode to get all available rates. |
| packageTypeCode | string | No | The package type code. |
| sender.country | string | Yes | ISO two-character country code |
| sender.zip | string or null | Yes | Zip or postal code |
| receiver.city | string | No | Destination city/town |
| receiver.country | string | Yes | ISO two-character country code |
| receiver.zip | string or null | Yes | Zip or postal code |
| receiver.email | string | No | Receiver email address |
| residential | boolean | No | Set to true if the receiver address is residential |
| signatureOptionCode | string or null | No | Signature option code. Null for no signature. |
| uspsExpressAmDelivery | boolean | No | 10:30 AM Delivery |
| saturdayDelivery | boolean | No | Saturday Delivery |
| contentType | string | No | Carrier-specific content type. Defaults to carrier's default if omitted. |
| contentDescription | string | No | Content description. Often required for international shipments. |
| weightUnit | string | Yes | "lb", "oz", "kg", or "g" |
| dimUnit | string or null | Yes | "in" or "cm", or null if packageType has preset dimensions |
| currency | string | Yes | Currency for insuranceAmount, declaredValue, customsValue (USD, GBP, CAD, EUR) |
| customsCurrency | string | Yes | Currency for customsValue if present (USD, GBP, CAD, EUR) |
| pieces[n].weight | decimal | Yes | Numeric weight as a JSON string |
| pieces[n].length | decimal or null | Yes | Length as a JSON string. Null if packageType has preset dimensions. |
| pieces[n].width | decimal or null | Yes | Width as a JSON string. Null if packageType has preset dimensions. |
| pieces[n].height | decimal or null | Yes | Height as a JSON string. Null if packageType has preset dimensions. |
| pieces[n].insuranceAmount | decimal or null | Yes | Insurance value as a JSON string. Null for no insurance. |
| pieces[n].declaredValue | decimal or null | Yes | Declared value for international shipments. Null for domestic. |
| billing.party | string | No | "sender", "receiver", or "third_party" |
| providerAccountId | string or null | No | Provider Account ID from the List Provider Accounts endpoint |
serviceCode valuesups_next_day_airups_next_day_air_early_amups_next_day_air_saverups_second_day_airups_second_day_air_amups_three_day_selectups_groundfedex_priority_overnightfedex_first_overnightfedex_standard_overnightfedex_two_dayfedex_express_saverfedex_groundfedex_ground_home_deliverydhl_express_worldwide: outbound from USdhl_inbound: inbound to USsignatureOptionCode valuesnoneNo signature requiredDIRECTDirect signatureADULTAdult 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
| Field | Type | Description |
|---|---|---|
| carrierCode | string | The carrier code |
| serviceCode | string | The service code |
| serviceDescription | string | Service description (only present when getting multiple quotes) |
| packageTypeCode | string | The package type code |
| currency | string | 3-character currency code |
| customsCurrency | string | 3-character currency code |
| totalAmount | decimal | Total quote amount (base charge + all surcharges) |
| baseAmount | decimal | Base charge amount |
| surcharges[n].description | string | Human-readable surcharge description |
| surcharges[n].amount | decimal | Surcharge amount |
| zone | string | The zone used to compute shipping cost |
| quotedWeight | string | The weight value used in the quote |
| quotedWeightType | string | Weight type (e.g. "Actual" or "Dimensional") |
| pieces[n].totalAmount | decimal | USPS Multipiece only: total amount for piece |
| pieces[n].baseAmount | decimal | USPS Multipiece only: base charge for piece |
| pieces[n].surcharges[n].description | string | USPS Multipiece only: piece surcharge description |
| pieces[n].surcharges[n].amount | decimal | USPS 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