Read a rating job, and optionally the rates it collected.

Poll this until is_terminal is true, then read it once more with ?include=rates.

Every job reaches a terminal status within roughly rating_task_min_age_minutes (30 by default): carrier attempts still processing after that are finalized as errored, so the loop is bounded even when a carrier never answers.

SecurityAPIKeyHeader
Request
path Parameters
rating_job_id
required
string (Rating Job Id)
query Parameters
include
string (Include)

Related resources to expand. rates is the only supported value, and it is not expanded by default.

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 (RatingJobResult)

A rating job: whether it has finished, and — once expanded — what the carriers answered.

Polling is the only completion signal. Every job reaches a terminal status within roughly rating_task_min_age_minutes (30 by default), because carrier attempts left processing longer than that are finalized as errored by the stale-task reaper.

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}
Request samples
Response samples
application/json
{}
Copyright © Shipwell 2025. All right reserved.