Details of received price offer

Details of received price offers for active freight pub­li­ca­tion.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • End­point: /ext/freights-api/v1/freights/offers/{offers-id}
  • 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

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 and freight for­warders, there will be a list of pric­ing offers received. This method allows to view details of a sin­gle received price offer by it’s id.

Status codes:

  • 200 OK — details of received offers
  • 404 Not found — offer does­n’t exist or no freight access

Each list of offers contains of:

FieldTypeExam­pleDescrip­tion
car­ri­erObjectIden­ti­fies the com­pa­ny that respond­ed to the offer
carrier.addressObjectCar­ri­er address infor­ma­tion
carrier.company_idInt1013865Car­ri­er com­pa­ny id
carrier.emailStringinfo@trans.euCar­ri­er email address
carrier.fax_numberString1111111111111Car­ri­er fax num­ber
carrier.legal_nameStringCom­pa­ny nameCar­ri­er full legal name
carrier.telephoneString1111111111111Car­ri­er tele­phone num­ber
carrier.vat_idString1111111111111Car­ri­er legal (tax) num­ber
contact_employeesArray of objectsList of employ­ees assigned to freight nego­ti­a­tion
contact_employees.last_nameStringDoeSur­name of assigned employ­ee
contact_employees.nameStringJohnFirst name of assigned employ­ee
contact_employees.trans_idString123–1Tran­sId of assigned employ­ee
idUUID4a2dbtsd-bd6b-4c24-6t2c-256af1005591Freight offer iden­ti­fi­er (impor­tant for nego­ti­a­tion process)
negotiation_logsArray of objectsList of price changes with addi­tion­al details (described in table below)
offer_expiration_dateTime­stamp2020–06-03T14:29:49+02:00The time when the exchange offer expires (the valid­i­ty time is set auto­mat­i­cal­ly to 15 min­utes)
priceObjectCur­rent price and cur­ren­cy
price.currencyStringEurCur­ren­cy of cur­rent price
price.valueInt or float1250Val­ue of cur­rent price
sta­tusStringWaiting_for_acceptPrice nego­ti­a­tion offer sta­tus
ver­sionInt5Ver­sion of nego­ti­a­tion offer (impor­tant for nego­ti­a­tion process)

Negotiations log

FieldTypeExam­pleDescrip­tion
actionStringCre­ateNego­ti­a­tion action type
carrier_offer_expiration_dateTime­stampNullDate and time of offer expi­ra­tion
com­mentStringNullAddi­tion­al com­ment, post­ed as “require­ments” dur­ing offer cre­ation
created_atTime­stamp2021–03-08T10:59:02+01:00Date and time of offer cre­ation
created_byObjectDetails of per­son sub­mit­ting the offer
created_by.emailString info@trans.euEmail address
created_by.family_nameStringKowal­s­kiName
created_by.given_nameStringJanSur­name
created_by.trans_idString12345–67Tran­sId
created_by_company_idInt12345Com­pa­ny id
is_shipperBooleanTrueVal­ue set to true if offer was sent by ship­per
is_withdrawnBooleanFalseVal­ue set to true if offer has been already with­drawn
priceObjectPrice val­ue and cur­ren­cy
price.currencyStringEurPrice cur­ren­cy
price.valueInt200Price val­ue
withdrawn_atTime­stampNullDate and time of cur­ren­cy with­drawn

Json example Request:

{
  "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": "4a2dbtsd-bd6b-4c24-6t2c-256af1005591",
  "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
    }
  ],
  "offer_expiration_date": "2020-06-03T14:29:49+02:00",
  "price": {
    "currency": "pln",
    "value": 103
  },
  "status": "waiting_for_accept",
  "version": 5
}