An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.
Arguments
last ● Int
Returns the last n elements in the list.
reverse ● Boolean
Whether to reverse the order of the list.
● true: reverse
● false: do not reverse
Default value: false
query ● String
Supported query parameters
namedescription
created_atSearch by product creation time, support range query.
updated_atSearch by product update time, support range query.
titlePrecise search by product title.
tagPrecise search by product tag.
available_for_saleInventory search by product dimension.
vendorPrecise search by product vendor.
product_typePrecise search by product type.
variants.pricePrice search by variant dimension, supports range query.

Search syntax reference

variants.price:<100 OR (title:'Arc logo T-shirt' AND updated_at:>'2020-10-21T23:39:20Z')
tip
Only supports up to 5 parameters and will continue to be optimized in the future.
sortKey ● ProductSortKeys
Sort the underlying list by the given key. The default is UPDATED_AT
More
productIds ● [ID]
Specified product ID list, product ID is globally unique
after ● String
Returns elements following the specified cursor. The first argument must also be specified when using this argument.
before ● String
Returns elements preceding the specified cursor. The last argument must also be specified when using this argument.
first ● Int
Returns the first n elements in the list.
Return
edges ● [ProductEdge!]non-null
A list of edges.
More
filters ● [Filter]
A list of available filters. Note that products does not support
More
nodes ● [Product!]non-null
A list of the nodes contained in ProductEdge.
More
pageInfo ● PageInfo!non-null
Information to aid in pagination.
More
totalCount ● Int
Total number of results based on filter criteria. Note that products does not support
Status and error codes
For detailed information about common codes, see Status and error codes.
Was this article helpful to you?