List of received price offers for freight publication.
Url parameters and connection settings
- URL: https://api.platform.trans.eu
- Endpoint: /ext/freights-api/v1/freights/{freight-id}/offers
- Method: GET
Headers:
- Content-type: application/json
- Accept: application/json
- Authorization: Bearer {access_token}
- Api-key: {unique_app_api-key}
Authorization and access
Authorization process is described here. Each API request must also consist of unique Api-key obtained during application registration together with client_id and client_secret.
For accessing freights API no additional scopes are set, therefore the scope parameter can be left empty. If 403 error is received, please contact API support.
Usage
After successful freight publication to a group of carriers, there will be pricing offers received.
Status codes:
- 200 OK – list of received offers
- 200 OK with empty table – no offers received or freight expired
- 404 OK – freight doesn’t exist or no freight access allowed
Each list of offers contains of:
| Field | Type | Example | Description |
| company_id | int | 123 | Identifies the company that submitted the offer |
| created_at | string | 2020-04-24T08:24:36+02:00 | Date and time of creating the offer (UTC) |
| freight_id | int | 12 | Id of freight for which the offers are submitted |
| id | int | 8 | Id of offer |
| price | Object | Pricing conditions | |
| price.currency | string | eur | Currency of received offer |
| price.value | int | 1000 | Price value |
| status | string | waiting_for_accept | Current status of offer |
| trans_id | string | 123-1 | Identifies employee of the company who submitted the offer |
| vat_id | string | PL111111 | Legal (tax) company identifier |
| version | string | 3 | Version required for replying to the offer |
Json examples:
Without any price or acceptance response from carriers:
[]
With two price offerings from two different carriers:
[
{
“company_id”: 101,
“created_at”: “2020-06-03T13:39:09+02:00”,
“freight_id”: 1234567,
“id”: 996924,
“legal_name”: “Example Company Name #1”,
“price”: {
“currency”: “eur”,
“value”: 2000
},
“status”: “waiting_for_accept”,
“trans_id”: “101-1”,
“vat_id”: “PL1111111”,
“version”: 3
},
{
“company_id”: 102,
“created_at”: “2020-06-03T13:29:19+02:00”,
“freight_id”: 1234567,
“id”: 996925,
“legal_name”: “Example Company Different Name”,
“price”: {
“currency”: “eur”,
“value”: 2200
},
“status”: “waiting_for_accept”,
“trans_id”: “102-1”,
“vat_id”: “PL222222”,
“version”: 3
}
]