body_2

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-body-2-schema.json",
  "title": "body_2",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fedex-pickup-api-openapi.yml#/components/schemas/body_2",
  "oneOf": [
    {
      "$ref": "#/$defs/Full_Schema_Cancel_Pickup"
    },
    {
      "$ref": "#/$defs/Cancel_Pickup_Ground"
    },
    {
      "$ref": "#/$defs/Cancel_Pickup_Express"
    }
  ],
  "$defs": {
    "AccountNumber": {
      "type": "object",
      "properties": {
        "value": {
          "type": "string",
          "description": "This is the account number. Maximum Length is 9. <br>Example: Your account number"
        }
      },
      "description": "This is the FedEx account number. <br>Example: Your account number"
    },
    "Cancel_Pickup_Express": {},
    "Cancel_Pickup_Ground": {},
    "Full_Schema_Cancel_Pickup": {
      "required": [
        "pickupConfirmationCode",
        "scheduledDate",
        "associatedAccountNumber"
      ],
      "type": "object",
      "properties": {
        "associatedAccountNumber": {
          "$ref": "#/$defs/AccountNumber"
        },
        "pickupConfirmationCode": {
          "type": "string",
          "description": "The confirmation number provided by FedEx to the customer when the pickup was scheduled or requested.<br> Example: 7"
        },
        "remarks": {
          "type": "string",
          "description": "Placeholder for any message to be passed to the FedEx pickup courier.<br>Note:Maximum length is 60 characters.<br> Example: Please ring bell at loading dock."
        },
        "carrierCode": {
          "type": "string",
          "description": "This is a placeholder to provide the FedEx operating company (transportation) code used for package delivery. Required for FedEx Ground.<br> Optional for FedEx Express.<br> The Default is FedEx Express i.e. FDXE.",
          "enum": [
            "FDXE",
            "FDXG"
          ]
        },
        "scheduledDate": {
          "type": "string",
          "description": "Indicates the date the pickup dispatch occurs.<br>Format YYYY-MM-DD <br> Example: 2019-10-15"
        },
        "location": {
          "type": "string",
          "description": "The FedEx Express location identifier responsible for processing the pickup request. This is returned in the CreatePickup response and is required to cancel a FedEx Express dispatch.Required only for FedEx Express Pickups. Optional for FedEx Ground. Example: LOSA"
        },
        "version": {
          "$ref": "#/$defs/Version"
        }
      },
      "description": "This is a placeholder for cancelled pickup request elements."
    },
    "Version": {
      "type": "object",
      "properties": {
        "major": {
          "description": "This version is incremented when significant changes are made to the API functionality. These could be breaking changes and might require code-adjustments from clients. Accepts only numbers",
          "type": "integer"
        },
        "minor": {
          "description": "This represents a backward-compatible minor adjustment to an existing API functionality. This is the second number in API versioning scheme. Accepts only numbers",
          "type": "integer"
        },
        "patch": {
          "description": "This represents a backward-compatible bug fix to an existing API functionality. This is the third number in API versioning scheme. Accepts only numbers",
          "type": "integer"
        }
      }
    }
  }
}