Rate Shop and Get Single Rate

This API contains 2 operations, rate shop and single rate. Rate shop will fetch rates for all carrier services based on the given addresses (From and To), weight, and dimension for given parcelType. If parcelType is not provided, it will default to PKG. Single rate will get rate for specific service and special service (if requested) based on the given addresses (From and To), weight, and dimension, parcelType and serviceId with or without specialServices. Single rate will be used mainly to a rate a shipment before creating shipment.

SecuritybearerAuth

Request

header Parameters

X-PB-Developer-Partner-Id	string This is the Developer Partner ID. When the developer is the only partner, this field is not required.
compactResponse	boolean The header defines if the response required is detailed or compact. When value is set to true, it will only return rates object in response. Example: true

Request Body schema: application/json

One of:

required	object Sender address details
required	object Parcel dimension, weight and respective unit of measurement
carrierAccounts required	Array of strings It provides a single carrier account Id in case of single rate request. It can be referred from response of `Get Carrier Accounts` API.
parcelType required	string Parcel Type its value can be referred from response of `Get Parcel Types` API.
serviceId required	string Service to be used for rating, it can be referred from response of `Get Services` API
	Array of objects (SpecialService) Special services to be used for rating, it can be referred from response of `Get Special Services` API
required	object Recipient address details

Responses

200

The Rating is done for the shipment(s).

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v1/rates

Request samples

application/json

{"fromAddress": {"addressLine1": "27 Waterview Dr",
"addressLine2": "near abc street",
"addressLine3": "near xyz street",
"cityTown": "Beals",
"company": "Pitney Bowes Inc.",
"countryCode": "US",
"email": "sender@email.com",
"name": "Sasha Sekrotov",
"phone": "323 555-1212",
"postalCode": "04611-3214",
"inductionPostalCode": "06905",
"stateProvince": "ME",
"residential": false
},
"parcel": {"length": 2,
"width": 1,
"height": 1,
"dimUnit": "IN",
"weightUnit": "OZ",
"weight": 1
},
"carrierAccounts": ["12prrs1"
],
"parcelType": "PKG",
"serviceId": "EM",
"specialServices": [{"inputParameters": [{"name": "INPUT_VALUE",
"value": "100"
}
],
"specialserviceId": "Ins"
}
],
"toAddress": {"addressLine1": "27 Waterview Dr",
"addressLine2": "near abc street",
"addressLine3": "near xyz street",
"cityTown": "Westford",
"company": "Pitney Bowes Inc.",
"countryCode": "US",
"email": "receiver@email.com",
"name": "sender_fname",
"phone": "2032032033",
"postalCode": "01886-6502",
"residential": true,
"stateProvince": "MA"
}
}

Response samples

application/json

{"errors": [{"code": "validation_error",
"message": "error while getting rates for carrier with carrierAccount eRMnRx4mzPP : "
}
],
"fromAddress": {"addressLine1": "27 Waterview Drive",
"addressLine2": "",
"addressLine3": "",
"cityTown": "Beals",
"company": "ABC Company",
"countryCode": "US",
"email": "sender@email.com",
"name": "Sasha Sekrotov",
"phone": "323 555-1212",
"postalCode": "04611-3214",
"residential": false,
"stateProvince": "ME"
},
"parcel": {"dimension": {"length": 10,
"width": 10,
"height": 10,
"unitOfMeasurement": "IN"
},
"weight": {"unitOfMeasurement": "OZ",
"weight": 1
}
},
"rates": [{"baseCharge": 28.07,
"carrier": "ups",
"carrierAccount": "as1233234s",
"deliveryCommitment": {"additionalDetails": "3 - 5 business days for major markets",
"guarantee": "NONE",
"maxEstimatedNumberOfDays": "5",
"minEstimatedNumberOfDays": "3"
},
"currencyCode": "USD",
"parcelType": "PKG",
"rateTypeId": "COMMERCIAL",
"serviceId": "3DA",
"surcharges": [{"fee": 5.85,
"name": "RESIDENTIAL"
},
{"fee": 4.66,
"name": "FUEL"
}
],
"totalCarrierCharge": 38.58,
"destinationZone": 1
},
{"baseCharge": 104.12,
"carrier": "ups",
"carrierAccount": "as1233234s",
"currencyCode": "USD",
"parcelType": "PKG",
"rateTypeId": "COMMERCIAL",
"serviceId": "NDA_AM",
"surcharges": [{"fee": 5.85,
"name": "RESIDENTIAL"
},
{"fee": 15.12,
"name": "FUEL"
}
],
"totalCarrierCharge": 125.09,
"destinationZone": 8
},
{"baseCharge": 14.16,
"carrier": "ups",
"carrierAccount": "as1233234s",
"currencyCode": "USD",
"parcelType": "PKG",
"rateTypeId": "COMMERCIAL",
"serviceId": "GRD",
"surcharges": [{"fee": 5.25,
"name": "RESIDENTIAL"
},
{"fee": 2.81,
"name": "FUEL"
}
],
"totalCarrierCharge": 22.22,
"destinationZone": 5
},
{"baseCharge": 69.01,
"carrier": "ups",
"carrierAccount": "as1233234s",
"currencyCode": "USD",
"parcelType": "PKG",
"rateTypeId": "COMMERCIAL",
"serviceId": "NDA_SVR",
"surcharges": [{"fee": 5.85,
"name": "RESIDENTIAL"
},
{"fee": 10.29,
"name": "FUEL"
}
],
"totalCarrierCharge": 85.15,
"destinationZone": 1
},
{"baseCharge": 74.12,
"carrier": "ups",
"carrierAccount": "as1233234s",
"currencyCode": "USD",
"parcelType": "PKG",
"rateTypeId": "COMMERCIAL",
"serviceId": "NDA",
"surcharges": [{"fee": 5.85,
"name": "RESIDENTIAL"
},
{"fee": 10.99,
"name": "FUEL"
}
],
"totalCarrierCharge": 90.96,
"destinationZone": 1
},
{"baseCharge": 33.86,
"carrier": "ups",
"carrierAccount": "as1233234s",
"currencyCode": "USD",
"parcelType": "PKG",
"rateTypeId": "COMMERCIAL",
"serviceId": "2DA",
"surcharges": [{"fee": 5.85,
"name": "RESIDENTIAL"
},
{"fee": 5.46,
"name": "FUEL"
}
],
"totalCarrierCharge": 45.17,
"destinationZone": 2
},
{"baseCharge": 104.37,
"carrier": "FedEx",
"carrierAccount": "12232err3",
"currencyCode": "USD",
"parcelType": "PKG",
"rateTypeId": "COMMERCIAL",
"serviceId": "NDA_AM",
"surcharges": [{"fee": 5.8,
"name": "RESIDENTIAL_DELIVERY"
},
{"fee": 17.63,
"name": "FUEL"
}
],
"totalCarrierCharge": 127.8,
"destinationZone": 3
},
{"baseCharge": 38.59,
"carrier": "FedEx",
"carrierAccount": "12232err3",
"currencyCode": "USD",
"parcelType": "PKG",
"rateTypeId": "COMMERCIAL",
"serviceId": "2DA_AM",
"surcharges": [{"fee": 5.8,
"name": "RESIDENTIAL_DELIVERY"
},
{"fee": 7.1,
"name": "FUEL"
}
],
"totalCarrierCharge": 51.49,
"destinationZone": 4
}
],
"toAddress": {"addressLine1": "70 Hanlan RD",
"addressLine2": "Unit # 8",
"addressLine3": "",
"cityTown": "Westford",
"company": "Pitney Bowes Inc.",
"countryCode": "US",
"email": "receiver@email.com",
"name": "sender_fname",
"phone": "2032032033",
"postalCode": "01886-6502",
"residential": true,
"stateProvince": "MA"
}
}