CountryCXSResponseVO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-country-cxsresponse-vo-schema.json",
  "title": "CountryCXSResponseVO",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fedex-postal-code-api-openapi.yml#/components/schemas/CountryCXSResponseVO",
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "string",
      "description": "The transaction ID is special set of number that allows FedEx customer to assign a unique identifier to their each transaction. Helps in matching requests to reply.<br>Max 40 characters.<br>Example: 624deea6-b709-470c-8c39-4b5511281492"
    },
    "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"
    },
    "output": {
      "$ref": "#/$defs/BaseProcessOutputVO"
    }
  },
  "$defs": {
    "Alert": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Specifies the API alert code.<br>Example: CITYNAME.POSTALCODE.REQUIRED"
        },
        "alertType": {
          "type": "string",
          "description": "Specifies the alert type.",
          "enum": [
            "NOTE",
            "WARNING"
          ]
        },
        "parameterList": {
          "type": "array",
          "description": "List of parameters which indicates the properties of the alert message.",
          "items": {
            "$ref": "#/$defs/Parameter"
          }
        },
        "message": {
          "type": "string",
          "description": "This is the alert message. <br> Example: We are unable to process this request. Please try again later or contact FedEx Customer Service."
        }
      },
      "description": "Specifies the api alerts."
    },
    "BaseProcessOutputVO": {
      "$ref": "#/$defs/ValidatePostalOutputVO"
    },
    "LocationDescription": {
      "required": [
        "airportId",
        "locationId",
        "locationNumber",
        "serviceArea"
      ],
      "type": "object",
      "properties": {
        "locationId": {
          "type": "string",
          "description": "Location id of the postal code provided. <br> Example: MAAPD"
        },
        "locationNumber": {
          "type": "integer",
          "description": "Location number of the postal code provided. <br> Example: 6955"
        },
        "serviceArea": {
          "type": "string",
          "description": "Service area of the postal code provided. <br> Example: AA"
        },
        "airportId": {
          "type": "string",
          "description": "Airport Id of the postal code provided. <br> Example: BLR"
        }
      },
      "description": "Location Description"
    },
    "Parameter": {
      "type": "object",
      "properties": {
        "value": {
          "type": "string",
          "description": "Identifies the error option to be applied."
        },
        "key": {
          "type": "string",
          "description": "Indicates the value associated with the key."
        }
      },
      "description": "These are alert parameters."
    },
    "ValidatePostalOutputVO": {
      "type": "object",
      "properties": {
        "countryCode": {
          "type": "string",
          "description": "The two-letter code used to identify a country. <br>Example:US<br><a onclick='loadDocReference(\"countrycodes\")'>Click here to see Country Codes</a>"
        },
        "cityFirstInitials": {
          "type": "string",
          "description": "Initials of the City.<br>Example:C <br>"
        },
        "stateOrProvinceCode": {
          "type": "string",
          "description": "This is the state or province code. Format and presence of this element will vary, depending on country. <br> Max length is 2. <br> Example: US<br><a onclick='loadDocReference(\"canadaprovincecodes\")'>Click here to see State Or Province Code</a>"
        },
        "alerts": {
          "type": "array",
          "description": "This object specifies Alert details returned in the reply such as code, message and any other parameters.",
          "items": {
            "$ref": "#/$defs/Alert"
          }
        },
        "locationDescriptions": {
          "type": "array",
          "description": "This object specifies location details returned in the reply such as location ID, service area and airport ID etc.",
          "items": {
            "$ref": "#/$defs/LocationDescription"
          }
        },
        "cleanedPostalCode": {
          "type": "string",
          "description": "This is a cleaned postal code returned in the reply.</br>Example: 94267<br><a onclick='loadDocReference(\"postalawarecountries\")'>Click here to see Postal aware countries</a>"
        }
      },
      "description": "Indicates data returned in the postal validation reply."
    }
  }
}