CreateConsolidationResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-create-consolidation-response-schema.json",
  "title": "CreateConsolidationResponse",
  "description": "Wrapper class for CreateConsolidationOutputVO. It holds transactionId and output.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fedex-consolidation-api-openapi.yml#/components/schemas/CreateConsolidationResponse",
  "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. <br> Example: AnyCo_order123456789"
    },
    "transactionId": {
      "type": "string",
      "description": "The transaction ID is a special set of numbers that defines each transaction.<br>Example: 624deea6-b709-470c-8c39-4b5511281492"
    },
    "output": {
      "$ref": "#/$defs/CreateConsolidationOutputVO"
    }
  },
  "$defs": {
    "Alert": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Specifies the api alert code."
        },
        "alertType": {
          "type": "string",
          "description": "Specifies the api alert type.",
          "enum": [
            "NOTE",
            "WARNING"
          ]
        },
        "message": {
          "type": "string",
          "description": "Specifies the api alert message."
        }
      },
      "description": "These are alert details received in the response."
    },
    "ConsolidationKey": {
      "required": [
        "date",
        "index",
        "type"
      ],
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "The date on which the consolidation was created."
        },
        "index": {
          "type": "string",
          "description": "The unique consolidation identifier."
        },
        "type": {
          "type": "string",
          "description": "Specify the type of consolidation.",
          "enum": [
            "INTERNATIONAL_DISTRIBUTION_FREIGHT",
            "INTERNATIONAL_ECONOMY_DISTRIBUTION",
            "INTERNATIONAL_GROUND_DISTRIBUTION",
            "TRANSBORDER_DISTRIBUTION",
            "INTERNATIONAL_PRIORITY_DISTRIBUTION"
          ]
        }
      },
      "description": "Identifies the consolidation to which this open shipment should be added after successful creation."
    },
    "CreateConsolidationOutputVO": {
      "type": "object",
      "properties": {
        "trackingIds": {
          "type": "array",
          "description": "The field is present to allow use of preassigned Master Airway Bill tracking number.",
          "items": {
            "$ref": "#/$defs/TrackingIds"
          }
        },
        "consolidationKey": {
          "$ref": "#/$defs/ConsolidationKey"
        },
        "alerts": {
          "type": "array",
          "description": "The alerts received when processing a shipment request.",
          "items": {
            "$ref": "#/$defs/Alert"
          }
        }
      },
      "description": "This is the response received when a consolidation shipment is requested."
    },
    "TrackingIds": {
      "required": [
        "formId",
        "trackingIdType",
        "trackingNumber"
      ],
      "type": "object",
      "properties": {
        "trackingIdType": {
          "type": "string",
          "description": "Specify the FedEx transportation type (EXPRESS, GROUND, FREIGHT)."
        },
        "formId": {
          "type": "string",
          "description": "This is FedEx tracking Identifier associated with the package."
        },
        "trackingNumber": {
          "type": "string",
          "description": "This is a number associated with a package that is used to track it."
        }
      },
      "description": "The field is present to allow use of preassigned Master Airway Bill tracking number."
    }
  }
}