API / Trip

Get trip

get/v1/trips/trip/{trip_id}

Request

  • Base URL: https://api.qargo.com
  • URL: https://api.qargo.com/v1/trips/trip/{trip_id}
  • Auth: OAuth 2 (client credentials, token URL /v1/auth/token)

Path parameters

trip_idstring uuid required

Response

Successful Response

idstring uuid required

ID of the trip

namestring required

Name of the trip

status'CREATED' | 'PLANNED' | 'COMPLETED' required

Example response

{
  "resource_allocations": [
    {
      "resource": {
        "is_external_resource": true,
        "subcontractor": {
          "currency": "EUR",
          "name": "John Doe",
          "legal_name": "John Doe",
          "vat_number": "BE1234.123.123",
          "accounting_code": "1234",
          "billing_location": {
            "code": "LOC123",
            "display_name": "Main Office",
            "address": "Gaston Crommenlaan 4",
            "city": "Ghent",
            "country": "BE",
            "postal_code": "9050",
            "name": "Qargo HQ"
          },
          "locale": "en",
          "contacts": [
            {
              "name": "John Doe",
              "phone_number": "+32485123456"
            }
          ]
        }
      }
    }
  ],
  "stops": [
    {
      "time_window": {
        "start_time": "09:30",
        "end_time": "16:30"
      },
      "date": "2024-12-31",
      "depot": {
        "unload_timestamp": "2024-12-31T14:30:00Z",
        "load_timestamp": "2024-12-31T08:00:00Z"
      },
      "location": {
        "code": "LOC123",
        "display_name": "Main Office",
        "address": "Gaston Crommenlaan 4",
        "city": "Ghent",
        "country": "BE",
        "postal_code": "9050",
        "name": "Qargo HQ"
      },
      "end_timestamp": "2024-12-31T08:15:00Z",
      "start_timestamp": "2024-12-31T08:00:00Z",
      "status": "PLANNED"
    }
  ]
}

Changes

    • warning

      added the new UK_REVERSE_CHARGE enum value to the /////// response property for the response status

    • warning

      added the new UK_REVERSE_CHARGE enum value to the /////// response property for the response status

    • warning

      added the new UK_REVERSE_CHARGE enum value to the /////// response property for the response status

    • warning

      added the new UK_REVERSE_CHARGE enum value to the /////// response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status