{
  "opencollection": "1.0.0",
  "info": {
    "name": "Qargo TMS API / Accounting Use case / Order API",
    "version": "1.2.0"
  },
  "items": [
    {
      "info": {
        "name": "Use case / Order",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Download Document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.qargo.com/v1/documents/document/:id/download",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "direct",
                "value": "",
                "type": "query",
                "description": "Query parameter to indicate that the response should contain all the document bytes"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Download a document by its ID. You can choose to download the document directly or stream it."
        },
        {
          "info": {
            "name": "Import Order",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.qargo.com/v1/orders/order/upload",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create or update orders in Qargo. See the \"Transport order creation & status\" section for more info."
        },
        {
          "info": {
            "name": "Get Order Import Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.qargo.com/v1/orders/order/upload/:upload_id",
            "params": [
              {
                "name": "upload_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get the status of an order import"
        },
        {
          "info": {
            "name": "Get Order Details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.qargo.com/v1/orders/order/:order_id",
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Fetch order detail"
        },
        {
          "info": {
            "name": "List Order Charges",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.qargo.com/v1/orders/order/:order_id/charges",
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Charges for a certain order. Note that these charges are not final and may change"
        },
        {
          "info": {
            "name": "Approve Order Charges",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.qargo.com/v1/orders/order/:order_id/charges/approval",
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Approve or reject certain charges on the order"
        },
        {
          "info": {
            "name": "List Order Documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.qargo.com/v1/orders/order/:order_id/documents",
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Fetch documents for an order. This includes `consignment` documents"
        },
        {
          "info": {
            "name": "Order Export",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.qargo.com/v1/orders/order/:order_id/export",
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Provides a minimal set of order data that can be used as a blueprint to create a new order"
        },
        {
          "info": {
            "name": "Order Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.qargo.com/v1/orders/order/:order_id/status",
            "params": [
              {
                "name": "order_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Order status endpoint. Provides information on the status of the order"
        },
        {
          "info": {
            "name": "Operational Visibility Event",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.qargo.comhttps://<visibility-event-receiving-endpoint>",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Webhook for updates to orders and trips. Subscribe to this endpoint to receive updates.\n\nNote that both support our canonical VisibilityUpdate schema,\nbut the body can also be a custom mapped format."
        },
        {
          "info": {
            "name": "Create/Update/Cancel Orders",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.qargo.com/v1/webhook",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Webhook for creating/updating and cancelling transport orders.\n\nThis is the fully asynchronous version of the order upload api.\nThe documented schema is our default input format, but we can also map custom formats.\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."
        },
        {
          "info": {
            "name": "Partial Order Update",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.qargo.com/v1/webhook/partial-order-update",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Webhook for partial order updates. Push to the endpoint to update specific fields of an existing order."
        }
      ]
    }
  ],
  "bundled": true
}