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
  • Product Options
  • Pagination
  • Response
  • Response
ArchiveStore OperationsCatalog V2 Products

Product Options

Deprecated
Was this page helpful?
Previous

Product Reviews

Next

Product Images

Built with

Product Options

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

Product Options Object Properties
TitleNameTypeDescription
idint
option_idint
display_namestring
sort_orderint
is_requiredboolean
List Product Options

Gets the options associated with a product.

GET /stores/{store_hash}/v2/products/{product_id}/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
}