Allows to block cooperation with company because of delays in the delivery of documents, lack of efficient communication, lack of care for goods, etc.
Details
- You suspend cooperation with the whole company, not individual people.
- Suspending cooperation means that no employee of your company will be able to conclude transactions until cooperation activation.
- Changing the status of cooperation is not communicated to the contractor.
- Only user with administrator role can change cooperation status.
Url parameters and connection settings
- URL: https://api.platform.trans.eu
- Endpoint: /ext/partners-api/v1/partners/:partnerId/block
- Method: POST
Headers
- Content-type: application/json
- Accept: application/json
- Authorization: Bearer {access_token}
- Api-key: {unique_app_api-key}
Authorization and access
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.
Description and example values
Json | Is required | Example | Type | Description |
reasons | Yes | lack_of_efficient_communication | Array of objects | Reason of cooperation block depending on blocked company role (forwarder, shipper, carrier) — list of available reasons below |
remarks | No | Cooperation blocked | String | Additional description (at least 3 characters 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