AvailabilitycxsResponseVO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-availabilitycxs-response-vo-schema.json",
  "title": "AvailabilitycxsResponseVO",
  "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-service-availability-api-openapi.yml#/components/schemas/AvailabilitycxsResponseVO",
  "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"
    },
    "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."
        },
        "alertType": {
          "type": "string",
          "description": "Specifies the api alert type.",
          "enum": [
            "NOTE",
            "WARNING"
          ]
        },
        "message": {
          "type": "string",
          "description": "Specifies the api alert message."
        }
      },
      "description": "Specifies the api alerts."
    },
    "BaseProcessOutputVO": {
      "$ref": "#/$defs/SpecialServicesOptionsOutputVO"
    },
    "BatteryDetail": {
      "type": "object",
      "properties": {
        "batteryPackingType": {
          "type": "string",
          "description": "Describe the packing arrangement of the battery or cell with respect to other items within the same package.",
          "enum": [
            "CONTAINED_IN_EQUIPMENT",
            "PACKED_WITH_EQUIPMENT"
          ]
        },
        "batteryRegulatoryType": {
          "type": "string",
          "description": "This is a regulation specific classification for the battery or the cell.",
          "enum": [
            "IATA_SECTION_II"
          ]
        },
        "batteryMaterialType": {
          "type": "string",
          "description": "Indicate the material composition of the battery or cell.",
          "enum": [
            "LITHIUM_METAL",
            "LITHIUM_ION"
          ]
        }
      },
      "description": "Provide details about the batteries or cells that are contained within this specific package."
    },
    "CodeDisplayTextVO": {
      "type": "object",
      "properties": {
        "displayText": {
          "type": "string",
          "description": "Display Text"
        },
        "code": {
          "type": "string",
          "description": "Unique code"
        }
      },
      "description": "applicable key and display text value pairs."
    },
    "KeyDisplayTextVO": {
      "allOf": [
        {
          "$ref": "#/$defs/KeyDisplayTextVO1"
        },
        {
          "required": [
            "displayText",
            "key"
          ],
          "properties": {
            "displayText": {
              "description": "Display Text"
            },
            "key": {
              "description": "Unique Key"
            }
          }
        }
      ]
    },
    "KeyDisplayTextVO1": {
      "type": "object",
      "properties": {
        "displayText": {
          "type": "string",
          "description": "Display Text"
        },
        "key": {
          "type": "string",
          "description": "Unique Key"
        }
      },
      "description": "this object holds applicable key and display text value pairs."
    },
    "OptionalServices": {
      "type": "object",
      "properties": {
        "serviceType": {
          "type": "string",
          "description": "Indicates the type of service that is used to ship the package.<br>Example: INTERNATIONAL_FIRST<br><a onclick='loadDocReference(\"servicetypes\")'>Click here to see Service Types</a>"
        },
        "issEnabled": {
          "type": "boolean",
          "description": "Specifies if international signature options are available."
        },
        "signatureOptionsList": {
          "type": "array",
          "description": "All possible signature options if signature options are available.  Indicated by the issEnabled boolean.",
          "items": {
            "$ref": "#/$defs/CodeDisplayTextVO"
          }
        },
        "packageSpecialServicesList": {
          "type": "array",
          "description": "Indicates the list of special services that are available at package level for some or all service types.",
          "items": {
            "$ref": "#/$defs/PackageSpecialServiceOption"
          }
        },
        "returnShipmentList": {
          "type": "array",
          "items": {
            "type": "string",
            "description": "possible return shipment types",
            "enum": [
              "FEDEX_TAG",
              "PENDING",
              "PRINT_RETURN_LABEL",
              "EMAIL_LABEL"
            ]
          }
        },
        "carrierCode": {
          "type": "string",
          "description": "Specify the four letter code of a FedEx operating company that meets your requirements<br>Examples of FedEx Operating Companies are:<ul><li>FDXE - FedEx Express</li><li>FDXG - FedEx Ground</li><li>FXSP - FedEx SmartPost</li><li>FXCC - FedEx Custom Critical.</li></ul>",
          "enum": [
            "FDXE",
            "FDXG",
            "FXSP",
            "FXFR"
          ]
        },
        "batteryOptionList": {
          "type": "array",
          "description": "Indicates the battery option list.",
          "items": {
            "$ref": "#/$defs/BatteryDetail"
          }
        },
        "alertList": {
          "type": "array",
          "description": "Indicates the alert details.",
          "items": {
            "$ref": "#/$defs/KeyDisplayTextVO"
          }
        },
        "shipmentSpecialServicesList": {
          "type": "array",
          "description": "Indicates the list of special services that are available at the shipment level for some or all service types.",
          "items": {
            "$ref": "#/$defs/ShipmentSpecialServiceOption"
          }
        },
        "alerts": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Alert"
          }
        }
      },
      "description": "Holds the details of OptionalServices for the SpecialServiceOptions and PackageAndServiceOptions Endpoints"
    },
    "PackageSpecialServiceOption": {
      "type": "object",
      "properties": {
        "customerIntegrationMode": {
          "type": "string",
          "description": "Specifies customer integration mode."
        },
        "subType": {
          "type": "string",
          "description": "Specifies sub-type of the special service option."
        },
        "specialServiceType": {
          "type": "string",
          "description": "Indicate the types of special services requested for the shipment.<br><a onclick='loadDocReference(\"packagelevelspecialservicetypes\")'>Click here to see Package level Special Service Types</a>"
        }
      },
      "description": "FedEx Package Special Services options."
    },
    "ShipmentSpecialServiceOption": {
      "type": "object",
      "properties": {
        "customerIntegrationMode": {
          "type": "string",
          "description": "Specifies customer Integration Mode"
        },
        "astraDescription": {
          "type": "string",
          "description": "Specifies the astra label description"
        },
        "ltlPaymentTerms": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "PREPAID",
              "COLLECT",
              "COLLECT_SECTION_7_SIGNED",
              "COLLECT_SECTION_9_SIGNED"
            ]
          }
        },
        "subType": {
          "type": "string",
          "description": "Specifies sub-type of the special service option"
        },
        "value": {
          "type": "string",
          "description": "Specifies the value of the special service option."
        },
        "specialServiceType": {
          "type": "string",
          "description": "Specify special services requested for the package.<br>Example: BROKER_SELECT_OPTION<br><a onclick='loadDocReference(\"shipmentlevelspecialservicetypes\")'>Click here to see Shipment Level Special Service Types.</a>"
        }
      },
      "description": "FedEx Shipment Special Services options.<br><a onclick='loadDocReference(\"shipmentlevelspecialservicetypes\")'>Click here to see Shipment Level Special Service Types</a>"
    },
    "SpecialServicesOptionsOutputVO": {
      "type": "object",
      "properties": {
        "alerts": {
          "type": "array",
          "description": "The cxs alert type, alert code, and alert message.",
          "items": {
            "$ref": "#/$defs/Alert"
          }
        },
        "serviceOptionsList": {
          "type": "array",
          "description": "The list of options applicable when special service option is selected. The options include:<br>-Service types<br>-Signature options</br>-Package Special services list<br>-Return shipment list<br>-Carrier code<br>-Battery option list<br>-Alert list<br>-Shipment special services ist<br>-Cxs alerts",
          "items": {
            "$ref": "#/$defs/OptionalServices"
          }
        }
      },
      "description": "The response elements for the special service availability request."
    }
  }
}