Skip to main content

Search

Retrieve products from the Shopify Catalog using the /global/v2/search endpoint.

The resource returns an array of Universal Products, each representing a high-level product grouping that might contain multiple variants or offers from different shops.


Pass a search query to retrieve products from the Shopify Catalog.

This example illustrates how to retrieve information from many products using the Search resource and the /global/v2/search endpoint. Replace {query} with the buyer's search terms and {BEARER_TOKEN} with the bearer token you generated in the Authentication section.


query•StringRequired

Keywords for search. For example, Running Shoes


available_for_sale•Int (0,1)Default: 1 (only available items)

Filter by availability.

When 1, only products available for sale are included. When 0, unavailable items are only included if they are a good match for the query.


categories•String

Comma-delimited list of global IDs for taxonomy categories. Refer to the Shopify Standard Product Taxonomy and raw category list.

For example, for shoes, use: gid://shopify/TaxonomyCategory/aa-8.


include_secondhand•Int (0,1)Default: 1 (include)

Include secondhand products.

When 1, include secondhand products in the results.


limit•Integer (1-10)Default: 10

Max results to return.


max_price•Decimal

Maximum price (currency determined by ships_to). API accepts decimals.


min_price•Decimal

Minimum price (currency determined by ships_to). API accepts decimals.


products_limit•Integer (1-10)Default: 10

The maximum number of variants to return per Universal Product.


ships_from•String

An ISO 3166 country code. For example, US


ships_to•StringDefault: US

An ISO 3166 country code.


shop_ids•String

Filter by specific shops. For example, gid://shopify/Shop/1234 or 1234



Anchor to Search response schemaSearch response schema

The Search endpoint returns an array of UniversalProduct objects. Each object contains product information optimized for discovery and browsing.

Some fields are generated using machine learning and are marked with Inferred in the documentation. These fields may not always be present or may have varying accuracy depending on the available product data.

Anchor to The UniversalProduct resourceThe UniversalProduct resource

Represents a high-level product grouping that may contain multiple variants or offers from different shops.


attributes•Hash[]Inferred

Array of product attributes as name-value pairs.


description•stringInferred

Detailed product description.


id•string

Unique identifier for the universal product.

For example, gid://shopify/p/1UT1zYWaL8WeTNCllgUbsM


lookupUrl•string

URL for subsequent calls to the Lookup endpoint.


media•Media[]

Product media from the top-ranked variant. Currently returns images only.


options•ProductOption[]Inferred

Array of product options/variants.


priceRange•PriceRange

Price range from the top-ranked variant.


rating•Rating

Universal product rating information.


techSpecs•string[]Inferred

Array of technical specifications.


title•string

Product title from the top-ranked variant.


topFeatures•string[]Inferred

Array of top product features.


uniqueSellingPoint•stringInferred

The unique selling point for the product.


url•string

URL for the product with search context parameters preserved.


variants•Variant[]

Array of product variants.


Anchor to The Variant resourceThe Variant resource

Represents a specific product variant with pricing, availability, and checkout information.


availableForSale•boolean

Whether the variant is available for purchase.


checkoutUrl•string

Direct checkout URL for this variant.


displayName•string

Display name for the variant.


eligibleForNativeCheckout•boolean

Whether the variant supports native checkout. This field is not returned by default and requires opt-in from Shopify.


id•string

Unique variant identifier.


lookupUrl•string

URL for looking up this variant.


media•Media[]

Media for this variant. Currently returns images only.


options•VariantOption[]

Array of options for this variant.


price•Price

Price information for this variant.


productId•string

ID of the parent product.


rating•Rating

Rating information for this variant.


secondhand•booleanInferred

Whether the variant is secondhand.


shop•Shop

Shop offering this variant.


variantUrl•string

URL for the variant's product page.


Represents the shop offering the product. In Search responses, Shop contains only basic information.


id•string

Unique shop identifier.

For example, gid://shopify/Shop/54623456


name•string

Shop name.


onlineStoreUrl•string

Shop page URL.


permanentDomain•string

Shop's permanent domain. For example, mock-shop.myshopify.com. This field is null if the client is not opted in to receive eligibleForNativeCheckout.


Anchor to The ProductOption resourceThe ProductOption resource

Represents a product option like Size or Color.


name•string

Option name. For example, Color or Size


values•OptionValue[]

Array of possible values for this option.


Anchor to The OptionValue resourceThe OptionValue resource

Represents a product option value. In Search responses, OptionValue contains only the value.


value•string

Option value, configured by the merchant. For example, US5.5


Anchor to The PriceRange resourceThe PriceRange resource

Represents the minimum and maximum prices for a product or collection of variants.


max•Price

Maximum price in the range.


min•Price

Minimum price in the range.


Anchor to The VariantOption resourceThe VariantOption resource

Represents a selected option for a specific variant.


name•string

The name of the option (e.g., Color, Size).


value•string

The selected value for this option (e.g., Blue, Medium).


Represents product media. Currently returns images only.


altText•string

Alt text for the media.


url•string

URL of the media asset.


Represents a monetary value with currency.


amount•integer

The price amount in the smallest currency unit (e.g., cents for USD).


currency•string

The three-letter ISO 4217 currency code (e.g., USD, EUR).


Represents product or variant rating information.


count•integer

The total number of ratings.


rating•number

The average rating value.



Was this page helpful?