{ "opencollection": "1.0.0", "info": { "name": "BigCommerce Abandoned Cart Emails Products API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Products", "type": "folder" }, "items": [ { "info": { "name": "BigCommerce Get All Products", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Filter items by ID.\n" }, { "name": "id:in", "value": "", "type": "query" }, { "name": "id:not_in", "value": "", "type": "query" }, { "name": "id:min", "value": "", "type": "query" }, { "name": "id:max", "value": "", "type": "query" }, { "name": "id:greater", "value": "", "type": "query" }, { "name": "id:less", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query", "description": "Filter items by name.\n" }, { "name": "mpn", "value": "", "type": "query", "description": "Filter items by Manufacturer Part Number (MPN).\n" }, { "name": "upc", "value": "", "type": "query", "description": "Filter items by UPC.\n" }, { "name": "price", "value": "", "type": "query", "description": "Filter items by price.\n" }, { "name": "weight", "value": "", "type": "query", "description": "Filter items by weight.\n" }, { "name": "condition", "value": "", "type": "query", "description": "Filter items by condition.\n" }, { "name": "brand_id", "value": "", "type": "query", "description": "Filter items by brand_id.\n" }, { "name": "date_modified", "value": "", "type": "query", "description": "Filter items by `date_modified`. " }, { "name": "date_modified:max", "value": "", "type": "query", "description": "Filter items by `date_modified`. For example, `date_modified:max=2020-06-15`." }, { "name": "date_modified:min", "value": "", "type": "query", "description": "Filter items by `date_modified`. For example, `date_modified:min=2018-06-15`." }, { "name": "date_last_imported", "value": "", "type": "query", "description": "Filter items by date_last_imported." }, { "name": "date_last_imported:not", "value": "", "type": "query", "description": "Filter items by date_last_imported. For example, `date_last_imported:not=2015-08-21T22%3A53%3A23%2B00%3A00`." }, { "name": "date_last_imported:max", "value": "", "type": "query", "description": "Filter items by date_last_imported. For example, `date_last_imported:max=2015-08-21T22%3A53%3A23%2B00%3A00`." }, { "name": "date_last_imported:min", "value": "", "type": "query", "description": "Filter items by date_last_imported. For example, `date_last_imported:min=2015-08-21T22%3A53%3A23%2B00%3A00`." }, { "name": "is_visible", "value": "", "type": "query", "description": "Filter items based on whether the product is currently visible on the storefront." }, { "name": "is_featured", "value": "", "type": "query", "description": "Filter items by is_featured. `1` for true, `0` for false." }, { "name": "is_free_shipping", "value": "", "type": "query", "description": "Filter items by is_free_shipping. `1` for true, `0` for false." }, { "name": "inventory_level", "value": "", "type": "query", "description": "Filter items by inventory_level.\n" }, { "name": "inventory_level:in", "value": "", "type": "query" }, { "name": "inventory_level:not_in", "value": "", "type": "query" }, { "name": "inventory_level:min", "value": "", "type": "query" }, { "name": "inventory_level:max", "value": "", "type": "query" }, { "name": "inventory_level:greater", "value": "", "type": "query" }, { "name": "inventory_level:less", "value": "", "type": "query" }, { "name": "inventory_low", "value": "", "type": "query", "description": "Filter items by inventory_low. Values: 1, 0.\n" }, { "name": "out_of_stock", "value": "", "type": "query", "description": "Filter items by out_of_stock. To enable the filter, pass `out_of_stock`=`1`.\n" }, { "name": "total_sold", "value": "", "type": "query", "description": "Filter items by total_sold.\n" }, { "name": "type", "value": "", "type": "query", "description": "Filter items by type." }, { "name": "categories", "value": "", "type": "query", "description": "Filter items by categories.\n If a product is in more than one category, using this query will not return the product. Instead use `categories:in=12`." }, { "name": "keyword", "value": "", "type": "query", "description": "Filter items by keywords found in the `name` or `sku` fields" }, { "name": "keyword_context", "value": "", "type": "query", "description": "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." }, { "name": "status", "value": "", "type": "query", "description": "Filter items by status.\n" }, { "name": "include", "value": "", "type": "query", "description": "Sub-resources to include on a product, in a comma-separated list. If `options` or `modifiers` is used, results are limited to 10 per page.\n\n**Note:** The following sub-resources include:\n * variants\n * images\n * custom_fields\n * bulk_pricing_rules\n * primary_image\n * modifiers\n * options\n * videos" }, { "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." }, { "name": "availability", "value": "", "type": "query", "description": "Filter items by availability. Values are: available, disabled, preorder.\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. The default product limit is 50 with a maximum limit of 250." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction. Acceptable values are: `asc`, `desc`.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Field name to sort by. Note: Since `id` increments when new products are added, you can use that field to sort by product create date.\n" }, { "name": "categories:in", "value": "", "type": "query", "description": "Filter items by categories. Use for products in multiple categories. For example, `categories:in=12,15`." }, { "name": "sku", "value": "", "type": "query", "description": "Filter items by main SKU. To filter by variant SKU, see [Get All Variants](/docs/rest-catalog/product-variants#get-all-product-variants). " }, { "name": "sku:in", "value": "", "type": "query", "description": "Filter items by SKU." } ] }, "docs": "Returns a list of **Products**. Optional filter parameters can be passed in." }, { "info": { "name": "BigCommerce Create a Product", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "include_fields", "value": "", "type": "query", "description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a *Product*. Only one product can be created at a time; however, you can create multiple product variants using the `variants` array.\n\n**Required Fields:**\n- `name`\n- `type`\n- `weight`\n- `price`\n\n**Read-Only Fields**\n- `id`\n- `date_created`\n- `date_modified`\n- `calculated_price`\n- `base_variant_id`\n\n**Limits**\n- 250 characters product name length.\n- A product can have up to 1000 images. Each image file or image uploaded by URL can be up to 8 MB.\n\n**Usage Notes**\n* You can create multiple" }, { "info": { "name": "BigCommerce Update Products (Batch)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "include_fields", "value": "", "type": "query", "description": "Fields to include, in a comma-separated list. The ID and the specified fields will be returned." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates products in batches. Batches are limited to 10 products.\n\n**Required Fields**\n* `id` - product `id` is required for batch updates to products.\n\n**Read-Only Fields**\n- `id`\n- `date_created`\n- `date_modified`\n- `calculated_price`\n- `base_variant_id`" }, { "info": { "name": "BigCommerce Delete Products", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter items by name.\n" }, { "name": "sku", "value": "", "type": "query", "description": "Filter items by SKU.\n" }, { "name": "price", "value": "", "type": "query", "description": "Filter items by price.\n" }, { "name": "weight", "value": "", "type": "query", "description": "Filter items by weight.\n" }, { "name": "condition", "value": "", "type": "query", "description": "Filter items by condition.\n" }, { "name": "brand_id", "value": "", "type": "query", "description": "Filter items by brand_id.\n" }, { "name": "date_modified", "value": "", "type": "query", "description": "Filter items by date_modified. For example `v3/catalog/products?date_modified:min=2018-06-15`" }, { "name": "date_last_imported", "value": "", "type": "query", "description": "Filter items by date_last_imported. For example `v3/catalog/products?date_last_imported:min=2015-08-21T22%3A53%3A23%2B00%3A00`" }, { "name": "is_visible", "value": "", "type": "query", "description": "Filter items by if visible on the storefront. " }, { "name": "is_featured", "value": "", "type": "query", "description": "Filter items by is_featured.\n" }, { "name": "id:in", "value": "", "type": "query", "description": "Filter by product ID(s)." }, { "name": "inventory_level", "value": "", "type": "query", "description": "Filter items by inventory_level.\n" }, { "name": "total_sold", "value": "", "type": "query", "description": "Filter items by total_sold.\n" }, { "name": "type", "value": "", "type": "query", "description": "Filter items by type: `physical` or `digital`." }, { "name": "categories", "value": "", "type": "query", "description": "Filter items by categories.\n If a product is in more than one category, using this query will not return the product. Instead use `categories:in=12`." }, { "name": "keyword", "value": "", "type": "query", "description": "Filter items by keywords found in the `name`, `description`, or `sku` fields, or in the brand name.\n" } ] }, "docs": "To delete *Product* objects, you must include a filter. This prevents inadvertently deleting all *Product* objects in a store.\n\n> #### Note\n> The maximum number of products you can delete at one time is 250.\n\n**Example**:\nTo delete products with IDs 1,2 and 3, use `DELETE /v3/catalog/products?id:in=1,2,3`." }, { "info": { "name": "BigCommerce Get a Product", "type": "http" }, "http": { "method": "GET", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "product_id", "value": "", "type": "path", "description": "The ID of the `Product` to which the resource belongs.\n" }, { "name": "include", "value": "", "type": "query", "description": "Sub-resources to include on a product, in a comma-separated list. If `options` or `modifiers` is used, results are limited to 10 per page." }, { "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*. Optional parameters can be passed in." }, { "info": { "name": "BigCommerce Update a Product", "type": "http" }, "http": { "method": "PUT", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_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.\n" }, { "name": "include_fields", "value": "", "type": "query", "description": "Sub-resources to include on a product, in a comma-separated list. If `options` or `modifiers` is used, results are limited to 10 per page. The ID and the specified fields will be returned." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a *Product*.\n\n**Limits**\n- A product can have up to 1000 images. Each image file or image uploaded by URL can be up to 8 MB.\n\n**Read-Only Fields**\n- id\n- date_created\n- date_modified\n- calculated_price\n- base_variant_id\n" }, { "info": { "name": "BigCommerce Delete a Product", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/:product_id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "product_id", "value": "", "type": "path", "description": "The ID of the `Product` to which the resource belongs.\n" } ] }, "docs": "Deletes a *Product*." }, { "info": { "name": "BigCommerce Get Prices (Batch)", "type": "http" }, "http": { "method": "POST", "url": "https://api.bigcommerce.com/stores/{store_hash}/v3/pricing/products", "body": { "type": "json", "data": "{}" } }, "docs": "Calculate batch pricing for products for a specific channel, currency, and customer group.\n\n**Limits**\n* Limit of 50 concurrent requests." } ] } ], "bundled": true }