Rate Comparisons

Carrier rate comparison analysis

All endpoints require a bearer token (oh_... API key or user JWT) and are served under https://api.orderly-hub.com. Use the Try it consoles to run a request against the Preview (test) server.

List rate comparisons

GET/api/v1/rate-comparisons

Parameters

Name	In	Required	Type	Description
page	query	no	integer
limit	query	no	integer
status	query	no	string

Responses

200 Paginated rate comparison list

GET/api/v1/rate-comparisons

List rate comparisons

API key (Bearer token)

page (query)

limit (query)

status (query)

https://api-test.orderly-hub.com/api/v1/rate-comparisons

Create a rate comparison

POST/api/v1/rate-comparisons

Request body

Field	Type	Description
name	string
carrierAccountId	string
sourceCarrier	string
items	array

{
  "name": "Jane Doe",
  "carrierAccountId": "550e8400-e29b-41d4-a716-446655440000",
  "sourceCarrier": "string",
  "items": [
    {
      "trackingNumber": "string",
      "netCost": 0,
      "serviceType": "string",
      "originZip": "string",
      "originCity": "string",
      "originState": "string",
      "destinationZip": "string",
      "destinationCity": "string",
      "destinationState": "string"
    }
  ]
}

Responses

201 Rate comparison created

POST/api/v1/rate-comparisons

Create a rate comparison

API key (Bearer token)

Request body (JSON){ "name": "Jane Doe", "carrierAccountId": "550e8400-e29b-41d4-a716-446655440000", "sourceCarrier": "string", "items": [ { "trackingNumber": "string", "netCost": 0, "serviceType": "string", "originZip": "string", "originCity": "string", "originState": "string", "destinationZip": "string", "destinationCity": "string", "destinationState": "string" } ] }

https://api-test.orderly-hub.com/api/v1/rate-comparisons

Get rate comparison details

GET/api/v1/rate-comparisons/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Rate comparison details

GET/api/v1/rate-comparisons/{id}

Get rate comparison details

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/rate-comparisons/

Delete a rate comparison

DELETE/api/v1/rate-comparisons/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Rate comparison deleted

DELETE/api/v1/rate-comparisons/{id}

Delete a rate comparison

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/rate-comparisons/

List rate comparison items

GET/api/v1/rate-comparisons/{id}/items

Parameters

Name	In	Required	Type	Description
id	path	yes	string
page	query	no	integer
limit	query	no	integer
status	query	no	string
zone	query	no	string
serviceType	query	no	string
search	query	no	string

Responses

200 Paginated item list

GET/api/v1/rate-comparisons/{id}/items

List rate comparison items

API key (Bearer token)

id * (path)

page (query)

limit (query)

status (query)

zone (query)

serviceType (query)

search (query)

https://api-test.orderly-hub.com/api/v1/rate-comparisons//items

Start processing a rate comparison

POST/api/v1/rate-comparisons/{id}/process

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Processing started

POST/api/v1/rate-comparisons/{id}/process

Start processing a rate comparison

API key (Bearer token)

id * (path)

Request body (JSON)

https://api-test.orderly-hub.com/api/v1/rate-comparisons//process

Get rate comparison summary/analytics

GET/api/v1/rate-comparisons/{id}/summary

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Summary with cost and zone breakdowns

GET/api/v1/rate-comparisons/{id}/summary

Get rate comparison summary/analytics

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/rate-comparisons//summary