Pricing Templates
Log in Sign up
Integrations / BigCommerce Catalog - Products / ...

GET /catalog/products

Returns a list of Products. Optional filter parameters can be passed in.

Servers

Request headers

Name Type Required Description
Accept String Yes

The MIME type of the response body.

Default value: "application/json"

Query parameters

Name Type Required Description
categories:in[] Array No

A comma-separated list of category IDs. Returns a list of products that are in all the categories specified.
exclude_fields[] Array No

Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
date_last_imported:max String No

Filter items by date_last_imported. For example, date_last_imported:max=2015-08-21T22%3A53%3A23%2B00%3A00.
inventory_level Integer No

Filter items by inventory_level.
id Integer No

Filter items by product ID.
date_last_imported:not String No

Filter products by specifying a date they were NOT last imported. For example, date_last_imported:not=2015-08-21T22%3A53%3A23%2B00%3A00.
total_sold Integer No

Filter items by total_sold.
inventory_level:less Integer No
date_last_imported String No

Filter items by date_last_imported.
limit Integer No

Controls the number of items per page in a limited (paginated) list of products.

Default value: 50
date_last_imported:min String No

Filter items by date_last_imported. For example, date_last_imported:min=2015-08-21T22%3A53%3A23%2B00%3A00.
sku String No

Filter items by main SKU. To filter by variant SKU, see Get all variants.
inventory_level:not_in[] Array No

A comma-separated list of inventory levels. Returns a list of all products that have inventory amounts other than those specified.
is_free_shipping Integer No

Filter items by is_free_shipping. 1 for true, 0 for false.
type String No

Filter items by type.

Valid values:

  • "digital"
  • "physical"
upc String No

Filter items by UPC.
inventory_level:min Integer No
mpn String No

Filter items by Manufacturer Part Number (MPN).
id:min Integer No
sort String No

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.

Valid values:

  • "price"
  • "sku"
  • "calculated_price"
  • "id"
  • "name"
  • "is_visible"
  • "date_last_imported"
  • "total_sold"
  • "inventory_level"
  • "date_modified"
keyword String No

Filter items by keywords found in the name, description, or sku fields, or in the brand name.
include_fields[] Array No

Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
id:in[] Array No

Pass a comma-separated list to filter by one or more product IDs.
page Integer No

Specifies the page number in a limited (paginated) list of products.
id:max Integer No
name String No

Filter items by name.
brand_id Integer No

Filter items by brand ID.
condition String No

Filter items by condition.

Valid values:

  • "new"
  • "used"
  • "refurbished"
weight Number No

Filter items by weight.
availability String No

Filter items by availability. Values are: available, disabled, preorder.

Valid values:

  • "available"
  • "disabled"
  • "preorder"
sku:in[] Array No

A comma-separated list of SKUs. Returns a list of products with those SKUs.
is_featured Integer No

Filter items by is_featured. 1 for true, 0 for false.

Valid values:

  • 0
  • 1
out_of_stock Integer No

Filter items by out_of_stock. To enable the filter, pass out_of_stock=1.
date_modified:max String No

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 String No

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.
include[] Array No

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.
direction String No

Sort direction. Acceptable values are: asc, desc.

Valid values:

  • "desc"
  • "asc"
id:greater Integer No
categories Integer No

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_context String No

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.

Valid values:

  • "merchant"
  • "shopper"
price Number No

Filter items by price.
date_modified String No

Filter items by date_modified.
channel_id:in[] Array No

Pass a comma-separated list to filter by one or more channel IDs.
inventory_level:in[] Array No

A comma-separated list of inventory levels. Returns a list of all products that have any of the listed inventory amounts.
is_visible Boolean No

Filter items based on whether the product is currently visible on the storefront.
id:not_in[] Array No

Pass a comma-separated list to exclude one or more product IDs.
inventory_level:max Integer No
inventory_level:greater Integer No
id:less Integer No
inventory_low Integer No

Filter items by inventory_low. Values: 1, 0.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2026 SimWorkflow
Terms of Service Privacy Policy