v1

latestSwagger 2.02026-07-17148179252.3 KB
Catalog

Returns a paginated collection of Products objects from the BigCommerce Catalog.

get/catalog/products

Query parameters

idinteger

Filter items by id.

namestring

Filter items by name.

skustring

Filter items by sku.

upcstring

Filter items by upc.

pricenumber

Filter items by price.

weightnumber

Filter items by weight.

conditioninteger

Filter items by condition.

brand_idinteger

Filter items by brand_id.

date_modifiedstring date-time

Filter items by date_modified.

date_last_importedstring date-time

Filter items by date_last_imported.

is_visibleinteger

Filter items by is_visible.

is_featuredinteger

Filter items by is_featured.

is_free_shippinginteger

Filter items by is_free_shipping.

inventory_levelinteger

Filter items by inventory_level.

inventory_lowinteger

Filter items by inventory_low. Values: 1, 0.

out_of_stockinteger

Filter items by out_of_stock. To enable the filter, pass out_of_stock=1.

total_soldinteger

Filter items by total_sold.

typestring

Filter items by type: physical or digital.

categoriesinteger

Filter items by categories.

keywordstring

Filter items by keywords found in the name, description, or sku fields, or in the brand name.

keyword_context'shopper' | 'merchant'

Set context for a product search.

statusinteger

Filter items by status.

include'variants' | 'images' | 'custom_fields' | 'bulk_pricing_rules' | 'primary_image'

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`.

include_fieldsstring

Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

exclude_fieldsstring

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

availability'available' | 'disabled' | 'preorder'

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

price_list_idinteger

The ID of the Price List.

pageinteger

Specifies the page number in a limited (paginated) list of products.

limitinteger

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

direction'asc' | 'desc'

Sort direction. Acceptable values are: asc, desc.

sort'id' | 'name' | 'sku' | 'price' | 'date_modified' | 'date_last_imported' | 'inventory_level' | 'is_visible' | 'total_sold'

Field name to sort by.

Response

An array of products and metadata.

All 148 operations