{
  "opencollection": "1.0.0",
  "info": {
    "name": "Qargo TMS API / Accounting Use case / Document import API",
    "version": "1.2.0"
  },
  "items": [
    {
      "info": {
        "name": "Use case / Document import",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Upload Document Content",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.qargo.com/v1/documents/document/upload_content",
            "body": {
              "type": "multipart-form",
              "data": []
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Upload document content."
        },
        {
          "info": {
            "name": "Generic Document Import",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.qargo.com/v1/webhook/document-import",
            "params": [
              {
                "name": "filename",
                "value": "",
                "type": "query",
                "description": "Name of the file being uploaded, including extension. This is used as the primary source for the file name in Qargo."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Webhook for importing documents and attaching them to existing orders in Qargo.\n\n## How it works\n\n1. An external system sends a file to this endpoint with metadata as query parameters.\n2. The system matches the document to an order in Qargo using the provided query parameters.\n3. The document is created and attached to the matched order.\n\n## Query parameters\n\nThe `filename` parameter is always required. Additional query parameters are **configurable\nper integration** during setup and are used to"
        },
        {
          "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 Document Update With Payload",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.qargo.com/v1/webhook/subco-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"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Upload a document to a specific stop on a subcontracted 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` | Yes | The Qargo UUID of the stop to attach the documen"
        }
      ]
    }
  ],
  "bundled": true
}