Rate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Rate",
  "title": "Rate",
  "type": "object",
  "properties": {
    "additionalOptions": {
      "type": "array",
      "description": "Contains service and pricing information for one or more shipping options that are offered by the carrier and can be purchased in addition to the base shipping service provided by this rate. Shipping options can include items such as <code>INSURANCE</code> and <code>SIGNATURE</code>.",
      "items": {
        "$ref": "#/components/schemas/AdditionalOption"
      }
    },
    "baseShippingCost": {
      "description": "A live quote for the cost that the carrier (identified by <b>shippingCarrierCode</b>) is charging for the shipping service being offered (identified by <b>shippingServiceCode</b>), excluding any additional shipping options.",
      "$ref": "#/components/schemas/Amount"
    },
    "destinationTimeZone": {
      "type": "string",
      "description": "The name of the time zone region, as defined in the <a href=\"http://www.iana.org/time-zones \"  target=\"_blank\">IANA Time Zone Database</a>, to which the package is being shipped.  <br><br>Delivery dates are calculated relative to this time zone.  <br><br><span class=\"tablenote\"><strong>Note:</strong> This is different from a Coordinated Universal Time (UTC) offset. For example, the <i>America/Los_Angeles</i> time zone identifies a region with the UTC standard time offset of <code>-08:00</code>, but so do several other time zones, including <i>America/Tijuana</i>,<i>America/Dawson</i>, and <i>Pacific/Pitcairn</i>.</span>"
    },
    "maxEstimatedDeliveryDate": {
      "type": "string",
      "description": "The latest stated date and time the shipment will be delivered at this rate.  <br><br>The time stamp is formatted as an <a href=\"https://www.iso.org/iso-8601-date-and-time-format.html \" title=\"https://www.iso.org \" target=\"_blank\">ISO 8601</a> string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.  <br><br><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> <br><b>Example:</b> <code>2018-08-20T07:09:00.000Z</code>"
    },
    "minEstimatedDeliveryDate": {
      "type": "string",
      "description": "The estimated earliest date and time the shipment will be delivered at this rate. The time stamp is formatted as an ISO 8601 UTC string."
    },
    "pickupNetworks": {
      "type": "array",
      "description": "A list of pickup networks compatible with the shipping service.",
      "items": {
        "type": "string"
      }
    },
    "pickupSlots": {
      "type": "array",
      "description": "A list of available pickup slots for the package.",
      "items": {
        "$ref": "#/components/schemas/PickupSlot"
      }
    },
    "pickupType": {
      "type": "string",
      "description": "The type of pickup or drop-off service associated with the <b>pickupSlots</b> time frames. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/logistics/types/api:PickupTypeEnum'>eBay API documentation</a>"
    },
    "rateId": {
      "type": "string",
      "description": "The unique eBay-assigned ID for this shipping rate."
    },
    "rateRecommendation": {
      "type": "array",
      "description": "A list of reasons this rate is recommended. Available values are: <ul> <li><code>BUYER_CHOSEN</code> &mdash; The rate meets or exceeds the requirements of the buyer's preferred shipping option.</li> <li><code>CHEAPEST_ON_TIME</code> &mdash; The rate is the cheapest rate available that will provide delivery within the seller's time frame commitment.</li>  <li><code>EBAY_PLUS_OK</code> &mdash; The rate complies with the shipping requirements of the eBay Plus program.</li> <li><code>FASTEST_ON_TIME</code> &mdash; The rate has the fastest shipping time, and will provide delivery within the seller's time frame commitment.</li> <li><code>GUARANTEED_DELIVERY_OK</code> &mdash; The rate complies with the shipping requirements of the eBay Guaranteed Delivery program.</li></ul>",
      "items": {
        "type": "string",
        "description": " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/logistics/types/api:RateRecommendationEnum'>eBay API documentation</a>"
      }
    },
    "shippingCarrierCode": {
      "type": "string",
      "description": "The code name of the shipping carrier who will provide the service identified by <b>shippingServiceCode</b>."
    },
    "shippingCarrierName": {
      "type": "string",
      "description": "The common name of the shipping carrier."
    },
    "shippingServiceCode": {
      "type": "string",
      "description": "The code name of the shipping service to be provided by the carrier identified by <b>shippingCarrierCode</b>."
    },
    "shippingServiceName": {
      "type": "string",
      "description": "The common name of the shipping service."
    }
  },
  "description": "This complex type contains live quote information about a shipping service that's available for a given shipping quote request, including the shipping carrier and service, delivery window, shipping cost, and additional shipping options."
}