Negotiate freight offer

Allows to nego­ti­ate con­di­tions of received offer

Url parameters and connection settings

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

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

Once the car­ri­er response has been received it is pos­si­ble to nego­ti­ate received con­di­tions with own offer.

Each offer contains of:

FieldTypeExam­pleDescrip­tion
pay­mentObjectPro­posed price descrip­tion
payment.priceObjectPro­posed price descrip­tion
payment.price.currencyStringEurCur­ren­cy of pro­posed price offer
payment.price.valueInt1000Val­ue of pro­posed price offer
ver­sionString2Nego­ti­a­tion ver­sion

Conditions:

  • cur­ren­cy must be the same as in pub­lished freight
  • ver­sion must be the same as received

Json example with required data only:

{
  "payment": {
    "price": {
      "value": 150
    }
  },
  "version": 2
}

Example response:

{
  "carrier": {
    "company_id": 1013865,
    "cooperation": {
      "is_suspended": false
    },
    "legal_name": "Firma Testowa Przewoźnik IIT 2",
    "vat_id": "PL111111111"
  },
  "created_at": "2021-03-08T10:58:59+01:00",
  "id": "4a2dbtsd-bd6b-4c24-6t2c-256af1005591",
  "price": {
    "currency": "eur",
    "value": 150
  },
  "requirements": "",
  "version": 3,
  "was_negotiated": true
}