@spree/docs 0.1.0

package/dist/api-reference/v2/fetching-multiple-resources.md

@@ -0,0 +1,26 @@
+Spree APIs allow you to fetch multiple associated resources in one API call, both for singular resources and collections, eg. we can fetch a Product with all of its variants and images:
+
+```curl
+curl --request GET \
+     --url 'https://demo.spreecommerce.org/api/v2/storefront/products/classic-varsity-top?include=variants%252Cimages' \
+     --header 'Accept: application/vnd.api+json'
+```
+
+This will return a JSON response with `data[relationships]` node (links to what resources connects to which) and `included` node (images and variants JSON responses).
+
+This way you can easily control what resources you want to include in the response and
+avoid making multiple API calls.
+
+## Nested resources
+
+You can also nest resources, eg. fetching Product Variants with their Option Values:
+
+```curl
+curl --request GET \
+     --url 'https://demo.spreecommerce.org/api/v2/storefront/products/classic-varsity-top?include=variants.option_values' \
+     --header 'Accept: application/vnd.api+json'
+```
+
+## Open source libraries to transform JSONApi to a flat JSON response
+
+As you probably noticed the JSON response can sometimes be quite big and hard to follow. To ease working with included resources we recommend checking out [one of the open-source libraries](https://jsonapi.org/implementations/) that can help deserialize responses.

package/dist/api-reference/v2/filtering-and-sorting.md

@@ -0,0 +1,53 @@
+## Filtering
+
+You can filter out collection results by applying filter parameters to your API calls, eg.
+
+```curl
+curl --request GET \
+     --url 'https://demo.spreecommerce.org/api/v2/storefront/products' \
+     --header 'Accept: application/vnd.api+json' \
+     --data-urlencode 'filter[skus]=classic-varsity-top-large'
+```
+
+You can combine multiple filters to find only records that match both criteria:
+
+```http
+curl --request GET \
+     --url 'https://demo.spreecommerce.org/api/v2/storefront/products' \
+     --header 'Accept: application/vnd.api+json' \
+     --data-urlencode 'filter[price]=10,100' \
+     --data-urlencode 'filter[name]=Classic Varsity'
+```
+
+[Products list endpoint ](https://developers.spreecommerce.org/reference/products-list) covers how to filter by these attributes in more detail.
+
+## Sorting
+
+Sorting is being performed by supplying `sort` parameter in your API calls.
+
+Ascending sort, eg.
+
+```curl
+curl --request GET \
+     --url 'https://demo.spreecommerce.org/api/v2/storefront/products?sort=price' \
+     --header 'Accept: application/vnd.api+json'
+```
+
+Descending sort is performed by adding `-` before the column name, eg:
+
+```curl
+curl --request GET \
+     --url 'https://demo.spreecommerce.org/api/v2/storefront/products?sort=-price' \
+     --header 'Accept: application/vnd.api+json'
+```
+
+You can also combine multiple attributes:
+
+```curl
+curl --request GET \
+     --url 'https://demo.spreecommerce.org/api/v2/storefront/products' \
+     --data-urlencode 'sort=-price,updated_at' \
+     --header 'Accept: application/vnd.api+json'
+```
+
+Each endpoint includes a list of attributes you can sort by. The default ones are always `id`, `created_at`, `updated_at` and `name`.

package/dist/api-reference/v2/introduction.md

@@ -0,0 +1,22 @@
+---
+description: "Spree open-source comes with a fully-featured Ecommerce API for headless eCommerce apps."
+title: "Ecommerce API"
+---
+
+Spree Commerce open-source comes with a fully-featured Ecommerce API enabling a fully headless mode. This means that you can use Spree as a backend to build your custom [Next.js storefront](https://spreecommerce.org/category/next-js-ecommerce/), eCommerce mobile app functionality, or any other customer-facing application that needs to interact with an e-commerce platform.
+
+## API v2
+
+Currently Spree includes 2 modern REST APIs:
+
+
+  - [Storefront API](/api-reference/storefront/authentication) — Designed to allow customers to interact with the store via external applications (e.g. Next.js storefront or a dedicated mobile app)
+
+  - [Platform API](/api-reference/platform/authentication) — Provides management capabilities, allowing third party apps to perform actions otherwise available via the admin panel.
+
+
+## Thank you!
+
+Give Spree a [GitHub Star](https://github.com/spree/spree), why dont't ya? Thank you for supporting Spree open-source! 
+
+Need support or want to give some feedback? Join our [community](https://slack.spreecommerce.org/) with 6000+ members or drop us an email at [hello@spreecommerce.org](mailto:hello@spreecommerce.org).

package/dist/api-reference/v2/pagination.md

@@ -0,0 +1,37 @@
+All lists implement the same method for pagination with `page` and `per_page` parameters, eg.
+
+```curl
+curl --request GET \
+     --url 'https://demo.spreecommerce.org/api/v2/storefront/products?page=1&per_page=25' \
+     --header 'Accept: application/vnd.api+json'
+```
+
+Both of these parameters are optional. There is a limit of 500 records that can be fetched by a single request. If this doesn't work for your use case, please contact us so we can work on resolving this issue.
+
+Response for that call will include a `meta` node with:
+
+```json
+"meta": {
+  "count": 25,
+  "total_count": 26,
+  "total_pages": 2
+}
+```
+
+`count` is the number of records returned on the current page  
+`total_count` is the total number of records in the collection  
+`total_pages` is the total number of pages
+
+The response will also include the`links` node:
+
+```json
+"links": {
+    "self": "https://demo.spreecommerce.org/api/v2/storefront/products?per_page=25",
+    "next": "https://demo.spreecommerce.org/api/v2/storefront/products?page=2&per_page=25",
+    "prev": "https://demo.spreecommerce.org/api/v2/storefront/products?page=1&per_page=25",
+    "last": "https://demo.spreecommerce.org/api/v2/storefront/products?page=2&per_page=25",
+    "first": "https://demo.spreecommerce.org/api/v2/storefront/products?page=1&per_page=25"
+  }
+```
+
+With fully generates API URLs for pagination.