PudcResponseVO_CancelPickup

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-pudc-response-vo-cancel-pickup-schema.json",
  "title": "PudcResponseVO_CancelPickup",
  "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-pickup-api-openapi.yml#/components/schemas/PudcResponseVO_CancelPickup",
  "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_CancelPickup"
    }
  },
  "$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_CancelPickup": {
      "$ref": "#/$defs/CancelPickupOutputVO"
    },
    "CancelPickupOutputVO": {
      "type": "object",
      "properties": {
        "pickupConfirmationCode": {
          "type": "string",
          "description": "Specify the pickup confirmation code. <br> Example: NQAA97"
        },
        "cancelConfirmationMessage": {
          "type": "string",
          "description": "Indicates a cancelled pickup confirmation message.<br> Example: Requested pickup has been cancelled successfully."
        },
        "alerts": {
          "type": "array",
          "description": "Optional alerts received when a cancel pickup is requested. This includes an alert code, type, and message.",
          "items": {
            "$ref": "#/$defs/Alert"
          }
        }
      },
      "description": "The cancel pickup response elements."
    }
  }
}