List collections

List collections

const options = {method: 'GET', headers: {'x-spree-api-key': '<api-key>'}};

fetch('http://{defaultHost}/api/v3/store/collections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "coll_UkLWZg9DAJ",
      "name": "Summer Sale",
      "permalink": "summer-sale",
      "position": 1,
      "sort_order": "manual",
      "meta_title": null,
      "meta_description": null,
      "meta_keywords": null,
      "products_count": 1,
      "description": "",
      "description_html": "",
      "image_url": null,
      "square_image_url": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

{
  "error": {
    "code": "invalid_token",
    "message": "Valid API key required"
  }
}

GET

api

store

collections

List collections

const options = {method: 'GET', headers: {'x-spree-api-key': '<api-key>'}};

fetch('http://{defaultHost}/api/v3/store/collections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "coll_UkLWZg9DAJ",
      "name": "Summer Sale",
      "permalink": "summer-sale",
      "position": 1,
      "sort_order": "manual",
      "meta_title": null,
      "meta_description": null,
      "meta_keywords": null,
      "products_count": 1,
      "description": "",
      "description_html": "",
      "image_url": null,
      "square_image_url": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

{
  "error": {
    "code": "invalid_token",
    "message": "Valid API key required"
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[name_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`automatic`	True or false	`eq` `not_eq` `in` `not_in` `true` `false` `null`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`name`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`permalink`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`position`	Number	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`products_count`	Number	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`sort_order`	One of `manual`, `best_selling`, `price asc`, `price desc`, `available_on desc`, `available_on asc`, `name asc`, `name desc`	`eq` `not_eq` `in` `not_in` `null` `not_null`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Sort by: automatic, created_at, id, name, permalink, position, products_count, sort_order, updated_at. Prefix a field with - to sort descending.

Authorizations

x-spree-api-key

string

header

required

Publishable API key for store access

Headers

x-spree-api-key

string

required

Query Parameters

q[search]

string

Matches any of name (partial, case-insensitive).

page

integer

limit

integer

object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

fields

string

Comma-separated list of fields to include (e.g., name,permalink). id is always included.

Response

collections found

data

object[]

Show child attributes

API basics

Endpoints

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters