For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
  • Overview
    • Quick Start
    • Sandboxes
    • Tools & SDKs
    • Support
  • Docs
    • Archive
          • SKU
          • Videos
          • Product Rules
          • Product Reviews
          • Product Options
          • Product Images
          • Option Values
          • Option Set Options
          • Option Sets
          • Options
          • Custom Fields
          • Categories
          • Bulk Pricing Rules
          • Products
          • Brands
    • Closed Beta Programs
Dev Portal
LogoLogo
On this page
  • Options
  • Filters
  • Pagination
  • Response
  • Response
ArchiveStore OperationsCatalog V2 Products

Product Options

Deprecated
Was this page helpful?
Previous

Option Sets

Next

Custom Fields

Built with

Options

Shared attributes that control value facets on a product.

This is archived documentation. The V2 Catalog API is deprecated. For current API documentation, see the Catalog API.

Options Object Properties
NameTypeDescription
namestringRequired field. The option’s name, as used internally. Must be unique.
display_namestringOptional field. The option’s name, as displayed on the storefront. Defaults to same value as name. However, a custom value can be defined here, and can be reused among multiple options.
typestringOptional field. The type of option, which determines how it will display on the storefront. Acceptable values:
C: Checkbox;
D: Date field;
F: File upload field;
MT: Multi-line text field;
RB: Radio buttons;
RT: Rectangular boxes (for product sizes);
S: Select/drop-down list;
C: Numbers-only text field;
P: Product Pick list;
CS: Color/texture Swatch;
T: Text field.
valuesobjectOptional field. Object containing option values: a url and a resource.
product_idintegerOptional field; read-only. If null, this option can be reused with any product. If populated with a numeric ID, this option can be used exclusively with the corresponding product.
List Product Options

Gets the options associated with a product.

GET /stores/{store_hash}/v2/products/{product_id}/options

Filters

There are no filter parameters specific to product options.

Pagination

Parameters can be added to the URL query string to paginate the collection. The maximum limit is 250. If a limit isn’t provided, up to 50 product_options are returned by default.

ParameterTypeExample
pageint/api/v2/products/{product_id}/options?page={number}
limitint/api/v2/products/{product_id}/options?limit={count}

Response

Example JSON returned in the response:

[
  {
    "id": 13,
    "option_id": 8,
    "display_name": "iPod Capacities",
    "sort_order": 0,
    "is_required": true
  },
  {
    "id": 14,
    "option_id": 9,
    "display_name": "Accessories",
    "sort_order": 1,
    "is_required": false
  }
]
Get a Product Option

Gets an option associated with a product.

GET /stores/{store_hash}/v2/products/{product_id}/options/{id}

Response

Example JSON returned in the response:

{
  "id": 14,
  "option_id": 9,
  "display_name": "Accessories",
  "sort_order": 1,
  "is_required": false
}