v1
latestSwagger 2.02026-07-17148179252.3 KBReturns a paginated collection of Products objects from the BigCommerce Catalog.
Query parameters
Filter items by id.
Filter items by name.
Filter items by sku.
Filter items by upc.
Filter items by price.
Filter items by weight.
Filter items by condition.
Filter items by brand_id.
Filter items by date_modified.
Filter items by date_last_imported.
Filter items by is_visible.
Filter items by is_featured.
Filter items by is_free_shipping.
Filter items by inventory_level.
Filter items by inventory_low. Values: 1, 0.
Filter items by out_of_stock. To enable the filter, pass out_of_stock=1.
Filter items by total_sold.
Filter items by type: physical or digital.
Filter items by categories.
Filter items by keywords found in the name, description, or sku fields, or in the brand name.
Set context for a product search.
Filter items by status.
Sub-resources to include on a product, in a comma-separated list. Valid expansions currently include variants, images, 'primary_image, custom_fields, and bulk_pricing_rules`.
Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
Filter items by availability. Values are: available, disabled, preorder.
The ID of the Price List.
Specifies the page number in a limited (paginated) list of products.
Controls the number of items per page in a limited (paginated) list of products.
Sort direction. Acceptable values are: asc, desc.
Field name to sort by.
Response
An array of products and metadata.