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

Authorization

Authorization process is described here.

For accessing freights API no additional scopes are set, therefore the scope parameter can be left empty. If 403 error is received, please contact API support.

Usage

After successful freight publication to a group of carriers, there will be pricing offers received. This method allows to view details of a single recieved price offer

Status codes:

  • 200 OK – details of received offers
  • 404 OK – 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.company_id int
carrier.cooperation string
carrier.email string
carrier.fax_number string
carrier.id int
carrier.legal_name string
carrier.source string
carrier.telephone string
carrier.vat_id string
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
negotiation_logs Object List of price changes with additional details
price Object Current price and currency
price.currency string eur Currency of current price
price.value int or float 1250 Value of current price

Json example:

{
  "carrier": {
    "address": {
      "country": "pl",
      "description": null,
      "id": 123,
      "locality": "City",
      "location_id": null,
      "postal_code": "11-000",
      "street": "Street"
    },
    "company_id": 123,
    "cooperation": {
      "is_suspended": false
    },
    "email": "jdoe@example.com",
    "fax_number": "0048 123456789",
    "id": 33779,
    "legal_name": "Example Company Name",
    "source": "companies",
    "telephone": "0048 123456789",
    "vat_id": "PL111111111"
  },
  "contact_employees": [
    {
      "last_name": "John",
      "name": "Doe",
      "trans_id": "123-1"
    }
  ],
  "id": 456,
  "negotiations_logs": [
    {
      "action": "create",
      "carrier_offer_expiration_date": null,
      "comment": null,
      "created_at": "2020-04-28T08:24:17+02:00",
      "created_by": {
        "email": "jdoe@example.com",
        "family_name": "Doe",
        "given_name": "John",
        "id": 979241,
        "telephone": "0048 12345678",
        "trans_id": "123-1"
      },
      "created_by_company_id": 123,
      "id": 1234,
      "is_shipper": true,
      "is_withdrawn": false,
      "price": {
        "currency": "pln",
        "value": null
      },
      "proposal_request_id": 1234,
      "withdrawn_at": null
    },
    {
      "action": "negotiation",
      "carrier_offer_expiration_date": null,
      "comment": null,
      "created_at": "2020-04-28T08:24:17+02:00",
      "created_by": {
        "email": "jdoe@example.com",
        "family_name": "Doe",
        "given_name": "John",
        "id": 979241,
        "telephone": "0048 12345678",
        "trans_id": "123-1"
      },
      "created_by_company_id": 123,
      "id": 1234,
      "is_shipper": true,
      "is_withdrawn": false,
      "price": {
        "currency": "pln",
        "value": null
      },
      "proposal_request_id": 1234,
      "withdrawn_at": null
    }
  ],
  "price": {
    "currency": "pln",
    "value": 1000
  }
}