Struktura podstawowa (model dostawy, dostawa i pojazd)

Celem interfejsu Route Optimization API jest planowanie tras dla floty pojazdów, które mają odwiedzić określone lokalizacje. Obiekt OptimizeToursRequest opisuje właściwości tych pojazdów i lokalizacji oraz jest podstawową strukturą treści żądania każdego punktu końcowego.

Podstawowa struktura obiektu OptimizeToursRequest wygląda tak:

• Pole model zawiera komunikat ShipmentModel, który zawiera 2 pola klucza:
  • Jedno pole shipments, które zawiera co najmniej 1 komunikat Shipment.
  • Jedno pole vehicles, które zawiera co najmniej 1 komunikat Vehicle.

W tym dokumencie opisano te typy wiadomości:

• ShipmentModel: zawiera listę przesyłek, dostępnych pojazdów i innych obiektów, które opisują ich relacje.
• Shipment: opisuje lokalizacje, które ma odwiedzić pojazd. Mogą reprezentować rzeczywiste paczki do odebrania i dostarczenia lub miejsca, w których kierowca pojazdu wykonuje usługę.
• Vehicle: opisuje środek transportu między lokalizacjami przesyłki. Każdy pojazd odpowiada rzeczywistemu pojazdowi lub osobie poruszającej się pieszo.

ShipmentModel

ShipmentModel zawiera elementy problemu optymalizacji trasy. Zawiera zestaw przesyłek, które mogą być realizowane przez zestaw pojazdów, przy uwzględnieniu ograniczeń i minimalizacji ogólnych kosztów.

W tabeli poniżej opisano niektóre istotne właściwości elementu ShipmentModel:

Pełną listę właściwości w ShipmentModel znajdziesz w dokumentacji.

ShipmentModel – przykład

W tym przykładzie prowadzisz hotel dla psów i zaczynasz tworzyć żądanie. Przesyłki i pojazdy zdefiniujesz później, ale chcesz zacząć od ustawienia godzin otwarcia i godzinowego kosztu operacyjnego.

W tym przykładzie wartości właściwości ShipmentModel w żądaniu są następujące:

Poniżej znajdziesz przykładowy kod komunikatu ShipmentModel zawierający wartości z przykładowego scenariusza.

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

Shipment

Typ wiadomości Shipment definiuje strukturę właściwości przesyłki, którą można dostarczyć, lub usługi, którą można wykonać na trasie.

Jak pokazano na diagramie:

• Wiadomość Shipment zawiera wszystkie informacje o rzeczywistej przesyłce lub usłudze.
• Wszystkie komunikaty Shipment są określone w polu shipments.
• Pole shipments zawiera co najmniej 1 komunikat Shipment.

Komunikat Shipment wymaga co najmniej jednego obiektu pickups lub deliveries. Definicje tych obiektów są następujące:

• pickups określa miejsce odbioru przesyłki.
• deliveries określa lokalizację dostawy przesyłki.
• Zarówno pickups, jak i deliveries zawierają typ wiadomości VisitRequest, który definiuje lokalizacje i inne szczegóły.

W tabeli poniżej opisano różne scenariusze w zależności od konfiguracji pól pickups i deliveries w wiadomości Shipment.

Pełną listę właściwości w Shipment znajdziesz w dokumentacji.

Shipment – przykład

W tym przykładzie prowadzisz świetlicę dla psów, odbierasz je z domu i przywozisz do świetlicy. Chcesz ustawić lokalizację odbioru 2 psów i ustawić lokalizację dostawy do Twojej firmy:

• Pierwszy pies mieszka w Coit Tower w San Francisco. Współrzędne tej lokalizacji to szerokość geograficzna 37,8024 i długość geograficzna -122,4058.
• Drugi pies mieszka w South Sunset Playground Park w San Francisco. Współrzędne tej lokalizacji to 37,7359 szerokości geograficznej i -122,5011 długości geograficznej.
• Twoja świetlica dla psów znajduje się w parku Mission Dolores w San Francisco. Współrzędne tej lokalizacji to 37.759773 (szerokość geograficzna) i -122.427063 (długość geograficzna).

Poniżej znajdziesz przykładowy kod wiadomości Shipment, w której obiekt shipments zawiera 2 typy wiadomości Shipment z przykładowymi współrzędnymi.

{
  "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

Typ wiadomości Vehicle definiuje strukturę właściwości pojazdu, który może wykonać przesyłkę na trasie.

Jak pokazano na diagramie:

• Komunikat Vehicle zawiera wszystkie informacje o pojeździe w rzeczywistości.
• Wszystkie komunikaty Vehicle są określone w polu vehicles.
• Pole vehicles zawiera wiele komunikatów Vehicle.

W tabeli poniżej opisano niektóre istotne właściwości elementu Vehicle.

Vehicle – przykład

W tym przykładzie prowadzisz opiekę dzienną nad psami i chcesz określić lokalizację pojazdu na początku i na końcu dnia oraz ilość zużywanego paliwa. Nie musisz określać godzin pracy pojazdu, ponieważ są one zgodne z godzinami zdefiniowanymi we właściwościach globalStartTime i globalEndTime w obiekcie ShipmentModel.

W tym przykładzie wartości właściwości Vehicle w żądaniu są następujące:

Poniżej znajdziesz przykładowy kod komunikatu Vehicle zawierający wartości z przykładowego scenariusza.

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

Pełną listę właściwości w Vehicle znajdziesz w dokumentacji.

Przykładowe pełne żądanie

Poniższy przykładowy kod zawiera kompletny przykład żądania, który łączy przykłady ShipmentModel, Shipment i Vehicle przedstawione w tym dokumencie.

{
  "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"
  }
}