Skip to main content

Interface: ProductSearchParams_2020_12

Properties​

collection_ids?​

optional collection_ids: (string | number)[]

Query by collection id, these are ReCharge collection_id’s.

exclude_prepaids?​

optional exclude_prepaids: boolean

If true, do NOT include products where subscription_options.is_prepaid is false. If true, ignore the value in subscription_options.is_prepaid.

external_product_ids?​

optional external_product_ids: (string | number)[]

Query by product id, these are external product id’s.

format_type?​

optional format_type: "vendor" | "recharge"

Specifies the product format of the response.

format_version​

format_version: "2020-12"

Required. Product search version.

include_deleted?​

optional include_deleted: boolean

Whether to include deleted results, default false

limit?​

optional limit: number

default is 50, max is 250

not_collection_ids?​

optional not_collection_ids: (string | number)[]

Ignore given collection ids

not_product_ids?​

optional not_product_ids: (string | number)[]

Ignore given product ids

page?​

optional page: number

Specifies the page of results to return for a query. Defaults to 1.

product_ids?​

optional product_ids: (string | number)[]

Query by product id, these are ReCharge product_id’s.

product_types?​

optional product_types: PlanType[]

Return all products that have a matching type

published_status?​

optional published_status: PublishStatus

External platform published status.

sort_by?​

optional sort_by: "title" | "score"

Determines the sort order. Default is elasticsearch’s score. If sort_by = title, results will be sorted by the product title in ascending order.

source?​

optional source: ProductSource

Query by source

title?​

optional title: string

string representing at least 3 characters of the product title being queried. Should perform a like search ('%{querytext}%')

variant_ids?​

optional variant_ids: (string | number)[]

Query by variant id, these are external variant ids

variant_published_status?​

optional variant_published_status: PublishStatus

External platform published status for the variant. This really only comes into play with BigCommerce because in BC you can set purchaseability at the variant-level. If variant_published_status=published, the product-proxy's response only includes variants where variants[].is_published=true. If variant_published_status=unpublished, the product-proxy's response only includes variants where variants[].is_published=false. If variant_published_status=any, the product-proxy's response includes all variants irrespective of the value for variants[].is_published.