{
  "opencollection": "1.0.0",
  "info": {
    "name": "ShipmentDocumentManagement",
    "version": "v3"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "implicit",
      "authorizationUrl": "https://gateway.api.kuehne-nagel.com/authorize",
      "credentials": {
        "clientId": "{{clientId}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "List",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "listDocuments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://gateway.api.kuehne-nagel.com/transport/execution/documentation/shipment/v3/shipments/:uniqueShipmentReference/documents",
            "params": [
              {
                "name": "uniqueShipmentReference",
                "value": "",
                "type": "path",
                "description": "By default this is the shipment __tracking number__ e.g. `N4242`. \n\nIn case a tracking number is not available a limited set of alternative references can be used.\nPlease use the track and trace API to first search for shipment details (e.g. by a customer specific reference)\nif none of the supported references are available .\n    \nSupported references:\n* __tracking number__\n  * `{trackingNumber}` or `tracking-number:{trackingNumber}`\n  * e.g. `N4242` or `tracking-number:N4242`\n* __booking number__\n  * `booking-number:{bookingNumber}`\n  * e.g. `booking-number:B1`\n* __shipment id__\n  * `shipment-id:{shipmentId}` \n  * e.g. `shipment-id:S1`\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://gateway.api.kuehne-nagel.com/authorize",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "List all documents for a specific shipment."
        },
        {
          "info": {
            "name": "retrieveDocumentDetails",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://gateway.api.kuehne-nagel.com/transport/execution/documentation/shipment/v3/shipments/:uniqueShipmentReference/documents/:documentId",
            "params": [
              {
                "name": "uniqueShipmentReference",
                "value": "",
                "type": "path",
                "description": "By default this is the shipment __tracking number__ e.g. `N4242`. \n\nIn case a tracking number is not available a limited set of alternative references can be used.\nPlease use the track and trace API to first search for shipment details (e.g. by a customer specific reference)\nif none of the supported references are available .\n    \nSupported references:\n* __tracking number__\n  * `{trackingNumber}` or `tracking-number:{trackingNumber}`\n  * e.g. `N4242` or `tracking-number:N4242`\n* __booking number__\n  * `booking-number:{bookingNumber}`\n  * e.g. `booking-number:B1`\n* __shipment id__\n  * `shipment-id:{shipmentId}` \n  * e.g. `shipment-id:S1`\n"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a document"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://gateway.api.kuehne-nagel.com/authorize",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Retrieve meta data of a specific shipment document."
        }
      ]
    },
    {
      "info": {
        "name": "Upload",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "addDocument",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://gateway.api.kuehne-nagel.com/transport/execution/documentation/shipment/v3/shipments/:uniqueShipmentReference/documents",
            "params": [
              {
                "name": "uniqueShipmentReference",
                "value": "",
                "type": "path",
                "description": "By default this is the shipment __tracking number__ e.g. `N4242`. \n\nIn case a tracking number is not available a limited set of alternative references can be used.\nPlease use the track and trace API to first search for shipment details (e.g. by a customer specific reference)\nif none of the supported references are available .\n    \nSupported references:\n* __tracking number__\n  * `{trackingNumber}` or `tracking-number:{trackingNumber}`\n  * e.g. `N4242` or `tracking-number:N4242`\n* __booking number__\n  * `booking-number:{bookingNumber}`\n  * e.g. `booking-number:B1`\n* __shipment id__\n  * `shipment-id:{shipmentId}` \n  * e.g. `shipment-id:S1`\n"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": []
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://gateway.api.kuehne-nagel.com/authorize",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Add a document to a specific shipment.\n\nBefore the document is actually added to the shipment the uploaded content must pass a\nsecurity scan and conversion to [PDF/A](https://en.wikipedia.org/wiki/PDF/A). This is done asynchronously \nand usually only takes a couple of seconds. For the future it is planned to immediately scan and convert the document.\n"
        },
        {
          "info": {
            "name": "retrieveUploadableDocumentTypes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://gateway.api.kuehne-nagel.com/transport/execution/documentation/shipment/v3/shipments/:uniqueShipmentReference/uploadable-document-types",
            "params": [
              {
                "name": "uniqueShipmentReference",
                "value": "",
                "type": "path",
                "description": "By default this is the shipment __tracking number__ e.g. `N4242`. \n\nIn case a tracking number is not available a limited set of alternative references can be used.\nPlease use the track and trace API to first search for shipment details (e.g. by a customer specific reference)\nif none of the supported references are available .\n    \nSupported references:\n* __tracking number__\n  * `{trackingNumber}` or `tracking-number:{trackingNumber}`\n  * e.g. `N4242` or `tracking-number:N4242`\n* __booking number__\n  * `booking-number:{bookingNumber}`\n  * e.g. `booking-number:B1`\n* __shipment id__\n  * `shipment-id:{shipmentId}` \n  * e.g. `shipment-id:S1`\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://gateway.api.kuehne-nagel.com/authorize",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Retrieve the document types that can be used to add a document to the specific shipment."
        }
      ]
    },
    {
      "info": {
        "name": "Delete",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "deleteDocument",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://gateway.api.kuehne-nagel.com/transport/execution/documentation/shipment/v3/shipments/:uniqueShipmentReference/documents/:documentId",
            "params": [
              {
                "name": "uniqueShipmentReference",
                "value": "",
                "type": "path",
                "description": "By default this is the shipment __tracking number__ e.g. `N4242`. \n\nIn case a tracking number is not available a limited set of alternative references can be used.\nPlease use the track and trace API to first search for shipment details (e.g. by a customer specific reference)\nif none of the supported references are available .\n    \nSupported references:\n* __tracking number__\n  * `{trackingNumber}` or `tracking-number:{trackingNumber}`\n  * e.g. `N4242` or `tracking-number:N4242`\n* __booking number__\n  * `booking-number:{bookingNumber}`\n  * e.g. `booking-number:B1`\n* __shipment id__\n  * `shipment-id:{shipmentId}` \n  * e.g. `shipment-id:S1`\n"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a document"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://gateway.api.kuehne-nagel.com/authorize",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Delete a specific document from a shipment (only applicable if `isDeletable=true` in the document meta data)."
        }
      ]
    },
    {
      "info": {
        "name": "Download",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "downloadDocumentContent",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://gateway.api.kuehne-nagel.com/transport/execution/documentation/shipment/v3/shipments/:uniqueShipmentReference/documents/:documentId/contents",
            "params": [
              {
                "name": "uniqueShipmentReference",
                "value": "",
                "type": "path",
                "description": "By default this is the shipment __tracking number__ e.g. `N4242`. \n\nIn case a tracking number is not available a limited set of alternative references can be used.\nPlease use the track and trace API to first search for shipment details (e.g. by a customer specific reference)\nif none of the supported references are available .\n    \nSupported references:\n* __tracking number__\n  * `{trackingNumber}` or `tracking-number:{trackingNumber}`\n  * e.g. `N4242` or `tracking-number:N4242`\n* __booking number__\n  * `booking-number:{bookingNumber}`\n  * e.g. `booking-number:B1`\n* __shipment id__\n  * `shipment-id:{shipmentId}` \n  * e.g. `shipment-id:S1`\n"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of a document"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://gateway.api.kuehne-nagel.com/authorize",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Download the binary content of a specific shipment document.\n\nThis endpoint always returns exactly one content item (singleton collection, cardinality 1).\n"
        }
      ]
    }
  ],
  "bundled": true
}