Skip to main content
GET
/
v1
/
contracts
/
{contract_id}
/
rates
List contract rates
curl --request GET \
  --url https://api.opereit.com/v1/contracts/{contract_id}/rates \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "id": "<string>",
      "contract_id": "<string>",
      "origin_country": "<string>",
      "destination_country": "<string>",
      "service_type": "EXPRESS_WORLDWIDE",
      "container_type": "PARCEL",
      "rate": "12.50",
      "currency": "EUR",
      "origin_postcode": "<string>",
      "destination_postcode": "<string>",
      "weight": "<string>",
      "weight_min": "<string>",
      "weight_max": "<string>"
    }
  ],
  "pagination": {
    "cursor": "<string>",
    "has_more": true
  }
}

Authorizations

​
Authorization
string
header
required

HTTP Basic Auth using your API key. Send Authorization: Basic base64(key_id:key_secret).

Path Parameters

​
contract_id
string
required

ID of the contract.

Query Parameters

​
limit
integer
default:50

Number of items to return per request.

Required range: 1 <= x <= 100
​
cursor
string

Opaque cursor from a previous response. Omit on the first request.

​
origin_country
string

Filter by ISO 3166-1 alpha-2 origin country code.

Required string length: 2
​
destination_country
string

Filter by ISO 3166-1 alpha-2 destination country code.

Required string length: 2
​
service_type
string

Filter by carrier service code (e.g. EXPRESS_WORLDWIDE).

​
weight_min
number

Return only rates whose weight band overlaps with weight ≥ this value (kg).

​
weight_max
number

Return only rates whose weight band overlaps with weight ≤ this value (kg).

Response

Cursor-paginated rate-card entries.

​
data
object[]
required
​
pagination
object
required