1. Trans.eu Api
  2. Freights
  3. Internal note

Internal note

An inter­nal note can be added to a freight and is only vis­i­ble to trans.eu users from your com­pa­ny. Only one note can be added to the freight, on which the oper­a­tions list­ed below can be per­formed. The note can­not be longer than 500 char­ac­ters.

Operations that can be performed on the internal note object

  1. Adding an inter­nal note.
  2. Down­load­ing (get­ting) an inter­nal note.
  3. Updat­ing an inter­nal note.
  4. Delet­ing an inter­nal note.

Authorization and access

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.

You can get FreightID:

  • in the sys­tem response after pub­lish­ing the freight,
  • by down­load­ing the freight list.

Headers

  • Accept: application/json
  • Con­tent-type: application/json
  • Autho­riza­tion: Bear­er {access_token}
  • Api-key: {unique_ap­p_api-key}

Url parameters and connection settings for adding note

  • URL: https://api.platform.trans.eu
  • End­point: /ext/freights-api/v1/freights/{FeightID}/internal-note
  • Http Method: POST

Json request example

{
  "contents": "Test content of internal freight note"
}

Json response example

Http code 201 Created
{
  "contents": "Test content of internal freight note"
}

Url parameters and connection settings for getting note

  • URL: https://api.platform.trans.eu
  • End­point: /ext/freights-api/v1/freights/{FeightID}/internal-note
  • Http Method: GET

Json response example

Http code 200 OK
{
  "contents": "Test content of internal freight note"
}

Url parameters and connection settings for updating note

  • URL: https://api.platform.trans.eu
  • End­point: /ext/freights-api/v1/freights/{FeightID}/internal-note
  • Http Method: PUT

Json request example

{
  "contents": "Test 2 content of internal freight note"
}

Json response example

Http code 200 OK
{
  "contents": "Test 2 content of internal freight note"
}

Url parameters and connection settings for deleting note

  • URL: https://api.platform.trans.eu
  • End­point: /ext/freights-api/v1/freights/{FeightID}/internal-note
  • Http Method: DELETE

Json response example

Http code 204 No Content