CatalogItemOptionValue
November 20, 2019 ยท View on GitHub
Description
An enumerated value that can link a CatalogItemVariation to an item option as one of its item option values.
Properties
| Name | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| item_option_id | getItemOptionId() | setItemOptionId($value) | string | Unique ID of the associated item option. | [optional] |
| name | getName() | setName($value) | string | Name of this item option value. Searchable. | [optional] |
| description | getDescription() | setDescription($value) | string | A human-readable description for the option value. | [optional] |
| color | getColor() | setColor($value) | string | The HTML-supported hex color for the item option (e.g., "#ff8d4e85"). Only displayed if `show_colors` is enabled on the parent `ItemOption`. When left unset, `color` defaults to white ("#ffffff") when `show_colors` is enabled on the parent `ItemOption`. | [optional] |
| ordinal | getOrdinal() | setOrdinal($value) | int | Determines where this option value appears in a list of option values. | [optional] |
| item_variation_count | getItemVariationCount() | setItemVariationCount($value) | int | The number of `CatalogItemVariation`s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts. | [optional] |
Note: All properties are protected and only accessed via getters and setters.