Rates

Shipping rate requests

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.

Get shipping rates

POST/api/v1/rates

Request body

Field	Type	Description
carrierAccountId	string
shipFrom	Address
shipTo	Address
parcels	array

{
  "carrierAccountId": "550e8400-e29b-41d4-a716-446655440000",
  "shipFrom": {
    "name": "Jane Doe",
    "company": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province": "string",
    "provinceCode": "string",
    "zip": "94107",
    "country": "string",
    "countryCode": "string",
    "phone": "string",
    "email": "jane@example.com"
  },
  "shipTo": {
    "name": "Jane Doe",
    "company": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province": "string",
    "provinceCode": "string",
    "zip": "94107",
    "country": "string",
    "countryCode": "string",
    "phone": "string",
    "email": "jane@example.com"
  },
  "parcels": [
    {}
  ]
}

Responses

200 Rate quotes

POST/api/v1/rates

Get shipping rates

API key (Bearer token)

Request body (JSON){ "carrierAccountId": "550e8400-e29b-41d4-a716-446655440000", "shipFrom": { "name": "Jane Doe", "company": "string", "address1": "string", "address2": "string", "city": "string", "province": "string", "provinceCode": "string", "zip": "94107", "country": "string", "countryCode": "string", "phone": "string", "email": "jane@example.com" }, "shipTo": { "name": "Jane Doe", "company": "string", "address1": "string", "address2": "string", "city": "string", "province": "string", "provinceCode": "string", "zip": "94107", "country": "string", "countryCode": "string", "phone": "string", "email": "jane@example.com" }, "parcels": [ {} ] }

https://api-test.orderly-hub.com/api/v1/rates

Get rates using order data

POST/api/v1/rates/from-order/{orderId}

Parameters

Name	In	Required	Type	Description
orderId	path	yes	string

Request body

Field	Type	Description
carrierAccountId	string

{
  "carrierAccountId": "550e8400-e29b-41d4-a716-446655440000"
}

Responses

200 Rate quotes for order

POST/api/v1/rates/from-order/{orderId}

Get rates using order data

API key (Bearer token)

orderId * (path)

Request body (JSON){ "carrierAccountId": "550e8400-e29b-41d4-a716-446655440000" }

https://api-test.orderly-hub.com/api/v1/rates/from-order/

Save a rate snapshot

POST/api/v1/rates/snapshots

Request body

{}

Responses

201 Snapshot saved

POST/api/v1/rates/snapshots

Save a rate snapshot

API key (Bearer token)

Request body (JSON){}

https://api-test.orderly-hub.com/api/v1/rates/snapshots

Get a rate snapshot

GET/api/v1/rates/snapshots/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Snapshot details

GET/api/v1/rates/snapshots/{id}

Get a rate snapshot

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/rates/snapshots/