Allows to negotiate conditions of received offer

Url parameters and connection settings

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

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.

Usage

Once the carrier response has been received it is possible to negotiate received conditions with own offer.

Each offer contains of:

Field Type Example Description
payment Object Proposed price description
payment.price Object Proposed price description
payment.price.currency String Eur Currency of proposed price offer
payment.price.value Int 1000 Value of proposed price offer
requirements String Additional requirements Requirements and conditions for the offer
version String 2 Negotiation version
carrier_offer_expiration_date Timestamp
2021-03-08T12:20:34+01:00
Offer validity date

 

Conditions:

  • currency must be the same as in published freight
  • version must be the same as received

Json example with required data only:

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

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": 1735632,
    "price": {
        "currency": "eur",
        "value": 150
    },
    "requirements": "",
    "version": 3,
    "was_negotiated": true
}