# REST Resource: networks.shipments

## Resource: Shipment

Shipment to perform.

| JSON representation |
|---|
| ``` { "name": string, "sourceHub": string, "destinationHub": string, "departureTime": { object (`https://developers.google.com/optimization/middlemileoptimization/reference/rest/v1/DateTime`) }, "arrivalTime": { object (`https://developers.google.com/optimization/middlemileoptimization/reference/rest/v1/DateTimeRange`) }, "arrivalEarlinessTardinessCost": { object (`https://developers.google.com/optimization/middlemileoptimization/reference/rest/v1/EarlinessTardiness`) }, "size": [ { object (`https://developers.google.com/optimization/middlemileoptimization/reference/rest/v1/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 (`https://developers.google.com/optimization/middlemileoptimization/reference/rest/v1/DateTime`)`` Required. Departure time. |
| `arrivalTime` | ``object (`https://developers.google.com/optimization/middlemileoptimization/reference/rest/v1/DateTimeRange`)`` Required. *Expected* arrival time (i.e. soft constraint). |
| `arrivalEarlinessTardinessCost` | ``object (`https://developers.google.com/optimization/middlemileoptimization/reference/rest/v1/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 (`https://developers.google.com/optimization/middlemileoptimization/reference/rest/v1/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 ||
|---|---|
| ### `https://developers.google.com/optimization/middlemileoptimization/reference/rest/v1/networks.shipments/delete` | Deletes a Shipment. |
| ### `https://developers.google.com/optimization/middlemileoptimization/reference/rest/v1/networks.shipments/get` | Gets the details of a Shipment. |
| ### `https://developers.google.com/optimization/middlemileoptimization/reference/rest/v1/networks.shipments/list` | Lists the Shipments. |
| ### `https://developers.google.com/optimization/middlemileoptimization/reference/rest/v1/networks.shipments/route` | Route a new shipment. |