This method allows you to cancel selected order, which was previously created by any company employee. To be cancelled, order must be active.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • Endpoint: /ext/orders-api/v1/orders-created/{orderId}/cancel
  • 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.

Available reasons for cancellation

For shippers and forwarders (orders-created):

  • contractor_did_not_obey_arrangements
  • other
  • out_of_stock
  • otherwise_transported
  • contractor_tried_to_change_arrangements

For carriers and forwarders (orders-received):

  • no_car
  • no_driver
  • contractor_tried_to_change_arrangements
  • contractor_did_not_obey_arrangements
  • other

Example

Sample Json for cancel order by Id using required data only

{
"reasons":["other"],
"explanation":"Example explanation"
}

Response

Response for properly given order id is Http code 204 with no content.