List sellers

List sellers

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

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

{
  "data": [
    {
      "id": "sel_UkLWZg9DAJ",
      "name": "Sparks Audio",
      "slug": "sparks-audio",
      "about": "",
      "about_html": "",
      "logo_url": null,
      "square_logo_url": null,
      "cover_photo_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

sellers

List sellers

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

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

{
  "data": [
    {
      "id": "sel_UkLWZg9DAJ",
      "name": "Sparks Audio",
      "slug": "sparks-audio",
      "about": "",
      "about_html": "",
      "logo_url": null,
      "square_logo_url": null,
      "cover_photo_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
`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`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Sort by: created_at, id, name, 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.

expand

string

Comma-separated associations to expand (policies). A seller's policies are their own published legal documents.

fields

string

Comma-separated list of fields to include. id is always included.

Response

sellers found

data

object[]

Show child attributes

API basics

Endpoints

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters