IrcpResponseVO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-ircp-response-vo-schema.json",
  "title": "IrcpResponseVO",
  "description": "This is a wrapper class for outputVO",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fedex-registration-api-openapi.yml#/components/schemas/IrcpResponseVO",
  "type": "object",
  "properties": {
    "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/BaseProcessOutputVO"
    }
  },
  "$defs": {
    "Alert": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Specifies the cxs alert code."
        },
        "alertType": {
          "type": "string",
          "description": "Specifies the cxs alert type.",
          "enum": [
            "NOTE",
            "WARNING"
          ]
        },
        "parameterList": {
          "type": "array",
          "description": "This object provides additional paramters resulted in the alert.",
          "items": {
            "$ref": "#/$defs/Parameter"
          }
        },
        "message": {
          "type": "string",
          "description": "Specifies the cxs alert message."
        }
      },
      "description": "Specifies the cxs alerts."
    },
    "BaseProcessOutputVO": {
      "$ref": "#/$defs/CustomerKeyOutputVO"
    },
    "CustomerKeyOutputVO": {
      "required": [
        "customerKey",
        "customerPassword"
      ],
      "type": "object",
      "properties": {
        "customerKey": {
          "type": "string",
          "description": "Customer Key is a JSON Web Token provided for each of your customers. You must use the Customer Key along with the Client Key, Client Secret and Customer Secret to get oAuth token, which should be used as credentials with each API transaction."
        },
        "customerPassword": {
          "type": "string",
          "description": "Customer Password, also referred to as <i>Customer Secret</i>, is provided for each of your customers. You must use the Customer Secret along with the Client Key, Client Secret and Customer Key to get the oAuth token, which should be used as credentials with each API transaction."
        },
        "alerts": {
          "type": "array",
          "description": "Specifies the cxs alerts.",
          "items": {
            "$ref": "#/$defs/Alert"
          }
        }
      },
      "description": "This is the response object providing Customer Key and secret key as a output."
    },
    "Parameter": {
      "type": "object",
      "properties": {
        "value": {
          "type": "string",
          "description": "This is a placeholder for parameter value."
        },
        "key": {
          "type": "string",
          "description": "This is a placeholder for parameter key."
        }
      },
      "description": "This object provides additional paramter details resulted in the alert."
    }
  }
}