eBay · Schema

AdditionalOption

This complex type contains information about a shipping option that can be purchased in addition to the base shipping cost of a recommended rate. Additional options for each rate are defined, named, and offered by the selected shipping carrier. Examples include shipping insurance or the requirement for a recipient signature.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
additionalCost object The monetary cost of the additional shipping option identified by the optionType field.
optionType string The name of a shipping option that can be purchased in addition to the base shipping cost of this rate. The value supplied in this field must match exactly the option name as supplied by the selected
View JSON Schema on GitHub

JSON Schema

ebay-additionaloption-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AdditionalOption",
  "title": "AdditionalOption",
  "type": "object",
  "properties": {
    "additionalCost": {
      "description": "The monetary cost of the additional shipping option identified by the <b>optionType</b> field.",
      "$ref": "#/components/schemas/Amount"
    },
    "optionType": {
      "type": "string",
      "description": "The name of a shipping option that can be purchased in addition to the base shipping cost of this rate. The value supplied in this field must match exactly the option name as supplied by the selected rate."
    }
  },
  "description": "This complex type contains information about a shipping option that can be purchased in addition to the base shipping cost of a recommended rate. Additional options for each rate are defined, named, and offered by the selected shipping carrier. Examples include shipping insurance or the requirement for a recipient signature."
}