Retrieve collections

Retrieves a list of all of your store's collections.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

How to use this endpoint

  • Required parameters are listed below. For the full list of properties, see About collections.
  • For example requests, see below.
  • For example responses, click the relevant status code on the right.

Example requests

GET /v3/stores/{store_id}/collections?names=surfboards%2Cwinter%20surfboards
GET /v3/stores/{store_id}/collections
GET /v3/stores/{store_id}/collections?page_info={page_info}
GET /v3/stores/{store_id}/collections?page_info={page_info}
Path Params
string
required

The store ID (app_key).

Query Params
string

Encoded page info.

int32
1 to 100
Defaults to 100

The number of results per page, from 1 to 100. Defaults to 100.

string

Return only entities specified by a comma-separated (without spaces) list of external IDs. The argument must be URL encoded. Max 100 IDs. Can't come with page_info or limit.

string

Return only entities specified by a comma-separated (without spaces) list of names.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain