Getting Shipment Rates
POST
api/v2/rates
Request
Header Params
Content-Type
string
required
Example:
application/json
Authorization
string
required
Example:
Basic {{apiKey}}
Body Params application/json
recipient
object
required
addressLine1
string
required
addressLine2
string | null
optional
city
string
required
stateCode
string
required
postalCode
string
required
countryCode
string
required
parcels
array [object {7}]
required
length
number
required
weight
number
required
height
number
required
dimensionUnit
enum<string>
required
Allowed values:
CMIN
width
number
optional
weightUnit
enum<string>
required
Allowed values:
KGLB
count
integer
optional
options
object
optional
signatureType
enum<string>
optional
Allowed values:
adultdirectindirectnone
Example
{
"recipient": {
"addressLine1": "725 CROSSWAY RD",
"postalCode": "94010",
"city": "BURLINGAME",
"stateCode": "CA",
"countryCode": "US"
},
"parcels": [
{
"length": 19,
"width": 13,
"height": 2,
"dimensionUnit": "IN",
"weight":20,
"weightUnit": "LB",
"count": 1
}
]
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.shipnitro.com/api/v2/rates' \
--header 'Authorization: Basic {{apiKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"recipient": {
"addressLine1": "725 CROSSWAY RD",
"postalCode": "94010",
"city": "BURLINGAME",
"stateCode": "CA",
"countryCode": "US"
},
"parcels": [
{
"length": 19,
"width": 13,
"height": 2,
"dimensionUnit": "IN",
"weight":20,
"weightUnit": "LB",
"count": 1
}
]
}'Responses
🟢200Success
application/json
Body
rates
array [object {5}]
required
service
string
required
serviceCode
string
required
currency
string
required
totalCharge
number
required
meta
object
required
Examples
{
"rates": [
{
"service": "fedex_ground",
"serviceCode": "FEDEX_GROUND",
"currency": "USD",
"totalCharge": 14.9,
"meta": {
"serviceName": "FedEx Ground®",
"rateProvider": "fedex"
}
}
]
}🟠400Bad Request
🟠400Bad Request: Package too large