Read one rate of a rating job.

The canonical URL a rate's self_link points at: the same resource the collection carries.

SecurityAPIKeyHeader

Request

path Parameters

rating_job_id required	string (Rating Job Id)
rate_id required	string (Rate Id)

header Parameters

X-Shipwell-Version

string (X-Shipwell-Version)

Pins this request to the API as it behaved on the given ISO date, e.g. 2026-08-25. Omitted or unparseable means the oldest behaviour, so a client that never sends it keeps the behaviour it was written against.

Responses

200

Successful Response

Response Schema: application/json

required

object (PublicRate)

One carrier attempt at one service level.

An entry without charges is a failed attempt and its reason is in messages; there is no separate flag, since a rate with no price is not bookable by definition.

400

Validation Error

404

The resource requested was not found either because you do not have permissions to access it or it does not exist.

500

An unknown internal server issue occured while processing a request. A report is created and logged.

get/rating/jobs/{rating_job_id}/rates/{rate_id}

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

application/json

{"data": {"id": "string",
"resource_type": "rate",
"self_link": "string",
"carrier_rate_id": "string",
"provider_code": "AMAZON",
"carrier_name": "string",
"capacity_provider": {"account_id": "string",
"account_name": "string",
"scac": "string"
},
"transportation_mode": "DRAYAGE",
"charges": {"total_charges": {"currency": "USD",
"amount": 9001.01
},
"charge_breakdown": [{"charge_code": "string",
"description": "string",
"charge_detail": {"unit_rate": {"currency": "USD",
"amount": 9001.01
},
"unit_quantity": 0
}
}
]
},
"transit_time": {"transit_days": 0
},
"distance": {"unit": "MI",
"value": 2734.23
},
"service_code": "string",
"service_options": { },
"origin_service_type": "string",
"destination_service_type": "string",
"equipment": {"equipment_type": "AUTO_CARRIER",
"temperature": {"unit": "CELSIUS",
"minimum": 32.32,
"maximum": 212.212
}
},
"accessorials": ["string"
],
"expiration_date": "2019-08-24T14:15:22Z",
"terms": "string",
"messages": [{"type": "string",
"title": "string",
"status": "string",
"detail": "string",
"source": "string"
}
],
"recommendations": [{"code": "string",
"message": "string",
"recommendation": { }
}
],
"created_at": "2019-08-24T14:15:22Z"
}
}