Fedex Label Request Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ordoro/refs/heads/main/json-schema/ordoro-post_fedex_label-schema.json",
  "title": "Fedex Label Request Schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "alcohol_shipment_license": {
      "type": "string"
    },
    "alternate_return_to_address": {
      "$ref": "#/components/schemas/v1_address"
    },
    "b13a_filing_option": {
      "description": "Specify the filing option being exercised. Required for non-document shipments originating in Canada destinated for any country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands",
      "enum": [
        "NOT_REQUIRED",
        "MANUALLY_ATTACHED",
        "FILED_ELECTRONICALLY",
        "SUMMARY_REPORTING",
        "FEDEX_TO_STAMP"
      ],
      "type": "string"
    },
    "cod": {
      "type": "object",
      "properties": {
        "collection_type": {
          "type": "string",
          "enum": [
            "ANY",
            "CASH",
            "GUARANTEED_FUNDS",
            "COMPANY_CHECK",
            "PERSONAL_CHECK"
          ]
        },
        "amount": {
          "type": "number"
        }
      }
    },
    "declared_value": {
      "description": "Package level Insured Value for Fedex",
      "type": "number"
    },
    "reference_number": {
      "description": "Package level reference, not always necessarily a number",
      "type": "string"
    },
    "packages": {
      "type": "array",
      "maxItems": 99,
      "items": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "box_shape": {
            "type": "string"
          },
          "declared_value": {
            "description": "Package level Insured Value for Fedex",
            "type": "number"
          },
          "description": {
            "type": "string"
          },
          "dry_ice_weight": {
            "description": "Weight in ounces.",
            "type": "number",
            "default": 0
          },
          "height": {
            "description": "Height in inches",
            "type": "number"
          },
          "length": {
            "description": "Length in inches",
            "type": "number"
          },
          "reference_number": {
            "description": "Package level reference, not always necessarily a number",
            "type": "string"
          },
          "department": {
            "description": "Department number. Displayed as DEPT field on label",
            "type": "string",
            "maxLength": 40
          },
          "invoice": {
            "description": "Invoice number. Displayed as INV field on label",
            "type": "string",
            "maxLength": 40
          },
          "purchase_order": {
            "description": "Purchase order number. Displayed as PO field on label",
            "type": "string",
            "maxLength": 40
          },
          "sub_package_type": {
            "description": "if you are using your own packaging for the shipment. Example: TUBE, CARTON, CONTAINER. etc",
            "type": "string"
          },
          "weight": {
            "description": "Weight in ounces.",
            "type": "number"
          },
          "width": {
            "description": "Width in inches",
            "type": "number"
          }
        },
        "required": [
          "box_shape"
        ]
      }
    },
    "packing_list_id": {
      "description": "id for packing list for profile template associated with this label",
      "type": "integer"
    },
    "customs_info": {
      "items": {
        "$ref": "#/components/schemas/customs_line"
      },
      "type": "array"
    },
    "delivery_confirmation": {
      "default": "SERVICE_DEFAULT",
      "enum": [
        "NO_SIGNATURE_REQUIRED",
        "INDIRECT",
        "DIRECT",
        "ADULT",
        "SERVICE_DEFAULT"
      ],
      "type": "string"
    },
    "delivery_instructions": {
      "type": "string"
    },
    "dry_ice_weight": {
      "description": "Weight in ounces.",
      "type": "number",
      "default": 0
    },
    "duties_payment_type": {
      "type": "string"
    },
    "duties_payment_account": {
      "type": "string"
    },
    "export_compliance_statement": {
      "description": "For US export shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number.The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES.",
      "type": "string"
    },
    "importer_of_record": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "address": {
          "$ref": "#/components/schemas/address"
        },
        "tin": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "tin_type": {
              "type": "string",
              "enum": [
                "BUSINESS_NATIONAL",
                "BUSINESS_STATE",
                "BUSINESS_UNION",
                "PERSONAL_NATIONAL",
                "PERSONAL_STATE"
              ]
            },
            "number": {
              "type": "string",
              "maxLength": 15
            }
          },
          "required": [
            "tin_type",
            "number"
          ]
        },
        "account_number": {
          "type": "string",
          "maxLength": 12
        }
      },
      "required": [
        "address",
        "tin"
      ]
    },
    "insurance_type": {
      "enum": [
        "discounted_insurance",
        "fedex"
      ],
      "type": "string"
    },
    "insured_value": {
      "default": 0,
      "type": "number"
    },
    "label_type": {
      "description": "FedEx: option for Tire Loss labels with doc tab",
      "type": "string",
      "enum": [
        "STOCK_4X85_TRAILING_DOC_TAB",
        "STOCK_4X105_TRAILING_DOC_TAB"
      ]
    },
    "notify_bill_to": {
      "default": false,
      "type": "boolean"
    },
    "notify_ship_to": {
      "default": false,
      "type": "boolean"
    },
    "one_rate": {
      "type": "boolean"
    },
    "payment_account": {
      "type": "string"
    },
    "payment_type": {
      "type": "string"
    },
    "pharmacy_delivery": {
      "default": false,
      "type": "boolean"
    },
    "priority_alert": {
      "type": "string",
      "enum": [
        "PRIORITY_ALERT",
        "PRIORITY_ALERT_PLUS"
      ]
    },
    "reason_for_export": {
      "enum": [
        "SOLD",
        "NOT_SOLD",
        "PERSONAL_EFFECTS",
        "GIFT",
        "REPAIR_AND_RETURN",
        "SAMPLE"
      ],
      "type": "string"
    },
    "reason_for_export_explanation": {
      "type": "string"
    },
    "receiver_tax_info": {
      "$ref": "#/components/schemas/tax_info"
    },
    "recipient_address_is_residential": {
      "type": "boolean"
    },
    "return": {
      "type": "boolean"
    },
    "saturday_delivery": {
      "default": false,
      "type": "boolean"
    },
    "sender_tax_info": {
      "$ref": "#/components/schemas/tax_info"
    },
    "ship_date": {
      "format": "date-time",
      "type": "string"
    },
    "shipper_id": {
      "type": "integer"
    },
    "shipper_type": {
      "type": "string"
    },
    "shipping_method": {
      "type": "string"
    },
    "smart_post_ancillary_endorsement": {
      "enum": [
        "ADDRESS_CORRECTION",
        "CARRIER_LEAVE_IF_NO_RESPONSE",
        "CHANGE_SERVICE",
        "FORWARDING_SERVICE",
        "RETURN_SERVICE"
      ],
      "description": "Required for Presorted Standard but not for returns or parcel select. They are not all usable for all ancillary endorsements.",
      "type": "string"
    },
    "smart_post_hub": {
      "type": "string"
    },
    "smart_post_indicia": {
      "type": "string"
    },
    "ship_from": {
      "description": "The ship_from address is used as the originating address of the rate and label request.",
      "$ref": "#/components/schemas/v1_address"
    },
    "ship_to": {
      "description": "The to address is used as the destination address of a return order rate and label request.",
      "$ref": "#/components/schemas/v1_address"
    },
    "reference_id": {
      "description": "Identifier for a Return Order",
      "type": "string"
    },
    "dangerous_goods_option": {
      "type": "string"
    },
    "dangerous_goods_regulation_type": {
      "type": "string"
    },
    "warehouse_id": {
      "description": "Currently ignored. Previously used for updating a warehouse for the ship_from address on an order.",
      "type": "integer"
    },
    "etd_service": {
      "type": "boolean"
    },
    "etd_preshipment_docs": {
      "description": "for referencing previously uploaded ETD for shipment label",
      "items": {
        "properties": {
          "id": {
            "type": "string"
          },
          "document_type": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "hold_at_location": {
      "type": "boolean"
    },
    "hold_at_location_id": {
      "type": "string"
    },
    "certificate_of_origin": {
      "type": "boolean"
    },
    "use_metric_units": {
      "type": "boolean"
    }
  },
  "required": [
    "shipper_id",
    "shipping_method"
  ]
}