ProductSearchParams_2020_12
Properties
collection_ids?
collection_ids?: (
string
|number
)[]
Query by collection id, these are ReCharge collection_id’s.
exclude_prepaids?
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?
external_product_ids?: (
string
|number
)[]
Query by product id, these are external product id’s.
format_type?
format_type?:
"vendor"
|"recharge"
Specifies the product format of the response.
format_version
format_version:
"2020-12"
Required. Product search version.
include_deleted?
include_deleted?:
boolean
Whether to include deleted results, default false
limit?
limit?:
number
default is 50, max is 250
not_collection_ids?
not_collection_ids?: (
string
|number
)[]
Ignore given collection ids
not_product_ids?
not_product_ids?: (
string
|number
)[]
Ignore given product ids
page?
page?:
number
Specifies the page of results to return for a query. Defaults to 1.
product_ids?
product_ids?: (
string
|number
)[]
Query by product id, these are ReCharge product_id’s.
product_types?
product_types?:
PlanType
[]
Return all products that have a matching type
published_status?
published_status?:
PublishStatus
External platform published status.
sort_by?
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?
source?:
ProductSource
Query by source
title?
title?:
string
string representing at least 3 characters of the product title being queried. Should perform a like search ('%{querytext}%')
variant_ids?
variant_ids?: (
string
|number
)[]
Query by variant id, these are external variant ids
variant_published_status?
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.
Generated using typedoc-plugin-markdown and TypeDoc