An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.
List of the shop’s collections.
Arguments
reverse ● Boolean
Reverse the order of the underlying list.
sortkey ● CollectionSortKeys
Sort the underlying list by the given key.
query ● String
Apply one or multiple filters to the query.
tip
1·Please note that when using keywords as parameter values, they need to be escaped first.
2·Currently query supports up to 5 parameters, it will continue to be optimized in the future
valuedescription
collection_typeQuery by collection type (manualsmart). If not specified, all types of collections will be returned.
titleQuery by collection title. Searching for only one title is currently supported.
updated_atQuery by collection update time, with support for time range search.

Search syntax reference

title:'T-shirt' AND updated_at:>'2020-10-21T23:39:20Z'
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.
last ● Int
Returns up to the last n elements from the list.
Returns
edges ● [CollectionEdge!]non-null
A list of edges.
nodes ● [Collection]
A list of the nodes contained in CollectionEdge.
pageInfo ● PageInfo!non-null
Information to aid in pagination.
totalCount ● Int
the number of collections in the published scope
Error Code
For more information about common error codes, refer to Status and error codes.
Was this article helpful to you?