collections

query

An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.

Retrieve the list of collection.

Arguments

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.

reverse ● Boolean

Whether to reverse the order of the list.

● true: reverse

● false: do not reverse

Default value: false

query ● String

Use one or more filters for the query.

parameter	description
collection_type	Search by collection type (`MANUAL`、`SMART`). If not specified, it will return collection of all types.
title	Search by collection title. Currently, only searching a single title is supported.
updated_at	Search by collection update time. Supports searching within a time range.

tip

Note that when using keywords as parameter values, you need to first escape them.
The current supports a maximum of 5 parameters. Optimizations will be implemented in the future.

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

Order the base list in ascending manner using the specified sort key.

savedSearchId ● String

The ID of and search's query.

Return

edges ● [CollectionEdge!]non-null

List of edge nodes.

nodes ● [Collection!]non-null

List of nodes contained within a CollectionEdge.

pageInfo ● PageInfo!non-null

Pagination Assistance Information.

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