{
  "opencollection": "1.0.0",
  "info": {
    "name": "BigCommerce Abandoned Cart Emails Product Variants API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Auth-Token",
      "value": "{{X-Auth-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Product Variants",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "BigCommerce Get All Product Variants",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/variants",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "product_id",
                "value": "",
                "type": "path",
                "description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Specifies the page number in a limited (paginated) list of products."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Controls the number of items per page in a limited (paginated) list of products."
              },
              {
                "name": "include_fields",
                "value": "",
                "type": "query",
                "description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
              },
              {
                "name": "exclude_fields",
                "value": "",
                "type": "query",
                "description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
              }
            ]
          },
          "docs": "Returns a list of product *Variants*. Optional parameters can be passed in."
        },
        {
          "info": {
            "name": "BigCommerce Create a Product Variant",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/variants",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "product_id",
                "value": "",
                "type": "path",
                "description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a *Product Variant*.\n\n**Required Fields**\n* sku\n* option_values\n\n**Read-Only Fields**\n* id\n\n**Limits**\n* 600 SKUs per product limit.\n* 255 characters SKU length limit.\n\nVariants need to be created one at a time using this endpoint. To use a variant array, create products, and variants in the same call use the [Create Products](/docs/rest-catalog/products#create-a-product) endpoint during the initial product creation."
        },
        {
          "info": {
            "name": "BigCommerce Get a Product Variant",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/variants/:variant_id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "product_id",
                "value": "",
                "type": "path",
                "description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
              },
              {
                "name": "variant_id",
                "value": "",
                "type": "path",
                "description": "ID of the variant on a product, or on an associated Price List Record.\n"
              },
              {
                "name": "include_fields",
                "value": "",
                "type": "query",
                "description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned."
              },
              {
                "name": "exclude_fields",
                "value": "",
                "type": "query",
                "description": "Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded."
              }
            ]
          },
          "docs": "Returns a single product *Variant*. Optional parameters can be passed in."
        },
        {
          "info": {
            "name": "BigCommerce Update a Product Variant",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/variants/:variant_id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "product_id",
                "value": "",
                "type": "path",
                "description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
              },
              {
                "name": "variant_id",
                "value": "",
                "type": "path",
                "description": "ID of the variant on a product, or on an associated Price List Record.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a product *Variant*."
        },
        {
          "info": {
            "name": "BigCommerce Delete a Product Variant",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id/variants/:variant_id",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "product_id",
                "value": "",
                "type": "path",
                "description": "The ID of the `Product` to which the resource belongs. Product variant metafield endpoints that have the `product_id` in the request path are successful as long as the parameter is not empty. The `product_id` segment is there only for path consistency.\n"
              },
              {
                "name": "variant_id",
                "value": "",
                "type": "path",
                "description": "ID of the variant on a product, or on an associated Price List Record.\n"
              }
            ]
          },
          "docs": "Deletes a product *Variant*."
        }
      ]
    }
  ],
  "bundled": true
}