Overview: 

The JSON structure outlined in this doc can be used to ingest customer defined item lists as part of a full survey or inventory of a move. This can include both furniture and packing materials. This doc outlines the necessary data structure that must be adhered to in order to properly ingest this. This is an addendum to the main Developer API endpoint and the Developer API - Add Survey payloads. 

Prerequisites: 

Developer API Endpoint: 

• The Developer API must be configured. Please see main Developer API Endpoint for more details.
• Payloads must have lead information and survey information, you can not submit survey information alone to this endpoint. 

Developer API - Add Survey Endpoint: 

• The Developer API - Add Survey Endpoint must be configured in the lead provider portal. Please see Developer API - Add Survey Endpoint for more details. 
• Payload must have project_uuid or customer_email within the payload. 

How to Debug Survey Processing: 

Please see Debugging Inbound Leads - Link. Survey processing logs will be surfaced within the associated endpoints. 

Overall Survey Structure: 

Warning: This doc is long and very technical. It is intended as a reference for developers working to integrate survey payloads into Supermove. 

"survey":[
    {
      "name": "Living Room",
      "description": "Large room with fireplace.",
      "items": [
        {
          "name": "Dishpack",
          "description": "PBO Dishpack. This is a example packing material cost",
          "take_count": 2,
          "weight": 400,
          "volume": 57,
          "price": 1150
        },
        {
          "name": "Yellow Chair",
          "description": "Very scratched up.",
          "take_count": 2,
          "volume": 2000
        },
        {
          "name": "Media Console",
          "description": "Mid Mod",
          "take_count": 1
        }
      ]
    },
    {
      "name": "Master Bedroom",
      "description": "Straight back on the right",
      "items": [
        {
          "name": "King bed frame",
          "description": "from IKEA",
          "take_count": 1
        },
        {
          "name": "dressers",
          "description": "from IKEA",
          "take_count": 2
        }
      ]
    }
  ]

Note: All fields are optional unless otherwise stated in the description.

Collection Object:

{
  "name": "Living Room",
  "description": "Large room with fireplace.",
  "items": [
    {
      "name": "Dishpack",
      "description": "PBO Dishpack. This is a example packing material cost",
      "take_count": 2,
      "weight": 400,
      "volume": 57,
      "price": 1150
    },
    {
      "name": "Yellow Chair",
      "description": "Very scratched up.",
      "take_count": 2,
      "volume": 2000
    },
    {
      "name": "Media Console",
      "description": "Mid Mod",
      "take_count": 1
    }
  ]
},

Note: All fields are optional unless otherwise stated in the description.

Item Object:

{
  "name": "Dishpack",
  "description": "PBO Dishpack. This is a example packing material cost",
  "take_count": 2,
  "weight": 400,
  "volume": 57,
  "price": 1150
}

Note: All fields are optional unless otherwise stated in the description.