Block cooperation

Allows to block coop­er­a­tion with com­pa­ny because of delays in the deliv­ery of doc­u­ments, lack of effi­cient com­mu­ni­ca­tion, lack of care for goods, etc.

Details

  • You sus­pend coop­er­a­tion with the whole com­pa­ny, not indi­vid­ual peo­ple.
  • Sus­pend­ing coop­er­a­tion means that no employ­ee of your com­pa­ny will be able to con­clude trans­ac­tions until coop­er­a­tion acti­va­tion.
  • Chang­ing the sta­tus of coop­er­a­tion is not com­mu­ni­cat­ed to the con­trac­tor.
  • Only user with admin­is­tra­tor role can change coop­er­a­tion sta­tus.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • End­point: /ext/partners-api/v1/partners/:partnerId/block
  • Method: POST

Headers

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

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.

Description and example values

JsonIs requiredExam­pleTypeDescrip­tion
rea­sonsYeslack_of_efficient_communicationArray of objectsRea­son of coop­er­a­tion block depend­ing on blocked com­pa­ny role (for­warder, ship­per, car­ri­er) — list of avail­able rea­sons below
remarksNoCoop­er­a­tion blockedStringAddi­tion­al descrip­tion (at least 3 char­ac­ters long)

Json example

{
  "reasons": [
    "lack_of_efficient_communication",
    "not_observing_transport_arrangements"
  ],
  "remarks": "cooperation blocked"
}

Response

{}

Available reasons list

Block cooperation with carrier reasons:

  • lack_of_efficient_communication
  • delays_in_the_delivery_of_documents
  • lack_of_care_for_goods
  • not_observing_transport_arrangements

Block cooperation with shipper reasons:

  • late_payments
  • lack_of_efficient_communication
  • lack_of_conformity_of_the_cargo_with_the_arrangements
  • long_waiting_time_for_loading
  • long_waiting_time_for_unloading
  • spam

Block cooperation with forwarder reasons:

  • lack_of_efficient_communication
  • delays_in_the_delivery_of_documents
  • lack_of_care_for_goods
  • not_observing_transport_arrangements
  • late_payments
  • lack_of_conformity_of_the_cargo_with_the_arrangements
  • long_waiting_time_for_loading
  • long_waiting_time_for_unloading
  • spam