| default |
string |
Filter by a case-insensitive search of multiple fields in a document. |
|
|
- query=Bob Norman - query=title:green hoodie |
| barcode |
string |
Filter by the product variant barcode field. |
|
|
- barcode:ABC-abc-123 |
| collection |
string |
Filter by the ID of the collection that the product variant belongs to. |
|
|
- collection:465903092033 |
| delivery_profile_id |
id |
Filter by the product variant delivery profile ID (ProductVariant.deliveryProfile.id). |
|
|
- delivery_profile_id:108179161409 |
| exclude_composite |
boolean |
Filter by product variants that aren't composites. |
|
|
- exclude_composite:true |
| exclude_variants_with_components |
boolean |
Filter by whether there are components that are associated with the product variants in a bundle. |
|
|
- exclude_variants_with_components:true |
| gift_card |
boolean |
Filter by the product isGiftCard field. |
|
|
- gift_card:true |
| id |
id |
Filter by id range. |
|
|
- id:1234 - id:>=1234 - id:<=1234 |
| inventory_quantity |
integer |
Filter by an aggregate of inventory across all locations where the product variant is stocked. |
|
|
- inventory_quantity:10 |
| location_id |
id |
Filter by the location ID for the product variant. |
|
|
- location_id:88511152449 |
| managed |
boolean |
Filter by whether there is fulfillment service tracking associated with the product variants. |
|
|
- managed:true |
| managed_by |
string |
Filter by the fulfillment service that tracks the number of items in stock for the product variant. |
|
|
- managed_by:shopify |
| option1 |
string |
Filter by a custom property that a shop owner uses to define product variants. |
|
|
- option1:small |
| option2 |
string |
Filter by a custom property that a shop owner uses to define product variants. |
|
|
- option2:medium |
| option3 |
string |
Filter by a custom property that a shop owner uses to define product variants. |
|
|
- option3:large |
| product_id |
id |
Filter by the product id field. |
|
|
- product_id:8474977763649 |
| product_ids |
string |
Filter by a comma-separated list of product IDs. |
|
|
- product_ids:8474977763649,8474977796417 |
| product_publication_status |
string |
Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values. For simple visibility checks, use published_status instead. |
- * {channel_app_id}-approved - * {channel_app_id}-rejected - * {channel_app_id}-needs_action - * {channel_app_id}-awaiting_review - * {channel_app_id}-published - * {channel_app_id}-demoted - * {channel_app_id}-scheduled - * {channel_app_id}-provisionally_published |
|
- product_publication_status:189769876-approved |
| product_status |
string |
Filter by a comma-separated list of product statuses. |
|
|
- product_status:ACTIVE,DRAFT |
| product_type |
string |
Filter by the product type that's associated with the product variants. |
|
|
- product_type:snowboard - product_type:snowboard,skis - product_type:snowboard OR product_type:skis |
| publishable_status |
string |
Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (Channel.app.id) and one of the valid status values. |
- * {channel_app_id}-unset - * {channel_app_id}-pending - * {channel_app_id}-approved - * {channel_app_id}-not_approved |
|
- publishable_status:580111-unset - publishable_status:580111-pending |
| published_status |
string |
Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel - published - visible - unpublished - * {channel_id_or_handle}-published - * {channel_id_or_handle}-visible - * {channel_id_or_handle}-intended - * {channel_id_or_handle}-hidden - * {channel_app_id_or_handle}-published - * {channel_app_id_or_handle}-visible - * {channel_app_id_or_handle}-intended - * {channel_app_id_or_handle}-hidden - unavailable |
|
- published_status:online_store_channel - published_status:published - published_status:580111-published - published_status:580111-hidden - published_status:my-channel-handle-published - published_status:unavailable |
| requires_components |
boolean |
Filter by whether the product variant can only be purchased with components. Learn more. |
|
|
- requires_components:true |
| sku |
string |
Filter by the product variant sku field. Learn more about SKUs. |
|
|
- sku:XYZ-12345 |
| tag |
string |
Filter objects by the tag field. |
|
|
- tag:my_tag |
| tag_not |
string |
Filter by objects that donβt have the specified tag. |
|
|
- tag_not:my_tag |
| taxable |
boolean |
Filter by the product variant taxable field. |
|
|
- taxable:false |
| title |
string |
Filter by the product variant title field. |
|
|
- title:ice |
| updated_at |
time |
Filter by date and time when the product variant was updated. |
|
|
- updated_at:>2020-10-21T23:39:20Z - updated_at:<now - updated_at:<=2024 |
| vendor |
string |
Filter by the origin or source of the product variant. Learn more about vendors and managing vendor information. |
|
|
- vendor:Snowdevil - vendor:Snowdevil,Icedevil - vendor:Snowdevil OR vendor:Icedevil |
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
|
|
|
|
|