Details of received price offers for freight publication.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • Endpoint: /ext/freights-api/v1/freights/offers/{offers-id}
  • Method: GET

Headers:

  • Content-type: application/json
  • Accept: application/json
  • Authorization: Bearer {access_token}
  • Api-key: {unique_app_api-key}

Authorization

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. This method allows to view details of a single recieved price offer

Status codes:

  • 200 OK – details of received offers
  • 404 Not found – offer doesn’t exist or no freight access

Each list of offers contains of:

Field Type Example Description
carrier Object Identifies the company that responded to the offer
carrier.address Object Carrier address information
carrier.company_id int Carrier company id
carrier.cooperation string Status of cooperation on Trans.eu Platform
carrier.email string Carrier email address
carrier.fax_number string Carrier fax number
carrier.id int Carrier employee id
carrier.legal_name string Carrier full legal name
carrier.telephone string Carrier telephone number
carrier.vat_id string Carrier legal (tax) number
contact_employees Array of object List of employees assigned to freight negotiation
contact_employees.last_name string Doe Surname of assigned employee
contact_employees.name string John First name of assigned employee
contact_employees.trans_id string 123-1 TransId of assigned employee
id int 456 Freight offer identifier
negotiation_logs Object List of price changes with additional details
price Object Current price and currency
price.currency string eur Currency of current price
price.value int or float 1250 Value of current price

Json example:

{
  "carrier": {
    "address": {
      "country": "pl",
      "locality": "City",
      "postal_code": "53-604",
      "street": "Street 93"
    },
    "company_id": 101,
    "email": "mail@example.com",
    "legal_name": "Firma Testowa Przewo┼║nik IIT 2",
    "telephone": "0048 633833929",
    "vat_id": "PL4574663803"
  },
  "contact_employees": [
    {
      "last_name": "Surname",
      "name": "Name",
      "trans_id": "101-1"
    }
  ],
  "id": 996924,
  "negotiations_logs": [
    {
      "action": "create",
      "carrier_offer_expiration_date": null,
      "comment": null,
      "created_at": "2020-06-03T13:34:53+02:00",
      "created_by": {
        "email": "mail@example.com",
        "family_name": "Surname",
        "given_name": "Name",
        "trans_id": "102-2"
      },
      "created_by_company_id": 102,
      "is_shipper": true,
      "is_withdrawn": false,
      "price": {
        "currency": "eur",
        "value": 2
      },
      "withdrawn_at": null
    },
    {
      "action": "negotiation",
      "carrier_offer_expiration_date": null,
      "comment": null,
      "created_at": "2020-06-03T13:39:09+02:00",
      "created_by": {
        "email": "mail@example.com",
        "family_name": "Surname",
        "given_name": "Name",
        "trans_id": "101-1"
      },
      "created_by_company_id": 101,
      "is_shipper": false,
      "is_withdrawn": false,
      "price": {
        "currency": "eur",
        "value": 2000
      },
      "withdrawn_at": null
    },
    {
      "action": "negotiation",
      "carrier_offer_expiration_date": null,
      "comment": "Example comment",
      "created_at": "2020-06-03T13:47:23+02:00",
      "created_by": {
        "email": "mail@example.com",
        "family_name": "Surname",
        "given_name": "Name",
        "trans_id": "102-2"
      },
      "created_by_company_id": 102,
      "is_shipper": true,
      "is_withdrawn": false,
      "price": {
        "currency": "pln",
        "value": 100
      },
      "withdrawn_at": null
    },
    {
      "action": "negotiation",
      "carrier_offer_expiration_date": null,
      "comment": "Example comment",
      "created_at": "2020-06-03T14:00:34+02:00",
      "created_by": {
        "email": "mail@example.com",
        "family_name": "Surname",
        "given_name": "Name",
        "trans_id": "101-1"
      },
      "created_by_company_id": 101,
      "is_shipper": false,
      "is_withdrawn": false,
      "price": {
        "currency": "pln",
        "value": 103
      },
      "withdrawn_at": null
    }
  ],
  "price": {
    "currency": "pln",
    "value": 103
  },
  "status": "waiting_for_accept",
  "version": 5
}