Updated API from documentation release

commercetools · Jan 2, 2025 · 2a4e9c2 · 2a4e9c2
1 parent b7b82f5
commit 2a4e9c2
Show file tree

Hide file tree

Showing 97 changed files with 701 additions and 242 deletions.
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountChangeCartPredicateAction.json b/api-specs/api/examples/CartDiscount/CartDiscountChangeCartPredicateAction.json
@@ -1,4 +1,4 @@
 {
   "action": "changeCartPredicate",
-  "cartPredicate": "cartPredicateString"
-}
+  "cartPredicate": "shippingInfo.taxRate.country = \"DE\""
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountChangeNameAction.json b/api-specs/api/examples/CartDiscount/CartDiscountChangeNameAction.json
@@ -1,7 +1,7 @@
 {
   "action": "changeName",
   "name": {
-    "en": "NewNameEN",
-    "de": "NewNameDE"
+    "en": "New name",
+    "de": "Neuer Name"
   }
-}
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountChangeRequiresDiscountCodeAction.json b/api-specs/api/examples/CartDiscount/CartDiscountChangeRequiresDiscountCodeAction.json
@@ -1,4 +1,4 @@
 {
   "action": "changeRequiresDiscountCode",
-  "requiresDiscountCode": true
-}
+  "requiresDiscountCode": false
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountChangeSortOrderAction.json b/api-specs/api/examples/CartDiscount/CartDiscountChangeSortOrderAction.json
@@ -1,4 +1,4 @@
 {
   "action": "changeSortOrder",
-  "sortOrder": "0.2"
-}
+  "sortOrder": "0.1"
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountChangeStackingModeAction.json b/api-specs/api/examples/CartDiscount/CartDiscountChangeStackingModeAction.json
@@ -1,4 +1,4 @@
 {
   "action": "changeStackingMode",
-  "stackingMode": "Stacking"
-}
+  "stackingMode": "StopAfterThisDiscount"
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountCustomLineItemsTarget.json b/api-specs/api/examples/CartDiscount/CartDiscountCustomLineItemsTarget.json
@@ -0,0 +1,4 @@
+{
+  "type": "customLineItems",
+  "predicate": "customLineItemTotal(1 = 1) = \"20.00 EUR\""
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountLineItemsTarget.json b/api-specs/api/examples/CartDiscount/CartDiscountLineItemsTarget.json
@@ -0,0 +1,4 @@
+{
+  "type": "lineItems",
+  "predicate": "shippingInfo.price = \"50.00 EUR\""
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountMultiBuyCustomLineItemsTarget.json b/api-specs/api/examples/CartDiscount/CartDiscountMultiBuyCustomLineItemsTarget.json
@@ -0,0 +1,8 @@
+{
+  "type": "multiBuyCustomLineItems",
+  "predicate": "taxedPrice.gross = \"200.00 EUR\"",
+  "triggerQuantity": 2,
+  "discountedQuantity": 1,
+  "maxOccurrence": 5,
+  "selectionMode": "MostExpensive"
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountMultiBuyLineItemsTarget.json b/api-specs/api/examples/CartDiscount/CartDiscountMultiBuyLineItemsTarget.json
@@ -0,0 +1,8 @@
+{
+  "type": "multiBuyLineItems",
+  "predicate": "taxedPrice.gross = \"200.00 EUR\"",
+  "triggerQuantity": 5,
+  "discountedQuantity": 2,
+  "maxOccurrence": 10,
+  "selectionMode": "Cheapest"
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountSetDescriptionAction.json b/api-specs/api/examples/CartDiscount/CartDiscountSetDescriptionAction.json
@@ -1,7 +1,7 @@
 {
   "action": "setDescription",
   "description": {
-    "en": "New Description EN",
-    "de": "New Description DE"
+    "en": "New description",
+    "de": "neue Beschreibung"
   }
-}
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountSetValidFromAction.json b/api-specs/api/examples/CartDiscount/CartDiscountSetValidFromAction.json
@@ -1,4 +1,4 @@
 {
  "action": "setValidFrom",
-  "validFrom": "2017-10-15T15:00:00.000Z"
-}
+  "validFrom": "2025-10-15T15:00:00.000Z"
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountSetValidFromAndUntilAction.json b/api-specs/api/examples/CartDiscount/CartDiscountSetValidFromAndUntilAction.json
@@ -1,5 +1,5 @@
 {
   "action": "setValidFromAndUntil",
-  "validFrom": "2017-10-15T15:00:00.000Z",
-  "validUntil": "2017-10-15T15:05:00.000Z"
-}
+  "validFrom": "2025-10-15T15:00:00.000Z",
+  "validUntil": "2025-11-15T15:05:00.000Z"
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountSetValidUntilAction.json b/api-specs/api/examples/CartDiscount/CartDiscountSetValidUntilAction.json
@@ -1,4 +1,4 @@
 {
   "action": "setValidUntil",
-  "validUntil": "2017-10-15T20:00:00.000Z"
-}
+  "validUntil": "2025-11-15T20:00:00.000Z"
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountShippingCostTarget.json b/api-specs/api/examples/CartDiscount/CartDiscountShippingCostTarget.json
@@ -0,0 +1,3 @@
+{
+  "type": "shipping"
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountTotalPriceTarget.json b/api-specs/api/examples/CartDiscount/CartDiscountTotalPriceTarget.json
@@ -0,0 +1,3 @@
+{
+  "type": "totalPrice"
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountValueAbsolute.json b/api-specs/api/examples/CartDiscount/CartDiscountValueAbsolute.json
@@ -0,0 +1,10 @@
+{
+  "type": "absolute",
+  "money": {
+    "centAmount": 2000,
+    "currencyCode": "EUR",
+    "type": "centPrecision",
+    "fractionDigits": 2
+  },
+  "applicationMode": "IndividualApplication"
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountValueAbsoluteDraft.json b/api-specs/api/examples/CartDiscount/CartDiscountValueAbsoluteDraft.json
@@ -0,0 +1,8 @@
+{
+  "type": "absolute",
+  "money": {
+    "centAmount": 2000,
+    "currencyCode": "EUR"
+  },
+  "applicationMode": "IndividualApplication"
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountValueFixed.json b/api-specs/api/examples/CartDiscount/CartDiscountValueFixed.json
@@ -0,0 +1,9 @@
+{
+  "type": "fixed",
+  "money": {
+    "centAmount": 2000,
+    "currencyCode": "EUR",
+    "type": "centPrecision",
+    "fractionDigits": 2
+  }
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountValueFixedDraft.json b/api-specs/api/examples/CartDiscount/CartDiscountValueFixedDraft.json
@@ -0,0 +1,7 @@
+{
+  "type": "fixed",
+  "money": {
+    "centAmount": 2000,
+    "currencyCode": "EUR"
+  }
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountValueGiftLineItem.json b/api-specs/api/examples/CartDiscount/CartDiscountValueGiftLineItem.json
@@ -0,0 +1,12 @@
+{
+  "type": "giftLineItem",
+  "product": {
+    "id": "{{product-id}}",
+    "typeId" : "product"
+  },
+  "variantId": 1,
+  "distributionChannel": {
+    "id": "{{channel-id}}",
+    "typeId" : "channel"
+  }
+}
diff --git a/api-specs/api/examples/CartDiscount/CartDiscountValueRelative.json b/api-specs/api/examples/CartDiscount/CartDiscountValueRelative.json
@@ -0,0 +1,4 @@
+{
+  "type": "relative",
+  "permyriad": 1000
+}
diff --git a/api-specs/api/examples/DiscountCode/DiscountCodeSetDescriptionAction.json b/api-specs/api/examples/DiscountCode/DiscountCodeSetDescriptionAction.json
@@ -1,7 +1,7 @@
 {
   "action": "setDescription",
   "description": {
-    "en": "New Description EN",
-    "de": "New Description DE"
+    "en": "New description",
+    "de": "Neue Beschreibung"
   }
-}
+}
diff --git a/api-specs/api/examples/DiscountCode/DiscountCodeSetMaxApplicationsAction.json b/api-specs/api/examples/DiscountCode/DiscountCodeSetMaxApplicationsAction.json
@@ -1,4 +1,4 @@
 {
   "action": "setMaxApplications",
-  "maxApplications": 100
-}
+  "maxApplications": 150
+}
diff --git a/api-specs/api/examples/DiscountCode/DiscountCodeSetNameAction.json b/api-specs/api/examples/DiscountCode/DiscountCodeSetNameAction.json
@@ -1,7 +1,7 @@
 {
   "action": "setName",
   "name": {
-    "en": "New Name EN",
-    "de": "New Name DE"
+    "en": "New name",
+    "de": "Neuer Name"
   }
-}
+}
diff --git a/api-specs/api/examples/DiscountCode/DiscountCodeSetValidFromAction.json b/api-specs/api/examples/DiscountCode/DiscountCodeSetValidFromAction.json
@@ -1,4 +1,4 @@
 {
   "action": "setValidFrom",
-  "validFrom": "2018-10-12T14:00:00.000Z"
+  "validFrom": "2025-10-12T14:00:00.000Z"
 }
diff --git a/api-specs/api/examples/DiscountCode/DiscountCodeSetValidFromAndUntilAction.json b/api-specs/api/examples/DiscountCode/DiscountCodeSetValidFromAndUntilAction.json
@@ -1,5 +1,5 @@
 {
   "action": "setValidFromAndUntil",
-  "validFrom": "2018-10-12T14:00:00.000Z",
-  "validUntil": "2018-10-12T14:05:00.000Z"
+  "validFrom": "2025-10-12T14:00:00.000Z",
+  "validUntil": "2025-11-12T14:05:00.000Z"
 }
diff --git a/api-specs/api/examples/DiscountCode/DiscountCodeSetValidUntilAction.json b/api-specs/api/examples/DiscountCode/DiscountCodeSetValidUntilAction.json
@@ -1,4 +1,4 @@
 {
   "action": "setValidUntil",
-  "validUntil": "2018-10-12T14:00:00.000Z"
+  "validUntil": "2025-11-12T14:00:00.000Z"
 }
diff --git a/api-specs/api/examples/ProductDiscount/ProductDiscountChangeNameAction.json b/api-specs/api/examples/ProductDiscount/ProductDiscountChangeNameAction.json
@@ -1,7 +1,7 @@
 {
   "action": "changeName",
   "name": {
-    "de": "NewProductDiscountDE",
-    "en": "NewProductDiscountEN"
+    "de": "Neuer Rabatt",
+    "en": "New discount"
   }
 }
diff --git a/api-specs/api/examples/ProductDiscount/ProductDiscountMatchQuery.json b/api-specs/api/examples/ProductDiscount/ProductDiscountMatchQuery.json
@@ -0,0 +1,26 @@
+{
+  "productId": "{{product-id}}",
+  "variantId": 1,
+  "staged": false,
+  "price": {
+    "id": "{{price-id}}",
+    "value": {
+      "currencyCode": "EUR",
+      "centAmount": 10000
+    },
+    "country": "DE",
+    "customerGroup": {
+      "typeId": "customer-group",
+      "id": "{{customer-group-id}}"
+    },
+    "tiers": [
+      {
+        "minimumQuantity": 10,
+        "value": {
+          "currencyCode": "EUR",
+          "centAmount": 9000
+        }
+      }
+    ]
+  }
+}
diff --git a/api-specs/api/examples/ProductDiscount/ProductDiscountQueryPrice.json b/api-specs/api/examples/ProductDiscount/ProductDiscountQueryPrice.json
@@ -0,0 +1,21 @@
+{
+  "id": "{{price-id}}",
+  "value": {
+    "currencyCode": "EUR",
+    "centAmount": 10000
+  },
+  "country": "DE",
+  "customerGroup": {
+    "typeId": "customer-group",
+    "id": "{{customer-group-id}}"
+  },
+  "tiers": [
+    {
+      "minimumQuantity": 10,
+      "value": {
+        "currencyCode": "EUR",
+        "centAmount": 9000
+      }
+    }
+  ]
+}
diff --git a/api-specs/api/examples/ProductDiscount/ProductDiscountSetDescriptionAction.json b/api-specs/api/examples/ProductDiscount/ProductDiscountSetDescriptionAction.json
@@ -1,7 +1,7 @@
 {
   "action": "setDescription",
   "description": {
-    "de": "New Product Discount Description DE",
-    "en": "New Product Discount Description EN"
+    "de": "Neue Beschreibung",
+    "en": "New description"
   }
-}
+}
diff --git a/api-specs/api/examples/ProductDiscount/ProductDiscountSetValidFromAction.json b/api-specs/api/examples/ProductDiscount/ProductDiscountSetValidFromAction.json
@@ -1,4 +1,4 @@
 {
   "action": "setValidFrom",
-  "validFrom": "2018-10-12T14:05:00.000Z"
+  "validFrom": "2025-10-12T14:05:00.000Z"
 }
diff --git a/api-specs/api/examples/ProductDiscount/ProductDiscountSetValidFromAndUntilAction.json b/api-specs/api/examples/ProductDiscount/ProductDiscountSetValidFromAndUntilAction.json
@@ -1,5 +1,5 @@
 {
   "action": "setValidFromAndUntil",
-  "validFrom": "2018-10-12T14:00:00.000Z",
-  "validUntil": "2018-10-12T14:05:00.000Z"
+  "validFrom": "2025-10-12T14:00:00.000Z",
+  "validUntil": "2025-11-12T14:05:00.000Z"
 }
diff --git a/api-specs/api/examples/ProductDiscount/ProductDiscountSetValidUntilAction.json b/api-specs/api/examples/ProductDiscount/ProductDiscountSetValidUntilAction.json
@@ -1,4 +1,4 @@
 {
   "action": "setValidUntil",
-  "validUntil": "2018-10-12T14:05:00.000Z"
+  "validUntil": "2025-11-12T14:05:00.000Z"
 }
diff --git a/api-specs/api/examples/ProductDiscount/ProductDiscountValueAbsolute.json b/api-specs/api/examples/ProductDiscount/ProductDiscountValueAbsolute.json
@@ -0,0 +1,11 @@
+{
+  "type": "absolute",
+  "money": [
+    {
+      "type": "centPrecision",
+      "currencyCode": "EUR",
+      "centAmount": 100,
+      "fractionDigits": 2
+    }
+  ]
+}
diff --git a/api-specs/api/examples/ProductDiscount/ProductDiscountValueAbsoluteDraft.json b/api-specs/api/examples/ProductDiscount/ProductDiscountValueAbsoluteDraft.json
@@ -0,0 +1,9 @@
+{
+  "type": "absolute",
+  "money": [
+    {
+      "currencyCode": "EUR",
+      "centAmount": 100
+    }
+  ]
+}
diff --git a/api-specs/api/examples/ProductDiscount/ProductDiscountValueExternal.json b/api-specs/api/examples/ProductDiscount/ProductDiscountValueExternal.json
@@ -0,0 +1,3 @@
+{
+  "type": "external"
+}
diff --git a/api-specs/api/examples/ProductDiscount/ProductDiscountValueRelative.json b/api-specs/api/examples/ProductDiscount/ProductDiscountValueRelative.json
@@ -0,0 +1,4 @@
+{
+  "type": "relative",
+  "permyriad": 1000
+}
diff --git a/api-specs/api/examples/StandalonePrice/StandalonePriceChangeValueAction.json b/api-specs/api/examples/StandalonePrice/StandalonePriceChangeValueAction.json
@@ -3,6 +3,6 @@
   "staged" : false,
   "value": {
     "currencyCode": "EUR",
-    "centAmount": 10000
+    "centAmount": 20000
   }
 }
diff --git a/api-specs/api/examples/StandalonePrice/StandalonePriceSetDiscountedPriceAction.json b/api-specs/api/examples/StandalonePrice/StandalonePriceSetDiscountedPriceAction.json
@@ -12,4 +12,4 @@
       "id": "{{product-discount-id}}"
     }
   }
-}
+}
diff --git a/api-specs/api/examples/StandalonePrice/StandalonePriceSetPriceTiersAction.json b/api-specs/api/examples/StandalonePrice/StandalonePriceSetPriceTiersAction.json
@@ -10,7 +10,7 @@
       }
     },
     {
-      "minimumQuantity": 1000,
+      "minimumQuantity": 150,
       "value": {
         "centAmount": 4000,
         "currencyCode": "EUR",

diff --git a/api-specs/api/examples/StandalonePrice/StandalonePriceSetValidFromAction.json b/api-specs/api/examples/StandalonePrice/StandalonePriceSetValidFromAction.json
@@ -1,4 +1,4 @@
 {
   "action": "setValidFrom",
-  "validFrom": "2019-03-30T20:30:00.000Z"
-}
+  "validFrom": "2025-03-30T20:30:00.000Z"
+}
diff --git a/api-specs/api/examples/StandalonePrice/StandalonePriceSetValidFromAndUntilAction.json b/api-specs/api/examples/StandalonePrice/StandalonePriceSetValidFromAndUntilAction.json
@@ -1,5 +1,5 @@
 {
   "action": "setValidFromAndUntil",
-  "validFrom": "2019-03-30T20:30:00.000Z",
-  "validUntil": "2019-04-21T20:30:00.000Z"
-}
+  "validFrom": "2025-03-30T20:30:00.000Z",
+  "validUntil": "2025-04-21T20:30:00.000Z"
+}
diff --git a/api-specs/api/examples/StandalonePrice/StandalonePriceSetValidUntilAction.json b/api-specs/api/examples/StandalonePrice/StandalonePriceSetValidUntilAction.json
@@ -1,4 +1,4 @@
 {
   "action": "setValidUntil",
-  "validUntil": "2019-04-21T20:30:00.000Z"
-}
+  "validUntil": "2025-04-21T20:30:00.000Z"
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,4 +12,4 @@ @@
           "id": "{{product-discount-id}}"
         }
       }
-    }
+    }