REST Resource: networks.hubs

  • Hubs represent locations for transferring shipments between different points in a network.

  • Each hub is defined by its name, position, operating hours, and capacity for handling shipments (cross-docking).

  • You can manage hubs by creating, updating, deleting, and adjusting their availability status through the provided methods.

  • Hubs can include information about their cross-docking capacity and the time it takes to transfer shipments.

  • Latitude and longitude coordinates are used to specify the geographical location of a hub.

Resource: Hub

Shipments must be brought from one hub to another one.

JSON representation 
{
  "name": string,
  "position": {
    object (LatLng)
  },
  "openingTimes": [
    {
      object (DateTimeRange)
    }
  ],
  "crossDockingCapacity": {
    object (CrossDockingCapacity)
  },
  "crossDockingTime": {
    object (CrossDockingTime)
  }
}
Fields
name

string

Identifier. Cannot be updated.
position

object (LatLng)

Optional. Position to compute real-world paths.
openingTimes[]

object (DateTimeRange)

Required. Opening times. For now, use a very rough representation: one entry each time the hub opens (if its workers have a lunch break and no one works at that time, there will be two entries for that day).
crossDockingCapacity

object (CrossDockingCapacity)

Optional. Capacity of the complete hub.
crossDockingTime

object (CrossDockingTime)

Optional. Time to perform one cross-docking operation (per vehicle).

LatLng

An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.

JSON representation 
{
  "latitude": number,
  "longitude": number
}
Fields
latitude

number

The latitude in degrees. It must be in the range [-90.0, +90.0].
longitude

number

The longitude in degrees. It must be in the range [-180.0, +180.0].

CrossDockingCapacity

Overall cross-docking capacity for a hub.

JSON representation 
{
  "capacityPerHour": [
    {
      object (ValueDimension)
    }
  ]
}
Fields
capacityPerHour[]

object (ValueDimension)

Optional. Cross-docking capacity for each dimension.

CrossDockingTime

Overall cross-docking time for a hub.

JSON representation 
{
  "timeConstant": string,
  "time": {
    object (SeparableNDFunction)
  }
}
Fields
timeConstant

string (Duration format)

Optional. Constant time for a cross-docking operation.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
time

object (SeparableNDFunction)

Optional. Separability is a simplifying assumption.

Methods

create

 Creates a Hub.

delete

 Deletes a Hub.

get

 Gets the details of a Hub.

list

 Lists the Hubs.

makeAvailable

 Makes a hub available.

makeUnavailable

 Makes a hub unavailable.

patch

 Updates a Hub.