Overview

This is the main endpoint that syncs a project with Supermove. A project consists of many job objects where each job represents a single segment of work for a crew.

A project is uniquely identified by its identifier. If the system does not find a matching identifier, it will perform a CREATE action and a new instance will be created. If it does find a matching identifier, it will perform an UPDATE and update the existing object.

The id is provided alongside your API key (via email) and indicates the name of your organization on Supermove. This is used to validate your API request.

Resources described below are outlined here.

Request

An example request for creating a new project on the supermove-sandbox-demo account. Feel free to copy this payload and try the request yourself.

The request URL: https://api.supermove.co/v1/projects/sync

{
	  "id": "supermove-sandbox-demo",
		"project": {
				"identifier": "B10000",
				"name": "Apple Inc Weekly",
				"description": "Recurring commercial move with Apple, Inc.",
				"customer": {
				  "first_name": "Johnny",
				  "last_name": "Doe",
				  "phone_number": "1112223333",
				  "email": "[email protected]"
				},
				"jobs": [
				  {
						"identifier": "APP-001",
						"is_primary": true,
						"job_type": {
							"identifier": "local-move-move"
						},
            "status": "BOOKED",
				    "name": "Packing First Day",
						"move_size": "1 Bedroom",
						"crew_size": "3",
						"date": "2020-01-20",
						"start_time_1": "0900",
						"start_time_2": "1000",
						"additional_notes": "Make sure to take the 10 boxes",
						"dispatch_notes": "Might need to include a 2nd foreman",
						"office_notes": "Should call only after 5pm on weekdays",
						"note_to_customer": "We will be bringing two trucks to transport the piano",
						"referral_source": "GOOGLE",
						"referral_details": "",
						"locations": [
							{
								"address": "123 Main St.",
								"city": "Phoenix",
								"zip_code": "12345",
								"latitude": 37.5676217,
								"longitude": -122.3278207,
								"unit": "101",
								"floor_number": 2,
								"notes": "Long walk up the stairs",
								"has_elevator": true,
								"has_long_walk": false,
								"stair_count": 1
							}
						],
						"organization": {
							"identifier": "supermove-contractor-A"
						}
				  } 
				]
    }
}

Response

A successful response from the server will send back the project and its unique identifier.