{"_id":"56fb6e4d0023171700b95fc2","__v":9,"category":{"_id":"56a83b989ec7660d002e07c2","pages":["56a83b999ec7660d002e07c4","56a83c1011d0390d00a3d107","56a83c6ded52570d0001a1e8","56a83cba70a9440d00ef5ef9","56a83f1470a9440d00ef5efb","56a83f5b70a9440d00ef5efd","56a97284f834950d0037b35e","56a973312bb3910d000ee937"],"project":"56a83b979ec7660d002e07be","version":"56a83b989ec7660d002e07c1","__v":8,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-27T03:38:00.961Z","from_sync":false,"order":1,"slug":"documentation","title":"General"},"user":"56a975c12d8fd90d0036eed0","parentDoc":null,"version":{"_id":"56a83b989ec7660d002e07c1","project":"56a83b979ec7660d002e07be","__v":9,"createdAt":"2016-01-27T03:38:00.333Z","releaseDate":"2016-01-27T03:38:00.333Z","categories":["56a83b989ec7660d002e07c2","56a83c282036420d002d21e1","56a96de8f834950d0037b35a","56a9706013a69a0d00a778c3","56a970ec2d8fd90d0036eec7","56a971a62bb3910d000ee934","56a973372d8fd90d0036eece","56a978dc2bb3910d000ee93f","571d5ae118b3c10e003e55cd"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Beta","version_clean":"1.0.0","version":"1.0"},"project":"56a83b979ec7660d002e07be","githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-30T06:12:29.183Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"<div class=\"corner-ribbon top-left sticky blue\"><a style=\"color: white;\" href=\"https://pathfinder.readme.io/blog/pathfinder-now-in-public-beta\">Public Beta!</a></div>\n\nPathfinder uses commodities, clusters, and transports to help users model their routing problem. Commodities are generally items that are picked up and dropped off by transports. Commodities might include pizzas, people, or dirty laundry. Transports move the commodities and might include cars, buses, or people walking. Clusters help users organize their transports and commodities into similar groups that are routed together. A cluster may also contain subclusters which let you even further group transports and commodities.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Commodities\"\n}\n[/block]\nA commodity represents a real life item that needs to be picked up and dropped off at two different locations. Every commodity has eight fields as described below.\n\n# Fields\n1. Start Latitude - The latitude that the commodity will be picked up at\n2. Start Longitude - The longitude that the commodity will be picked up at\n3. End Latitude - The latitude that the commodity will be dropped off at\n4. End Longitude - The longitude that the commodity will be dropped off at\n5. Status - Gives information on the status of the commodity, this includes inactive, waiting, picked up, dropped off, or cancelled\n6. Metadata - Information you provide to Pathfinder in the form of JSON to help us route your commodities better\n7. Transport - The transport moving the commodity\n8. Route - If the commodity is picked up by a transport the route will tell you the stops taken by its transport while getting to its destination\n\n# Statuses\n1. Inactive - Transports are not currently being routed to pick up this commodity. This is the default state when a commodity is created.\n2. Waiting - The commodity is currently waiting for a transport to pick it up.\n3. Picked up - The commodity is currently being moved by a transport to its destination.\n4. Dropped off - The commodity was dropped off by a transport at its destination.\n5. Cancelled - The commodity is no longer going to have transports pick it up.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Clusters\"\n}\n[/block]\nClusters are made up of commodities, transports, and subclusters. Each cluster is independently routed of its parent and subclusters, meaning only the transports will only pick up commodities in the same cluster. Clusters are there for you to group commodities and transports into a logical hierarchy. They could be based on geographic location, transport strategy, or anything your mind can imagine. You are in control of which commodities and transports are grouped into each cluster. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Transports\"\n}\n[/block]\nTransports pick up and drop off commodities at their intended locations. They can move commodities by any means and can start at any geographic location. Transports have six fields as described below.\n\n# Fields\n1. Latitude - The current latitude of the transport\n2. Longitude - The current longitude of the transport\n3. Status - Gives information on the status of the transport, such as online and offline\n4. Metadata - Information you provide to Pathfinder in the form of JSON to help us route your transports better\n5. Commodities - List of commodities currently being moved by this transport\n6. Route - A route describing the locations of the pick up and drop off locations of the commodities  in the best order found by Pathfinder.\n\n# Statuses\n1. Offline - The default status representing the transport not being available to move commodities.\n2. Online - The transport is available to move commodities.","excerpt":"","slug":"commodities-clusters-and-transports","type":"basic","title":"Models"}
<div class="corner-ribbon top-left sticky blue"><a style="color: white;" href="https://pathfinder.readme.io/blog/pathfinder-now-in-public-beta">Public Beta!</a></div> Pathfinder uses commodities, clusters, and transports to help users model their routing problem. Commodities are generally items that are picked up and dropped off by transports. Commodities might include pizzas, people, or dirty laundry. Transports move the commodities and might include cars, buses, or people walking. Clusters help users organize their transports and commodities into similar groups that are routed together. A cluster may also contain subclusters which let you even further group transports and commodities. [block:api-header] { "type": "basic", "title": "Commodities" } [/block] A commodity represents a real life item that needs to be picked up and dropped off at two different locations. Every commodity has eight fields as described below. # Fields 1. Start Latitude - The latitude that the commodity will be picked up at 2. Start Longitude - The longitude that the commodity will be picked up at 3. End Latitude - The latitude that the commodity will be dropped off at 4. End Longitude - The longitude that the commodity will be dropped off at 5. Status - Gives information on the status of the commodity, this includes inactive, waiting, picked up, dropped off, or cancelled 6. Metadata - Information you provide to Pathfinder in the form of JSON to help us route your commodities better 7. Transport - The transport moving the commodity 8. Route - If the commodity is picked up by a transport the route will tell you the stops taken by its transport while getting to its destination # Statuses 1. Inactive - Transports are not currently being routed to pick up this commodity. This is the default state when a commodity is created. 2. Waiting - The commodity is currently waiting for a transport to pick it up. 3. Picked up - The commodity is currently being moved by a transport to its destination. 4. Dropped off - The commodity was dropped off by a transport at its destination. 5. Cancelled - The commodity is no longer going to have transports pick it up. [block:api-header] { "type": "basic", "title": "Clusters" } [/block] Clusters are made up of commodities, transports, and subclusters. Each cluster is independently routed of its parent and subclusters, meaning only the transports will only pick up commodities in the same cluster. Clusters are there for you to group commodities and transports into a logical hierarchy. They could be based on geographic location, transport strategy, or anything your mind can imagine. You are in control of which commodities and transports are grouped into each cluster. [block:api-header] { "type": "basic", "title": "Transports" } [/block] Transports pick up and drop off commodities at their intended locations. They can move commodities by any means and can start at any geographic location. Transports have six fields as described below. # Fields 1. Latitude - The current latitude of the transport 2. Longitude - The current longitude of the transport 3. Status - Gives information on the status of the transport, such as online and offline 4. Metadata - Information you provide to Pathfinder in the form of JSON to help us route your transports better 5. Commodities - List of commodities currently being moved by this transport 6. Route - A route describing the locations of the pick up and drop off locations of the commodities in the best order found by Pathfinder. # Statuses 1. Offline - The default status representing the transport not being available to move commodities. 2. Online - The transport is available to move commodities.