collections

query

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

Whether to reverse the order of the list.

● true: reverse

● false: do not reverse

Default value: false

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

value	description
collection_type	Query by collection type (`manual`、`smart`). If not specified, all types of collections will be returned.
title	Query by collection title. Searching for only one title is currently supported.
updated_at	Query by collection update time, with support for time range search.

title:'T-shirt' AND updated_at:>'2020-10-21T23:39:20Z'

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.

last ● Int

Returns the last n elements in the list.

Return

edges ● [CollectionEdge!]non-null

A list of edges.

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

Status and error codes

For detailed information about common codes, see Status and error codes.

Was this article helpful to you?

SHOPLINE

SHOPLINE

Legal

Privacy