{
  "opencollection": "1.0.0",
  "info": {
    "name": "Qargo TMS API / Accounting Use case / Fleet dispatch API",
    "version": "1.2.0"
  },
  "items": [
    {
      "info": {
        "name": "Use case / Fleet dispatch",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "External Document Upload From A Fleet Application",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.qargo.com/v1/webhook/fleet-document-upload",
            "params": [
              {
                "name": "question_path_key",
                "value": "",
                "type": "query",
                "description": "The question path key to map the file in Qargo, for example: CMR/POD"
              },
              {
                "name": "stop_id",
                "value": "",
                "type": "query",
                "description": "The stop ID to which the document is related"
              },
              {
                "name": "stop_group_id",
                "value": "",
                "type": "query",
                "description": "The stop group ID to which the document is related"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Upload a document to a specific stop or stop group on a fleet-dispatched trip.\n\nThis webhook uses **Basic Auth** (webhook credentials), not the OAuth credentials used for the API.\nContact integrations@qargo.com to request credentials.\n\n---\n\n## Query parameters\n\n| Parameter | Required | Description |\n|-----------|----------|-------------|\n| `question_path_key` | Yes | Maps the file to a document type in Qargo (e.g. `CMR`, `POD`, `WEIGHT_NOTE`) |\n| `stop_id` | No* | The Qargo UUID of the stop to a"
        },
        {
          "info": {
            "name": "External Status Update From A Fleet Application",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.qargo.com/v1/webhook/fleet-status-update",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Webhook for updating the status, ETA, and data of stops from an external fleet application.\n\nNote that this webhook uses Basic Auth instead of the OAuth credentials used for the api.\nPlease contact integrations@qargo.com to request credentials.\n\nAll `event_time`, `eta_start`, and `eta_end` date-time values must include a timezone offset,\nfor example `2025-06-15T10:30:00Z` or `2025-06-15T12:30:00+02:00`.\n\n---\n\n## Identifying a stop\n\nEach update targets either a single **stop** or a **stop group**"
        },
        {
          "info": {
            "name": "Fleet Dispatch Payload",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.qargo.comhttps://<external-fleet-receiving-endpoint>",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Payload for sending fleet app dispatches.\nIn this case, we send the payload to an external endpoint for processing.\n\nBy default, we send our standard `FleetDispatch` schema,\nbut the body can also be a custom mapped format."
        }
      ]
    }
  ],
  "bundled": true
}