solidus_json_api 0.3.0

data/docs/source/includes/_orders.md

@@ -0,0 +1,150 @@
+# Orders
+
+## List Orders
+
+```shell
+curl "https://example.com/api/v2/orders"
+  -d token=abc123
+```
+
+```json
+{
+  "data" : [
+    {
+      "attributes" : {
+        "additional_tax_total" : "0.0",
+        "adjustment_total" : "0.0",
+        "approved_at" : null,
+        "canceled_at" : null,
+        "channel" : "spree",
+        "completed_at" : "2015-09-08T04:04:01.162Z",
+        "confirmation_delivered" : false,
+        "currency" : "CAD",
+        "display_additional_tax_total" : "$0.00 CAD",
+        "display_adjustment_total" : "$0.00 CAD",
+        "display_included_tax_total" : "$0.00 CAD",
+        "display_item_total" : "$10.00 CAD",
+        "display_promo_total" : "$0.00 CAD",
+        "display_shipment_total" : "$100.00 CAD",
+        "display_total" : "$110.00 CAD",
+        "email" : "spree@example.com",
+        "included_tax_total" : "0.0",
+        "item_count" : 0,
+        "item_total" : "10.0",
+        "number" : "#R123456789",
+        "payment_state" : null,
+        "payment_total" : "0.0",
+        "promo_total" : "0.0",
+        "shipment_state" : null,
+        "shipment_total" : "100.0",
+        "special_instructions" : null,
+        "state" : "complete",
+        "store_name" : "Example Store",
+        "total" : "110.0"
+      },
+      "relationships" : {
+        "bill_address" : {
+          "data" : {
+            "type" : "spree_addresses"
+          }
+        },
+        "line_items" : {
+          "data" : [
+            {
+              "type" : "spree_line_items"
+            }
+          ]
+        },
+        "ship_address" : {
+          "data" : {
+            "type" : "spree_addresses"
+          }
+        },
+        "user" : {
+          "data" : {
+            "type" : "spree_users"
+          }
+        }
+      },
+      "type" : "spree_orders"
+    }
+  ]
+}
+```
+
+List all of the orders in the DB if you're an admin.
+If you're a standard user, then only the orders that you own are listed.
+
+## Show Order
+
+```shell
+curl "https://example.com/api/v2/orders/:id"
+  -d token=abc123
+```
+
+```json
+{
+  "data" : {
+    "attributes" : {
+      "additional_tax_total" : "0.0",
+      "adjustment_total" : "0.0",
+      "approved_at" : null,
+      "canceled_at" : null,
+      "channel" : "spree",
+      "completed_at" : "2015-09-08T04:04:01.162Z",
+      "confirmation_delivered" : false,
+      "currency" : "CAD",
+      "display_additional_tax_total" : "$0.00 CAD",
+      "display_adjustment_total" : "$0.00 CAD",
+      "display_included_tax_total" : "$0.00 CAD",
+      "display_item_total" : "$10.00 CAD",
+      "display_promo_total" : "$0.00 CAD",
+      "display_shipment_total" : "$100.00 CAD",
+      "display_total" : "$110.00 CAD",
+      "email" : "spree@example.com",
+      "included_tax_total" : "0.0",
+      "item_count" : 0,
+      "item_total" : "10.0",
+      "number" : "#R123456789",
+      "payment_state" : null,
+      "payment_total" : "0.0",
+      "promo_total" : "0.0",
+      "shipment_state" : null,
+      "shipment_total" : "100.0",
+      "special_instructions" : null,
+      "state" : "complete",
+      "store_name" : "Example Store",
+      "total" : "110.0"
+    },
+    "relationships" : {
+      "bill_address" : {
+        "data" : {
+          "type" : "spree_addresses"
+        }
+      },
+      "line_items" : {
+        "data" : [
+          {
+            "type" : "spree_line_items"
+          }
+        ]
+      },
+      "ship_address" : {
+        "data" : {
+          "type" : "spree_addresses"
+        }
+      },
+      "user" : {
+        "data" : {
+          "type" : "spree_users"
+        }
+      }
+    },
+    "type" : "spree_orders"
+  }
+}
+```
+
+This will get an order via the id supplied.
+Please note that you can ony access the orders that you own.
+If you are an admin, you can view any order.

data/docs/source/includes/_pagination.md

@@ -0,0 +1,10 @@
+# Pagination
+
+```shell
+curl "https://example.com/api/v2/kitten?page[number]2&page[size]=20"
+```
+
+This projects supports the [JSON API's `page` keyword](http://jsonapi.org/format/#fetching-pagination).
+To specify the page number, set a `page[number]` value.
+To specify the page size (the amount of records returned), set a `page[size]` value; the default is 24.
+If you would like the links to the `self`, `next`, `prev`, `first`, and `last` it is not yet supported.

data/docs/source/includes/_prices.md

@@ -0,0 +1,188 @@
+# Prices
+
+## List Prices
+
+```shell
+curl "https://example.com/api/v2/prices"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_prices",
+      "attributes": {
+        "amount": "15.99",
+        "price": "15.99",
+        "display_amount": "$15.99 CAD",
+        "display_price": "$15.99 CAD",
+        "currency": "CAD"
+      },
+      "relationships": {
+        "variant": {
+          "data": {
+            "type": "spree_variants",
+            "id": "1"
+          }
+        }
+      }
+    }
+  ]
+}
+```
+
+List all of the prices in the database.
+
+## Show Price
+
+```shell
+curl "https://example.com/api/v2/prices/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_prices",
+    "attributes": {
+      "amount": "15.99",
+      "price": "15.99",
+      "display_amount": "$15.99 CAD",
+      "display_price": "$15.99 CAD",
+      "currency": "CAD"
+    },
+    "relationships": {
+      "variant": {
+        "data": {
+          "type": "spree_variants",
+          "id": "1"
+        }
+      }
+    }
+  }
+}
+```
+
+Fetch a price via its `id`.
+
+## Show Variant of a Price
+
+```shell
+curl "https://example.com/api/v2/prices/1/variant"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_variants",
+    "attributes": {
+      "sku": "ROR-00011",
+      "weight": "0.0",
+      "height": "1.0",
+      "width": "3.0",
+      "depth": "2.0",
+      "is_master": true,
+      "position": 1,
+      "name": "Ruby on Rails Tote",
+      "price": "15.99",
+      "display_price" : "$15.99 CAD"
+    },
+    "relationships": {
+      "prices": {
+        "data": [
+          {
+            "type": "spree_prices",
+            "id": "1"
+          }
+        ]
+      },
+      "option_values": {
+        "data": [
+          {
+            "type": "spree_option_values",
+            "id": "1"
+          }
+        ]
+      },
+      "images": {
+        "data": [
+          {
+            "type": "spree_images",
+            "id": "1"
+          }
+        ]
+      },
+      "product": {
+        "data": {
+          "type": "spree_products",
+          "id": "1"
+        }
+      }
+    }
+  }
+}
+```
+
+Fetch the variant a price belongs to via the price's `id`.
+
+## Show Product of a Price
+
+```shell
+curl "https://example.com/api/v2/prices/1/product"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_products",
+    "attributes": {
+      "name": "Ruby on Rails Tote",
+      "description": "Dolorem molestias sint maxime id at rem qui exercitationem. Neque voluptas corrupti magni suscipit iusto voluptatum. Ea quibusdam dolorem inventore praesentium sed dicta eveniet et. Rerum inventore laudantium quisquam earum consequatur dignissimos.",
+      "slug": "ruby-on-rails-tote",
+      "meta_description": null,
+      "meta_keywords": null,
+      "store_name": "Whole New Home"
+    },
+    "relationships": {
+      "master": {
+        "data": {
+          "type": "spree_variants",
+          "id": "1"
+        }
+      },
+      "variants": {
+        "data": []
+      },
+      "taxons": {
+        "data": [
+          {
+            "type": "spree_taxons",
+            "id": "18"
+          }
+        ]
+      },
+      "option_types": {
+        "data": [
+          {
+            "type": "spree_option_types",
+            "id": "1"
+          }
+        ]
+      },
+      "images": {
+        "data": [
+          {
+            "type": "spree_images",
+            "id": "1"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+Fetch the product a price belongs to via the price's `id`.