Pickup Rate Example Request

POST {{base_url}}/api/shipments/:version/pickup/:pickuptype

This HTTP POST request returns the estimated rates of an on-call pickup when a PickupAddress and PickupDateInfo are provided.

Request Body

{"PickupRateRequest"=>{"PickupAddress"=>{"AddressLine"=>"315 Saddle Bridge Drive", "City"=>"Allendale", "StateProvince"=>"NJ", "PostalCode"=>"07401", "CountryCode"=>"US", "ResidentialIndicator"=>"Y"}, "AlternateAddressIndicator"=>"N", "ServiceDateOption"=>"02", "PickupDateInfo"=>{"CloseTime"=>"2000", "ReadyTime"=>"900", "PickupDate"=>"20160405"}}}

HEADERS

KeyDatatypeRequiredDescription
transIdnullAn identifier unique to the request. Length 32
transactionSrcstringAn identifier unique to the request. Length 32
Content-Typestring

RESPONSES

status: OK

{"PickupRateResponse":{"RateResult":{"ChargeDetail":[{"ChargeAmount":"5.80","ChargeCode":"B","ChargeDescription":"BASE CHARGE","TaxAmount":"0.00"},{"ChargeAmount":"0.00","ChargeCode":"S","ChargeDescription":"REMOTE AREA SURCHARGE","TaxAmount":"0.00"},{"ChargeAmount":"3.95","ChargeCode":"S","ChargeDescription":"RESIDENTIAL SURCHARGE","TaxAmount":"0.00"},{"ChargeAmount":"0.71","ChargeCode":"S","ChargeDescription":"FUEL SURCHARGE","TaxAmount":"0.00"}],"CurrencyCode":"USD","GrandTotalOfAllCharge":"10.46","RateType":"FD"},"Response":{"ResponseStatus":{"Code":"1","Description":"Success"}}}}