Important Information Step

This is an optional step which is useful for informing users about important info regarding their return, such as whether to keep some items / encourage users not to return certain items.

Example Flow

Example response (properies explained below):

{
  "type": "important_information",
  "nextType": "shipping_information",
  "payload": {
    "confirmButtonText": "Submit Return",
    "isSubmitReturnStep": true,
    "acknowledgementText": "I’ll ensure to pack my items carefully.",
    "categories": [
      {
        "type": "unopened_items",
        "title": "Only return unopened items!",
        "products": [
          {
            "id": "O111111"
          }
        ],
        "description": "Only pack your unopened items for return as we cannot take back any opened tins, bottles etc.",
        "quantitySelector": {
          "label": "cans",
          "title": "No. of unopened items",
          "isEnabled": true,
          "quantityNote": "Please DO NOT return opened cans.",
          "invalidQuantities": {
            "1": "Shipping issues prevent returning a single can."
          }
        }
      },
      {
        "type": "pack_items",
        "title": "Pack your items carefully",
        "products": [
          {
            "id": "O333333"
          }
        ],
        "description": "Please ensure items are well-sealed and secure to prevent any spills, as we need to test it."
      },
      {
        "type": "keep_items",
        "title": "Keep these items",
        "products": [
          {
            "id": "O444444"
          }
        ],
        "description": "You will still receive a refund/replacement but you don’t need to send these items back."
      }
    ]
  }
}

Properties

* indicates required field

Field	Description
`type`*	The current `step_type`
`nextType`*	The next `step_type` in the journey
`payload`*	Contains the details of the important information
`payload.confirmButtonText`*	The text displayed in the confirmation button.
`payload.isSubmitReturnStep`	Indicates whether this step will submit the return.
`payload.acknowledgementText`	When provided, a required checkbox labelled by this text is present.
`payload.categories`*	A list of categories for the important information.
`payload.categories[].type`*	The type of the category (`unopened_items`, `pack_items`, `keep_items`)
`payload.categories[].title`*	The title of the category.
`payload.categories[].description`*	The description of the category.
`payload.categories[].products`*	A list of products relevant to the category.
`payload.categories[].products[].id`*	The unique identifier for the product.
`payload.categories[].quantitySelector`	The quantity selector details for the category, if applicable.
`payload.categories[].quantitySelector.label`	Labels the selected quantity, e.g. 2x `cans`.
`payload.categories[].quantitySelector.title`	The title for the quantity selector.
`payload.categories[].quantitySelector.isEnabled`	Indicates whether the quantity selector is enabled.
`payload.categories[].quantitySelector.quantityNote`	Default text displayed when the selected quantity is valid.
`payload.categories[].quantitySelector.invalidQuantities`	A map of invalid quantities and their reasons. The key being the invalid quantity, and the value being the reason.

selected_products example

[
    {
        "id": "O111111",
        "name": "Cloudrunner 2",
        "size": "UK 9",
        "image": "some-image-url.jpg",
        "price": {
          "amount": 149.99,
          "currencyCode": "GBP"
        },
        "colour": "Black",
        "quantity": 5,
        "returnQuantity": 2, // the quantity the user wishes to return
        "returnReason": {
            "id": "arrived-damaged",
            "text": "Item arrived damaged"
        },
        "attachments": ["attachment1.jpg", "attachment2.jpg"],
        "returnOption": {
            "text": "Standard refund",
            "type": "refund",
            "description": "Timing depends on your original payment."
        }
    }
]