REST Resource: networks.shipments

  • Shipments represent the movement of goods between source and destination hubs with specific departure and arrival times.

  • Each shipment includes details like identifier, source and destination hubs, departure and arrival times, potential arrival penalties, size, and revenue.

  • You can manage shipments by deleting, retrieving details, listing them, or routing new ones using the available methods.

  • Shipment arrival times are soft constraints, allowing for potential delays with associated penalties defined by SLAs.

  • Size and revenue attributes contribute to optimizing vehicle and hub capacities and calculating overall transportation rewards.

Resource: Shipment

Shipment to perform.

JSON representation 
{
  "name": string,
  "sourceHub": string,
  "destinationHub": string,
  "departureTime": {
    object (DateTime)
  },
  "arrivalTime": {
    object (DateTimeRange)
  },
  "arrivalEarlinessTardinessCost": {
    object (EarlinessTardiness)
  },
  "size": [
    {
      object (ValueDimension)
    }
  ],
  "revenue": number
}
Fields
name

string

Identifier. Cannot be updated.
sourceHub

string

Required. Hub at which the shipment is made available.
destinationHub

string

Required. Hub to which the shipment must be delivered.
departureTime

object (DateTime)

Required. Departure time.
arrivalTime

object (DateTimeRange)

Required. Expected arrival time (i.e. soft constraint).
arrivalEarlinessTardinessCost

object (EarlinessTardiness)

Optional. SLAs indicate that this time may be exceeded with some penalty. (If later than the maximum, the package is no more useful.) The penalty is given by a function of the delay (in minutes).
size[]

object (ValueDimension)

Optional. Used with vehicle and hub capacities.
revenue

number

Optional. Revenue from this package (only used to compute the reward), i.e. price paid by the paying party. If unset, revenue is computed by the system (depending on whether a new line is generated for this shipment or not).

Methods

delete

 Deletes a Shipment.

get

 Gets the details of a Shipment.

list

 Lists the Shipments.

route

 Route a new shipment.