{"files":{"SKILL.md":"---\nname: catalog-products\ndescription: \"Catalog - Products API skill. Use when working with Catalog - Products for catalog. Covers 53 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Catalog - Products\n\n## Auth\nApiKey X-Auth-Token in header\n\n## Base URL\nhttps://api.bigcommerce.com/stores/{store_hash}/v3\n\n## Setup\n1. Set your API key in the appropriate header\n2. GET /catalog/products -- get all products\n3. POST /catalog/products -- create first product\n\n## Endpoints\n53 endpoints across 1 group. See references/api-spec.lap for full details.\n\n### Catalog\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /catalog/products | Get All Products |\n| PUT | /catalog/products | Update Products (Batch) |\n| POST | /catalog/products | Create a Product |\n| DELETE | /catalog/products | Delete Products |\n| GET | /catalog/products/{product_id} | Get a Product |\n| PUT | /catalog/products/{product_id} | Update a Product |\n| DELETE | /catalog/products/{product_id} | Delete a Product |\n| GET | /catalog/products/{product_id}/images | Get All Product Images |\n| POST | /catalog/products/{product_id}/images | Create a Product Image |\n| GET | /catalog/products/{product_id}/images/{image_id} | Get a Product Image |\n| PUT | /catalog/products/{product_id}/images/{image_id} | Update a Product Image |\n| DELETE | /catalog/products/{product_id}/images/{image_id} | Delete a Product Image |\n| GET | /catalog/products/{product_id}/videos | Get All Product Videos |\n| POST | /catalog/products/{product_id}/videos | Create a Product Video |\n| GET | /catalog/products/{product_id}/videos/{id} | Get a Product Video |\n| PUT | /catalog/products/{product_id}/videos/{id} | Update a Product Video |\n| DELETE | /catalog/products/{product_id}/videos/{id} | Delete a Product Video |\n| GET | /catalog/products/{product_id}/complex-rules | Get Complex Rules |\n| POST | /catalog/products/{product_id}/complex-rules | Create a Complex Rule |\n| GET | /catalog/products/{product_id}/complex-rules/{complex_rule_id} | Get a Product Complex Rule |\n| PUT | /catalog/products/{product_id}/complex-rules/{complex_rule_id} | Update a Product Complex Rule |\n| DELETE | /catalog/products/{product_id}/complex-rules/{complex_rule_id} | Delete a Product Complex Rule |\n| GET | /catalog/products/{product_id}/custom-fields | Get Product Custom Fields |\n| POST | /catalog/products/{product_id}/custom-fields | Create a Product Custom Field |\n| GET | /catalog/products/{product_id}/custom-fields/{custom_field_id} | Get a Product Custom Field |\n| PUT | /catalog/products/{product_id}/custom-fields/{custom_field_id} | Update a Product Custom Field |\n| DELETE | /catalog/products/{product_id}/custom-fields/{custom_field_id} | Delete a Product Custom Field |\n| POST | /catalog/products/{product_id}/bulk-pricing-rules | Create a Bulk Pricing Rule |\n| GET | /catalog/products/{product_id}/bulk-pricing-rules | Get all Bulk Pricing Rules |\n| GET | /catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id} | Get a Bulk Pricing Rule |\n| PUT | /catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id} | Update a Bulk Pricing Rule |\n| DELETE | /catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id} | Delete a Bulk Pricing Rule |\n| GET | /catalog/products/{product_id}/metafields | Get Product Metafields |\n| POST | /catalog/products/{product_id}/metafields | Create a Product Metafield |\n| GET | /catalog/products/{product_id}/metafields/{metafield_id} | Get a Product Metafield |\n| PUT | /catalog/products/{product_id}/metafields/{metafield_id} | Update a Product Metafield |\n| DELETE | /catalog/products/{product_id}/metafields/{metafield_id} | Delete a Product Metafield |\n| GET | /catalog/products/{product_id}/reviews | Get Product Reviews |\n| POST | /catalog/products/{product_id}/reviews | Create a Product Review |\n| GET | /catalog/products/{product_id}/reviews/{review_id} | Get a Product Review |\n| PUT | /catalog/products/{product_id}/reviews/{review_id} | Update a Product Review |\n| DELETE | /catalog/products/{product_id}/reviews/{review_id} | Delete a Product Review |\n| GET | /catalog/products/channel-assignments | Get Products Channel Assignments |\n| PUT | /catalog/products/channel-assignments | Create Products Channel Assignments |\n| DELETE | /catalog/products/channel-assignments | Delete Products Channel Assignments |\n| GET | /catalog/products/category-assignments | Get Products Category Assignments |\n| PUT | /catalog/products/category-assignments | Create Products Category Assignments |\n| DELETE | /catalog/products/category-assignments | Delete Products Category Assignments |\n| GET | /catalog/summary | Get a Catalog Summary |\n| GET | /catalog/products/metafields | Get All Product Metafields |\n| POST | /catalog/products/metafields | Create multiple Metafields |\n| PUT | /catalog/products/metafields | Update multiple Metafields |\n| DELETE | /catalog/products/metafields | Delete Multiple Metafields |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all products?\" -> GET /catalog/products\n- \"Create a product?\" -> POST /catalog/products\n- \"Get product details?\" -> GET /catalog/products/{product_id}\n- \"Update a product?\" -> PUT /catalog/products/{product_id}\n- \"Delete a product?\" -> DELETE /catalog/products/{product_id}\n- \"List all images?\" -> GET /catalog/products/{product_id}/images\n- \"Create a image?\" -> POST /catalog/products/{product_id}/images\n- \"Get image details?\" -> GET /catalog/products/{product_id}/images/{image_id}\n- \"Update a image?\" -> PUT /catalog/products/{product_id}/images/{image_id}\n- \"Delete a image?\" -> DELETE /catalog/products/{product_id}/images/{image_id}\n- \"List all videos?\" -> GET /catalog/products/{product_id}/videos\n- \"Create a video?\" -> POST /catalog/products/{product_id}/videos\n- \"Get video details?\" -> GET /catalog/products/{product_id}/videos/{id}\n- \"Update a video?\" -> PUT /catalog/products/{product_id}/videos/{id}\n- \"Delete a video?\" -> DELETE /catalog/products/{product_id}/videos/{id}\n- \"List all complex-rules?\" -> GET /catalog/products/{product_id}/complex-rules\n- \"Create a complex-rule?\" -> POST /catalog/products/{product_id}/complex-rules\n- \"Get complex-rule details?\" -> GET /catalog/products/{product_id}/complex-rules/{complex_rule_id}\n- \"Update a complex-rule?\" -> PUT /catalog/products/{product_id}/complex-rules/{complex_rule_id}\n- \"Delete a complex-rule?\" -> DELETE /catalog/products/{product_id}/complex-rules/{complex_rule_id}\n- \"List all custom-fields?\" -> GET /catalog/products/{product_id}/custom-fields\n- \"Create a custom-field?\" -> POST /catalog/products/{product_id}/custom-fields\n- \"Get custom-field details?\" -> GET /catalog/products/{product_id}/custom-fields/{custom_field_id}\n- \"Update a custom-field?\" -> PUT /catalog/products/{product_id}/custom-fields/{custom_field_id}\n- \"Delete a custom-field?\" -> DELETE /catalog/products/{product_id}/custom-fields/{custom_field_id}\n- \"Create a bulk-pricing-rule?\" -> POST /catalog/products/{product_id}/bulk-pricing-rules\n- \"List all bulk-pricing-rules?\" -> GET /catalog/products/{product_id}/bulk-pricing-rules\n- \"Get bulk-pricing-rule details?\" -> GET /catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}\n- \"Update a bulk-pricing-rule?\" -> PUT /catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}\n- \"Delete a bulk-pricing-rule?\" -> DELETE /catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}\n- \"List all metafields?\" -> GET /catalog/products/{product_id}/metafields\n- \"Create a metafield?\" -> POST /catalog/products/{product_id}/metafields\n- \"Get metafield details?\" -> GET /catalog/products/{product_id}/metafields/{metafield_id}\n- \"Update a metafield?\" -> PUT /catalog/products/{product_id}/metafields/{metafield_id}\n- \"Delete a metafield?\" -> DELETE /catalog/products/{product_id}/metafields/{metafield_id}\n- \"List all reviews?\" -> GET /catalog/products/{product_id}/reviews\n- \"Create a review?\" -> POST /catalog/products/{product_id}/reviews\n- \"Get review details?\" -> GET /catalog/products/{product_id}/reviews/{review_id}\n- \"Update a review?\" -> PUT /catalog/products/{product_id}/reviews/{review_id}\n- \"Delete a review?\" -> DELETE /catalog/products/{product_id}/reviews/{review_id}\n- \"List all channel-assignments?\" -> GET /catalog/products/channel-assignments\n- \"List all category-assignments?\" -> GET /catalog/products/category-assignments\n- \"List all summary?\" -> GET /catalog/summary\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Paginated endpoints accept limit/offset or cursor parameters\n- Create/update endpoints return the modified resource on success\n- Error responses include status codes and descriptions in the spec\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Catalog - Products\n@base https://api.bigcommerce.com/stores/{store_hash}/v3\n@auth ApiKey X-Auth-Token in header\n@endpoints 53\n@hint download_for_search\n@toc catalog(53)\n\n@endpoint GET /catalog/products\n@desc Get All Products\n@optional {id: int # Filter items by product ID., id:in: [int] # Pass a comma-separated list to filter by one or more product IDs., channel_id:in: [int] # Pass a comma-separated list to filter by one or more channel IDs., id:not_in: [int] # Pass a comma-separated list to exclude one or more product IDs., include: [str] # A comma-separated list of sub-resources to return with a product object. When you specify `options` or `modifiers`, results are limited to 10 per page., include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded., page: int # Specifies the page number in a limited (paginated) list of products., limit: int=50 # Controls the number of items per page in a limited (paginated) list of products., direction: str(asc/desc) # Sort direction. Acceptable values are: `asc`, `desc`., sort: str(id/name/sku/price/date_modified/date_last_imported/inventory_level/is_visible/total_sold/calculated_price) # Field name to sort by. Note: Since ID increments when new products are added, you can use the ID value to sort by product create date., categories:in: [int] # A comma-separated list of category IDs. Returns a list of products that are in all the categories specified., id:min: int, id:max: int, id:greater: int, id:less: int, name: str # Filter items by name., mpn: str # Filter items by Manufacturer Part Number (MPN)., upc: str # Filter items by UPC., price: num # Filter items by price., weight: num # Filter items by weight., condition: str(new/used/refurbished) # Filter items by condition., brand_id: int # Filter items by brand ID., date_modified: str(date) # Filter items by `date_modified`., date_modified:max: str # Filter items by `date_modified`. If the `date modified:max` does not include hours, minutes and seconds, the API automatically adds the current time of the request to the date. For example, `date_modified:max=2025-01-15` or `date_modified:max=2025-01-15T00:03:17Z`., date_modified:min: str # Filter items by `date_modified`. If the `date modified:min` does not include hours, minutes and seconds, the API automatically adds the current time of the request to the date. For example, `date_modified:min=2025-01-15` or `date_modified:min=2025-01-15T00:03:17Z`., date_last_imported: str(date) # Filter items by date_last_imported., date_last_imported:not: str(date) # Filter products by specifying a date they were NOT last imported. For example, `date_last_imported:not=2015-08-21T22%3A53%3A23%2B00%3A00`., date_last_imported:max: str(date) # Filter items by date_last_imported. For example, `date_last_imported:max=2015-08-21T22%3A53%3A23%2B00%3A00`., date_last_imported:min: str(date) # Filter items by date_last_imported. For example, `date_last_imported:min=2015-08-21T22%3A53%3A23%2B00%3A00`., is_visible: bool # Filter items based on whether the product is currently visible on the storefront., is_featured: int(1/0) # Filter items by is_featured. `1` for true, `0` for false., is_free_shipping: int # Filter items by is_free_shipping. `1` for true, `0` for false., inventory_level: int # Filter items by inventory_level., inventory_level:in: [int] # A comma-separated list of inventory levels. Returns a list of all products that have any of the listed inventory amounts., inventory_level:not_in: [int] # A comma-separated list of inventory levels. Returns a list of all products that have inventory amounts other than those specified., inventory_level:min: int, inventory_level:max: int, inventory_level:greater: int, inventory_level:less: int, inventory_low: int # Filter items by inventory_low. Values: 1, 0., out_of_stock: int # Filter items by out_of_stock. To enable the filter, pass `out_of_stock`=`1`., total_sold: int # Filter items by total_sold., type: str(digital/physical) # Filter items by type., categories: int # Filter items by categories.   If a product is in more than one category, using this query will not return the product. Instead use `categories:in=12`., keyword: str # Filter items by keywords found in the `name`, `description`, or `sku` fields, or in the brand name., keyword_context: str(shopper/merchant) # Set context used by the search algorithm to return results targeted towards the specified group. Use `merchant` to help merchants search their own catalog. Use `shopper` to return shopper-facing search results., availability: str(available/disabled/preorder) # Filter items by availability. Values are: available, disabled, preorder., sku: str # Filter items by main SKU. To filter by variant SKU, see [Get all variants](/docs/rest-catalog/product-variants#get-all-product-variants)., sku:in: [str] # A comma-separated list of SKUs. Returns a list of products with those SKUs.}\n@returns(200) {data: [any], meta: map{pagination: map{total: int, count: int, per_page: int, current_page: int, total_pages: int, links: map{previous: str, current: str, next: str}}}}\n\n@endpoint PUT /catalog/products\n@desc Update Products (Batch)\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.}\n@optional {include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned.}\n@returns(200) {data: [any], meta: any}\n@returns(207) {data: [any], errors: map{status: int, title: str, type: str, errors: map}, meta: map{pagination: map{total: int, count: int, per_page: int, current_page: int, total_pages: int, links: map{previous: str, current: str, next: str}}}} # Multi-status. Typically indicates that a partial failure has occurred, such as when a POST or PUT request is successful, but saving one of the attributes has failed.  For example, the product information was updated successfully, but the inventory data failed to update or saving the URL failed.   If inventory data failed to update, verify that the inventory-related updates are well-formed and correct; for example, that they donʼt result in negative stock levels. Then consider updating the inventory data again.  If the URL failed to update, check that the URL uses Latin letters, is no more than 255 characters, and is not taken by any other entity.\n@errors {404: The resource was not found., 409: `Product` was in conflict with another product. This is the result of duplicate unique values such as name or SKU; a missing or invalid `category_id`, `brand_id`, or `tax_class id`; or a conflicting `bulk_pricing_rule`., 413: 413 Request Entity Too Large, 422: `Product` was not valid. This is the result of missing required fields or invalid data. See the response for more details.}\n@example_request [{\"id\":0,\"name\":\"Smith Journal 13\",\"type\":\"physical\",\"sku\":\"SM-13\",\"description\":\"<p><span>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi vel metus ac est egestas porta sed quis erat. Integer id nulla massa. Proin vitae enim nisi. Praesent non dignissim nulla. Nulla mattis id massa ac pharetra. Mauris et nisi in dolor aliquam sodales. Aliquam dui nisl, dictum quis leo sit amet, rutrum volutpat metus. Curabitur libero nunc, interdum ac libero non, tristique porttitor metus. Ut non dignissim lorem, in vestibulum leo. Vivamus sodales quis turpis eget.</span></p>\",\"weight\":0,\"width\":0,\"depth\":0,\"height\":0,\"price\":0,\"cost_price\":0,\"retail_price\":0,\"sale_price\":0,\"map_price\":0,\"tax_class_id\":0,\"product_tax_code\":\"string\",\"categories\":[0],\"brand_id\":37,\"inventory_level\":0,\"inventory_warning_level\":0,\"inventory_tracking\":\"none\",\"fixed_cost_shipping_price\":0,\"is_free_shipping\":true,\"is_visible\":true,\"is_featured\":true,\"related_products\":[0],\"warranty\":\"string\",\"bin_picking_number\":\"string\",\"layout_file\":\"string\",\"upc\":\"string\",\"search_keywords\":\"string\",\"availability\":\"available\",\"availability_description\":\"string\",\"gift_wrapping_options_type\":\"any\",\"gift_wrapping_options_list\":[0],\"sort_order\":-2147483648,\"condition\":\"New\",\"is_condition_shown\":true,\"order_quantity_minimum\":0,\"order_quantity_maximum\":0,\"page_title\":\"string\",\"meta_keywords\":[\"string\"],\"meta_description\":\"string\",\"view_count\":0,\"preorder_release_date\":\"2019-08-24T14:15:22Z\",\"preorder_message\":\"string\",\"is_preorder_only\":true,\"is_price_hidden\":true,\"price_hidden_label\":\"string\",\"custom_url\":{\"url\":\"string\",\"is_customized\":true},\"open_graph_type\":\"product\",\"open_graph_title\":\"string\",\"open_graph_description\":\"string\",\"open_graph_use_meta_description\":true,\"open_graph_use_product_name\":true,\"open_graph_use_image\":true,\"gtin\":\"string\",\"mpn\":\"string\",\"date_last_imported\":\"2015-07-03T18:16:02+00:00\",\"reviews_rating_sum\":3,\"reviews_count\":4,\"total_sold\":80,\"custom_fields\":[{\"id\":6,\"name\":\"ISBN\",\"value\":\"1234567890123\"}],\"bulk_pricing_rules\":[{\"id\":0,\"quantity_min\":10,\"quantity_max\":50,\"type\":\"price\",\"amount\":10}],\"images\":[{\"image_file\":\"string\",\"is_thumbnail\":true,\"sort_order\":-2147483648,\"description\":\"string\",\"image_url\":\"string\",\"id\":0,\"product_id\":0,\"date_modified\":\"2019-08-24T14:15:22Z\"}]}]\n\n@endpoint POST /catalog/products\n@desc Create a Product\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body., name: str # A unique product name., type: str(physical/digital) # The product type. One of: `physical` - a physical stock unit, `digital` - a digital download., weight: num(float) # Weight of the product, which can be used when calculating shipping costs. This is based on the unit set on the store, price: num(float) # The price of the product. The price should include or exclude tax, based on the store settings.}\n@optional {include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., sku: str # A unique user-defined alphanumeric product code/stock keeping unit (SKU). The SKU is always unique regardless of the letter case for both products and variants., description: str # The product description, which can include HTML formatting., width: num(float) # Width of the product, which can be used when calculating shipping costs., depth: num(float) # Depth of the product, which can be used when calculating shipping costs., height: num(float) # Height of the product, which can be used when calculating shipping costs., cost_price: num(float) # The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store., retail_price: num(float) # The retail cost of the product. If entered, the retail cost price will be shown on the product page., sale_price: num(float) # If entered, the sale price will be used instead of value in the price field when calculating the productʼs cost., map_price: num # Minimum Advertised Price, tax_class_id: num # The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.), product_tax_code: str # Tax Codes, such as AvaTax System Tax Codes, identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to a tax provider integration, such as BigCommerceʼs Avalara Premium, can calculate sales taxes more accurately. Stores without a tax provider will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see the tax providerʼs documentation., categories: [num] # An array of IDs for the categories to which this product belongs. You will overwrite all product categories when updating a product and supplying an array of categories. The limit is 1,000 ID values. When you enable the catalog V2 product experience in the control panel, you must include the categories array in the request body., brand_id: int # You can add a product to an existing brand during a product /PUT or /POST. Use either the `brand_id` or the `brand_name` field. The response body can include `brand_id`., brand_name: str # You can create the brand during a product PUT or POST request. If the brand already exists, the product /PUT or /POST request adds the product to the brand. If not, the product /PUT or /POST request creates the brand and then adds the product to the brand. Brand name is not case-sensitive; \"Common Good\" and \"Common good\" are the same. Use either the `brand_id` or the `brand_name` field. The response body does not include `brand_name`., inventory_level: int # Current inventory level of the product. You must track inventory by _product_ for this to take effect (see the `inventory_tracking` field). The Catalog API returns the inventory for only the default location.  The inventory for a product cannot exceed 2,147,483,647 in the catalog. If you exceed the limit, the store sets the inventory level to the limit.  The Catalog API handles limits in a different way than the Inventory API. For more information, see [Limit handling](/docs/store-operations/catalog/inventory-adjustments#limit-handling-in-inventory-versus-catalog-api)., inventory_warning_level: int # 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: str(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: num(float) # 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: bool # Flag used to indicate whether the product has free shipping. If `true`, the shipping cost for the product will be zero., is_visible: bool # 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: bool # Flag to determine whether the product should be included in the `featured products` panel when viewing the store., related_products: [int] # An array of IDs for the related products., warranty: str # Warranty information displayed on the product page. Can include HTML formatting., bin_picking_number: str # The BIN picking number for the product., layout_file: str # The layout template file used to render this product category. This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see [Custom Template Associations](/docs/rest-content/custom-template-associations)., upc: str # The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations., search_keywords: str # A comma-separated list of keywords that can be used to locate the product when searching the store., availability_description: str # 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.', availability: str(available/disabled/preorder) # Availability of the product. (Corresponds to the productʼs [Purchasability](https://support.bigcommerce.com/s/article/Adding-Products-v3?language=en_US#sections) section in the control panel.) Supported values: `available` - the product is available for purchase; `disabled` - the product is listed on the storefront, but cannot be purchased; `preorder` - the product is listed for pre-orders., gift_wrapping_options_type: str(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.  Always included in the response body; not applicable for the `include_fields` and `exclude_fields` query parameters., gift_wrapping_options_list: [int] # A list of gift-wrapping option IDs.  Always included in the response body; not applicable for the `include_fields` and `exclude_fields` query parameters., sort_order: int # 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: str(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: bool # Flag used to determine whether the product condition is shown to the customer on the product page., order_quantity_minimum: int # The minimum quantity an order must contain, to be eligible to purchase this product., order_quantity_maximum: int # The maximum quantity an order can contain when purchasing the product., page_title: str # Custom title for the product page. If not defined, the product name will be used as the meta title., meta_keywords: [str] # Custom meta keywords for the product page. If not defined, the storeʼs default keywords will be used., meta_description: str # Custom meta description for the product page. If not defined, the storeʼs default meta description will be used., view_count: int # The number of times the product has been viewed., preorder_release_date: str(date-time) # Pre-order release date. See the `availability` field for details on setting a productʼs availability to accept pre-orders., preorder_message: str # 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: bool # If set to true then on the preorder release date the preorder status will automatically be removed. If set to false, then on the release date the preorder status **will not** be removed. It will need to be changed manually either in the control panel or using the API. Using the API set `availability` to `available`., is_price_hidden: bool # 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: str # 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: map{url: str, is_customized: bool, create_redirect: bool} # The custom URL for the product on the storefront. If not provided in the POST request, the URL will be autogenerated from the product name., open_graph_type: str(product/album/book/drink/food/game/movie/song/tv_show) # Type of product, defaults to `product`., open_graph_title: str # Title of the product, if not specified the product name will be used instead., open_graph_description: str # Description to use for the product, if not specified then the meta_description will be used instead., open_graph_use_meta_description: bool # Flag to determine if product description or open graph description is used., open_graph_use_product_name: bool # Flag to determine if product name or open graph name is used., open_graph_use_image: bool # Flag to determine if product image or open graph image is used., gtin: str # Global Trade Item Number, mpn: str # Manufacturer Part Number, date_last_imported: str # the date when the Product had been imported, reviews_rating_sum: int # The total (cumulative) rating for the product., reviews_count: int # The number of times the product has been rated., total_sold: int # The total quantity of this product sold., custom_fields: [map{id: int, name!: str, value!: str}] # 200 maximum custom fields per product. 255 maximum characters per custom field., bulk_pricing_rules: [any], images: [any], videos: [any] # The Catalog API integrates with third-party YouTube. The [YouTube Terms of Service](https://www.youtube.com/t/terms) and [Google Privacy Policy](https://policies.google.com/privacy) apply, as indicated in our [Privacy Policy](https://www.bigcommerce.com/privacy/) and [Terms of Service](https://www.bigcommerce.com/terms/)., variants: [any]}\n@returns(200) {data: any, meta: map}\n@returns(207) {data: [any], errors: map{status: int, title: str, type: str, errors: map}, meta: map{pagination: map{total: int, count: int, per_page: int, current_page: int, total_pages: int, links: map{previous: str, current: str, next: str}}}} # Multi-status. Typically indicates that a partial failure has occurred, such as when a POST or PUT request is successful, but saving one of the attributes has failed.  For example, the product information was updated successfully, but the inventory data failed to update or saving the URL failed.   If inventory data failed to update, verify that the inventory-related updates are well-formed and correct; for example, that they donʼt result in negative stock levels. Then consider updating the inventory data again.  If the URL failed to update, check that the URL uses Latin letters, is no more than 255 characters, and is not taken by any other entity.\n@errors {409: `Product` conflicted with another product. This is the result of duplicate unique values, such as name or SKU; a missing or invalid `category_id`, `brand_id`, or `tax_class id`; or a conflicting `bulk_pricing_rule` or `custom_url`., 422: `Product` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.}\n\n@endpoint DELETE /catalog/products\n@desc Delete Products\n@optional {name: str # Filter items by name., sku: str # Filter items by main SKU. To filter by variant SKU, see [Get all variants](/docs/rest-catalog/product-variants#get-all-product-variants)., price: num # Filter items by price., weight: num # Filter items by weight., condition: str(new/used/refurbished) # Filter items by condition., brand_id: int # Filter items by brand ID., date_modified: str(date) # Filter items by `date_modified`., date_last_imported: str(date) # Filter items by date_last_imported., is_visible: bool # Filter items based on whether the product is currently visible on the storefront., is_featured: int(1/0) # Filter items by is_featured. `1` for true, `0` for false., id:in: [int] # Pass a comma-separated list to filter by one or more product IDs., inventory_level: int # Filter items by inventory_level., total_sold: int # Filter items by total_sold., type: str(digital/physical) # Filter items by type., categories: int # Filter items by categories.   If a product is in more than one category, using this query will not return the product. Instead use `categories:in=12`., keyword: str # Filter items by keywords found in the `name`, `description`, or `sku` fields, or in the brand name.}\n@returns(204)\n\n@endpoint GET /catalog/products/{product_id}\n@desc Get a Product\n@optional {include: [str] # A comma-separated list of sub-resources to return with a product object., include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.}\n@returns(200) {data: any, meta: map}\n@errors {404: The resource was not found.}\n\n@endpoint PUT /catalog/products/{product_id}\n@desc Update a Product\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.}\n@optional {include: [str] # A comma-separated list of sub-resources to return with a product object. When you specify `options` or `modifiers`, results are limited to 10 per page., include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned.}\n@returns(200) {data: any, meta: map}\n@returns(201) Created\n@returns(207) {data: any, errors: map{status: int, title: str, type: str, errors: map}, meta: map{pagination: map{total: int, count: int, per_page: int, current_page: int, total_pages: int, links: map{previous: str, current: str, next: str}}}} # Multi-status. Typically indicates that a partial failure has occurred, such as when a POST or PUT request is successful, but saving one of the attributes has failed.  For example, the product information was updated successfully, but the inventory data failed to update or saving the URL failed.   If inventory data failed to update, verify that the inventory-related updates are well-formed and correct; for example, that they donʼt result in negative stock levels. Then consider updating the inventory data again.  If the URL failed to update, check that the URL uses Latin letters, is no more than 255 characters, and is not taken by any other entity.\n@errors {404: The resource was not found., 409: `Product` was in conflict with another product. This is caused by: duplicate unique values, such as name or SKU; a missing category, brand, or tax_class with which the product is being associated; or a conflicting bulk pricing rule., 422: `Product` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.}\n\n@endpoint DELETE /catalog/products/{product_id}\n@desc Delete a Product\n@returns(204)\n\n@endpoint GET /catalog/products/{product_id}/images\n@desc Get All Product Images\n@optional {page: int # Specifies the page number in a limited (paginated) list of products., limit: int=50 # Controls the number of items per page in a limited (paginated) list of products., include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.}\n@returns(200) {data: [any], meta: map{pagination: map{total: int, count: int, per_page: int, current_page: int, total_pages: int, links: map{previous: str, current: str, next: str}}}}\n@returns(204) There are not any images on this product.\n@errors {404: The product ID does not exist.}\n\n@endpoint POST /catalog/products/{product_id}/images\n@desc Create a Product Image\n@returns(200) {data: any, meta: map} # Success\n@errors {400: Bad Request. The requested resource could not be downloaded and may be invalid. Possible reasons include malformed request syntax or the file host blocking requests., 404: The product ID does not exist., 422: Unprocessable Entity.   May occur if the `Content-Type` header is set to `multipart/form-data` rather than `application/json` when creating a product image using `image_url`.}\n\n@endpoint GET /catalog/products/{product_id}/images/{image_id}\n@desc Get a Product Image\n@optional {include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.}\n@returns(200) {data: any, meta: map}\n@errors {404: The resource was not found.}\n\n@endpoint PUT /catalog/products/{product_id}/images/{image_id}\n@desc Update a Product Image\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.}\n@returns(200) {data: any, meta: map} # Success\n@returns(201) Created\n@errors {400: Bad Request. The requested resource could not be downloaded and may be invalid. Possible reasons include malformed request syntax or the file host blocking requests., 404: The resource was not found., 422: Product image was not valid. This is the result of missing required fields or invalid data. See the response for more details.}\n\n@endpoint DELETE /catalog/products/{product_id}/images/{image_id}\n@desc Delete a Product Image\n@returns(204)\n\n@endpoint GET /catalog/products/{product_id}/videos\n@desc Get All Product Videos\n@optional {include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded., page: int # Specifies the page number in a limited (paginated) list of products., limit: int=50 # Controls the number of items per page in a limited (paginated) list of products.}\n@returns(200) {data: [any], meta: map{pagination: map{total: int, count: int, per_page: int, current_page: int, total_pages: int, links: map{previous: str, current: str, next: str}}}}\n\n@endpoint POST /catalog/products/{product_id}/videos\n@desc Create a Product Video\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.}\n@returns(200) {data: any, meta: map}\n@errors {404: The resource was not found.}\n\n@endpoint GET /catalog/products/{product_id}/videos/{id}\n@desc Get a Product Video\n@optional {include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.}\n@returns(200) {data: any, meta: map}\n@errors {404: The resource was not found.}\n\n@endpoint PUT /catalog/products/{product_id}/videos/{id}\n@desc Update a Product Video\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.}\n@returns(200) {data: any, meta: map}\n@errors {404: The resource was not found.}\n\n@endpoint DELETE /catalog/products/{product_id}/videos/{id}\n@desc Delete a Product Video\n@returns(204)\n\n@endpoint GET /catalog/products/{product_id}/complex-rules\n@desc Get Complex Rules\n@optional {include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded., page: int # Specifies the page number in a limited (paginated) list of products., limit: int=50 # Controls the number of items per page in a limited (paginated) list of products.}\n@returns(200) {data: [map], meta: map{pagination: map{total: int, count: int, per_page: int, current_page: int, total_pages: int, links: map{previous: str, current: str, next: str}}}}\n\n@endpoint POST /catalog/products/{product_id}/complex-rules\n@desc Create a Complex Rule\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.}\n@optional {sort_order: int # The priority to give this rule when making adjustments to the product properties., enabled: bool # Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty., stop: bool # Flag for determining whether other rules should not be applied after this rule has been applied., purchasing_disabled: bool # Flag for determining whether the rule should disable purchasing of a product when the conditions are applied., purchasing_disabled_message: str # Message displayed on the storefront when a rule disables the purchasing of a product., purchasing_hidden: bool # Flag for determining whether the rule should hide purchasing of a product when the conditions are applied., image_url: str # The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file., price_adjuster: map{adjuster: str, adjuster_value: num} # Adjuster for Complex Rules., weight_adjuster: map{adjuster: str, adjuster_value: num} # Adjuster for Complex Rules., conditions: [any]}\n@returns(200) {data: map{id: int, product_id: int?, sort_order: int, enabled: bool, stop: bool, purchasing_disabled: bool, purchasing_disabled_message: str, purchasing_hidden: bool, image_url: str, price_adjuster: map{adjuster: str?, adjuster_value: num}, weight_adjuster: map{adjuster: str?, adjuster_value: num}, conditions: [map]}, meta: map}\n@errors {409: The `ComplexRule` was in conflict with another `ComplexRule`. This is the result of duplicate conditions., 422: The `ComplexRule` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.}\n\n@endpoint GET /catalog/products/{product_id}/complex-rules/{complex_rule_id}\n@desc Get a Product Complex Rule\n@optional {include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.}\n@returns(200) {data: map{id: int, product_id: int, sort_order: int, enabled: bool, stop: bool, purchasing_disabled: bool, purchasing_disabled_message: str, purchasing_hidden: bool, image_url: str, price_adjuster: map{adjuster: str, adjuster_value: num}, weight_adjuster: map{adjuster: str, adjuster_value: num}, conditions: [map]}, meta: map}\n@errors {404: The resource was not found.}\n\n@endpoint PUT /catalog/products/{product_id}/complex-rules/{complex_rule_id}\n@desc Update a Product Complex Rule\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.}\n@optional {sort_order: int # The priority to give this rule when making adjustments to the product properties., enabled: bool # Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty., stop: bool # Flag for determining whether other rules should not be applied after this rule has been applied., purchasing_disabled: bool # Flag for determining whether the rule should disable purchasing of a product when the conditions are applied., purchasing_disabled_message: str # Message displayed on the storefront when a rule disables the purchasing of a product., purchasing_hidden: bool # Flag for determining whether the rule should hide purchasing of a product when the conditions are applied., image_url: str # The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file., price_adjuster: map{adjuster: str, adjuster_value: num} # Adjuster for Complex Rules., weight_adjuster: map{adjuster: str, adjuster_value: num} # Adjuster for Complex Rules., conditions: [map{modifier_id!: int, modifier_value_id!: int, variant_id!: int}]}\n@returns(200) {data: map{id: int, product_id: int, sort_order: int, enabled: bool, stop: bool, purchasing_disabled: bool, purchasing_disabled_message: str, purchasing_hidden: bool, image_url: str, price_adjuster: map{adjuster: str, adjuster_value: num}, weight_adjuster: map{adjuster: str, adjuster_value: num}, conditions: [map]}, meta: map}\n@errors {409: The `ComplexRule` was in conflict with another `ComplexRule`. This is the result of duplicate conditions., 422: The `ComplexRule` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.}\n\n@endpoint DELETE /catalog/products/{product_id}/complex-rules/{complex_rule_id}\n@desc Delete a Product Complex Rule\n@returns(204)\n\n@endpoint GET /catalog/products/{product_id}/custom-fields\n@desc Get Product Custom Fields\n@optional {include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded., page: int # Specifies the page number in a limited (paginated) list of products., limit: int=50 # Controls the number of items per page in a limited (paginated) list of products.}\n@returns(200) {data: [map], meta: map{pagination: map{total: int, count: int, per_page: int, current_page: int, total_pages: int, links: map{previous: str, current: str, next: str}}}} # Gets array of Custom fields.\n@errors {401: 401 Unauthorized, 403: General Error, 404: General Error., 405: 405 Method Not Allowed}\n\n@endpoint POST /catalog/products/{product_id}/custom-fields\n@desc Create a Product Custom Field\n@required {name: str # The name of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests., value: str # The value of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests.}\n@returns(200) {data: map{id: int, name: str, value: str}, meta: map} # Gets Custom field.\n@errors {401: 401 Unauthorized, 403: General Error, 404: General Error., 405: 405 Method Not Allowed, 415: 415 Unsupported Media Type, 422: General Error.}\n\n@endpoint GET /catalog/products/{product_id}/custom-fields/{custom_field_id}\n@desc Get a Product Custom Field\n@optional {include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.}\n@returns(200) {data: map{id: int, name: str, value: str}, meta: map} # Gets Custom field.\n@errors {401: 401 Unauthorized, 403: General Error, 404: General Error., 405: 405 Method Not Allowed}\n\n@endpoint PUT /catalog/products/{product_id}/custom-fields/{custom_field_id}\n@desc Update a Product Custom Field\n@optional {name: str # The value of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests., value: str # The value of the field, shown on the storefront, orders, etc. This field is a requirement for /POST requests.}\n@returns(200) {data: map{id: int, name: str, value: str}, meta: map} # Gets Custom field.\n@errors {401: 401 Unauthorized, 403: General Error, 404: General Error., 405: 405 Method Not Allowed, 415: 415 Unsupported Media Type, 422: General Error.}\n\n@endpoint DELETE /catalog/products/{product_id}/custom-fields/{custom_field_id}\n@desc Delete a Product Custom Field\n@returns(204) 204 No Content\n@errors {401: 401 Unauthorized, 403: General Error, 404: General Error., 405: 405 Method Not Allowed}\n\n@endpoint POST /catalog/products/{product_id}/bulk-pricing-rules\n@desc Create a Bulk Pricing Rule\n@required {quantity_min: int # The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero. Required in /POST., quantity_max: int # 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. Required in /POST., type: str(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. Required in /POST., amount: any # You can express the adjustment type as either a fixed dollar amount or a percentage. Send a number; the response will return a number for `price` and `fixed` adjustments. Divide the adjustment percentage by 100 and send the result in string format. For example, represent 10% as “.10”. The response will return a float value for both `price` and `percentage` adjustments.  Required in /POST.}\n@returns(200) {data: any, meta: map}\n\n@endpoint GET /catalog/products/{product_id}/bulk-pricing-rules\n@desc Get all Bulk Pricing Rules\n@optional {include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.}\n@returns(200) {data: any, meta: map{pagination: map{total: int, count: int, per_page: int, current_page: int, total_pages: int, links: map{previous: str, current: str, next: str}}}}\n\n@endpoint GET /catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}\n@desc Get a Bulk Pricing Rule\n@optional {include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.}\n@returns(200) {data: any, meta: map}\n@errors {404: The resource or parent resource was not found.}\n\n@endpoint PUT /catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}\n@desc Update a Bulk Pricing Rule\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.}\n@returns(200) {data: any, meta: map}\n@errors {404: The resource or parent resource was not found., 409: The `BulkPricingRule` was in conflict with another bulk pricing rule. This is the result of quantity range overlapping with existing bulk pricing rules., 422: The `BulkPricingRule` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.}\n\n@endpoint DELETE /catalog/products/{product_id}/bulk-pricing-rules/{bulk_pricing_rule_id}\n@desc Delete a Bulk Pricing Rule\n@returns(204)\n@errors {404: The resource or parent resource was not found.}\n\n@endpoint GET /catalog/products/{product_id}/metafields\n@desc Get Product Metafields\n@optional {page: int # Specifies the page number in a limited (paginated) list of products., limit: int=50 # Controls the number of items per page in a limited (paginated) list of products., key: str # Filter based on a metafieldʼs key., namespace: str # Filter based on a metafieldʼs namespaces., include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded., resource_id:in: str # A comma-separated list of entity ID values that filter results to metafields that belong to one of the matching entities.}\n@returns(200) {data: [any], meta: map{pagination: map{total: int, count: int, per_page: int, current_page: int, total_pages: int, links: map{previous: str, current: str, next: str}}}}\n\n@endpoint POST /catalog/products/{product_id}/metafields\n@desc Create a Product Metafield\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body., key: str # The name of the field, for example: `location_id`, `color`. Required for POST., value: str # The value of the field, for example: `1`, `blue`. You must enter a JSON formatted string for [ShipperHQ](/docs/store-operations/shipping/shipper-hq#shipperhq-object-properties) metafields. Required for POST., namespace: str # Namespace for the metafield, for organizational purposes. This is set by the developer. Required for POST., permission_set: str(app_only/read/write/read_and_sf_access/write_and_sf_access) # Determines the visibility and writeability of the field by other API consumers.  |Value|Description |-|-| |`app_only`|Private to the app that owns the field| |`read`|Visible to other API consumers| |`write`|Open for reading and writing by other API consumers| |`read_and_sf_access`|Visible to other API consumers, including on storefront| |`write_and_sf_access`|Open for reading and writing by other API consumers, including on storefront|}\n@optional {description: str # Description for the metafields.}\n@returns(200) {data: any, meta: map}\n@errors {400: Bad Request. Input is invalid., 409: The `Metafield` was in conflict with another `Metafield`. This can be the result of duplicate unique key combinations of the appʼs client ID, namespace, key, resource_type, and resource_id., 422: The `Metafield` was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.}\n\n@endpoint GET /catalog/products/{product_id}/metafields/{metafield_id}\n@desc Get a Product Metafield\n@optional {include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.}\n@returns(200) {data: any, meta: map}\n@errors {404: The resource was not found.}\n\n@endpoint PUT /catalog/products/{product_id}/metafields/{metafield_id}\n@desc Update a Product Metafield\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body., key: str # The name of the field, for example: `location_id`, `color`. Required for POST., value: str # The value of the field, for example: `1`, `blue`. You must enter a JSON formatted string for [ShipperHQ](/docs/store-operations/shipping/shipper-hq#shipperhq-object-properties) metafields. Required for POST., namespace: str # Namespace for the metafield, for organizational purposes. This is set by the developer. Required for POST., permission_set: str(app_only/read/write/read_and_sf_access/write_and_sf_access) # Determines the visibility and writeability of the field by other API consumers.  |Value|Description |-|-| |`app_only`|Private to the app that owns the field| |`read`|Visible to other API consumers| |`write`|Open for reading and writing by other API consumers| |`read_and_sf_access`|Visible to other API consumers, including on storefront| |`write_and_sf_access`|Open for reading and writing by other API consumers, including on storefront|}\n@optional {description: str # Description for the metafields.}\n@returns(200) {data: any, meta: map}\n@errors {400: Bad Request. Input is invalid., 404: The resource was not found.}\n\n@endpoint DELETE /catalog/products/{product_id}/metafields/{metafield_id}\n@desc Delete a Product Metafield\n@returns(204)\n@errors {404: The resource was not found.}\n\n@endpoint GET /catalog/products/{product_id}/reviews\n@desc Get Product Reviews\n@optional {include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded., page: int # Specifies the page number in a limited (paginated) list of products., limit: int=50 # Controls the number of items per page in a limited (paginated) list of products., status: int(0/1) # Filter items by status. `1` for approved, `0` for pending.}\n@returns(200) {data: [any], meta: map{pagination: map{total: int, count: int, per_page: int, current_page: int, total_pages: int, links: map{previous: str, current: str, next: str}}}}\n@returns(204) There are no reviews on this product.\n@errors {404: The product ID does not exist.}\n\n@endpoint POST /catalog/products/{product_id}/reviews\n@desc Create a Product Review\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.}\n@returns(200) {data: any, meta: map}\n@errors {404: The product ID does not exist.}\n\n@endpoint GET /catalog/products/{product_id}/reviews/{review_id}\n@desc Get a Product Review\n@optional {include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., exclude_fields: [str] # Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.}\n@returns(200) {data: any, meta: map}\n@errors {404: The resource was not found.}\n\n@endpoint PUT /catalog/products/{product_id}/reviews/{review_id}\n@desc Update a Product Review\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.}\n@returns(200) {data: any, meta: map}\n@errors {404: The resource was not found.}\n\n@endpoint DELETE /catalog/products/{product_id}/reviews/{review_id}\n@desc Delete a Product Review\n@returns(204)\n\n@endpoint GET /catalog/products/channel-assignments\n@desc Get Products Channel Assignments\n@optional {page: int # Specifies the page number in a limited (paginated) list of products., limit: int=50 # Controls the number of items per page in a limited (paginated) list of products., product_id:in: [int] # Pass a comma-separated list to filter by one or more product IDs., channel_id:in: [int] # Pass a comma-separated list to filter by one or more channel IDs.}\n@returns(200) {data: [map], meta: map{pagination: map{total: int, count: int, per_page: int, current_page: int, total_pages: int, links: map{previous: str, current: str, next: str}}}} # Collection of channel assignments.\n\n@endpoint PUT /catalog/products/channel-assignments\n@desc Create Products Channel Assignments\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.}\n@returns(204) Updated\n@errors {422: Error response for batch PUT of Channel Assignments. Includes the errors for each reference id.}\n\n@endpoint DELETE /catalog/products/channel-assignments\n@desc Delete Products Channel Assignments\n@optional {product_id:in: [int] # Pass a comma-separated list to filter by one or more product IDs., channel_id:in: [int] # Pass a comma-separated list to filter by one or more channel IDs.}\n@returns(204) Deleted\n@errors {422: At least one filter must be provided in order to delete channel assignments}\n\n@endpoint GET /catalog/products/category-assignments\n@desc Get Products Category Assignments\n@optional {page: int # Specifies the page number in a limited (paginated) list of products., limit: int=50 # Controls the number of items per page in a limited (paginated) list of products., product_id:in: [int] # Pass a comma-separated list to filter by one or more product IDs., category_id:in: [int] # Pass a comma-separated list to filter by one or more category IDs.}\n@returns(200) {data: [map], meta: map{pagination: map{total: int, count: int, per_page: int, current_page: int, total_pages: int, links: map{previous: str, current: str, next: str}}}} # Collection of category assignments.\n\n@endpoint PUT /catalog/products/category-assignments\n@desc Create Products Category Assignments\n@required {Content-Type: str=application/json # The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.}\n@returns(204) Updated\n@errors {422: Error response for batch PUT of Category Assignments. Includes the errors for each reference id.}\n\n@endpoint DELETE /catalog/products/category-assignments\n@desc Delete Products Category Assignments\n@optional {product_id:in: [int] # Pass a comma-separated list to filter by one or more product IDs., category_id:in: [int] # Pass a comma-separated list to filter by one or more category IDs.}\n@returns(204) Deleted\n@errors {422: At least one filter must be provided in order to delete category assignments}\n\n@endpoint GET /catalog/summary\n@desc Get a Catalog Summary\n@returns(200) {data: map{inventory_count: int, inventory_value: num(double), primary_category_id: int, primary_category_name: str, variant_count: int, highest_variant_price: num(double), average_variant_price: num(double), lowest_variant_price: str, oldest_variant_date: str, newest_variant_date: str}, meta: map}\n\n@endpoint GET /catalog/products/metafields\n@desc Get All Product Metafields\n@optional {page: int # Specifies the page number in a limited (paginated) list of products., limit: int=50 # Controls the number of items per page in a limited (paginated) list of products., key: str # Filter based on a metafieldʼs key., key:in: [str] # Filter based on comma-separated metafieldʼs keys. Could be used with vanilla `key` query parameter., namespace: str # Filter based on a metafieldʼs namespaces., namespace:in: [str] # Filter based on comma-separated metafieldʼs namespaces. Could be used with vanilla `namespace` query parameter., direction: str(asc/desc) # Sort direction. Acceptable values are: `asc`, `desc`., include_fields: [str] # Fields to include, in a comma-separated list. The ID and the specified fields will be returned., date_modified:min: str # 'Query parameter that lets you filter by the minimum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified after this date.', date_modified:max: str # 'Query parameter that lets you filter by the maximum date modified created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields modified before this date.', date_created:min: str # 'Query parameter that lets you filter by the minimum date created, ffor example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created after this date.', date_created:max: str # 'Query parameter that lets you filter by the maximum date created, for example, `2024-05-14T09:34:00` or `2024-05-14`. Returns metafields created before this date.', before: str # A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter., after: str # A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter.}\n@returns(200) {data: [map], meta: map{pagination: map{total: int, count: int, per_page: int, current_page: int, total_pages: int, links: map{previous: str, current: str, next: str}}, cursor_pagination: map{count: int, per_page: int, start_cursor: str, end_cursor: str, links: map{previous: str, current: str, next: str}}}} # List of `Metafield` objects.\n\n@endpoint POST /catalog/products/metafields\n@desc Create multiple Metafields\n@returns(200) {data: [map], errors: [any], meta: map{total: int, success: int, failed: int}} # List of created `Metafield` objects.\n@errors {400: Bad Request. Input is invalid., 422: Response object for metafields creation with partial success.}\n\n@endpoint PUT /catalog/products/metafields\n@desc Update multiple Metafields\n@returns(200) {data: [map], errors: [any], meta: map{total: int, success: int, failed: int}} # List of updated `Metafield` objects.\n@errors {400: Bad Request. Input is invalid., 422: Response object for metafields creation with partial success.}\n\n@endpoint DELETE /catalog/products/metafields\n@desc Delete Multiple Metafields\n@returns(200) {data: [int], errors: [any], meta: map{total: int, success: int, failed: int}} # Response object for metafields deletion with success.\n@errors {400: Bad Request. Input is invalid., 422: Response object for metafields deletion with partial success.}\n\n@end\n"}}