Details of received price offers for active 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.

Usage

After successful freight publication to a group of carriers and freight forwarders, there will be a list of pricing offers received. This method allows to view details of a single received price offer by it’s id.

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 1013865 Carrier company id
carrier.email String info@trans.eu Carrier email address
carrier.fax_number String 1111111111111 Carrier fax number
carrier.legal_name String Company name Carrier full legal name
carrier.telephone String 1111111111111 Carrier telephone number
carrier.vat_id String 1111111111111 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 (important for negotiation process)
negotiation_logs Array of object List of price changes with additional details (described in table below)
price Object Current price and currency
price.currency String Eur Currency of current price
price.value Int or float 1250 Value of current price
status String Waiting_for_accept Price negotiation offer status
version Int 5 Version of negotiation offer (important for negotiation process)

Negotiations log

Field Type Example Description
action String Create Negotiation action type
carrier_offer_expiration_date Timestamp Null Date and time of offer expiration
comment String Null Additional comment, posted as “requirements” during offer creation
created_at Timestamp 2021-03-08T10:59:02+01:00 Date and time of offer creation
created_by Object Details of person submitting the offer
created_by.email String  info@trans.eu Email address
created_by.family_name String Kowalski Name
created_by.given_name String Jan Surname
created_by.trans_id String 12345-67 TransId
created_by_company_id Int 12345 Company id
is_shipper Boolean True Value set to true if offer was sent by shipper
is_withdrawn Boolean False Value set to true if offer has been already withdrawn
price Object Price value and currency
price.currency String Eur Price currency
price.value Int 200 Price value
withdrawn_at Timestamp Null Date and time of currency withdrawn

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
}