{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/dhl/json-schema/dhl-international-rating-response-schema.json",
  "title": "InternationalRatingResponse",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/dhl-product-finder-dhl-ecommerce-americas-openapi.yml#/components/schemas/InternationalRatingResponse",
  "type": "object",
  "properties": {
    "Labelrequest": {
      "type": "object",
      "description": "https://developer.dhl.com/api-reference/label-dhl-ecommerce-americas#operations-Label-createLabel"
    },
    "shipDate": {
      "type": "string",
      "maxLength": 10,
      "minLength": 10,
      "description": "Date on which the shipment is created or the expectedShipDate if it is provided. (O)"
    },
    "rate": {
      "type": "object",
      "description": "Rate request configuration. (O)",
      "properties": {
        "calculate": {
          "type": "boolean",
          "description": "Whether or not to calculate rates (default: false) (O)",
          "enum": [
            true,
            false
          ]
        },
        "currency": {
          "type": "string",
          "maxLength": 3,
          "minLength": 3,
          "description": "Currency for maxPrice and for rates returned; required if calculate is true (C)"
        },
        "rateDate": {
          "type": "string",
          "maxLength": 10,
          "minLength": 10,
          "description": "Rate date to be used for the rate calculation, in YYYY-MM-DD format. This field is deprecated. Rate date will always be set to the current date. (O)"
        },
        "maxPrice": {
          "type": "number",
          "format": "float",
          "maximum": 9999999,
          "description": "Filter for products that are under a maximum price. (O)"
        }
      }
    },
    "estimatedDeliveryDate": {
      "type": "object",
      "description": "EDD request configuration. (O)",
      "properties": {
        "calculate": {
          "type": "boolean",
          "description": "Whether or not to calculate estimated delivery date (default: false). (O)",
          "enum": [
            true,
            false
          ]
        },
        "deliveryBy": {
          "type": "string",
          "maxLength": 10,
          "minLength": 10,
          "description": "Latest delivery by date in YYYY-MM-DD format. (O)"
        },
        "expectedShipDate": {
          "type": "string",
          "maxLength": 10,
          "minLength": 10,
          "description": "Expected ship date in YYYY-MM-DD format; when provided, estimatedDeliveryMin and estimatedDeliveryMax will be calculated using this ship date (O)"
        },
        "expectedTransit": {
          "type": "integer",
          "maximum": 99,
          "minimum": 1,
          "description": "Filter for maximum transit days. (O)"
        }
      }
    },
    "products": {
      "type": "object",
      "description": "Array of products found. (O)",
      "properties": {
        "orderedProductID": {
          "type": "string",
          "maxLength": 3,
          "minLength": 3,
          "description": "DHLeC three-letter product code; refer to [Product Codes] https://developer.dhl.com/api-reference/references-dhl-ecommerce-americas#get-started-section/domestic-products in References for a list of product codes (O)"
        },
        "productName": {
          "type": "string",
          "maxLength": 50,
          "minLength": 0,
          "description": "The full name of the product. (O)"
        },
        "description": {
          "type": "string",
          "maxLength": 250,
          "minLength": 0,
          "description": "A short description of the product. This field is subject to change and should not be used to uniquely identify and select products. (O)"
        },
        "trackingAvailable": {
          "type": "string",
          "maxLength": 20,
          "minLength": 0,
          "description": "Level of tracking available for this product (PARTIAL, FULL) (O)"
        },
        "rate": {
          "type": "object",
          "description": "Rate information for this product. (O)",
          "properties": {
            "priceZone": {
              "type": "string",
              "maxLength": 6,
              "minLength": 1,
              "description": "The price zone for this rate. (M)"
            },
            "amount": {
              "type": "number",
              "maximum": 999999999,
              "minimum": 0,
              "description": "The total rate calculated for this product. (M)"
            },
            "currency": {
              "type": "string",
              "maxLength": 3,
              "minLength": 3,
              "description": "Three-character ISO currency code for the rate. (M)"
            },
            "effectiveFrom": {
              "type": "string",
              "maxLength": 10,
              "minLength": 10,
              "description": "Date that reflects when a rate was last updated. (M)"
            },
            "rateComponents": {
              "type": "object",
              "description": "Rate Components (M)",
              "properties": {
                "rateComponentID": {
                  "type": "string",
                  "maxLength": 10,
                  "minLength": 1,
                  "description": "Unique rate component identifier. (M)"
                },
                "partID": {
                  "type": "string",
                  "maxLength": 20,
                  "minLength": 1,
                  "description": "Invoiced part identifier for this rate component. (M)"
                },
                "description": {
                  "type": "string",
                  "maxLength": 50,
                  "minLength": 1,
                  "description": "Short description of this rate component. (M)"
                },
                "amount": {
                  "type": "integer",
                  "maximum": 999999999,
                  "minimum": 0,
                  "description": "Amount of this rate component, expressed in the total rate currency. (M)"
                }
              }
            },
            "estimatedDeliveryDate": {
              "type": "object",
              "description": "EDD information for this product. (O)",
              "required": [
                "isGuaranteed",
                "deliveryDaysMin",
                "deliveryDaysMax",
                "estimatedDeliveryMin",
                "estimatedDeliveryMax"
              ],
              "properties": {
                "isGuaranteed": {
                  "type": "boolean",
                  "enum": [
                    true,
                    false
                  ],
                  "description": "Whether or not the estimated delivery date is guaranteed. (M)"
                },
                "deliveryDaysMin": {
                  "type": "integer",
                  "maximum": 9,
                  "minimum": 1,
                  "description": "The minimum number of transit days for this shipment. (M)"
                },
                "deliveryDaysMax": {
                  "type": "integer",
                  "maximum": 99,
                  "minimum": 1,
                  "description": "The maximum number of transit days for this shipment. (M)"
                },
                "estimatedDeliveryMin": {
                  "type": "string",
                  "maxLength": 10,
                  "minLength": 10,
                  "description": "The earliest date that this shipment might arrive. (M)"
                },
                "estimatedDeliveryMax": {
                  "type": "string",
                  "maxLength": 10,
                  "minLength": 10,
                  "description": "Estimated delivery date for this product. (M)"
                }
              }
            }
          }
        }
      }
    }
  }
}