merge P5-567

2016-08-01 13:16:12 +02:00
parent 4c8c35f298
commit 9dbee8ca2c
8 changed files with 343 additions and 2 deletions
@@ -0,0 +1,74 @@
+# Prices
+
+The prices resource provides a simple API to retrive price information about wallpaper and canvas products.
+
+## Calculate wallpaper price
+
+Calculate price inc VAT of a wallpaper product. The response will contain prices for all available materials.
+
+| Parameter | Description |
+| --------- | -----| -------- | -
+| `width` | Wallpaper width in cm e.g `100'  |
+| `height` | Wallpaper height in cm e.g `50` |
+| `territory` | Two letter iso code e.g `SE`. Territory affect the price in different ways like VAT, currency exchanges etc. |
+| `dealerurl` | Optional parameter e.g `ackes`. Should always be used when calling the api from a dealerstore. If a dealerstore exists with this url additional fees will be applied to the price. |
+
+
+Sample request
+
+`curl -X GET 'https://api2.photowall.com/prices/wallpaper?width=100&height=50&territory=SE&dealerurl=ackes'`
+
+Sample response
+```
+{
+  "data": [
+    {
+      "material": "standard-wallpaper",
+      "material_id": 1,
+      "price": 295
+    },
+    {
+      "material": "self-adhesive-wallpaper",
+      "material_id": 2,
+      "price": 445
+    },
+    {
+      "material": "premium-wallpaper",
+      "material_id": 4,
+      "price": 325
+    }
+  ]
+}
+```
+
+## Calculate canvas price
+
+Calculate price inc VAT of a canvas product. The response will contain information for both framed/not framed canvases.
+
+| Parameter | Description |
+| --------- | -----| -------- | -
+| `width` | Canvas width in cm e.g `100'  |
+| `height` | Canvas height in cm e.g `50` |
+| `territory` | Two letter iso code e.g `SE`. Territory affect the price in different ways like VAT, currency exchanges etc. |
+| `dealerurl` | Optional parameter e.g `ackes`. Should always be used when calling the api from a dealerstore. If a dealerstore exists with this url additional fees will be applied to the price. |
+
+
+Sample request
+
+`curl -X GET 'https://api2.photowall.com/prices/canvas?width=100&height=50&territory=PL`
+
+Sample response
+```
+{
+  "data": [
+    {
+      "framed": true,
+      "price": 284
+    },
+    {
+      "framed": false,
+      "price": 249
+    }
+  ]
+}
+```