1. Trans.eu Api
  2. Freights
  3. Negotiation
  4. List of freight offers by freight ID

List of freight offers by freight ID

List of received price offers for spe­cif­ic freight pub­li­ca­tion. With­drawed offers or offers which expi­ra­tion date has passed will dis­ap­pear from the list.

Url parameters and connection settings

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

Headers:

  • Con­tent-type: application/json
  • Accept: application/json
  • Autho­riza­tion: Bear­er {access_token}
  • Api-key: {unique_ap­p_api-key}

Authorization and access

Autho­riza­tion process is described here. Each API request must also con­sist of unique Api-key obtained dur­ing appli­ca­tion reg­is­tra­tion togeth­er with client_id and client_secret.

Usage

After suc­cess­ful freight pub­li­ca­tion to a group of car­ri­ers, there will be a list of pric­ing offers received.

Offer statuses:

  • waiting_for_accept,
  • in_negotiation,
  • accept­ed,
  • reject­ed,
  • fin­ished

Status codes:

  • 200 OK — list of received offers
  • 200 OK with emp­ty table — no offers received or freight expired
  • 404 OK — freight pub­li­ca­tion does­n’t exist or no freight access allowed

Each list of offers contains of:

FieldTypeExam­pleDescrip­tion
carrier_offer_expiration_date
Time­stamp2021–03-04T12:00:00+02:00Time when car­ri­er offer expires
company_idInt123Iden­ti­fies the com­pa­ny that sub­mit­ted the price offer
created_atString2021–03-04T08:24:36+02:00Date and time of cre­at­ing the offer (UTC)
freight_idInt641839Id of freight for which the offers are sub­mit­ted
idGUID4a2dbtsd-bd6b-4c24-6t2c-256af1005591Id of offer (impor­tant for nego­ti­a­tion process)
offer_expiration_dateTime­stamp2021–03-04T12:00:00+02:00The time when the exchange offer expires (the valid­i­ty time is set auto­mat­i­cal­ly to 15 min­utes)
priceObjectPric­ing con­di­tions
price.currencyStringEurCur­ren­cy of received offer
price.valueInt2000Price val­ue
require­mentsStringMy addi­tion­al require­mentsAddi­tion­al requirements/arrangements send by car­ri­er
sta­tusStringWaiting_for_acceptCur­rent sta­tus of offer
trans_idString123–1Iden­ti­fies employ­ee of the com­pa­ny who sub­mit­ted the price offer
vat_idStringPL111111Legal (tax) com­pa­ny iden­ti­fi­er
ver­sionString3Ver­sion required for reply­ing to the offer (impor­tant for nego­ti­a­tion process)

Json examples:

With­out any price or accep­tance response from car­ri­ers:

[]

With two price offer­ings from two dif­fer­ent car­ri­ers:

[
  {
    "carrier_offer_expiration_date": null,
    "company_id": 123,
    "created_at": "2021-03-04T13:39:09+02:00",
    "freight_id": 641839,
    "id": "4a2dbtsd-bd6b-4c24-6t2c-256af1005591",
    "legal_name": "Example Company Name #1",
    "offer_expiration_date": "2021-03-04T14:18:49+02:00",
    "price": {
      "currency": "eur",
      "value": 2000
    },
    "status": "waiting_for_accept",
    "trans_id": "123-1",
    "vat_id": "PL1111111",
    "version": 3
  },
  {
    "carrier_offer_expiration_date": null,
    "company_id": 102,
    "created_at": "2021-03-04T13:29:19+02:00",
    "freight_id": 1234567,
    "id": "8b2dbtsd-bd6b-4c24-6t2c-256af1005591",
    "legal_name": "Example Company Different Name",
    "offer_expiration_date": "2021-03-04T14:19:49+02:00",
    "price": {
      "currency": "eur",
      "value": 2200
    },
    "requirements": null,
    "status": "waiting_for_accept",
    "trans_id": "102-1",
    "vat_id": "PL222222",
    "version": 3
  }
]