--- title: "GET /catalog/products" method: GET path: "/catalog/products" tags: ["Catalog"] --- # GET /catalog/products `GET /catalog/products` Returns a paginated collection of `Products` objects from the BigCommerce Catalog. ## Query parameters - `id` integer - `name` string - `sku` string - `upc` string - `price` number - `weight` number - `condition` integer - `brand_id` integer - `date_modified` string, date-time - `date_last_imported` string, date-time - `is_visible` integer - `is_featured` integer - `is_free_shipping` integer - `inventory_level` integer - `inventory_low` integer - `out_of_stock` integer - `total_sold` integer - `type` string - `categories` integer - `keyword` string - `keyword_context` 'shopper' | 'merchant' - `status` integer - `include` 'variants' | 'images' | 'custom_fields' | 'bulk_pricing_rules' | 'primary_image' - `include_fields` string - `exclude_fields` string - `availability` 'available' | 'disabled' | 'preorder' - `price_list_id` integer - `page` integer - `limit` integer - `direction` 'asc' | 'desc' - `sort` 'id' | 'name' | 'sku' | 'price' | 'date_modified' | 'date_last_imported' | 'inventory_level' | 'is_visible' | 'total_sold' ## Response `200` An array of products and metadata. - ProductCollectionResponse — Response payload for the BigCommerce API. - `data` Product[] - `name` string — The product name. - `type` 'physical' | 'digital' — The product type. One of: `physical` - a physical stock unit, `digital` - a digital download. - `sku` string — User defined product code/stock keeping unit (SKU). - `description` string — The product description, which can include HTML formatting. - `weight` number, double — Weight of the product, which can be used when calculating shipping costs. - `width` number, double — Width of the product, which can be used when calculating shipping costs. - `depth` number, double — Depth of the product, which can be used when calculating shipping costs. - `height` number, double — Height of the product, which can be used when calculating shipping costs. - `price` number, double — The price of the product. The price should include or exclude tax, based on the store settings. - `cost_price` number, double — The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store. - `retail_price` number, double — The retail cost of the product. If entered, the retail cost price will be shown on the product page. - `sale_price` number, double — If entered, the sale price will be used instead of value in the price field when calculating the product's cost. - `tax_class_id` integer — The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.) - `product_tax_code` string — Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to BigCommerce's Avalara Premium integration can calculate sales taxes more accurately. Stores without Avalara Premium will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see Avalara's documentation. - `categories` integer[] — An array of IDs for the categories to which this product belongs. When updating a product, if an array of categories is supplied, all product categories will be overwritten. Does not accept more than 1,000 ID values. - `brand_id` integer — The ID associated with the product's brand. - `inventory_level` integer — Current inventory level of the product. Simple inventory tracking must be enabled (See the `inventory_tracking` field) for this to take any effect. - `inventory_warning_level` integer — Inventory warning level for the product. When the product's inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the `inventory_tracking` field) for this to take any effect. - `inventory_tracking` 'none' | 'product' | 'variant' — The type of inventory tracking for the product. Values are: `none` - inventory levels will not be tracked; `product` - inventory levels will be tracked using the `inventory_level` and `inventory_warning_level` fields; `variant` - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels. - `fixed_cost_shipping_price` number, double — A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation. - `is_free_shipping` boolean — Flag used to indicate whether the product has free shipping. If `true`, the shipping cost for the product will be zero. - `is_visible` boolean — Flag to determine whether the product should be displayed to customers browsing the store. If `true`, the product will be displayed. If `false`, the product will be hidden from view. - `is_featured` boolean — Flag to determine whether the product should be included in the `featured products` panel when viewing the store. - `related_products` integer[] — An array of IDs for the related products. - `warranty` string — Warranty information displayed on the product page. Can include HTML formatting. - `bin_picking_number` string — The BIN picking number for the product. - `layout_file` string — The layout template file used to render this product. - `upc` string — The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations. - `search_keywords` string — A comma-separated list of keywords that can be used to locate the product when searching the store. - `availability` 'available' | 'disabled' | 'preorder' — Availability of the product. Availability options are: `available` - the product can be purchased on the storefront; `disabled` - the product is listed in the storefront, but cannot be purchased; `preorder` - the product is listed for pre-orders. - `availability_description` string — Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.' - `gift_wrapping_options_type` 'any' | 'none' | 'list' — Type of gift-wrapping options. Values: `any` - allow any gift-wrapping options in the store; `none` - disallow gift-wrapping on the product; `list` – provide a list of IDs in the `gift_wrapping_options_list` field. - `gift_wrapping_options_list` integer[] — A list of gift-wrapping option IDs. - `sort_order` integer — Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results. - `condition` 'New' | 'Used' | 'Refurbished' — The product condition. Will be shown on the product page if the `is_condition_shown` field's value is `true`. Possible values: `New`, `Used`, `Refurbished`. - `is_condition_shown` boolean — Flag used to determine whether the product condition is shown to the customer on the product page. - `order_quantity_minimum` integer — The minimum quantity an order must contain, to be eligible to purchase this product. - `order_quantity_maximum` integer — The maximum quantity an order can contain when purchasing the product. - `page_title` string — Custom title for the product page. If not defined, the product name will be used as the meta title. - `meta_keywords` string[] — Custom meta keywords for the product page. If not defined, the store's default keywords will be used. - `meta_description` string — Custom meta description for the product page. If not defined, the store's default meta description will be used. - `view_count` integer — The number of times the product has been viewed. - `preorder_release_date` string, date-time, nullable — Pre-order release date. See the `availability` field for details on setting a product's availability to accept pre-orders. - `preorder_message` string — Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the `%%DATE%%` placeholder, which will be substituted for the release date. - `is_preorder_only` boolean — If set to `false`, the product will not change its availability from `preorder` to `available` on the release date. Otherwise, on the release date the product's availability/status will change to `available`. - `is_price_hidden` boolean — False by default, indicating that this product's price should be shown on the product page. If set to `true`, the price is hidden. (NOTE: To successfully set `is_price_hidden` to `true`, the `availability` value must be `disabled`.) - `price_hidden_label` string — By default, an empty string. If `is_price_hidden` is `true`, the value of `price_hidden_label` is displayed instead of the price. (NOTE: To successfully set a non-empty string value with `is_price_hidden` set to `true`, the `availability` value must be `disabled`.) - `custom_url` CustomUrlProduct — The custom URL for the product on the storefront. - `url` string — Product URL on the storefront. - `is_customized` boolean — Returns `true` if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides). - `open_graph_type` 'product' | 'album' | 'book' | 'drink' | 'food' | 'game' | 'movie' | 'song' | 'tv_show' — Type of product, defaults to `product`. - `open_graph_title` string — Title of the product, if not specified the product name will be used instead. - `open_graph_description` string — Description to use for the product, if not specified then the meta_description will be used instead. - `open_graph_use_meta_description` boolean — Flag to determine if product description or open graph description is used. - `open_graph_use_product_name` boolean — Flag to determine if product name or open graph name is used. - `open_graph_use_image` boolean — Flag to determine if product image or open graph image is used. - `id` integer — The unique numeric ID of the product; increments sequentially. - `calculated_price` number, double — The price of the product as seen on the storefront. It will be equal to the `sale_price`, if set, and the `price` if there is not a `sale_price`. - `reviews_rating_sum` integer — The total rating for the product. - `reviews_count` integer — The number of times the product has been rated. - `total_sold` integer — The total quantity of this product sold. - `custom_fields` CustomField[] - `name` string — The name of the field, shown on the storefront, orders, etc. - `value` string — The name of the field, shown on the storefront, orders, etc. - `id` integer — The unique numeric ID of the custom field; increments sequentially. - `bulk_pricing_rules` BulkPricingRule[] - `quantity_min` integer — The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero. - `quantity_max` integer — The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the `quantity_min` value – unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule. - `type` 'price' | 'percent' | 'fixed' — The type of adjustment that is made. Values: `price` - the adjustment amount per product; `percent` - the adjustment as a percentage of the original price; `fixed` - the adjusted absolute price of the product. - `amount` number, double — The value of the adjustment by the bulk pricing rule. - `id` integer — The ID of the bulk pricing rule. - `date_created` string, date-time — The date on which the product was created. - `date_modified` string, date-time — The date on which the product was modified. - `images` ProductImage[] - `is_thumbnail` boolean — Flag for identifying whether the image is used as the product's thumbnail. - `sort_order` integer — The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a `sort_order` the same as or greater than the image's new `sort_order` value will have their `sort_order`s reordered. - `description` string — The description for the image. - `id` integer — The unique numeric ID of the image; increments sequentially. - `product_id` integer — The unique numeric identifier for the product with which the image is associated. - `image_file` string — The local path to the original image file uploaded to BigCommerce. - `url_zoom` string — The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. - `url_standard` string — The standard URL for this image. By default, this is used for product-page images. - `url_thumbnail` string — The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. - `url_tiny` string — The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. - `date_modified` string, date-time — The date on which the product image was modified. - `videos` ProductVideo[] - `title` string — The title for the video. If left blank, this will be filled in according to data on a host site. - `description` string — The description for the video. If left blank, this will be filled in according to data on a host site. - `sort_order` integer — The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a `sort_order` the same as or greater than the video's new `sort_order` value will have their `sort_order`s reordered. - `type` 'youtube' — The video type (a short name of a host site). - `id` integer — The unique numeric ID of the product video; increments sequentially. - `video_id` string — The ID of the video on a host site. - `product_id` integer — The unique numeric identifier for the product with which the image is associated. - `length` string — Length of the video. This will be filled in according to data on a host site. - `variants` Variant[] - `cost_price` number, double, nullable — The cost price of the variant. Not affected by Price List prices. - `price` number, double, nullable — This variant's base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is `null`, the product's default price (set in the Product resource's `price` field) will be used as the base price. - `sale_price` number, double, nullable — This variant's sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's sale price (set in the Product resource's `price` field) will be used as the sale price. - `retail_price` number, double, nullable — This variant's retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product's retail price (set in the Product resource's `price` field) will be used as the retail price. - `weight` number, double, nullable — This variant's base weight on the storefront. If this value is null, the product's default weight (set in the Product resource's weight field) will be used as the base weight. - `width` number, double, nullable — Width of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default width (set in the Product resource's `width` field) will be used as the base width. - `height` number, double, nullable — Height of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default height (set in the Product resource's `height` field) will be used as the base height. - `depth` number, double, nullable — Depth of the variant, which can be used when calculating shipping costs. If this value is `null`, the product's default depth (set in the Product resource's `depth` field) will be used as the base depth. - `is_free_shipping` boolean — Flag used to indicate whether the variant has free shipping. If `true`, the shipping cost for the variant will be zero. - `fixed_cost_shipping_price` number, double, nullable — A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation. - `purchasing_disabled` boolean — If `true`, this variant will not be purchasable on the storefront. - `purchasing_disabled_message` string — If `purchasing_disabled` is `true`, this message should show on the storefront when the variant is selected. - `image_url` string — The image that will be displayed when this variant is selected on the storefront. When updating a SKU image, send the publicly accessible URL. Supported image formats are JPEG, PNG, and GIF. Generic product images not specific to the variant should be stored on the product. - `upc` string, nullable — The UPC code used in feeds for shopping comparison sites and external channel integrations. - `inventory_level` integer, nullable — Inventory level for the variant, which is used when the product's inventory_tracking is set to `variant`. - `inventory_warning_level` integer, nullable — When the variant hits this inventory level, it is considered low stock. - `bin_picking_number` string, nullable — Identifies where in a warehouse the variant is located. - `id` integer - `product_id` integer - `sku` string - `sku_id` integer, nullable — Read-only reference to v2 API's SKU ID. Null if it is a base variant. - `option_values` OptionValueVariant[] — Array of option and option values IDs that make up this variant. Will be empty if the variant is the product's base variant. - `option_display_name` string — The name of the option. - `label` string — The label of the option value. - `id` integer - `option_id` integer - `calculated_price` number, double — The price of the variant as seen on the storefront. This price takes into account `sale_price` and any price adjustment rules that are applicable to this variant. - `options` Option[] - `id` integer, nullable — The unique numerical ID of the option, increments sequentially. - `product_id` integer — The unique numerical ID of the product to which the option belongs. - `display_name` string — The name of the option shown on the storefront. - `type` 'radio_buttons' | 'rectangles' | 'dropdown' | 'product_list' | 'product_list_with_images' | 'swatch' — The type of option, which determines how it will display on the storefront. Acceptable values: `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch. - `sort_order` integer — The order the modifiers display on the product detail page. - `config` OptionConfig - `default_value` string — (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. - `checked_by_default` boolean — (checkbox) Flag for setting the checkbox to be checked by default. - `checkbox_label` string — (checkbox) Label displayed for the checkbox option. - `date_limited` boolean — (date) Flag to limit the dates allowed to be entered on a date option. - `date_limit_mode` 'earliest' | 'range' | 'latest' — (date) The type of limit that is allowed to be entered on a date option. - `date_earliest_value` string, date — (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string. - `date_latest_value` string, date — (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string. - `file_types_mode` 'specific' | 'all' — (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. - `file_types_supported` string[] — (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: `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`). `other` - Allows file types defined in the `file_types_other` array. - `file_types_other` string[] — (file) A list of other file types allowed with the file upload option. - `file_max_size` integer — (file) The maximum size for a file that can be used with the file upload option. - `text_characters_limited` boolean — (text, multi_line_text) Flag to validate the length of a text or multi-line text input. - `text_min_length` integer — (text, multi_line_text) The minimum length allowed for a text or multi-line text option. - `text_max_length` integer — (text, multi_line_text) The maximum length allowed for a text or multi line text option. - `text_lines_limited` boolean — (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input. - `text_max_lines` integer — (multi_line_text) The maximum number of lines allowed on a multi-line text input. - `number_limited` boolean — (numbers_only_text) Flag to limit the value of a number option. - `number_limit_mode` '' | 'lowest' | 'highest' | 'range' — (numbers_only_text) The type of limit on values entered for a number option. - `number_lowest_value` number — (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true. - `number_highest_value` number — (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. - `number_integers_only` boolean — (numbers_only_text) Flag to limit the input on a number option to whole numbers only. - `product_list_adjusts_inventory` boolean — (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. - `product_list_adjusts_pricing` boolean — (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. - `product_list_shipping_calc` 'none' | 'weight' | 'package' — (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. - `option_values` OptionValue[] - `is_default` boolean — The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - `label` string — The text display identifying the value on the storefront. - `sort_order` integer — The order in which the value will be displayed on the product page. - `value_data` object — Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - `id` integer — The unique numeric ID of the value; increments sequentially. - `name` string — The unique option name, auto-generated from the display name, a timestamp, and the product ID. - `modifiers` Modifier[] - `type` 'date' | 'checkbox' | 'file' | 'text' | 'multi_line_text' | 'numbers_only_text' | 'radio_buttons' | 'rectangles' | 'dropdown' | 'product_list' | 'product_list_with_images' | 'swatch' — BigCommerce API, which determines how it will display on the storefront. Acceptable values: `date`, `checkbox`, `file`, `text`, `multi_line_text`, `numbers_only_text`, `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. For reference, the former v2 API values are: D = date, C = checkbox, F = file, T = text, MT = multi_line_text, N = numbers_only_text, RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch. - `required` boolean — Whether or not this modifer is required or not at checkout. - `sort_order` integer — The order the modifiers display on the product detail page. - `config` OptionConfig - `default_value` string — (date, text, multi_line_text, numbers_only_text) The default value. Shown on a date option as an ISO-8601–formatted string, or on a text option as a string. - `checked_by_default` boolean — (checkbox) Flag for setting the checkbox to be checked by default. - `checkbox_label` string — (checkbox) Label displayed for the checkbox option. - `date_limited` boolean — (date) Flag to limit the dates allowed to be entered on a date option. - `date_limit_mode` 'earliest' | 'range' | 'latest' — (date) The type of limit that is allowed to be entered on a date option. - `date_earliest_value` string, date — (date) The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string. - `date_latest_value` string, date — (date) The latest date allowed to be entered on the date option, as an ISO-8601 formatted string. - `file_types_mode` 'specific' | 'all' — (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. - `file_types_supported` string[] — (file) The type of files allowed to be uploaded if the `file_type_option` is set to `specific`. Values: `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`). `other` - Allows file types defined in the `file_types_other` array. - `file_types_other` string[] — (file) A list of other file types allowed with the file upload option. - `file_max_size` integer — (file) The maximum size for a file that can be used with the file upload option. - `text_characters_limited` boolean — (text, multi_line_text) Flag to validate the length of a text or multi-line text input. - `text_min_length` integer — (text, multi_line_text) The minimum length allowed for a text or multi-line text option. - `text_max_length` integer — (text, multi_line_text) The maximum length allowed for a text or multi line text option. - `text_lines_limited` boolean — (multi_line_text) Flag to validate the maximum number of lines allowed on a multi-line text input. - `text_max_lines` integer — (multi_line_text) The maximum number of lines allowed on a multi-line text input. - `number_limited` boolean — (numbers_only_text) Flag to limit the value of a number option. - `number_limit_mode` '' | 'lowest' | 'highest' | 'range' — (numbers_only_text) The type of limit on values entered for a number option. - `number_lowest_value` number — (numbers_only_text) The lowest allowed value for a number option if `number_limited` is true. - `number_highest_value` number — (numbers_only_text) The highest allowed value for a number option if `number_limited` is true. - `number_integers_only` boolean — (numbers_only_text) Flag to limit the input on a number option to whole numbers only. - `product_list_adjusts_inventory` boolean — (product_list, product_list_with_images) Flag for automatically adjusting inventory on a product included in the list. - `product_list_adjusts_pricing` boolean — (product_list, product_list_with_images) Flag to add the optional product's price to the main product's price. - `product_list_shipping_calc` 'none' | 'weight' | 'package' — (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. - `option_values` ModifierValue[] - `is_default` boolean — The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. - `label` string — The text display identifying the value on the storefront. - `sort_order` integer — The order in which the value will be displayed on the product page. - `value_data` object — Extra data describing the value, based on the type of option or modifier with which the value is associated. The `swatch` type option can accept an array of `colors`, with up to three hexidecimal color keys; or an `image_url`, which is a full image URL path including protocol. The `product list` type option requires a `product_id`. The `checkbox` type option requires a boolean flag, called `checked_value`, to determine which value is considered to be the checked state. - `adjusters` object - `price` Adjuster - `adjuster` 'relative' | 'percentage', nullable — The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - `adjuster_value` number — The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - `weight` Adjuster - `adjuster` 'relative' | 'percentage', nullable — The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront. - `adjuster_value` number — The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront. - `image_url` string — The URL for an image displayed on the storefront when the modifier value is selected. - `purchasing_disabled` object - `status` boolean — Flag for whether the modifier value disables purchasing when selected on the storefront. This can be used for temporarily disabling a particular modifier value. - `message` string — The message displayed on the storefront when the purchasing disabled status is `true`. - `id` integer — The unique numeric ID of the value; increments sequentially. - `id` integer — The unique numeric ID of the modifier; increments sequentially. - `product_id` integer — The unique numeric ID of the product to which the option belongs. - `name` string — The unique option name. Auto-generated from the display name, a timestamp, and the product ID. - `display_name` string — The name of the option shown on the storefront. - `base_variant_id` integer — The unique identifier of the base variant associated with a simple product. This value is null for complex products. - `meta` CollectionMeta — Data about the response, including pagination and collection totals. - `pagination` Pagination — Data about the response, including pagination and collection totals. - `total` integer — Total number of items in the result set. - `count` integer — Total number of items in the collection response. - `per_page` integer — The amount of items returned in the collection per page, controlled by the limit parameter. - `current_page` integer — The page you are currently on within the collection. - `total_pages` integer — The total number of pages in the collection. - `links` object — Pagination links for the previous and next parts of the whole collection. - `previous` string — Link to the previous page returned in the response. - `current` string — Link to the current page returned in the response. - `next` string — Link to the next page returned in the response. --- [API](https://skmtc.dev/bigcommerce/apis/bigcommerce-api.md) · [All operations](https://skmtc.dev/bigcommerce/apis/bigcommerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bigcommerce/bigcommerce-api/revisions/90efb67b99f3/schema)