products

query

[]

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 up to the last n elements from the list.

reverse ● Boolean

[]

Reverse the order of the underlying list.

query ● String

[]

Supported query parameters

name	description
created_at	Search by product creation time, support range query.
updated_at	Search by product update time, support range query.
title	Precise search by product title.
tag	Precise search by product tag.
available_for_sale	Inventory search by product dimension.
vendor	Precise search by product vendor.
product_type	Precise search by product type.
variants.price	Price search by variant dimension, supports range query.

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.

[]

Sort the underlying list by the given key. The default is UPDATED_AT

productIds ● [ID]

[]

Specified product ID list, product ID is globally unique

after ● String

[]

Returns the elements that come after the specified cursor.

before ● String

[]

Returns the elements that come before the specified cursor.

first ● Int

[]

Returns up to the first n elements from the list.

Returns

edges ● [ProductEdge!]non-null

[]

A list of edges.

filters ● [Filter]

[]

A list of available filters. Note that products does not support

nodes ● [Product!]non-null

[]

A list of the nodes contained in ProductEdge.

pageInfo ● PageInfo!non-null

[]

Information to aid in pagination.

totalCount ● Int

[]

Total number of results based on filter criteria. Note that products does not support

Error Code

[]

For more information about common error codes, refer to Status and error codes.

Was this article helpful to you?

SHOPLINE

SHOPLINE

Legal

Privacy

Error loading component.