Get routes list

Down­load­ing a list of active and archival routes reg­is­tered in your com­pa­ny.

GET
/ext/contracts-api/v2/routes
Request Authorization

Every request MUST include a valid access token obtained dur­ing the user autho­riza­tion process, pro­vid­ed using the Bear­er token scheme in the Autho­riza­tion head­er.

Successful Response
Request Header
GET /ext/contracts-api/v2/routes HTTP/1.1 
Host: api.platform.trans.eu 
Content-Type: application/json
Accept: application/json
Authorization: Bearer {access_token) 
Api-key: {unique_app_api-key}
Request Parameters (Query)
Pagination

By default, 10 results are down­load. You can change the num­ber of results with the lim­it para­me­ter, and you can skip fetch­ing the ini­tial results with the off­set para­me­ter.

/ext/contracts-api/v2/routes?limit=15           // downloading first 15 results
/ext/contracts-api/v2/routes?limit=10&offset=10 // downloading the second page for pages of size 10
Response Fields
AttributeTypeExam­pleDescrip­tion
_embeddedObjectCon­tains a route table
_embedded.routesArray of ObjectsCon­tains a list of routes. Def­i­n­i­tion of route object in the list is described in Get fixed route details
has_moreBooleanTrueAvail­abil­i­ty indi­ca­tor for next results from the route list
Response Body
{
    "_embedded": {
        "routes": [
            {
                "id": "ad00e2c7-4865-4708-ae5d-ac6858cdf526",
                "unique_key": null,
                "name": "!!testowa_trasa1",
                "publication_scenario": null,
                "spots": [
                    {
                        "id": "19a06f87-2315-4070-908c-21e7d506c2f2",
                        "name": "Punkt1",
                        "type": "loading",
                        "place": {
                            "address": {
                                "locality": null,
                                "postal_code": null,
                                "country": "pl",
                                "street": null,
                                "number": null,
                                "location_id": null,
                                "detailed_location_id": null,
                                "foreign_id": null,
                                "radius": null
                            },
                            "coordinates": {
                                "latitude": null,
                                "longitude": null
                            }
                        }
                    },
                    {
                        "id": "9f1e1dd0-7250-4f76-bef5-433f55370458",
                        "name": "Magazyn 1",
                        "type": "unloading",
                        "place": {
                            "address": {
                                "locality": "MARSYLIA",
                                "postal_code": "13014",
                                "country": "fr",
                                "street": "Boulevard Danielle Casanova",
                                "number": "151",
                                "location_id": 1436808,
                                "detailed_location_id": 63940925,
                                "foreign_id": null,
                                "radius": null
                            },
                            "coordinates": {
                                "latitude": 43.323447,
                                "longitude": 5.3740827
                            }
                        }
                    }
                ],
                "distance": {
                    "declared": null,
                    "calculated": null
                },
                "suggested_calculated_route_id": null,
                "distance_match": {
                    "min": null,
                    "max": null
                },
                "is_roundtrip": false,
                "requirements": {
                    "required_truck_bodies": [
                        "curtainsider"
                    ],
                    "required_adr_classes": [],
                    "required_ways_of_loading": [
                        "side"
                    ],
                    "additional_requirements": [
                        "hds",
                        "gps"
                    ],
                    "shipping_remarks": null,
                    "freight_type": "FTL",
                    "vehicle_size": "any_size",
                    "width": null,
                    "height": null,
                    "length": null,
                    "volume": null,
                    "capacity": {
                        "min": null,
                        "max": {
                            "value": 24,
                            "unit_code": "t"
                        }
                    },
                    "exemption_from_adr": false
                },
                "loads": [
                    {
                        "name": null,
                        "type_of_load": null,
                        "amount": null,
                        "width": null,
                        "height": null,
                        "length": null,
                        "volume": null,
                        "weight": {
                            "min": null,
                            "max": null
                        },
                        "pallets": {
                            "is_stackable": false,
                            "is_exchangeable": false
                        }
                    }
                ],
                "balancing": {
                    "type": "manual",
                    "allowed_types": [
                        "manual",
                        "contract_condition",
                        "freight_limit",
                        "percentage_share",
                        "price_ascending"
                    ],
                    "data": {
                        "freight_limit": {
                            "min": null,
                            "max": null
                        }
                    }
                },
                "status": "archival",
                "shipments_summary": {
                    "amount": 0,
                    "weight": {
                        "value": 0,
                        "unit_code": "t"
                    },
                    "distance": {
                        "value": 0,
                        "unit_code": "km"
                    },
                    "price": [
                        {
                            "amount": null,
                            "currency": null
                        }
                    ]
                },
                "position": null,
                "_stats": {
                    "contracts": {
                        "fixed": 0,
                        "flexible": 0,
                        "registered": 0,
                        "waiting_for_acceptance": 0,
                        "waiting_for_initial_carrier_offer": 0,
                        "waiting_for_shipper_offer": 0,
                        "waiting_for_carrier_offer": 0,
                        "refused": 0,
                        "accepted": 0,
                        "active": 0,
                        "finished": 1,
                        "finished_previously_accepted": 0
                    },
                    "transports": {
                        "realized": {
                            "average_price": null,
                            "count": 0
                        },
                        "awaiting": {
                            "median_price": null,
                            "count": null
                        },
                        "cheapest_carrier_offer": null
                    }
                },
                "shipper_id": 1007374,
                "last_modification_date": "2026-03-23T14:27:16+00:00"
            },
            {
                "id": "a367d921-aff7-4952-98d3-cb7a0c9faa0b",
                "unique_key": "API_test1",
                "name": "!!!API_test",
                "publication_scenario": {
                    "type": "parallel"
                },
                "spots": [
                    {
                        "id": "2c67b81d-93f4-4fdb-a147-20e2a65562be",
                        "name": "Początek trasy",
                        "type": "loading",
                        "place": {
                            "address": {
                                "locality": "Wrocław",
                                "postal_code": "53-146",
                                "country": "pl",
                                "street": "Racławicka",
                                "number": "2-4",
                                "location_id": 1185465,
                                "detailed_location_id": 58279582,
                                "foreign_id": null,
                                "radius": null
                            },
                            "coordinates": {
                                "latitude": 51.0825872,
                                "longitude": 17.0038841
                            }
                        }
                    },
                    {
                        "id": "e836e15c-1d71-4808-b5c8-94abc54d53fe",
                        "name": "Collection AB GmbH",
                        "type": "unloading",
                        "place": {
                            "address": {
                                "locality": "Brieselang",
                                "postal_code": "09000",
                                "country": "de",
                                "street": null,
                                "number": null,
                                "location_id": null,
                                "detailed_location_id": null,
                                "foreign_id": null,
                                "radius": null
                            },
                            "coordinates": {
                                "latitude": 52.58216,
                                "longitude": 12.99756
                            }
                        }
                    }
                ],
                "distance": {
                    "declared": {
                        "value": 165,
                        "unit_code": "km"
                    },
                    "calculated": {
                        "value": 374,
                        "unit_code": "km"
                    }
                },
                "suggested_calculated_route_id": "89a91340-bac1-4427-87da-82d694118b4e",
                "distance_match": {
                    "min": {
                        "value": 150,
                        "unit_code": "km"
                    },
                    "max": {
                        "value": 190,
                        "unit_code": "km"
                    }
                },
                "is_roundtrip": false,
                "requirements": {
                    "required_truck_bodies": [
                        "cooler"
                    ],
                    "required_adr_classes": [
                        "adr_1_1"
                    ],
                    "required_ways_of_loading": [
                        "top"
                    ],
                    "additional_requirements": [
                        "cleaning_certificate",
                        "adr"
                    ],
                    "shipping_remarks": "dodatkowy opis",
                    "freight_type": "MULTI_FTL",
                    "vehicle_size": "solo",
                    "width": {
                        "value": 2,
                        "unit_code": "m"
                    },
                    "height": {
                        "value": 2,
                        "unit_code": "m"
                    },
                    "length": {
                        "value": 5,
                        "unit_code": "m"
                    },
                    "volume": {
                        "value": 20,
                        "unit_code": "m3"
                    },
                    "capacity": {
                        "min": {
                            "value": 12,
                            "unit_code": "t"
                        },
                        "max": {
                            "value": 23,
                            "unit_code": "t"
                        }
                    },
                    "exemption_from_adr": true
                },
                "loads": [
                    {
                        "name": null,
                        "type_of_load": "20ot_open_top",
                        "amount": 2,
                        "width": {
                            "value": 2.44,
                            "unit_code": "m"
                        },
                        "height": {
                            "value": 2.59,
                            "unit_code": "m"
                        },
                        "length": {
                            "value": 6.1,
                            "unit_code": "m"
                        },
                        "volume": {
                            "value": 38.55,
                            "unit_code": "m3"
                        },
                        "weight": {
                            "min": {
                                "value": 5,
                                "unit_code": "t"
                            },
                            "max": {
                                "value": 7,
                                "unit_code": "t"
                            }
                        },
                        "pallets": {
                            "is_stackable": false,
                            "is_exchangeable": false
                        }
                    }
                ],
                "balancing": {
                    "type": "freight_limit",
                    "allowed_types": [
                        "manual",
                        "contract_condition",
                        "freight_limit",
                        "percentage_share",
                        "price_ascending"
                    ],
                    "data": {
                        "freight_limit": {
                            "min": 10,
                            "max": 90
                        }
                    }
                },
                "status": "active",
                "shipments_summary": {
                    "amount": 0,
                    "weight": {
                        "value": 0,
                        "unit_code": "t"
                    },
                    "distance": {
                        "value": 0,
                        "unit_code": "km"
                    },
                    "price": [
                        {
                            "amount": null,
                            "currency": null
                        }
                    ]
                },
                "position": 235,
                "_stats": {
                    "contracts": {
                        "fixed": 0,
                        "flexible": 0,
                        "registered": 0,
                        "waiting_for_acceptance": 0,
                        "waiting_for_initial_carrier_offer": 0,
                        "waiting_for_shipper_offer": 0,
                        "waiting_for_carrier_offer": 0,
                        "refused": 0,
                        "accepted": 0,
                        "active": 0,
                        "finished": 0,
                        "finished_previously_accepted": 0
                    },
                    "transports": {
                        "realized": {
                            "average_price": null,
                            "count": 0
                        },
                        "awaiting": {
                            "median_price": null,
                            "count": null
                        },
                        "cheapest_carrier_offer": null
                    }
                },
                "shipper_id": 1007374,
                "last_modification_date": "2026-04-23T09:07:13+00:00"
            }
        ]
    },
    "has_more": true
}

Client errors (code 400)

HTTP 4xx sta­tus codes indi­cate client errors, mean­ing that the request could not be processed due to an issue on the client side.