List all Products

List all Products

curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/products

{
  "data": [
    {
      "id": "1",
      "type": "product",
      "attributes": {
        "name": "Example product",
        "description": "Example description",
        "available_on": "2012-10-17T03:43:57Z",
        "slug": "example-product",
        "price": "15.99",
        "currency": "USD",
        "display_price": "$15.99",
        "purchasable": true,
        "in_stock": true,
        "backorderable": true,
        "meta_description": "Example product",
        "meta_keywords": "example, product",
        "updated_at": "2020-02-16T07:14:54.617Z",
        "sku": "9238-WS",
        "available": true,
        "compare_at_price": "49.99",
        "display_compare_at_price": "$49.99",
        "localized_slugs": {},
        "tags": [
          "<string>"
        ],
        "labels": [
          "<string>"
        ]
      },
      "relationships": {
        "variants": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        },
        "option_types": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        },
        "product_properties": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        },
        "taxons": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        },
        "images": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        },
        "default_variant": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "primary_variant": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        }
      }
    }
  ],
  "meta": {
    "count": 7,
    "total_count": 145,
    "total_pages": 10
  },
  "links": {
    "self": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "last": "<string>",
    "first": "<string>"
  },
  "included": [
    {
      "id": "1",
      "type": "payment_method",
      "attributes": {
        "type": "Spree::Gateway::StripeGateway",
        "name": "Stripe",
        "description": "Stripe Payments",
        "preferences": {}
      }
    }
  ]
}

GET

api

storefront

products

List all Products

curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/products

{
  "data": [
    {
      "id": "1",
      "type": "product",
      "attributes": {
        "name": "Example product",
        "description": "Example description",
        "available_on": "2012-10-17T03:43:57Z",
        "slug": "example-product",
        "price": "15.99",
        "currency": "USD",
        "display_price": "$15.99",
        "purchasable": true,
        "in_stock": true,
        "backorderable": true,
        "meta_description": "Example product",
        "meta_keywords": "example, product",
        "updated_at": "2020-02-16T07:14:54.617Z",
        "sku": "9238-WS",
        "available": true,
        "compare_at_price": "49.99",
        "display_compare_at_price": "$49.99",
        "localized_slugs": {},
        "tags": [
          "<string>"
        ],
        "labels": [
          "<string>"
        ]
      },
      "relationships": {
        "variants": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        },
        "option_types": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        },
        "product_properties": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        },
        "taxons": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        },
        "images": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        },
        "default_variant": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "primary_variant": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        }
      }
    }
  ],
  "meta": {
    "count": 7,
    "total_count": 145,
    "total_pages": 10
  },
  "links": {
    "self": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "last": "<string>",
    "first": "<string>"
  },
  "included": [
    {
      "id": "1",
      "type": "payment_method",
      "attributes": {
        "type": "Spree::Gateway::StripeGateway",
        "name": "Stripe",
        "description": "Stripe Payments",
        "preferences": {}
      }
    }
  ]
}

Query Parameters

filter[ids]

string

Fetch only resources with corresponding IDs

filter[skus]

string

Fetch only resources with corresponding SKUs

filter[price]

string

Filter Products based on price (minimum, maximum range)

filter[taxons]

string

Filter Products based on taxons (IDs of categories, brands, etc)

filter[vendor_ids]

string

Fetch products from specified Vendors (Sellers) - only available in Enterprise Edition

filter[name]

string

Find Products with matching name (supports wild-card, partial-word match search)

Find Products with Variants that have the specified option (eg. color, size) and value (eg. red, XS)

filter[properties][brand-name]

string

Find Products with Property Brand Name with value Alpha

filter[show_deleted]

boolean

Returns also deleted products

filter[show_discontinued]

boolean

Returns also discontinued products

filter[in_stock]

boolean

Returns only in stock products

filter[backorderable]

boolean

Returns only backorderable products

filter[purchasable]

boolean

Returns only in stock or backorderable products

sort

string

Sort products based on:

name (ascending/descending)
price (ascending/descending)
available_on (ascending/descending)
created_at (ascending/descending)
updated_at (ascending/descending)
sku (ascending/descending)

Use - sign to set descending sort, eg. -updated_at

page

integer

Number of requested page when paginating collection

per_page

integer

Number of requested records per page when paginating collection

include

string

Specify what related resources (relationships) you would like to receive in the response body. Eg.

default_variant,variants,option_types,product_properties,taxons,images,primary_variant

More information

fields[product]

string

Specify the fields you would like returned in the response body. More information.

image_transformation[size]

string

Specifies dimensions for included images at transformed_url attribute.

image_transformation[quality]

string

Specifies quality for included images at transformed_url attribute

Response

200 - application/vnd.api+json

200 Success - Returns an array of product objects.

data

Product · object[]

required

Show child attributes

data.id

string

required

Example:

"1"

data.type

string

default:product

required

data.attributes

object

required

Show child attributes

data.attributes.name

string

Example:

"Example product"

data.attributes.description

string | null

Example:

"Example description"

data.attributes.available_on

string | null

Example:

"2012-10-17T03:43:57Z"

data.attributes.slug

string

Example:

"example-product"

data.attributes.price

string | null

Example:

"15.99"

data.attributes.currency

string

Example:

"USD"

data.attributes.display_price

string | null

Example:

"$15.99"

data.attributes.purchasable

boolean

Indicates if any of Variants are in stock or backorderable

data.attributes.in_stock

boolean

Indicates if any of Variants are in stock

data.attributes.backorderable

boolean

Indicates if any of Variants are backeorderable

data.attributes.meta_description

string | null

Example:

"Example product"

data.attributes.meta_keywords

string | null

Example:

"example, product"

data.attributes.updated_at

string<date-time>

Example:

"2020-02-16T07:14:54.617Z"

data.attributes.sku

string

Example:

"9238-WS"

data.attributes.available

boolean

data.attributes.compare_at_price

string | null

Example:

"49.99"

data.attributes.display_compare_at_price

string | null

Example:

"$49.99"

data.attributes.localized_slugs

object

Provides product's slugs in other locales

data.attributes.tags

string[]

List of tags associated with the product

data.attributes.labels

string[]

List of labels associated with the product

data.relationships

object

required

Show child attributes

data.relationships.variants

object

List of Product Variants, excluding Master Variant

Show child attributes

data.relationships.variants.data

(object | null)[]

Show child attributes

data.relationships.variants.data.id

string

required

data.relationships.variants.data.type

string

required

data.relationships.option_types

object

List of Product Option Types

Show child attributes

data.relationships.option_types.data

(object | null)[]

Show child attributes

data.relationships.option_types.data.id

string

required

data.relationships.option_types.data.type

string

required

data.relationships.product_properties

object

List of Product Properties

Show child attributes

data.relationships.product_properties.data

(object | null)[]

Show child attributes

data.relationships.product_properties.data.id

string

required

data.relationships.product_properties.data.type

string

required

data.relationships.taxons

object

List of Taxons associated with this Product

Show child attributes

data.relationships.taxons.data

(object | null)[]

Show child attributes

data.relationships.taxons.data.id

string

required

data.relationships.taxons.data.type

string

required

data.relationships.images

object

List of Images associated with this Product

Show child attributes

data.relationships.images.data

(object | null)[]

Show child attributes

data.relationships.images.data.id

string

required

data.relationships.images.data.type

string

required

data.relationships.default_variant

object

The default Variant for this product

Show child attributes

data.relationships.default_variant.data

object

Show child attributes

data.relationships.default_variant.data.id

string

required

data.relationships.default_variant.data.type

string

required

data.relationships.primary_variant

object

The Primary Variant for this product

Show child attributes

data.relationships.primary_variant.data

object

Show child attributes

data.relationships.primary_variant.data.id

string

required

data.relationships.primary_variant.data.type

string

required

API basics

Tutorials

Storefront API

Platform API

Query Parameters

Response