Skip to main content

Interface: ProductSearchParams_2022_06

Extends​

Properties​

channel_settings_display?​

optional channel_settings_display: keyof ChannelSettings[]

Return all products that have at least one non-deleted plan with a matching channel_setting{}.display set to true.

check_market_availability?​

optional check_market_availability: boolean

Filter products that do not have a market price for the passed currency or country_code

collection_ids?​

optional collection_ids: (string | number)[]

Return products that are present in any of the passed in collection IDs.

collection_ids_not?​

optional collection_ids_not: (string | number)[]

Ignore given collection ids

country_code?​

optional country_code: string

Define which country to use as a lookup for Shopify availability and rates. The presentment_currencies will only contain currencies available in the Shopify market.

created_at?​

optional created_at: string

Query on created_at.

created_at_gt?​

optional created_at_gt: string

Query on created_at. '>'

created_at_gte?​

optional created_at_gte: string

Query on created_at. '>='

created_at_lt?​

optional created_at_lt: string

Query on created_at. '<'

created_at_lte?​

optional created_at_lte: string

Query on created_at. '<='

currency?​

optional currency: string

When used without country_code the presentment_currencies property will be filtered to only show the provided currency. When used with country_code the country code will be pulled from the Shopify market configuration used for that country. If the currency doesn't exist then the store currency will be converted to the provided currency using current market rates.

cursor?​

optional cursor: string

next or previous cursor returned by previous list call

Inherited from​

ListParams.cursor

description?​

optional description: string

Perform substring match on the product description.

discounted_price?​

optional discounted_price: number

Filter on the variants[].prices.plans[].discounted_price.

discounted_price_gt?​

optional discounted_price_gt: number

Filter on the variants[].prices.plans[].discounted_price. '>'

discounted_price_gte?​

optional discounted_price_gte: number

Filter on the variants[].prices.plans[].discounted_price. '>='

discounted_price_lt?​

optional discounted_price_lt: number

Filter on the variants[].prices.plans[].discounted_price. '<'

discounted_price_lte?​

optional discounted_price_lte: number

Filter on the variants[].prices.plans[].discounted_price. '<='

exclude_hidden?​

optional exclude_hidden: boolean

Exclude hidden results

external_product_ids?​

optional external_product_ids: (string | number)[]

List of external_product_ids.

external_variant_ids?​

optional external_variant_ids: (string | number)[]

List of external_variant_ids.

format_version​

format_version: "2022-06"

Required. Product search version.

has_bundle_product?​

optional has_bundle_product: boolean

If true, return only products that have a bundle product

has_plans?​

optional has_plans: boolean

If true, return only products that have at least one non-deleted plan in Recharge

id?​

optional id: string | number

Accepts either an external_product_id or an external_variant_id. Must perform exact match.

in_stock?​

optional in_stock: boolean

If true, return products where at least one variant’s inventory.level > 0 OR inventory.policy=continue.

include_deleted?​

optional include_deleted: boolean

Whether to include deleted results, default false

inventory_level?​

optional inventory_level: number

Query on the variants[].inventory.level.

inventory_level_gt?​

optional inventory_level_gt: number

Query on the variants[].inventory.level. '>'

inventory_level_gte?​

optional inventory_level_gte: number

Query on the variants[].inventory.level. '>='

inventory_level_lt?​

optional inventory_level_lt: number

Query on the variants[].inventory.level. '<'

inventory_level_lte?​

optional inventory_level_lte: number

Query on the variants[].inventory.level. '<='

limit?​

optional limit: number

default is 50, max is 250

Inherited from​

ListParams.limit

minimum_variant_price?​

optional minimum_variant_price: number

Filter on the minimum_variant_price.

minimum_variant_price_gt?​

optional minimum_variant_price_gt: number

Filter on the minimum_variant_price. '>'

minimum_variant_price_gte?​

optional minimum_variant_price_gte: number

Filter on the minimum_variant_price. '>='

minimum_variant_price_lt?​

optional minimum_variant_price_lt: number

Filter on the minimum_variant_price. '<'

minimum_variant_price_lte?​

optional minimum_variant_price_lte: number

Filter on the minimum_variant_price. '<='

plan_types?​

optional plan_types: PlanType[]

Return all products that have a matching plan.type

plan_types_exclusive?​

optional plan_types_exclusive: PlanType[]

Exclude given plan types

product_published_status?​

optional product_published_status: PublishStatus

Perform search on published status

product_title?​

optional product_title: string

Perform substring match on the product title

search_term?​

optional search_term: string

Accept up to 256 characters. Should search on the following fields: title, description, tags, variants[].sku, variants[].title.

sku?​

optional sku: string

Perform substring match on variants[].sku

smart_select_product_id?​

optional smart_select_product_id: string

Accepts an external_product_id. The product will be used as reference for smart select.

sort_by?​

optional sort_by: "updated_at-asc" | "updated_at-desc" | "created_at-asc" | "created_at-desc" | "external_product_id-asc" | "external_product_id-desc" | "minimum_variant_price-asc" | "minimum_variant_price-desc" | "product_title-asc" | "product_title-desc" | "unit_price-asc" | "unit_price-desc" | "collection_position-asc" | "collection_position-desc" | "relevance-asc" | "relevance-desc" | "discounted_price-asc" | "discounted_price-desc" | "inventory_level-asc" | "inventory_level-desc"

sort list by option

Inherited from​

ListParams.sort_by

tags?​

optional tags: string[]

Perform substring match on tags

unit_price?​

optional unit_price: number

Filter on the variants[].prices.unit_price.

unit_price_gt?​

optional unit_price_gt: number

Filter on the variants[].prices.unit_price. '>'

unit_price_gte?​

optional unit_price_gte: number

Filter on the variants[].prices.unit_price. '>='

unit_price_lt?​

optional unit_price_lt: number

Filter on the variants[].prices.unit_price. '<'

unit_price_lte?​

optional unit_price_lte: number

Filter on the variants[].prices.unit_price. '<='

updated_at?​

optional updated_at: string

Query on updated_at.

updated_at_gt?​

optional updated_at_gt: string

Query on updated_at. '>'

updated_at_gte?​

optional updated_at_gte: string

Query on updated_at. '>='

updated_at_lt?​

optional updated_at_lt: string

Query on updated_at. '<'

updated_at_lte?​

optional updated_at_lte: string

Query on updated_at. '<='

variant_published_status?​

optional variant_published_status: "published" | "unpublished"

Return products where at least one variant’s is_published value matches the value passed in to this query param.

variant_title?​

optional variant_title: string

Perform substring match on the variants[].title