productOptionConfig_Full

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/productOptionConfig_Full",
  "title": "productOptionConfig_Full",
  "type": "object",
  "properties": {
    "default_value": {
      "type": "string",
      "description": "(date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601\u2013formatted string, or on a text option as a string.\n"
    },
    "checked_by_default": {
      "type": "boolean",
      "description": "(checkbox) Flag for setting the checkbox to be checked by default.\n"
    },
    "checkbox_label": {
      "type": "string",
      "description": "(checkbox) Label displayed for the checkbox option.\n"
    },
    "date_limited": {
      "type": "boolean",
      "description": "(date) Flag to limit the dates allowed to be entered on a date option.\n"
    },
    "date_limit_mode": {
      "type": "string",
      "description": "(date) The type of limit that is allowed to be entered on a date option.\n",
      "example": "range",
      "enum": [
        "earliest",
        "range",
        "latest"
      ]
    },
    "date_earliest_value": {
      "type": "string",
      "description": "(date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.\n",
      "format": "date"
    },
    "date_latest_value": {
      "type": "string",
      "description": "(date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.\n",
      "format": "date"
    },
    "file_types_mode": {
      "type": "string",
      "description": "(file) The kind of restriction on the file types that can be uploaded with a file upload option. Values: `specific` - restricts uploads to particular file types; `all` - allows all file types.\n",
      "example": "specific",
      "enum": [
        "specific",
        "all"
      ]
    },
    "file_types_supported": {
      "type": "array",
      "description": "(file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values:\n  `images` - Allows upload of image MIME types (`bmp`, `gif`, `jpg`, `jpeg`, `jpe`, `jif`, `jfif`, `jfi`, `png`, `wbmp`, `xbm`, `tiff`). `documents` - Allows upload of document MIME types (`txt`, `pdf`, `rtf`, `doc`, `docx`, `xls`, `xlsx`, `accdb`, `mdb`, `one`, `pps`, `ppsx`, `ppt`, `pptx`, `pub`, `odt`, `ods`, `odp`, `odg`, `odf`).\n  `other` - Allows file types defined in the `file_types_other` array.\n",
      "items": {
        "type": "string",
        "example": "images, documents, other"
      }
    },
    "file_types_other": {
      "type": "array",
      "description": "(file) A list of other file types allowed with the file upload option.\n",
      "items": {
        "type": "string",
        "example": "pdf"
      }
    },
    "file_max_size": {
      "type": "integer",
      "description": "(file) The maximum size for a file that can be used with the file upload option. This will still be limited by the server.\n",
      "example": 5
    },
    "text_characters_limited": {
      "type": "boolean",
      "description": "(text, multi_line_text) Flag to validate the length of a text or multi-line text input.\n"
    },
    "text_min_length": {
      "type": "integer",
      "description": "(text, multi_line_text) The minimum length allowed for a text or multi-line text option.\n",
      "example": 1
    },
    "text_max_length": {
      "type": "integer",
      "description": "(text, multi_line_text) The maximum length allowed for a text or multi line text option.\n",
      "example": 55
    },
    "text_lines_limited": {
      "type": "boolean",
      "description": "(multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input.\n",
      "example": true
    },
    "text_max_lines": {
      "type": "integer",
      "description": "(multi_line_text) The maximum number of lines allowed on a multi-line text input.\n",
      "example": 4
    },
    "number_limited": {
      "type": "boolean",
      "description": "(numbers_only_text) Flag to limit the value of a number option.\n",
      "example": true
    },
    "number_limit_mode": {
      "type": "string",
      "description": "(numbers_only_text) The type of limit on values entered for a number option.\n",
      "example": "lowest",
      "enum": [
        "lowest",
        "highest",
        "range"
      ]
    },
    "number_lowest_value": {
      "type": "number",
      "description": "(numbers_only_text) The lowest allowed value for a number option if `number_limited` is true.\n",
      "example": 100
    },
    "number_highest_value": {
      "type": "number",
      "description": "(numbers_only_text) The highest allowed value for a number option if `number_limited` is true.\n"
    },
    "number_integers_only": {
      "type": "boolean",
      "description": "(numbers_only_text) Flag to limit the input on a number option to whole numbers only.\n",
      "example": false
    },
    "product_list_adjusts_inventory": {
      "type": "boolean",
      "description": "(product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list.\n"
    },
    "product_list_adjusts_pricing": {
      "type": "boolean",
      "description": "(product_list, product_list_with_images) Flag to add the optional product's price to the main product's price.\n"
    },
    "product_list_shipping_calc": {
      "type": "string",
      "description": "(product_list, product_list_with_images) How to factor the optional product's weight and package dimensions into the shipping quote. Values: `none` - don't adjust; `weight` - use shipping weight only; `package` - use weight and dimensions.\n",
      "example": "weight",
      "enum": [
        "none",
        "weight",
        "package"
      ]
    }
  },
  "description": "The values for option config can vary based on the Modifier created.",
  "x-internal": false
}