Updated api-reference from documentation release

api-specs/api/api.raml

@@ -126,6 +126,51 @@ resourceTypes:
           description: |
             ## Not Found
 
+            A 404 indicates that the <<resourceType>> was not found / does not exist.
+  baseSubResource:
+    type: base
+    get:
+      is:
+        - expandable
+      displayName: Get <<resourceType>>.
+      responses:
+        200:
+          body:
+            application/json:
+              type: <<resourceType>>
+    post?:
+      is:
+        - conflicting
+        - expandable
+        - deprecatable200
+      displayName: Update <<resourceType>>.
+      body:
+        application/json:
+          type: <<resourceUpdateType>>
+      responses:
+        200:
+          body:
+            application/json:
+              type: <<resourceType>>
+    delete?:
+      is:
+        - versioned
+        - conflicting
+        - expandable
+      displayName: Delete <<resourceType>>.
+      responses:
+        200:
+          body:
+            application/json:
+              type: <<resourceType>>
+    head?:
+      displayName: Check whether <<resourceType>> exists.
+      responses:
+        200:
+        404:
+          description: |
+            ## Not Found
+
             A 404 indicates that the <<resourceType>> was not found / does not exist.
   base:
     get?:
@@ -202,6 +247,7 @@ resourceTypes:
   /product-discounts: !include resources/product-discounts.raml
   /product-projections: !include resources/product-projections.raml
   /product-selections: !include resources/product-selections.raml
+  /product-tailoring: !include resources/product-tailoring.raml
   /product-types: !include resources/product-types.raml
   /quotes: !include resources/quotes.raml
   /quote-requests: !include resources/quote-requests.raml

api-specs/api/examples/Common/AddressDraft.json

@@ -0,0 +1,14 @@
+{
+  "key": "address1",
+  "title": "Mrs.",
+  "firstName": "Jane",
+  "lastName": "Doe",
+  "streetName": "First Street",
+  "streetNumber": "12",
+  "postalCode": "12345",
+  "city": "Example City",
+  "country": "NL",
+  "phone": "+312345678",
+  "mobile": "+312345679",
+  "email": "jane.doe@example.com"
+}

api-specs/api/examples/DiscountCode/DiscountCodeSetKeyAction.json

@@ -0,0 +1,4 @@
+{
+  "action": "setKey",
+  "key": "new-key"
+}

api-specs/api/examples/Product/ProductChangeAssetNameAction.json

@@ -1,8 +1,9 @@
 {
   "action": "changeAssetName",
+  "variantId": 1,
   "assetId": "{{assetId}}",
   "name": {
     "de": "Mein Asset",
     "en": "My asset"
   }
-}
+}

api-specs/api/examples/Product/ProductChangeAssetOrderAction.json

@@ -1,4 +1,5 @@
 {
   "action": "changeAssetOrder",
-  "assetOrder": ["{{assetId1}}","{{assetId2}}"]
-}
+  "variantId": 1,
+  "assetOrder": ["{{assetId1}}", "{{assetId2}}"]
+}

api-specs/api/examples/Product/ProductSetAssetCustomFieldAction.json

@@ -1,5 +1,6 @@
 {
   "action": "setAssetCustomField",
+  "variantId": 1,
   "assetId": "{{assetId}}",
   "name": "ExampleStringTypeField",
   "value": "TextString"

api-specs/api/examples/Product/ProductSetAssetCustomTypeAction.json

@@ -1,5 +1,6 @@
 {
   "action": "setAssetCustomType",
+  "variantId": 1,
   "assetId": "{{assetId}}",
   "type": {
     "id": "{{type-id}}",

api-specs/api/examples/Product/ProductSetAssetDescriptionAction.json

@@ -1,8 +1,9 @@
 {
   "action": "setAssetDescription",
+  "variantId": 1,
   "assetId": "{{assetId}}",
   "description": {
     "de": "Dies ist eine Asset-Beschreibung",
     "en": "This is an asset description"
   }
-}
+}

api-specs/api/examples/Product/ProductSetAssetKeyAction.json

@@ -1,5 +1,6 @@
 {
   "action": "setAssetKey",
+  "variantId": 1,
   "assetId": "{{assetId}}",
   "assetKey": "assetKeyString"
-}
+}

api-specs/api/examples/Product/ProductSetAssetSourcesAction.json

@@ -1,8 +1,11 @@
 {
   "action": "setAssetSources",
+  "variantId": 1,
   "assetId": "{{assetId}}",
-  "sources": [{
-    "uri": "https://www.commercetools.de/ct-logo.svg",
-    "key": "vector"
-  }]
-}
+  "sources": [
+    {
+      "uri": "https://www.commercetools.de/ct-logo.svg",
+      "key": "vector"
+    }
+  ]
+}

api-specs/api/examples/Product/ProductSetAssetTagsAction.json

@@ -1,5 +1,6 @@
 {
   "action": "setAssetTags",
+  "variantId": 1,
   "assetId": "{{assetId}}",
-  "tags": ["commercetools","awesome"]
-}
+  "tags": ["commercetools", "awesome"]
+}

api-specs/api/examples/ProductSearch/product-search-request.example.json

@@ -0,0 +1,33 @@
+{
+  "query": {
+    "and": [
+      {
+        "fullText": {
+          "field": "name",
+          "language": "en",
+          "value": "banana"
+        }
+      },
+      {
+        "filter": [
+          {
+            "exact": {
+              "field": "variants.attributes.farming",
+              "fieldType": "text",
+              "value": "organic"
+            }
+          }
+        ]
+      }
+    ]
+  },
+  "sort": [
+    {
+      "field": "name",
+      "language": "en",
+      "order": "desc"
+    }
+  ],
+  "limit": 10,
+  "offset": 0
+}

api-specs/api/examples/ProductSearch/product-search-response.example.json

@@ -0,0 +1,39 @@
+{
+  "total": 148,
+  "offset": 0,
+  "limit": 10,
+  "facets": [
+    {
+      "name": "countProducts",
+      "buckets": [
+        {
+          "key": "white",
+          "count": 37
+        }
+      ]
+    },
+    {
+      "name": "countVariants",
+      "buckets": [
+        {
+          "key": "white",
+          "count": 301
+        }
+      ]
+    }
+  ],
+  "results": [
+    {
+      "id": "8fde2af0-6a2f-4633-9ba4-83566f769a7f",
+      "matchingVariants": {
+        "allMatched": false,
+        "matchedVariants": [
+          {
+            "id": 1,
+            "sku": null
+          }
+        ]
+      }
+    }
+  ]
+}

api-specs/api/examples/ProductTailoring/ProductTailoringPublishAction.json

@@ -0,0 +1 @@
+{ "action": "publish" }

api-specs/api/examples/ProductTailoring/ProductTailoringSetDescriptionAction.json

@@ -0,0 +1,5 @@
+{
+  "action": "setDescription",
+  "description": { "en": "A description" },
+  "staged": true
+}

api-specs/api/examples/ProductTailoring/ProductTailoringSetMetaAttributesAction.json

@@ -0,0 +1,7 @@
+{
+  "action": "setMetaAttributes",
+  "metaTitle": { "en": "A Meta Title" },
+  "metaDescription": { "en": "A Meta Description" },
+  "metaKeywords": { "en": "Meta Keywords" },
+  "staged": true
+}

api-specs/api/examples/ProductTailoring/ProductTailoringSetMetaDescriptionAction.json

@@ -0,0 +1,5 @@
+{
+  "action": "setMetaDescription",
+  "metaDescription": { "en": "A Meta Description" },
+  "staged": true
+}

api-specs/api/examples/ProductTailoring/ProductTailoringSetMetaKeywordsAction.json

@@ -0,0 +1,5 @@
+{
+  "action": "setMetaKeywords",
+  "metaKeywords": { "en": "Meta Keywords" },
+  "staged": true
+}

api-specs/api/examples/ProductTailoring/ProductTailoringSetMetaTitleAction.json

@@ -0,0 +1,5 @@
+{
+  "action": "setMetaTitle",
+  "metaTitle": { "en": "A Meta Title" },
+  "staged": true
+}

api-specs/api/examples/ProductTailoring/ProductTailoringSetNameAction.json

@@ -0,0 +1,5 @@
+{
+  "action": "setName",
+  "name": { "en": "A name" },
+  "staged": true
+}

api-specs/api/examples/ProductTailoring/ProductTailoringSetSlugAction.json

@@ -0,0 +1,5 @@
+{
+  "action": "setSlug",
+  "slug": { "en": "a-slug" },
+  "staged": true
+}

api-specs/api/examples/ProductTailoring/ProductTailoringUnpublishAction.json

@@ -0,0 +1 @@
+{ "action": "unpublish" }

api-specs/api/examples/Project/ProjectChangeProductSearchIndexingEnabledAction.json

@@ -1,4 +1,5 @@
 {
   "action": "changeProductSearchIndexingEnabled",
-  "enabled": true
+  "enabled": true,
+  "mode": "ProductsSearch"
 }

api-specs/api/examples/customer-sign-in-result.example.json

@@ -10,6 +10,7 @@
     "version": 1,
     "createdAt": "2015-07-06T13:22:33.339Z",
     "lastModifiedAt": "2015-07-06T13:22:33.339Z",
-    "authenticationMode": "Password"
+    "authenticationMode": "Password",
+    "stores": []
   }
 }

api-specs/api/examples/customer-update-response.example.json

@@ -18,5 +18,6 @@
   "version": 4,
   "createdAt": "2015-05-06T12:10:12.421Z",
   "lastModifiedAt": "2015-07-06T13:22:33.339Z",
-  "authenticationMode": "Password"
+  "authenticationMode": "Password",
+  "stores": []
 }

api-specs/api/examples/order-edits.example.json

@@ -106,7 +106,19 @@
             "currencyCode": "EUR",
             "centAmount": 570,
             "fractionDigits": 2
-          }
+          },
+          "taxPortions": [
+            {
+              "rate": 0.1,
+              "amount": {
+                "type": "centPrecision",
+                "currencyCode": "EUR",
+                "centAmount": 634,
+                "fractionDigits": 2
+              },
+              "name": "Bla"
+            }
+          ]
         },
         "shippingMethodState": "MatchesCart"
       },
@@ -203,7 +215,19 @@
               "currencyCode": "EUR",
               "centAmount": 3400,
               "fractionDigits": 2
-            }
+            },
+            "taxPortions": [
+              {
+                "rate": 0.1,
+                "amount": {
+                  "type": "centPrecision",
+                  "currencyCode": "EUR",
+                  "centAmount": 634,
+                  "fractionDigits": 2
+                },
+                "name": "Bla"
+              }
+            ]
           },
           "lineItemMode": "Standard",
           "perMethodTaxRate": [],

api-specs/api/examples/order.example.json

@@ -115,7 +115,19 @@
           "fractionDigits": 2,
           "currencyCode": "EUR",
           "centAmount": 1100
-        }
+        },
+        "taxPortions": [
+          {
+            "rate": 0.1,
+            "amount": {
+              "type": "centPrecision",
+              "currencyCode": "EUR",
+              "centAmount": 634,
+              "fractionDigits": 2
+            },
+            "name": "Bla"
+          }
+        ]
       },
       "perMethodTaxRate": [],
       "taxedPricePortions": []

api-specs/api/examples/orders.example.json

@@ -121,7 +121,19 @@
               "fractionDigits": 2,
               "currencyCode": "EUR",
               "centAmount": 1100
-            }
+            },
+            "taxPortions": [
+              {
+                "rate": 0.1,
+                "amount": {
+                  "type": "centPrecision",
+                  "currencyCode": "EUR",
+                  "centAmount": 634,
+                  "fractionDigits": 2
+                },
+                "name": "Bla"
+              }
+            ]
           },
           "perMethodTaxRate": [],
           "taxedPricePortions": []