ProductSearchParams_2022_06
Extends
ListParams
<SortBy
>
Properties
channel_settings_display?
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.
collection_ids?
collection_ids?: (
string
|number
)[]
Return products that are present in any of the passed in collection IDs.
collection_ids_not?
collection_ids_not?: (
string
|number
)[]
Ignore given collection ids
created_at?
created_at?:
string
Query on created_at.
created_at_gt?
created_at_gt?:
string
Query on created_at. '>'
created_at_gte?
created_at_gte?:
string
Query on created_at. '>='
created_at_lt?
created_at_lt?:
string
Query on created_at. '<'
created_at_lte?
created_at_lte?:
string
Query on created_at. '<='
cursor?
cursor?:
string
next or previous cursor returned by previous list call
Inherited from
description?
description?:
string
Perform substring match on the product description.
discounted_price?
discounted_price?:
number
Filter on the variants[].prices.plans[].discounted_price.
discounted_price_gt?
discounted_price_gt?:
number
Filter on the variants[].prices.plans[].discounted_price. '>'
discounted_price_gte?
discounted_price_gte?:
number
Filter on the variants[].prices.plans[].discounted_price. '>='
discounted_price_lt?
discounted_price_lt?:
number
Filter on the variants[].prices.plans[].discounted_price. '<'
discounted_price_lte?
discounted_price_lte?:
number
Filter on the variants[].prices.plans[].discounted_price. '<='
exclude_hidden?
exclude_hidden?:
boolean
Exclude hidden results
external_product_ids?
external_product_ids?: (
string
|number
)[]
List of external_product_ids.
external_variant_ids?
external_variant_ids?: (
string
|number
)[]
List of external_variant_ids.
format_version
format_version:
"2022-06"
Required. Product search version.
has_plans?
has_plans?:
boolean
If true, return only products that have at least one non-deleted plan in Recharge
id?
id?:
string
|number
Accepts either an external_product_id or an external_variant_id. Must perform exact match.
in_stock?
in_stock?:
boolean
If true, return products where at least one variant’s inventory.level > 0 OR inventory.policy=continue.
include_deleted?
include_deleted?:
boolean
Whether to include deleted results, default false
inventory_level?
inventory_level?:
number
Query on the variants[].inventory.level.
inventory_level_gt?
inventory_level_gt?:
number
Query on the variants[].inventory.level. '>'
inventory_level_gte?
inventory_level_gte?:
number
Query on the variants[].inventory.level. '>='
inventory_level_lt?
inventory_level_lt?:
number
Query on the variants[].inventory.level. '<'
inventory_level_lte?
inventory_level_lte?:
number
Query on the variants[].inventory.level. '<='
limit?
limit?:
number
default is 50, max is 250
Inherited from
minimum_variant_price?
minimum_variant_price?:
number
Filter on the minimum_variant_price.
minimum_variant_price_gt?
minimum_variant_price_gt?:
number
Filter on the minimum_variant_price. '>'
minimum_variant_price_gte?
minimum_variant_price_gte?:
number
Filter on the minimum_variant_price. '>='
minimum_variant_price_lt?
minimum_variant_price_lt?:
number
Filter on the minimum_variant_price. '<'
minimum_variant_price_lte?
minimum_variant_price_lte?:
number
Filter on the minimum_variant_price. '<='
plan_types?
plan_types?:
PlanType
[]
Return all products that have a matching plan.type
plan_types_exclusive?
plan_types_exclusive?:
PlanType
[]
Exclude given plan types
product_published_status?
product_published_status?:
PublishStatus
Perform search on published status
product_title?
product_title?:
string
Perform substring match on the product title
search_term?
search_term?:
string
Accept up to 256 characters. Should search on the following fields: title, description, tags, variants[].sku, variants[].title.
sku?
sku?:
string
Perform substring match on variants[].sku
sort_by?
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
tags?
tags?:
string
[]
Perform substring match on tags
unit_price?
unit_price?:
number
Filter on the variants[].prices.unit_price.
unit_price_gt?
unit_price_gt?:
number
Filter on the variants[].prices.unit_price. '>'
unit_price_gte?
unit_price_gte?:
number
Filter on the variants[].prices.unit_price. '>='
unit_price_lt?
unit_price_lt?:
number
Filter on the variants[].prices.unit_price. '<'
unit_price_lte?
unit_price_lte?:
number
Filter on the variants[].prices.unit_price. '<='
updated_at?
updated_at?:
string
Query on updated_at.
updated_at_gt?
updated_at_gt?:
string
Query on updated_at. '>'
updated_at_gte?
updated_at_gte?:
string
Query on updated_at. '>='
updated_at_lt?
updated_at_lt?:
string
Query on updated_at. '<'
updated_at_lte?
updated_at_lte?:
string
Query on updated_at. '<='
variant_published_status?
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?
variant_title?:
string
Perform substring match on the variants[].title
Generated using typedoc-plugin-markdown and TypeDoc