Rate Options / Index
Long Description
Get shipping and rate options via FedEx.
If the type is set as a shipment type in your Shipment Settings then the set_rate returned will be the price you have set. If it is not one of your shipment types then set_rate will be null.
Parameters
Name | Description | Type | Presence | Location | Other |
|---|---|---|---|---|---|
recipient_address_id | ID of the recipient’s Address | Integer | Required | Body | Either a recipient_address_id or address_attributes is required |
address_attributes | All of the necessary properties of the recipient’s Address | Object | |||
shipper_address_id | ID of the sender’s Address | Integer | Required | Body | Either a shipper_address_id or shipper is required |
shipper | All of the necessary properties of the sender’s Address | Object |
Examples
| Request | Response |
|---|---|
Body {
"rate_options": [
{
"shipper_address_id": "123",
"recipient_address_id": "234"
}
]
}
| {
"rate_options": [
{
"type": "FIRST_OVERNIGHT",
"currency": "USD",
"origin": "fedex",
"rate": "64.55",
"saturday": false,
"delivered_by": "2014-10-15T13:00:00+00:00",
"speed": 86400,
"name": "First Overnight",
"set_rate": null
},
{
"type": "PRIORITY_OVERNIGHT",
"currency": "USD",
"origin": "fedex",
"rate": "33.89",
"saturday": false,
"delivered_by": "2014-10-15T15:30:00+00:00",
"speed": 86400,
"name": "Priority Overnight",
"set_rate": 20.0
},
{
"type": "STANDARD_OVERNIGHT",
"currency": "USD",
"origin": "fedex",
"rate": "32.63",
"saturday": false,
"delivered_by": "2014-10-15T20:00:00+00:00",
"speed": 86400,
"name": "Standard Overnight",
"set_rate": 15.0
},
{
"type": "FEDEX_2_DAY",
"currency": "USD",
"origin": "fedex",
"rate": "22.5",
"saturday": false,
"delivered_by": "2014-10-16T21:30:00+00:00",
"speed": 172800,
"name": "FedEx 2 Day",
"set_rate": 12.0
},
{
"type": "FEDEX_EXPRESS_SAVER",
"currency": "USD",
"origin": "fedex",
"rate": "16.21",
"saturday": false,
"delivered_by": "2014-10-17T21:30:00+00:00",
"speed": 259200,
"name": "FedEx Express Saver",
"set_rate": 10.0
}
]
}
|
Body {
"rate_options": [
{
"shipper": {
"address_id": "123"
},
"recipient_address_id": "234"
}
]
}
| |
Body {
"rate_options": [
{
"address_attributes": {
"street_address": "555 Evergreen Terrace",
"locality": "Springfield",
"region": "MG",
"postal_code": "58008-0000",
"country_code": "US"
},
"shipper": {
"street_address": "110 W 30th St",
"extended_address": "Seventh floor",
"locality": "New York",
"region": "NY",
"postal_code": "10001",
"country_code": "US"
}
}
]
}
|