🚀 Update staging

specification/paths/Returns-v1-shops-shop_id-reasons-return_reason_id.json

@@ -73,27 +73,13 @@
                         "is_required": true
                       },
                       {
-                        "code": "unexpected-quality",
-                        "is_required": false
+                        "code": "still-sealed",
+                        "is_required": false,
+                        "no_note": "This product cannot be returned after it was unsealed. Proceeding will lead to a rejected return request."
                       }
                     ],
                     "items": {
-                      "type": "object",
-                      "additionalProperties": false,
-                      "required": [
-                        "code",
-                        "is_required"
-                      ],
-                      "properties": {
-                        "code": {
-                          "type": "string",
-                          "description": "The code of the shop return reason"
-                        },
-                        "is_required": {
-                          "type": "boolean",
-                          "description": "Indication whether a consumer is required to answer this question related to the selected return reason"
-                        }
-                      }
+                      "$ref": "#/components/schemas/ShopReturnReasonQuestion"
                     }
                   }
                 }

specification/schemas.json

@@ -566,6 +566,9 @@
   "ShopReturnReason": {
     "$ref": "./schemas/return-reasons/ShopReturnReason.json"
   },
+  "ShopReturnReasonQuestion": {
+    "$ref": "./schemas/return-reasons/ShopReturnReasonQuestion.json"
+  },
   "ShopReturnReasonResponse": {
     "$ref": "./schemas/return-reasons/ShopReturnReasonResponse.json"
   },
@@ -575,6 +578,9 @@
   "ReturnQuestion": {
     "$ref": "./schemas/return-questions/ReturnQuestion.json"
   },
+  "ReturnQuestionAnswerType": {
+    "$ref": "./schemas/return-questions/ReturnQuestionAnswerType.json"
+  },
   "ReturnQuestionResource": {
     "$ref": "./schemas/return-questions/ReturnQuestionResource.json"
   },

specification/schemas/hooks/HookTrigger.json

@@ -52,7 +52,8 @@
             "type": [
               "string",
               "number",
-              "array"
+              "array",
+              "object"
             ],
             "example": 1000
           }

specification/schemas/return-orders/ItemReasonQuestion.json

@@ -11,7 +11,10 @@
       "description": "A code that identifies the question for the return of this item. See the <a href=\"/#tag/ReturnQuestions/paths/~1returns~1v1~1questions/get\">return-question</a> `code` attribute."
     },
     "answer": {
-      "type": "string",
+      "type": [
+        "string",
+        "boolean"
+      ],
       "description": "The answer to the question referenced by the code attribute."
     }
   }

specification/schemas/return-questions/CreateReturnQuestionRequest.json

@@ -25,6 +25,9 @@
                   }
                 }
               ]
+            },
+            "answer_type": {
+              "$ref": "#/components/schemas/ReturnQuestionAnswerType"
             }
           }
         }

specification/schemas/return-questions/PatchReturnQuestionRequest.json

@@ -20,6 +20,9 @@
                   }
                 }
               ]
+            },
+            "answer_type": {
+              "$ref": "#/components/schemas/ReturnQuestionAnswerType"
             }
           }
         }

specification/schemas/return-questions/ReturnQuestion.json

@@ -8,6 +8,9 @@
         "attributes": {
           "type": "object",
           "additionalProperties": false,
+          "required": [
+            "answer_type"
+          ],
           "properties": {
             "code": {
               "type": "string",
@@ -36,6 +39,9 @@
                 }
               ],
               "description": "The value of the ``Accept-Language`` header determines the language in which the description is returned. If the ``Accept-Language`` header is missing, we default to ``en-GB``. If the User has the ``return_questions.manage`` scope and the ``Accept-Language`` header is set to ``*``, all descriptions will be returned in a key/value object."
+            },
+            "answer_type": {
+              "$ref": "#/components/schemas/ReturnQuestionAnswerType"
             }
           }
         }

specification/schemas/return-questions/ReturnQuestionAnswerType.json

@@ -0,0 +1,9 @@
+{
+    "type": "string",
+    "enum": [
+      "string",
+      "boolean"
+    ],
+    "example": "string",
+    "description": "The type of answer expected for this question."
+}

specification/schemas/return-reasons/ShopReturnReason.json

@@ -47,6 +47,7 @@
                 "required": [
                   "code",
                   "description",
+                  "answer_type",
                   "is_required"
                 ],
                 "properties": {
@@ -56,6 +57,9 @@
                   "description": {
                     "type": "string"
                   },
+                  "answer_type": {
+                    "$ref": "#/components/schemas/ReturnQuestionAnswerType"
+                  },
                   "is_required": {
                     "type": "boolean"
                   }

specification/schemas/return-reasons/ShopReturnReasonQuestion.json

@@ -0,0 +1,35 @@
+{
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "code",
+    "is_required"
+  ],
+  "properties": {
+    "code": {
+      "type": "string",
+      "description": "The code of the shop return question",
+      "example": "what-size"
+    },
+    "is_required": {
+      "type": "boolean",
+      "description": "Indication whether a consumer is required to answer this question related to the selected return reason",
+      "example": true
+    },
+    "answer_type": {
+      "$ref": "#/components/schemas/ReturnQuestionAnswerType"
+    },
+    "yes_note": {
+      "type": "string",
+      "maxLength": 255,
+      "description": "A note to show the user when they answer a `boolean` type question with `true`. Will be shown in the return portal.",
+      "example": "This product can't be returned after its been used. Proceeding will lead to a rejected return request."
+    },
+    "no_note": {
+      "type": "string",
+      "maxLength": 255,
+      "description": "A note to show the user when they answer a `boolean` type question with `false`. Will be shown in the return portal.",
+      "example": "This product cannot be returned after it was unsealed. Proceeding will lead to a rejected return request."
+    }
+  }
+}