Structure de base (ShipmentModel, Shipment et Vehicle)

L'objectif de l'API Route Optimization est de planifier des itinéraires pour une flotte de véhicules afin de visiter un ensemble de lieux. L'objet OptimizeToursRequest décrit les propriétés de ces véhicules et de ces emplacements. Il s'agit de la structure principale du corps de la requête de chaque point de terminaison.

La structure de base de l'objet OptimizeToursRequest est la suivante :

• Le champ model contient un message ShipmentModel qui contient deux champs clés :
  • Un champ shipments, qui contient un ou plusieurs messages Shipment.
  • Un champ vehicles, qui contient un ou plusieurs messages Vehicle.

Ce document décrit les types de messages suivants :

• ShipmentModel : contient la liste des envois, des véhicules disponibles et d'autres objets décrivant leurs relations.
• Shipment : décrit les lieux à visiter par un véhicule. Elles peuvent représenter des colis réels à récupérer et à livrer, ou des lieux où le conducteur du véhicule effectue un service.
• Vehicle : décrit le moyen de transport entre les lieux d'expédition. Chaque véhicule correspond à un véhicule réel ou à une personne se déplaçant à pied.

ShipmentModel

ShipmentModel contient les éléments du problème d'optimisation d'itinéraire. Il contient un ensemble d'envois pouvant être effectués par un ensemble de véhicules, tout en tenant compte des contraintes et en minimisant le coût global.

Le tableau ci-dessous décrit certaines propriétés pertinentes de ShipmentModel :

Consultez la documentation de référence pour obtenir la liste complète des propriétés de ShipmentModel.

Exemple d'utilisation de la fonction ShipmentModel

Dans cet exemple, vous proposez un service de garde de chiens et vous commencez à créer votre requête. Vous définirez les livraisons et les véhicules plus tard, mais vous souhaitez commencer par définir vos horaires d'ouverture et votre coût opérationnel horaire.

Pour cet exemple, les valeurs de la propriété ShipmentModel de votre requête sont les suivantes :

Voici un exemple de code d'un message ShipmentModel intégrant les valeurs de l'exemple de scénario.

{
  "model": {
    "shipments": [
      ...
    ],
    "vehicles": [
      ...
    ],
   "globalStartTime": "2024-02-13T00:00:00.000Z",
   "globalEndTime": "2024-02-14T06:00:00.000Z"
  }
}

Shipment

Le type de message Shipment définit la structure des propriétés d'un envoi pouvant être livré ou d'un service pouvant être effectué sur un itinéraire.

Comme illustré dans le schéma :

• Un message Shipment contient toutes les informations d'un envoi ou d'un service réel.
• Tous les messages Shipment sont spécifiés dans le champ shipments.
• Le champ shipments contient un ou plusieurs messages Shipment.

Un message Shipment nécessite au moins un objet pickups ou deliveries. La définition de ces objets est la suivante :

• pickups définit le lieu de retrait d'un envoi.
• deliveries définit le lieu de livraison d'un envoi.
• pickups et deliveries contiennent un type de message VisitRequest qui définit les emplacements et d'autres détails.

Le tableau suivant décrit les différents scénarios en fonction de la configuration de pickups et deliveries dans un message Shipment.

Consultez la documentation de référence pour obtenir la liste complète des propriétés de Shipment.

Exemple d'utilisation de la fonction Shipment

Dans cet exemple, vous proposez un service de garde de chiens à la journée. Vous allez chercher les chiens chez eux et les amenez à votre garderie. Vous souhaitez définir le lieu de prise en charge de deux chiens et définir leur lieu de livraison sur votre établissement :

• La maison du premier chien se trouve dans la Coit Tower, à San Francisco. Les coordonnées de cet emplacement sont : latitude 37.8024 et longitude -122.4058.
• La maison du deuxième chien se trouve dans le South Sunset Playground Park, à San Francisco. Les coordonnées de cet emplacement sont : latitude 37.7359 et longitude -122.5011.
• Votre garderie pour chiens se trouve à Mission Dolores Park, San Francisco. Les coordonnées de cet emplacement sont : latitude 37.759773 et longitude -122.427063.

Voici un exemple de code d'un message Shipment, où l'objet shipments contient deux types de messages Shipment avec les exemples de coordonnées.

{
  "model": {
    "shipments": [
      {
        "pickups": [
          {
            "arrivalLocation": {
              "latitude": 37.8024,
              "longitude": -122.4058
            }
          }
        ],
        "deliveries": [
          {
            "arrivalLocation": {
              "latitude": 37.759773,
              "longitude": -122.427063
            }
          }
        ]
      },
      {
        "pickups": [
          {
            "arrivalLocation": {
              "latitude": 37.7359,
              "longitude": -122.5011
            }
          }
        ],
        "deliveries": [
          {
            "arrivalLocation": {
              "latitude": 37.759773,
              "longitude": -122.427063
            }
          }
        ]
      }
    ],
    "vehicles": [
    ...
    ]
  }
}

Vehicle

Le type de message Vehicle définit la structure des propriétés d'un véhicule pouvant effectuer un envoi sur un itinéraire.

Comme illustré dans le schéma :

• Un message Vehicle contient toutes les informations d'un véhicule réel.
• Tous les messages Vehicle sont spécifiés dans le champ vehicles.
• Le champ vehicles contient plusieurs messages Vehicle.

Le tableau suivant décrit certaines propriétés pertinentes d'un Vehicle.

Exemple d'utilisation de la fonction Vehicle

Dans cet exemple, vous proposez un service de garde de chiens et vous souhaitez définir l'emplacement de votre véhicule au début et à la fin de la journée, ainsi que la quantité de carburant qu'il consomme. Vous n'avez pas besoin de spécifier les heures de travail du véhicule, car elles correspondent aux heures que vous avez définies dans les propriétés globalStartTime et globalEndTime de l'objet ShipmentModel.

Pour cet exemple, les valeurs de la propriété Vehicle de votre requête sont les suivantes :

Voici un exemple de code d'un message Vehicle intégrant les valeurs de l'exemple de scénario.

{
  "model": {
    "shipments": [
    ...
    ],
    "vehicles": [
      {
        "startLocation": {
          "latitude": 37.759773,
          "longitude": -122.427063
        },
        "endLocation": {
          "latitude": 37.759773,
          "longitude": -122.427063
        },
        "costPerHour": 27
      }
    ]
  }
}

Consultez la documentation de référence pour obtenir la liste complète des propriétés de Vehicle.

Exemple de requête complet

L'exemple de code suivant fournit un exemple de requête complet, combinant les exemples ShipmentModel, Shipment et Vehicle présentés dans ce document.

{
  "model": {
    "shipments": [
      {
        "pickups": [
          {
            "arrivalLocation": {
              "latitude": 37.8024,
              "longitude": -122.4058
            }
          }
        ],
        "deliveries": [
          {
            "arrivalLocation": {
              "latitude": 37.759773,
              "longitude": -122.427063
            }
          }
        ]
      },
      {
        "pickups": [
          {
            "arrivalLocation": {
              "latitude": 37.7359,
              "longitude": -122.5011
            }
          }
        ],
        "deliveries": [
          {
            "arrivalLocation": {
              "latitude": 37.759773,
              "longitude": -122.427063
            }
          }
        ]
      }
    ],
    "vehicles": [
      {
        "startLocation": {
          "latitude": 37.759773,
          "longitude": -122.427063
        },
        "endLocation": {
          "latitude": 37.759773,
          "longitude": -122.427063
        },
        "costPerHour": 27
      }
    ],
    "globalStartTime": "2024-02-13T00:00:00.000Z",
    "globalEndTime": "2024-02-14T06:00:00.000Z"
  }
}