solidus_json_api 0.3.0

data/docs/source/includes/_line_items.md

@@ -0,0 +1,143 @@
+# Line Items
+
+## Create Line Item
+
+```shell
+curl "https://example.com/api/v2/line_items"
+  -X POST
+  -d token=abc123
+  -d data[attributes][order_id]=1
+  -d data[attributes][variant_id]=1
+  -d data[attributes][quantity]=1
+```
+
+```json
+{
+  "data": {
+    "attributes": {
+      "additional_tax_total": "0",
+      "adjustment_total": "0.0",
+      "amount": "10.0",
+      "cost_price": "17.0",
+      "currency": "CAD",
+      "display_amount": "$10.00 CAD",
+      "display_price": "$10.00 CAD",
+      "display_total": "$10.00 CAD",
+      "order_id": 1,
+      "price": "10.0",
+      "quantity": 1,
+      "total": "10.0",
+      "variant_id": 1
+    },
+    "relationships": {
+      "order": {
+        "data": {
+          "type": "spree_orders"
+        }
+      },
+      "variant": {
+        "data": {
+          "type": "spree_variants"
+        }
+      }
+    },
+    "type": "spree_line_items"
+  }
+}
+```
+
+This endpoint allows you add a variant to a users order by creating a line item.
+
+### When Out of Range
+
+> Quantity is out of range.
+
+```shell
+curl "https://example.com/api/v2/line_items"
+  -X POST
+  -d token=abc123
+  -d data[attributes][order_id]=1
+  -d data[attributes][variant_id]=1
+  -d data[attributes][quantity]=100000000000
+```
+
+```json
+{
+  "errors": [
+    {
+      "code": "400",
+      "detail": "Quantity is too High",
+      "meta": {},
+      "status": "Bad Request",
+      "title": "The quantity that you have submitted is astronomically high, please tone it down a bit."
+    }
+  ]
+}
+```
+
+When requesting an insanely large amount of variants to be added to your order, this will result in an error.
+
+### When a Variant or an Order Could Not be Found
+
+> Order could not be found.
+
+```shell
+curl "https://example.com/api/v2/line_items"
+  -X POST
+  -d token=abc123
+  -d data[attributes][order_id]=0
+  -d data[attributes][variant_id]=1
+  -d data[attributes][quantity]=1
+```
+
+```json
+{
+  "errors": [
+    {
+      "code": "400",
+      "detail": "Record Not Found",
+      "meta": {},
+      "status": "Bad Request",
+      "title": "One of the records that you were looking for could not be found. Please check to see if the record exists or if you're permitted to read it"
+    }
+  ]
+}
+```
+
+Sometimes, you'll submit a bad variant id or order id.
+When this happens, you'll receive an error because of it.
+
+### When the Product is Out of Stock
+
+> Product is out of stock.
+
+```shell
+curl "https://example.com/api/v2/line_items"
+  -X POST
+  -d token=abc123
+  -d data[attributes][order_id]=1
+  -d data[attributes][variant_id]=1
+  -d data[attributes][quantity]=1
+```
+
+```json
+{
+  "errors": [
+    {
+      "code": "400",
+      "detail": "Product is out of Stock",
+      "meta": {},
+      "status": "Bad Request",
+      "title": "This product is out of stock for the selected quantity."
+    }
+  ]
+}
+```
+
+Sometimes, there's just not going to be any left in stock.
+This can happen for both two reasons:
+
+1. The variant is tracking inventory and its stock items `count_on_hand`s have all reached 0.
+2. The variant is not backorderable.
+
+If both of these conditions are met, then you will reveice an out of stock error.

data/docs/source/includes/_option_types.md

@@ -0,0 +1,267 @@
+# Option Types
+
+## List Option Types
+
+```shell
+curl "https://example.com/api/v2/option_types"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_option_types",
+      "attributes": {
+        "name": "tshirt-size",
+        "presentation": "Size",
+        "position": 1
+      },
+      "relationships": {
+        "option_values": {
+          "data": [
+            {
+              "type": "spree_option_values",
+              "id": "1"
+            }
+          ]
+        },
+        "products": {
+          "data": [
+            {
+              "type": "spree_products",
+              "id": "1"
+            }
+          ]
+        }
+      }
+    }
+  ]
+}
+```
+
+List all of the option types in the database.
+
+## Show Option Type
+
+```shell
+curl "https://example.com/api/v2/option_types/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_option_types",
+    "attributes": {
+      "name": "tshirt-size",
+      "presentation": "Size",
+      "position": 1
+    },
+    "relationships": {
+      "option_values": {
+        "data": [
+          {
+            "type": "spree_option_values",
+            "id": "1"
+          }
+        ]
+      },
+      "products": {
+        "data": [
+          {
+            "type": "spree_products",
+            "id": "1"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+Fetch an option type in the database.
+
+## List Option Values of a Option Type
+
+```shell
+curl "https://example.com/api/v2/option_types/1/option_values"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_option_values",
+      "attributes": {
+        "name": "Small",
+        "presentation": "S",
+        "position": 1
+      },
+      "relationships": {
+        "option_type": {
+          "data": {
+            "type": "spree_option_types",
+            "id": "1"
+          }
+        }
+      }
+    }
+  ]
+}
+```
+
+See all of the option values that an option type owns.
+
+## Show Option Values of a Option Type
+
+```shell
+curl "https://example.com/api/v2/option_types/1/option_values/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_option_values",
+    "attributes": {
+      "name": "Small",
+      "presentation": "S",
+      "position": 1
+    },
+    "relationships": {
+      "option_type": {
+        "data": {
+          "type": "spree_option_types",
+          "id": "1"
+        }
+      }
+    }
+  }
+}
+```
+
+Fetch an option value that an option type owns.
+
+## List Products of a Option Type
+
+```shell
+curl "https://example.com/api/v2/option_types/1/products"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_products",
+      "attributes": {
+        "name": "Ruby on Rails Tote",
+        "description": "Velit nemo odio ducimus nobis non doloremque beatae sunt. Totam quia voluptatum perferendis tempore sed voluptate consequuntur. Sit id corporis autem veritatis reprehenderit.",
+        "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": "1"
+            }
+          ]
+        },
+        "option_types": {
+          "data": [
+            {
+              "type": "spree_option_types",
+              "id": "1"
+            }
+          ]
+        },
+        "images": {
+          "data": [
+            {
+              "type": "spree_images",
+              "id": "1"
+            }
+          ]
+        }
+      }
+    }
+  ]
+}
+```
+
+See all of the products that an option type owns.
+
+## Show Product of a Option Type
+
+```shell
+curl "https://example.com/api/v2/option_types/1/products/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_products",
+    "attributes": {
+      "name": "Ruby on Rails Tote",
+      "description": "Velit nemo odio ducimus nobis non doloremque beatae sunt. Totam quia voluptatum perferendis tempore sed voluptate consequuntur. Sit id corporis autem veritatis reprehenderit.",
+      "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": "1"
+          }
+        ]
+      },
+      "option_types": {
+        "data": [
+          {
+            "type": "spree_option_types",
+            "id": "1"
+          }
+        ]
+      },
+      "images": {
+        "data": [
+          {
+            "type": "spree_images",
+            "id": "1"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+Find a product that an option type owns.

data/docs/source/includes/_option_values.md

@@ -0,0 +1,227 @@
+# Option Values
+
+## List Option Values
+
+```shell
+curl "https://example.com/api/v2/option_values"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_option_values",
+      "attributes": {
+        "name": "Small",
+        "presentation": "S",
+        "position": 1
+      },
+      "relationships": {
+        "option_type": {
+          "data": {
+            "type": "spree_option_types",
+            "id": "1"
+          }
+        }
+      }
+    }
+  ]
+}
+```
+
+List all of the option values.
+
+## Show Option Value
+
+```shell
+curl "https://example.com/api/v2/option_values/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_option_values",
+    "attributes": {
+      "name": "Small",
+      "presentation": "S",
+      "position": 1
+    },
+    "relationships": {
+      "option_type": {
+        "data": {
+          "type": "spree_option_types",
+          "id": "1"
+        }
+      }
+    }
+  }
+}
+```
+
+Find an option value by its `id`.
+
+## Show Option Type of an Option Value
+
+```shell
+curl "https://example.com/api/v2/option_values/1/option_type"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_option_types",
+    "attributes": {
+      "name": "tshirt-size",
+      "presentation": "Size",
+      "position": 1
+    },
+    "relationships": {
+      "option_values": {
+        "data": [
+          {
+            "type": "spree_option_values",
+            "id": "1"
+          }
+        ]
+      },
+      "products": {
+        "data": [
+          {
+            "type": "spree_products",
+            "id": "1"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+Find the option type of an option value by the option value's `id`.
+
+## List Variants of an Option Value
+
+```shell
+curl "https://example.com/api/v2/option_values/1/variants"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_variants",
+      "attributes": {
+        "sku": "ROR-00001",
+        "weight": "0.0",
+        "height": null,
+        "width": null,
+        "depth": null,
+        "is_master": false,
+        "position": 2,
+        "name": "Ruby on Rails Baseball Jersey",
+        "price": "15.99",
+        "display_price": "$15.99 CAD"
+      },
+      "relationships": {
+        "prices": {
+          "data": [
+            {
+              "type": "spree_prices",
+              "id": "33"
+            }
+          ]
+        },
+        "option_values": {
+          "data": [
+            {
+              "type": "spree_option_values",
+              "id": "1"
+            }
+          ]
+        },
+        "images": {
+          "data": [
+            {
+              "type": "spree_images",
+              "id": "1"
+            }
+          ]
+        },
+        "product": {
+          "data": {
+            "type": "spree_products",
+            "id": "3"
+          }
+        }
+      }
+    }
+  ]
+}
+```
+
+List all of the variants that belong to an option value via the option value's `id`.
+
+## Show Variant of an Option Value
+
+```shell
+curl "https://example.com/api/v2/option_values/1/variants/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_variants",
+    "attributes": {
+      "sku": "ROR-00001",
+      "weight": "0.0",
+      "height": null,
+      "width": null,
+      "depth": null,
+      "is_master": false,
+      "position": 2,
+      "name": "Ruby on Rails Baseball Jersey",
+      "price": "15.99",
+      "display_price": "$15.99 CAD"
+    },
+    "relationships": {
+      "prices": {
+        "data": [
+          {
+            "type": "spree_prices",
+            "id": "33"
+          }
+        ]
+      },
+      "option_values": {
+        "data": [
+          {
+            "type": "spree_option_values",
+            "id": "1"
+          }
+        ]
+      },
+      "images": {
+        "data": [
+          {
+            "type": "spree_images",
+            "id": "1"
+          }
+        ]
+      },
+      "product": {
+        "data": {
+          "type": "spree_products",
+          "id": "3"
+        }
+      }
+    }
+  }
+}
+```
+
+Show a variant that belongs to an option value via the option value's `id`.