Home

Introduction

Rate Management System API

version 1

Rates Management System API allows user to add, edit and delete own standarad rates as well as list with pagination all available rates.

OpenAPI Specification

Start designing your API in minutes. The OpenAPI specification file enables you to learn and interact with API elements, including all available endpoints, input and output representations.

OpenAPI Spec

General information

Rate Management System API is organized around REST.
Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

API endpoint#

1https://rates.searates.com/api/v1/rates

All endpoints are only accessible via HTTPS and are located at rates.searates.com

Shipping types list

get/dictionary/shipping-types

Find shipping types by part of the name or retrieve the full list. Also includes transport unit types

Headers

Content-Typeapplication/json

Query Parameters
  • searchOptionalstring

    Text for searching in carriers' names

Response example
OK

Carriers list

get/dictionary/carriers

Find carriers by part of the name or retrieve the full list

Headers

Content-Typeapplication/json

Query Parameters
  • searchOptionalstring

    Text for searching in carriers' names

  • carrier_typeREQUIREDstring

    Carrier type

    Allowed values:SEALINEAIRLINELAND_SHIPPER

Response example
OK

Get available rates

post/index

Paginate list of all available rates for selected shipping type with possible other filters

Headers

Content-Typeapplication/json

Body Parameters
  • idOptionalarray[integer]

    List of specific rate IDs to find

  • shipping_typeOptionalstring or integer

    ID or short name for specific shipping type. Can be retrieved via dictionary request.

  • door_serviceOptionalno type

    Whether to filter rates by door service (door-to-door, port-to-port, etc.)

    Allowed values:port_to_portport_to_doordoor_to_portdoor_to_door

  • statusOptionalno type

    Whether to show rates with only specific validity status

    Allowed values:ValidProspectiveExpiresExpired

  • pre_carriage_typeOptionalno type

    Filter by specific pre-carriage type

    Allowed values:TRUCKRAIL

  • pre_carriage_placeOptionalstring

    ID of pre-carriage place, when needed

  • originOptionalstring

    ID of origin place, when needed

  • destinationOptionalstring

    ID of destination place, when needed

  • on_carriage_typeOptionalno type

    Filter by specific on-carriage type

    Allowed values:TRUCKRAIL

  • on_carriage_placeOptionalstring

    ID of on-carriage place, when needed

  • carrier_idOptionalstring

    ID of carrier to filter by. Can be retrieved via dictionary query.

  • valid_fromOptionalobject

    Dates range of rate's validity end

  • valid_toOptionalobject

    Dates range of rate's validity end

  • spotOptionalboolean
  • space_guaranteeOptionalboolean
  • hot_dealsOptionalboolean
  • OTHCOptionalboolean

    Only for FCL, LCL, Bulk shipping types

  • DTHCOptionalboolean

    Only for FCL, LCL, Bulk shipping types

  • commodityOptionalno type

    Only for Air

    Allowed values:GENPRIEXPDGRPER

  • volume_ratioOptionalno type

    Only for Air

    Allowed values:1:11:21:31:41:51:6

  • unit_systemOptionalno type

    For FTL, LTL, LCL shipping types

    Allowed values:metricimperial

  • max_transit_timeOptionalinteger

    Whether to show only rates with transit time that is less of equal to selected

  • currencyOptionalstring

    3-char currency code (USD, EUR, etc.)

  • pageOptionalinteger

    Pagination data - number of page to show

    >= 1

    Default:1

  • per_pageOptionalinteger

    Pagination data - number of rates per page to show

    >= 1<= 100

Response example
OK

Add new rate

post/add
Headers

Content-Typeapplication/json

Body Parameters
  • shipping_typeREQUIREDstring

    ID or short name of specific shipping type

  • valid_fromREQUIREDstring

    Rate validity start date

  • valid_toREQUIREDstring

    Rate validity end date

  • transit_timeOptionalinteger
  • spotOptionalboolean
  • hot_dealsOptionalboolean
  • space_guaranteeOptionalboolean
  • notesOptionalstring
  • OTHCOptionalboolean

    Only for Sea types (FCL, LCL, Bulk)

  • DTHCOptionalboolean

    Only for Sea types (FCL, LCL, Bulk)

  • carrier_idOptionalstring

    ID of carrier. Can be retrieved via dictionary request

  • commodityOptionalno type

    Only for Air shipping type

    Allowed values:GENPRIEXPDGRPER

  • volume_ratioOptionalno type

    Only for Air shipping type

    Allowed values:1:11:21:31:41:51:6

  • pre_carriage_typeOptionalno type

    Only for Sea (FCL, LCL, Bulk) shipping types. Only when pre-carriage is planned.

    Allowed values:TRUCKRAIL

  • pre_carriage_placeOptionalobject

    Only for Sea (FCL, LCL, Bulk) and Air shipping types. Only when on-carriage is planned.

  • originREQUIREDobject

    Only for Sea (FCL, LCL, Bulk) and Air shipping types. Only when on-carriage is planned.

  • destinationREQUIREDobject

    Only for Sea (FCL, LCL, Bulk) and Air shipping types. Only when on-carriage is planned.

  • on_carriage_typeOptionalno type

    Only for Sea (FCL, LCL, Bulk) shipping types. Only when on-carriage is planned.

    Allowed values:TRUCKRAIL

  • on_carriage_placeOptionalobject

    Only for Sea (FCL, LCL, Bulk) and Air shipping types. Only when on-carriage is planned.

  • pricesREQUIREDarray[object]

    List of prices for different unit types

Response example
Rate data, retrieved after creating/updating/showing
1{
2  "success": true,
3  "data": {
4    "id": 1577156,
5    "valid_from": "2025-05-29 00:00:00",
6    "valid_to": "2025-06-12 00:00:00",
7    "commodity": null,
8    "created_at": "2025-05-28 15:50:40",
9    "transit_time": null,
10    "spot": false,
11    "space_guarantee": false,
12    "OTHC": false,
13    "DTHC": false,
14    "door_service": null,
15    "hot_deals": false,
16    "co2": null,
17    "notes": null,
18    "volume_ratio": null,
19    "status": "Valid",
20    "carrier": {
21      "id": 10,
22      "name": "Maersk",
23      "short_name": "MAEU",
24      "type": "SEALINE"
25    },
26    "shipping_type": {
27      "id": 1,
28      "name": "Full Container Load",
29      "short_name": "FCL",
30      "shipping_mode": "sea"
31    },
32    "points": {
33      "pre_carriage": {
34        "id": "2",
35        "name": "New York, NY, USA",
36        "short_name": "USNYC",
37        "country": "US",
38        "latitude": 40.7127753,
39        "longitude": -74.0059728
40      },
41      "origin": {
42        "id": 16959,
43        "name": "New York",
44        "short_name": "USNYC",
45        "country": "US",
46        "latitude": 40.70547541536396,
47        "longitude": -74.01768086553932
48      },
49      "destination": {
50        "id": 23097,
51        "name": "Callao",
52        "short_name": "PECLL",
53        "country": "PE",
54        "latitude": -12.053688182127662,
55        "longitude": -77.1212778432581
56      },
57      "on_carriage": null
58    },
59    "prices": [
60      {
61        "amount": "1",
62        "type": "weight",
63        "unit": "mt",
64        "unit_short_name": "MT",
65        "price": null,
66        "currency": null,
67        "calculation_data": null
68      },
69      {
70        "amount": "1",
71        "type": "container",
72        "unit": "20' Standard",
73        "unit_short_name": "20'ST",
74        "price": null,
75        "currency": null,
76        "calculation_data": null
77      }
78    ]
79  }
80}

Show rate data by ID

post/show/{rateId}
Headers

Content-Typeapplication/json

Path Parameters
  • rateIdREQUIREDinteger

    ID of existing rate to be shown, edited or deleted

Response example
Rate data, retrieved after creating/updating/showing
1{
2  "success": true,
3  "data": {
4    "id": 1577156,
5    "valid_from": "2025-05-29 00:00:00",
6    "valid_to": "2025-06-12 00:00:00",
7    "commodity": null,
8    "created_at": "2025-05-28 15:50:40",
9    "transit_time": null,
10    "spot": false,
11    "space_guarantee": false,
12    "OTHC": false,
13    "DTHC": false,
14    "door_service": null,
15    "hot_deals": false,
16    "co2": null,
17    "notes": null,
18    "volume_ratio": null,
19    "status": "Valid",
20    "carrier": {
21      "id": 10,
22      "name": "Maersk",
23      "short_name": "MAEU",
24      "type": "SEALINE"
25    },
26    "shipping_type": {
27      "id": 1,
28      "name": "Full Container Load",
29      "short_name": "FCL",
30      "shipping_mode": "sea"
31    },
32    "points": {
33      "pre_carriage": {
34        "id": "2",
35        "name": "New York, NY, USA",
36        "short_name": "USNYC",
37        "country": "US",
38        "latitude": 40.7127753,
39        "longitude": -74.0059728
40      },
41      "origin": {
42        "id": 16959,
43        "name": "New York",
44        "short_name": "USNYC",
45        "country": "US",
46        "latitude": 40.70547541536396,
47        "longitude": -74.01768086553932
48      },
49      "destination": {
50        "id": 23097,
51        "name": "Callao",
52        "short_name": "PECLL",
53        "country": "PE",
54        "latitude": -12.053688182127662,
55        "longitude": -77.1212778432581
56      },
57      "on_carriage": null
58    },
59    "prices": [
60      {
61        "amount": "1",
62        "type": "weight",
63        "unit": "mt",
64        "unit_short_name": "MT",
65        "price": null,
66        "currency": null,
67        "calculation_data": null
68      },
69      {
70        "amount": "1",
71        "type": "container",
72        "unit": "20' Standard",
73        "unit_short_name": "20'ST",
74        "price": null,
75        "currency": null,
76        "calculation_data": null
77      }
78    ]
79  }
80}

Update rate data by ID

post/update/{rateId}
Headers

Content-Typeapplication/json

Path Parameters
  • rateIdREQUIREDinteger

    ID of existing rate to be shown, edited or deleted

Body Parameters
  • shipping_typeREQUIREDstring

    ID or short name of specific shipping type

  • valid_fromREQUIREDstring

    Rate validity start date

  • valid_toREQUIREDstring

    Rate validity end date

  • transit_timeOptionalinteger
  • spotOptionalboolean
  • hot_dealsOptionalboolean
  • space_guaranteeOptionalboolean
  • notesOptionalstring
  • OTHCOptionalboolean

    Only for Sea types (FCL, LCL, Bulk)

  • DTHCOptionalboolean

    Only for Sea types (FCL, LCL, Bulk)

  • carrier_idOptionalstring

    ID of carrier. Can be retrieved via dictionary request

  • commodityOptionalno type

    Only for Air shipping type

    Allowed values:GENPRIEXPDGRPER

  • volume_ratioOptionalno type

    Only for Air shipping type

    Allowed values:1:11:21:31:41:51:6

  • pre_carriage_typeOptionalno type

    Only for Sea (FCL, LCL, Bulk) shipping types. Only when pre-carriage is planned.

    Allowed values:TRUCKRAIL

  • pre_carriage_placeOptionalobject

    Only for Sea (FCL, LCL, Bulk) and Air shipping types. Only when on-carriage is planned.

  • originREQUIREDobject

    Only for Sea (FCL, LCL, Bulk) and Air shipping types. Only when on-carriage is planned.

  • destinationREQUIREDobject

    Only for Sea (FCL, LCL, Bulk) and Air shipping types. Only when on-carriage is planned.

  • on_carriage_typeOptionalno type

    Only for Sea (FCL, LCL, Bulk) shipping types. Only when on-carriage is planned.

    Allowed values:TRUCKRAIL

  • on_carriage_placeOptionalobject

    Only for Sea (FCL, LCL, Bulk) and Air shipping types. Only when on-carriage is planned.

  • pricesREQUIREDarray[object]

    List of prices for different unit types

Response example
Rate data, retrieved after creating/updating/showing
1{
2  "success": true,
3  "data": {
4    "id": 1577156,
5    "valid_from": "2025-05-29 00:00:00",
6    "valid_to": "2025-06-12 00:00:00",
7    "commodity": null,
8    "created_at": "2025-05-28 15:50:40",
9    "transit_time": null,
10    "spot": false,
11    "space_guarantee": false,
12    "OTHC": false,
13    "DTHC": false,
14    "door_service": null,
15    "hot_deals": false,
16    "co2": null,
17    "notes": null,
18    "volume_ratio": null,
19    "status": "Valid",
20    "carrier": {
21      "id": 10,
22      "name": "Maersk",
23      "short_name": "MAEU",
24      "type": "SEALINE"
25    },
26    "shipping_type": {
27      "id": 1,
28      "name": "Full Container Load",
29      "short_name": "FCL",
30      "shipping_mode": "sea"
31    },
32    "points": {
33      "pre_carriage": {
34        "id": "2",
35        "name": "New York, NY, USA",
36        "short_name": "USNYC",
37        "country": "US",
38        "latitude": 40.7127753,
39        "longitude": -74.0059728
40      },
41      "origin": {
42        "id": 16959,
43        "name": "New York",
44        "short_name": "USNYC",
45        "country": "US",
46        "latitude": 40.70547541536396,
47        "longitude": -74.01768086553932
48      },
49      "destination": {
50        "id": 23097,
51        "name": "Callao",
52        "short_name": "PECLL",
53        "country": "PE",
54        "latitude": -12.053688182127662,
55        "longitude": -77.1212778432581
56      },
57      "on_carriage": null
58    },
59    "prices": [
60      {
61        "amount": "1",
62        "type": "weight",
63        "unit": "mt",
64        "unit_short_name": "MT",
65        "price": null,
66        "currency": null,
67        "calculation_data": null
68      },
69      {
70        "amount": "1",
71        "type": "container",
72        "unit": "20' Standard",
73        "unit_short_name": "20'ST",
74        "price": null,
75        "currency": null,
76        "calculation_data": null
77      }
78    ]
79  }
80}

Delete rate by ID

post/delete/{rateId}
Headers

Content-Typeapplication/json

Path Parameters
  • rateIdREQUIREDinteger

    ID of existing rate to be shown, edited or deleted

Response example
OK
SeaRates 2025—Find a toolRequest an IT quoteContact us