MultiBasePreResponse_1

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-multi-base-pre-response-1-schema.json",
  "title": "MultiBasePreResponse_1",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fedex-upload-documents-api-openapi.yml#/components/schemas/MultiBasePreResponse_1",
  "type": "object",
  "properties": {
    "customerTransactionId": {
      "type": "string",
      "description": "This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply."
    },
    "transactionId": {
      "type": "string",
      "description": "The transaction ID is a special set of numbers that defines each transaction."
    },
    "output": {
      "$ref": "#/$defs/MultiBasePreResponse_1_output"
    }
  },
  "$defs": {
    "MultiBasePreResponse_1_output": {
      "type": "object",
      "properties": {
        "documentResponses": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/MultiDocumentPreResponse"
          }
        }
      }
    },
    "MultiDocumentPreResponse": {
      "type": "object",
      "properties": {
        "fileReferenceId": {
          "type": "string",
          "description": "Unique reference to the file"
        },
        "metaData": {
          "type": "object",
          "description": "Response to indicate status of upload completion. Data includes document related identifiers",
          "allOf": [
            {
              "$ref": "#/$defs/MultiMetaDataPreResponse"
            }
          ]
        }
      },
      "description": "This is the response indicating upload reference details."
    },
    "MultiMetaDataPreResponse": {
      "type": "object",
      "properties": {
        "formCode": {
          "type": "string",
          "description": "Specify the form code. This value is required for the shipments travelling between the 3 countries US, CA & MX and when the shipment is USMCA eligible."
        },
        "documentType": {
          "type": "string",
          "description": "Indicates the type of document uploaded. <br><br> Example:CO<br>Following are the values returned depending on the document type<ul><li>CERTIFICATE_OF_ORIGIN – CO</li><li>COMMERCIAL_INVOICE –  CI</li><li>ETD_LABEL –  AWB</li><li>USMCA_CERTIFICATE_OF_ORIGIN –  CO</li><li>USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN –  CI</li><li>OTHER –  OTHER</li><li>PRO_FORMA_INVOICE –  PRO</li></ul>"
        },
        "docId": {
          "type": "string",
          "description": "This is the document id or the upload reference. Note this and use this in your shipment if you have uploaded the document prior to shipment request.<br> Example: 090493e181586308"
        },
        "folderId": {
          "type": "string",
          "description": "This is the reference server folder id, where the document is uploaded. Note that, this data is returned only for Post-Shipment Upload scenario",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}