Get the rates associated with a rating request by its ID.

Retrieve the list of rates associated with a specific rating request.

SecurityAPIKeyHeader
Request
path Parameters
rate_request_id
required
string (Rate Request Id)
query Parameters
page
integer (Page) >= 1
Default: 1
limit
integer (Limit) [ 1 .. 200 ]
Default: 50
Responses
200

Successful Response

Response Schema: application/json
required
Array of objects (Data)
count
required
integer (Count)

Number of the items within the 'data' array.

required
Total Count (integer) or Total Count (null) (Total Count)

Number of items in the entire result set. Value is always >= count. Inclusion depends on the underlying result set.

required
object (PaginationLinks)
status
string (RateStatus)
Default: "CREATED"
Enum: "CREATED" "PROCESSING" "ERRORED" "SUCCEEDED" "CANCELLED" "EXPIRED" "REVOKED" "COMPLETED"
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/{rate_request_id}/rates
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "count": 0,
  • "total_count": 0,
  • "links": {},
  • "status": "CREATED"
}
Copyright © Shipwell 2025. All right reserved.