Status
Request Type	POST

The parcel rating endpoint accepts information about a parcel shipment and returns a formatted list of available carriers and services.

The parcel rating endpoint will only return rates for carriers that have been set up for your company within TargetTMS.

On this page:

Related:

Page:

Making a Request

Endpoint

 https://tms.targetfmi.com/?p=api&r=text&c=parcelRateRequest&m=getParcelRates

Request Parameters

Parameter	Required	Available Options/Data Type	Max Length	Description
/shipper	Yes	n/a	n/a	Shipper container node
/shipper/state	Yes	Valid state abbreviation / String	2	The state abbreviation where the shipment will move from.
/shipper/zip	Yes	Valid postal code / String	10	The zip code where the shipment will move from.
/shipper/country	Yes	US CAN	3	The country code where the shipment will move from.
/consignee	Yes	n/a	n/a	Consignee container node
/consignee/address	No	String	~65k	Consignee address
/consignee/state	Yes	Valid state abbreviation / String	2	The state code where the shipment will move to.
/consignee/zip	Yes	Valid postal code / String	10	The zip code where the shipment will move to.
/consignee/country	Yes	US CAN	3	The country code where the shipment will move to.
/residential	Yes	[True][False] / Boolean	1	Indicates whether the shipment will be delivered to a residential address.
/packagingType	Yes	BOX* ENVELOPE PAK TUBE EXPRESS_BOX LARGE_BOX MEDIUM_BOX SMALL_BOX FEDEX_EXTRA_LARGE_BOX* PALLET* 10KG_BOX* 25KG_BOX*	n/a	The type of packaging used for the shipment. Applies to the entire rate request. Multi-piece shipments must contain the same packaging type in order to be valid. BOX should be used for customer provided packaging that does not fall into any other category. Only FedEx shipments support FEDEX_EXTRA_LARGE_BOX package types. 10KG_BOX and 25KG_BOX are only supported for international shipments. PALLET is only allowed for UPS international shipments.
/dropoffType	Yes	REGULAR_PICKUP DROP_BOX REQUEST_COURIER	n/a	Indicates how the shipment will be tendered to the carrier. This field does not initiate any type of pickup or drop off, it simply indicates how the package will be tendered in order to provide the most accurate rates.
/warehouseCode	Yes	String	20	The warehouse (facility) you wish to get a rate for (TFM will provide this). Case sensitive.
/shipDate	No	YYYY/MM/DD / String	n/a	Requested ship date for the shipment.
/packages	Yes	n/a	n/a	Packages container node.
/packages/length	Cond	Float > 0	n/a, rounding may be applied	The length of the package, in inches. Required for packaging of type BOX*
/packages/width	Cond	Float > 0	n/a, rounding may be applied	The width of the package, in inches. Required for packaging of type BOX*
/packages/height	Cond	Float > 0	n/a, rounding may be applied	The height of the package, in inches. Required for packaging of type BOX*
/packages/weight	Yes	Float > 0	n/a, rounding may be applied	The weight of the package, in pounds.
/packages/qty	Yes	Integer > 0	depends on carrier limits	The number of packages in the shipment that are identical in every way to this one. Enter 1 for a single unique package.
/packages/standardUnits	No	[True][False] / Boolean	1	Indicates whether units are standard (in/lbs) or metric (cm/kg). Default value: true.
/packages/declaredValue	No	Integer >= 100	depends on carrier limits	Declared value is covered up to the first $100 on a package by default. If you require additional insurance, enter a declared value higher than $100 for an additional surcharge.
/packages/dgInfo	No	n/a	n/a	Dangerous goods / hazardous materials container node. Must be a contracted HazMat shipper to request dangerous goods.
/packages/dgInfo/regulationSet	Cond	IATA DOT ORMD	n/a	The regulatory set associated with regulated shipment. Must be the same across the entire shipment.
/packages/dgInfo/unNum	Cond	'####' / String	4	The four digit UN number for the specified commodity.
/packages/dgInfo/classNum	Cond	String	n/a	The hazard class associated to the specified commodity.
/packages/dgInfo/subriskClassNum	Cond	String	n/a	The sub risk class associated with the specified commodity. Required if the field applies to the material by regulation.
/packages/dgInfo/properShippingName	Cond	String	n/a	The proper shipping name assigned by the regulating body.
/packages/dgInfo/technicalName	Cond	String	n/a	The technical name (when required) for the specified commodity.
/packages/dgInfo/transportMode	Cond	Ground Passenger Cargo	n/a	Declares that a package was prepared according to ground, passenger aircraft or cargo aircraft only.
/packages/dgInfo/packagingType	Cond	CYLINDER FIBERBOARD METAL BOX PLASTIC BOX PLASTIC DRUM PLASTIC JERRICAN PLASTIC PAIL STEEL DRUM STYROFOAM BOX WOODEN BOX OTHER	n/a	The type of package used to contain the regulated good.
/packages/dgInfo/regulatoryQuantity	Cond	FR LQ	n/a	Indicates the type of commodity. FR = Fully Regulated, LQ = Limited Quantity
/packages/dgInfo/packingInstructionCode	Cond	String	n/a	The packing instructions related to the chemical record. Required if the field applies to the material by regulation.
/packages/dgInfo/packagingGroup	Cond	I II III	n/a	The packing group category associated to the specified commodity. Required if the field applies to the material by regulation.
/packages/dgInfo/innerContainerType	Optional	AluminiumBag AluminiumCans AluminiumTin AluminiumTube Earthenware FiberBox FiberCan GlassAmpoule GlassTube MetalCans MetalFlexibleTube MetalTin MetalTube MultiWallPaperBag PaperBag PlasticBag PlasticContainer PlasticFlexibleTube Receptable	n/a	An inner container packages inside of the packagingType.
/packages/dgInfo/accessibility	Cond	ACCESSIBLE INACCESSIBLE	n/a	The packing group category associated to the specified commodity. Required if the field applies to the material by regulation.
/packages/dgInfo/requiredLabel	Cond	String	n/a	The required label identifying the type of hazardous material being shipped. e.g. 'NON FLAMMABLE GAS'
/packages/dgInfo/emergencyPhone	Cond	String	n/a	A valid phone number to contact in case of an emergency during shipping.
/packages/dgInfo/internationalEmergencyPhone	Cond	String	n/a	A valid phone number to contact in case of an emergency during shipping.
/packages/dgInfo/emergencyResponseRegistrant	Cond	String	n/a	The emergency response registrant number
/packages/dgInfo/offeror	Cond	String	n/a	The offeror name
/packages/dgInfo/signatoryContactName	Cond	String		The signatory contact name
/packages/dgInfo/signatoryTitle	Cond	String		The signatory title
/packages/dgInfo/signatoryPlace	Cond	String		The location of the signatory.
/packages/dgInfo/packagingTypeQty	Cond	n/a	n/a	Packaging type quantity container node.
/packages/dgInfo/packagingTypeQty/uom	Cond	cylinder g gallon kg kg G L ml ounce pint pound quart	n/a	The unit of measure used for the mass capacity of the regulated good.
/packages/dgInfo/packagingTypeQty/qty	Cond	Float > 0.0	n/a, rounding may be applied	The numerical value of the mass capacity of the regulated good.
/customs/	Cond			Customs container node
/customs/customs_value	Cond	Integer > 0	n/a	Value of package reported to customs Required if: FedEx International Shipment Inbound International UPS Shipment
/customs/commodity_units	Cond	Integer > 0	n/a	The number of units in the package Required if: FedEx International Shipment Inbound International UPS Shipment
/customs/unit_value	Cond	Integer > 0	n/a	The value of each commodity unit Required for FedEx International Shipment
/customs/unit_count	Cond	Integer > 0	n/a
/customs/part_number	Cond	String		Part number of the commodity being shipped Required for inbound international UPS shipments.
/customs/description	Cond	String		Description of the commodity being shipped.
/customs/import_uom	Cond	BA (Barrel) BE (Bundle) BG (Bag) BH (Bunch) BOX BT (Bolt) BU (Butt) CI (Canister) CM (Centimeter) CON (Container) CR (Crate) CS (Case) CT (Carton) CY (Cylinder) DOX (Dozen) EA (Each) EN (Envelope) Ft (Feet) KG (Kilogram) KGS (Kilograms) Pound (LB) LBS (Pounds) L (Liters) M (Meter) NMB (Number) PA (Packet) PAL (Pallet) PC (Piece) PCS (Pieces) PL (Proof Liters) PKG (Package) PR (Pair) PRS (Pairs) RL (Roll) SET (Set) SME (Sq Meters) SYD (SYD) TU (Tube) YD (Yard)		A description of the units of measure of the commodity. Required for inbound international UPS shipments.
/customs/export_reason	Cond	SALE GIFT SAMPLE RETURN REPAIR INTERCOMPANYDATA		The reason the commodity is being exported. Only required for inbound international UPS shipments.
/customs/origin_country	Cond	String	2	The country code of the origin of the commodity being shipped.
/specialServices	No	n/a	n/a	Special services container node.
/specialServices/type	No	COD SIGNATURE_OPTION SATURDAY_DELIVERY	n/a	Type of special service for the shipment. Numerically indexed if both are required.
/specialServices/additionalInfo	No	INDIRECT DIRECT ADULT	n/a	Type of signature option for the shipment. COD does not require additional information for a rate.
/carrier	No	FEDEX UPS USPS	n/a	The carrier for which a rate is being requested
/service	No	FEDEX_GROUND GROUND_HOME_DELIVERY FEDEX_EXPRESS_SAVER FEDEX_2_DAY FEDEX_2_DAY_AM STANDARD_OVERNIGHT PRIORITY_OVERNIGHT FIRST_OVERNIGHT INTERNATIONAL_PRIORITY INTERNATIONAL_ECONOMY 01 (UPS Next Day Air/UPS Express) 02 (UPS 2nd Day Air/UPS Expedited) 03 (UPS Ground) 04 (UPS 05 (UPS 06 (UPS 07 (UPS Worldwide Express) 08 (UPS Worldwide Expedited) 09 (UPS 10 11 (UPS Standard) 12 (UPS 3 Day Select) 13 (UPS Next Day Air Saver/UPS Express Saver) 14 (UPS Next Day Air Early/ UPS Express Early) 54 (UPS Worldwide Express Plus) 59 (UPS 2nd Day Air AM) 65 (UPS Express Saver / UPS Worldwide Saver) 70 (UPS Acess Point Economy usps_priority usps_express usps_first_class	n/a	A specified service for which a rate is being requested. UPS codes are numeric strings. In parentheses are the services they correspond to.

A Note on HazMat shipping

We currently only support Hazardous Materials shipping with FedEx and this service is available only by contractual basis.

Examples

Using an Array

 <?php
/**
 * Parcel Rate Example (Using Array Format)
 */
$data = array(
	'shipper' => array(
		'state' => 'PA',
		'zip' => '15236',
		'country' => 'US',
	),
	'consignee' => array(
		'state' => 'PA',
		'zip' => '15129',
		'country' => 'US',
	),
	'residential' => TRUE,
	'packagingType' => 'BOX',
	'dropoffType' => 'REGULAR_PICKUP',
	'warehouseCode' => 'CODE',
	'packages' => array(
		array(
			'length' => '10',
			'width' => '10',
			'height' => '10',
			'weight' => '5',
			'declaredValue' => 400,
			'qty' => 12,
		),
		array(
			'length' => '24',
			'width' => '17',
			'height' => '10',
			'weight' => '12',
			'qty' => 3,
		),
	),
);
?>

Using an Array - HazMat

 <?php
/**
 * Parcel Rate Example - HazMat (Using Array Format)
 */
$data = array (
    'warehouseCode' => 'CODE',
    'shipper' => 
    array (
      'zip' => '15056',
      'country' => 'US',
      'state' => 'PA',
    ),
    'consignee' => 
    array (
      'zip' => '15236',
      'country' => 'US',
      'state' => 'PA',
    ),
    'packages' => 
    array (
      0 => 
      array (
        'id' => '',
        'length' => '20',
        'width' => '20',
        'height' => '20',
        'weight' => '15',
        'declaredValue' => '',
        'qty' => '1',
        'standardUnits' => '1',
        'dgInfo' => 
        array (
          'selectedKey' => '',
          'regulationSet' => 'IATA',
          'unNum' => '1002',
          'classNum' => '2.2',
          'subriskClassNum' => '2.2',
          'properShippingName' => 'Air, compressed',
          'technicalName' => '',
          'transportMode' => 'Ground',
          'packagingType' => 'CYLINDER',
          'innerContainerType' => '',
          'regulatoryQuantity' => '',
          'packingInstructionCode' => '200',
          'packagingGroup' => 'None',
          'accessibility' => 'ACCESSIBLE',
          'requiredLabel' => 'NON FLAMMABLE GAS',
          'emergencyPhone' => '8005551234',
          'intlEmergencyPhone' => '8005551234',
          'emergencyResponseRegistrant' => 'REGISTRANT_NUM',
          'offeror' => 'OFFEROR',
          'signatoryContactName' => 'SIGNATORY_CONTACT',
          'signatoryTitle' => 'SIGNATORY_TITLE',
          'signatoryPlace' => 'SIGNATORY_PLACE',
          'packagingTypeQty' => 
          array (
            'uom' => 'kg',
            'qty' => '1',
          ),
        ),
      ),
    ),
    'residential' => FALSE,
    'dropoffType' => 'REGULAR_PICKUP',
    'shipDate' => '',
    'asnEmail' => '',
    'packagingType' => 'BOX',
    'shipmentId' => '',
    'carrier' => 'FEDEX',
    'service' => 'FEDEX_GROUND',
);
?>

Using stdClass()

 <?php
/**
* Parcel Rate Example (Using stdClass() Format)
*/

// Base request node
$data = new stdClass();

// Shipper details
$data->shipper = new stdClass();
$data->shipper->state = 'NY';
$data->shipper->zip = '10980';
$data->shipper->country = 'US';


// Consignee details
$data->consignee = new stdClass();
$data->consignee->state = 'PA';
$data->consignee->zip = '15129';
$data->consignee->country = 'US';

// General shipment information
$data->residential = TRUE;
$data->packagingType = 'BOX';
$data->dropoffType = 'REGULAR_PICKUP';
$data->warehouseCode = 'CODE';
$data->shipDate = '2019/01/09';

// Packages container
$data->packages = array();

// First package in the shipment
$package = new stdClass();
$package->length = '10';
$package->width = '10';
$package->height = '10';
$package->weight = '10';
$package->declaredValue = 400;
$package->qty = 2;
	
// Add the package to the container
$data->packages[] = $package;

// Second package in the shipment
$package = new stdClass();
$package->length = '20';
$package->width = '45';
$package->height = '15';
$package->weight = '8';
$package->qty = 2;

// Add the package to the container
$data->packages[] = $package;
?>

Response Parameters

Parameter Name	Description
/body/parcelRates	Container for returned parcel rates
/body/parcelRates/carrier	Name of the carrier
/body/parcelRates/shipper	Shipper zip code
/body/parcelRates/consignee	Consignee zip code
/body/parcelRates/shipDate	Date the shipment is rated for
/body/parcelRates/shipmentType	Indicates if the shipment is domestic or international
/body/parcelRates/ratingMethod	The method used to rate the package. DIM (dimensional) or ACTUAL may be returned. UPS does not return this value, but it can be inferred from the total billing weight vs. actual weight of the shipment.
/body/parcelRates/dimDivisor	The dimensional divisor that is used to calculate the shipment.
/body/parcelRates/billingWeight	The total weight that was used to calculate billing for the shipment.
/body/parcelRates/rates	Container for returned rates for this carrier.
/body/parcelRates/rates/service	Textual name of the service type.
/body/parcelRates/rates/serviceCode	Code used by the API to denote the service type.
/body/parcelRates/rates/delivery	Container for delivery date and time information.
/body/parcelRates/rates/delivery/dayOfWeek	Day of the week and date that the shipment will arrive by.
/body/parcelRates/rates/delivery/dateTime	Time of the day that the shipment will arrive by.
/body/parcelRates/rates/delivery/guaranteed	Indicates whether the delivery day of week and date time are guaranteed or estimated. 1 = Guaranteed, 0 = Estimated.
/body/parcelRates/rates/baseCharge	Base charge of the shipment.
/body/parcelRates/rates/discount	Discount amount that has been applied to the shipment.
/body/parcelRates/rates/surcharges	Container to hold surcharge information.
/body/parcelRates/rates/surcharges/type	Type of surcharge that has been applied.
/body/parcelRates/rates/surcharges/amount	Monetary amount of the surcharge.
/body/parcelRates/rates/totalSurcharges	Total monetary amount of all surcharges applied to the shipment
/body/parcelRates/rates/totalCharge	Total monetary charge for the shipment
/body/residential/	True if the address is determined to be residential. [True][False] / Boolean (only returned if rating for a UPS shipment, or if carrier/service are not specified)

Example

Example Response

Full Example

Example