REST Resource: networks

  • A Network describes the full existing network infrastructure available for use, including details like distance, pricing, and dimensions.

  • Networks are defined by their name, dimensions for measuring shipments, pricing strategies, currency, time discretization, and a distance matrix representing connections between hubs.

  • DistanceMatrixEntry objects within the network define the distance between source and destination hubs across various dimensions.

  • Users can manage Networks via API methods to create, delete, retrieve, list, analyze paths, and update network information.

Resource: Network

Describes the full existing network that can be used. A given API customer might have several networks (e.g., the main network and a possible future modification to evaluate).

JSON representation 
{
  "name": string,
  "dimensions": [
    {
      object (ValueDimension)
    }
  ],
  "pricing": {
    object (PricingStrategy)
  },
  "currencyCode": string,
  "timeStep": string,
  "distanceMatrix": [
    {
      object (DistanceMatrixEntry)
    }
  ]
}
Fields
name

string

Identifier. Cannot be updated.
dimensions[]

object (ValueDimension)

Distance, weight, pallets, etc., plus scaling (to map floats to integers).
pricing

object (PricingStrategy)

Optional. Price to be paid by the sender for shipping a shipment that does not require a dedicated line.
currencyCode

string

Optional. Single monetary unit used throughout the network. A given API customer can have several different units for different networks; a network is only allowed to have one monetary unit. The unit must be encoded in ISO 4217.
timeStep

string (Duration format)

Optional. Time discretization. Decisions are output with this precision in time. Internally, state is kept with this precision.

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

object (DistanceMatrixEntry)

Optional. Distance matrix (represented a list of weighted directed edges).

DistanceMatrixEntry

Distance between a source hub and a destination hub.

JSON representation 
{
  "sourceHub": string,
  "destinationHub": string,
  "weights": [
    {
      object (ValueDimension)
    }
  ]
}
Fields
sourceHub

string

Required. Source hub.
destinationHub

string

Required. Destination hub.
weights[]

object (ValueDimension)

Required. Distance between the hubs, measured in several dimensions.

Methods

create

 Creates a Network.

delete

 Deletes a Network.

get

 Gets the details of a Network.

list

 Lists the Network.

listPaths

 Returns all the paths that are currently available.

patch

 Updates a Network.