Shipping Information Step

Displays shipping information once the return has been submitted.

Example response (properies explained below):

{
  "type": "shipping_information",
  "nextType": null,
  "payload": {
    "status": "return_submitted",
    "confirmButtonText": "Return to chat",
    "returnInstructions": [
      {
        "text": "Securely pack these items. If available, please use original packaging.",
        "imageUrls": ["https://example/image1.png", "https://example/image2.png"]
      },
      {
        "text": "Print the packing slip and include it in your package.",
        "downloadButton": {
          "url": "https://pdfobject.com/pdf/sample.pdf",
          "text": "Packing Slip"
        }
      },
      {
        "text": "Organise delivery with your preferred carrier to the Return address:",
        "subText": "Vantiva, 439 New Sanford Road, Door 3, La Vergne, Tennessee 37086, United States of America"
      },
      {
        "text": "We'll issue your refund, gift card, or exchange once we verify your return is in transit."
      }
    ]
  }
}

Properties

* indicates required field

Field	Description
`type`*	The current `step_type`
`nextType`	The next `step_type` in the journey. If `null`, it is assumed this is the final step.
`payload`*
`payload.status`*	The status of the order/return.
`payload.confirmButtonText`*	The text displayed in the confirmation button.
`payload.returnInstructions`*	A list of return instructions.
`payload.returnInstructions[].text`*	The text description of the return instruction.
`payload.returnInstructions[].imageUrls`	A list of product image URLs related to the return instruction, if applicable.
`payload.returnInstructions[].subText`	Additional text related to the return instruction, if applicable.
`payload.returnInstructions[].downloadButton`	If provided, the return instruction will contain a download button.
`payload.returnInstructions[].downloadButton.url`	The URL for the download button.
`payload.returnInstructions[].downloadButton.text`	The text for the download button.