1. Trans.eu Api
  2. Orders
  3. Order confirmations
  4. Confirm order unloading by Id

Confirm order unloading by Id

This method allows you to report unload­ing of the load from spe­cif­ic trans­porta­tion order. It is avail­able for sent and received orders for Ship­pers and Car­ri­ers.

You can con­firm unload­ing after pri­or con­fir­ma­tion of arrival or by skip­ping this step.

Url parameters and connection settings

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

Requirements

You can con­firm order in sta­tus­es – wait­ing-for-arrival-con­fir­ma­tion, wait­ing-for-unload­ing-con­fir­ma­tion or wait­ing-for-con­fir­ma­tion.

JsonExam­pleTypeIs requiredDescrip­tion
unloading_declarationnot-in-fullStringYes
Must have not-in-full or in-full val­ue
claimstest claimStringYes/No
Must con­sist of min 5 signs. If the “unloading_declaration” has “in-full” val­ue, “claims” is not required.
arrived_at2021–10-22T11:00:00+0600Time­stampYes/No
Val­ue is required for orders in sta­tus: “wait­ing-for-arrival-con­fir­ma­tion”

Example of minimum request for order in status “waiting-for-arrival-confirmation”

{
  "unloading_declaration": "in-full",
  "arrived_at": "2021-10-22T11:00:00+0600"
}

Example of minimum request for order in status “waiting-for-unloading-confirmation”

{
  "unloading_declaration": "in-full"
}

Response

Response for prop­er­ly giv­en order id is HTTP code 204 with no con­tent.