---
title: Spree API V2 Reference

language_tabs:
  - shell

toc_footers:
  - <a href="https://github.com/spree-contrib/spree_api_v2"> Source Code </a>
  - <a href="https://guides.spreecommerce.com/api/" target="_blank"> Spree API Documentation </a>
  - <a href="http://jsonapi.org/" target="_blank"> JSON API Documentation </a>
  - <a href="https://github.com/tripit/slate" target="_blank"> Documentation Powered by Slate </a>
  - <a href="https://kabuni.com?utm_source=SpreeApiV2Docs&utm_medium=sponsor&utm_campaign=opensource"> Kabuni, Proud Sponsor </a>

includes:
  - authentication
  - errors
  - pagination
  - filtering
  - countries
  - images
  - line_items
  - option_types
  - option_values
  - orders
  - prices
  - products
  - states
  - taxonomies
  - taxons
  - variants

search: true
---

# Introduction

Welcome to the Spree API V2 API!
You can use our API to grab data from our database and make updates.

We currently only have a language binding in Shell.
You can view code examples in the dark area to the right.

This example API documentation page was created with [Slate](http://github.com/tripit/slate).
Feel free to edit it and use it as a base for your own API's documentation.

This JSON API is formatted after the [JSON API spec](http://jsonapi.org).
Please follow its guidelines to learn about:

- Pagination
- Including Relationships
- Sorting
- Error Objects
- The Document Structure