Updated API from documentation release

commercetools · Oct 10, 2024 · 92698a8 · 92698a8
1 parent 7db26b7
commit 92698a8
Show file tree

Hide file tree

Showing 8 changed files with 94 additions and 10 deletions.
diff --git a/api-specs/api/examples/inventory-create.example.json b/api-specs/api/examples/inventory-create.example.json
@@ -1,5 +1,5 @@
 {
+  "key": "ie-key-1",
   "sku": "sku_GIRLS_CREW_variant1_1421832124541",
-  "quantityOnStock": 4,
-  "availableQuantity": 4
+  "quantityOnStock": 4
 }
diff --git a/api-specs/api/examples/order-import-create.example.json b/api-specs/api/examples/order-import-create.example.json
@@ -0,0 +1,74 @@
+{
+  "type": "Order",
+  "id": "35f816ea-7770-4623-895b-7a6454e22e8a",
+  "version": 1,
+  "createdAt": "2024-10-09T23:12:14.264Z",
+  "lastModifiedAt": "2024-10-09T23:12:14.264Z",
+  "lastModifiedBy": {
+    "clientId": "qnfzsm5-qNfCGwHiRgI03Emc",
+    "isPlatformClient": false
+  },
+  "createdBy": {
+    "clientId": "qnfzsm5-qNfCGwHiRgI03Emc",
+    "isPlatformClient": false
+  },
+  "orderNumber": "100000001",
+  "totalPrice": {
+    "type": "centPrecision",
+    "currencyCode": "EUR",
+    "centAmount": 4200,
+    "fractionDigits": 2
+  },
+  "orderState": "Open",
+  "syncInfo": [],
+  "returnInfo": [],
+  "taxMode": "External",
+  "inventoryMode": "None",
+  "taxRoundingMode": "HalfEven",
+  "taxCalculationMode": "LineItemLevel",
+  "origin": "Customer",
+  "shippingMode": "Single",
+  "shipping": [],
+  "lineItems": [],
+  "customLineItems": [
+    {
+      "id": "fc864da7-0cc9-438f-9626-4d5907ea51c9",
+      "name": {
+        "en": "Name EN",
+        "de": "Name DE"
+      },
+      "money": {
+        "type": "centPrecision",
+        "currencyCode": "EUR",
+        "centAmount": 4200,
+        "fractionDigits": 2
+      },
+      "slug": "mySlug",
+      "quantity": 1,
+      "discountedPricePerQuantity": [],
+      "state": [
+        {
+          "quantity": 1,
+          "state": {
+            "typeId": "state",
+            "id": "7e3b7f8b-74c1-4d01-8335-0197ba1de6e9"
+          }
+        }
+      ],
+      "totalPrice": {
+        "type": "centPrecision",
+        "currencyCode": "EUR",
+        "centAmount": 4200,
+        "fractionDigits": 2
+      },
+      "taxedPricePortions": [],
+      "perMethodTaxRate": [],
+      "priceMode": "Standard"
+    }
+  ],
+  "transactionFee": false,
+  "discountCodes": [],
+  "directDiscounts": [],
+  "itemShippingAddresses": [],
+  "refusedGifts": []
+}
diff --git a/api-specs/api/examples/order-import.example.json b/api-specs/api/examples/order-import.example.json
@@ -1,7 +1,22 @@
 {
   "orderNumber": "100000001",
   "totalPrice": {
-    "centAmount": 1000,
+    "centAmount": 4200,
     "currencyCode": "EUR"
-  }
+  },
+  "lineItems": [],
+  "customLineItems": [
+    {
+      "name": {
+        "en": "Name EN",
+        "de": "Name DE"
+      },
+      "quantity": 1,
+      "money": {
+        "currencyCode": "EUR",
+        "centAmount": 4200
+      },
+      "slug": "mySlug"
+    }
+  ]
 }
diff --git a/api-specs/api/examples/product-tailoring-list.example.json b/api-specs/api/examples/product-tailoring-list.example.json
@@ -6,7 +6,6 @@
     {
       "id": "207ee692-6002-4570-a78c-d15e7adbebbb",
       "version": 2,
-      "versionModifiedAt": "2023-09-01T13:41:50.662Z",
       "createdAt": "2023-09-01T13:26:10.475Z",
       "lastModifiedAt": "2023-09-01T13:26:10.475Z",
       "lastModifiedBy": {
@@ -85,7 +84,6 @@
     {
       "id": "207ee692-6002-4570-a78c-d15e7adbecc",
       "version": 2,
-      "versionModifiedAt": "2023-09-01T13:42:50.662Z",
       "createdAt": "2023-09-01T13:27:10.475Z",
       "lastModifiedAt": "2023-09-01T14:26:10.475Z",
       "lastModifiedBy": {

diff --git a/api-specs/api/examples/product-tailoring-updated.example.json b/api-specs/api/examples/product-tailoring-updated.example.json
@@ -1,7 +1,6 @@
 {
   "id": "207ee692-6002-4570-a78c-d15e7adbebbb",
   "version": 2,
-  "versionModifiedAt": "2023-09-01T13:41:50.662Z",
   "createdAt": "2023-09-01T13:26:10.475Z",
   "lastModifiedAt": "2023-09-01T13:26:10.475Z",
   "lastModifiedBy": {

diff --git a/api-specs/api/examples/product-tailoring-with-image-processing-warning.example.json b/api-specs/api/examples/product-tailoring-with-image-processing-warning.example.json
@@ -1,7 +1,6 @@
 {
   "id": "207ee692-6002-4570-a78c-d15e7adbebbb",
   "version": 2,
-  "versionModifiedAt": "2023-09-01T13:41:50.662Z",
   "createdAt": "2023-09-01T13:26:10.475Z",
   "lastModifiedAt": "2023-09-01T13:26:10.475Z",
   "lastModifiedBy": {

diff --git a/api-specs/api/examples/product-tailoring.example.json b/api-specs/api/examples/product-tailoring.example.json
@@ -1,7 +1,6 @@
 {
   "id": "207ee692-6002-4570-a78c-d15e7adbebbb",
   "version": 2,
-  "versionModifiedAt": "2023-09-01T13:41:50.662Z",
   "createdAt": "2023-09-01T13:26:10.475Z",
   "lastModifiedAt": "2023-09-01T13:26:10.475Z",
   "lastModifiedBy": {

diff --git a/api-specs/api/resources/orders.raml b/api-specs/api/resources/orders.raml
@@ -77,7 +77,7 @@ post:
       201:
         body:
           application/json:
-            example: !include ../examples/order.example.json
+            example: !include ../examples/order-import-create.example.json
             type: Order
 /quotes:
   (methodName): orderQuote