REST Resource: networks.shipments
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Shipment
| 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 |
|
|
Deletes a Shipment. |
|
|
Gets the details of a Shipment. |
|
|
Lists the Shipments. |
|
|
Route a new shipment. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-14 UTC."],[[["\u003cp\u003eShipments represent the movement of goods between source and destination hubs with specific departure and arrival times.\u003c/p\u003e\n"],["\u003cp\u003eEach shipment includes details like identifier, source and destination hubs, departure and arrival times, potential arrival penalties, size, and revenue.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage shipments by deleting, retrieving details, listing them, or routing new ones using the available methods.\u003c/p\u003e\n"],["\u003cp\u003eShipment arrival times are soft constraints, allowing for potential delays with associated penalties defined by SLAs.\u003c/p\u003e\n"],["\u003cp\u003eSize and revenue attributes contribute to optimizing vehicle and hub capacities and calculating overall transportation rewards.\u003c/p\u003e\n"]]],["This document details the structure and management of a \"Shipment\" resource. Key information includes: the shipment's unique `name`, required `sourceHub` and `destinationHub`, `departureTime`, and `arrivalTime`. Optional data includes `arrivalEarlinessTardinessCost`, `size`, and `revenue`. Shipments can be created, deleted, retrieved, listed, and routed using specified methods. The shipment represents a package which needs to be deliver between hubs with a time constraint.\n"],null,["# REST Resource: networks.shipments\n\nResource: Shipment\n------------------\n\nShipment to perform.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"sourceHub\": string, \"destinationHub\": string, \"departureTime\": { object (/optimization/middlemileoptimization/reference/rest/v1/DateTime) }, \"arrivalTime\": { object (/optimization/middlemileoptimization/reference/rest/v1/DateTimeRange) }, \"arrivalEarlinessTardinessCost\": { object (/optimization/middlemileoptimization/reference/rest/v1/EarlinessTardiness) }, \"size\": [ { object (/optimization/middlemileoptimization/reference/rest/v1/ValueDimension) } ], \"revenue\": number } ``` |\n\n| Fields ||\n|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. Cannot be updated. |\n| `source``Hub` | `string` Required. Hub at which the shipment is made available. |\n| `destination``Hub` | `string` Required. Hub to which the shipment must be delivered. |\n| `departure``Time` | `object (`[DateTime](/optimization/middlemileoptimization/reference/rest/v1/DateTime)`)` Required. Departure time. |\n| `arrival``Time` | `object (`[DateTimeRange](/optimization/middlemileoptimization/reference/rest/v1/DateTimeRange)`)` Required. *Expected* arrival time (i.e. soft constraint). |\n| `arrival``Earliness``Tardiness``Cost` | `object (`[EarlinessTardiness](/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). |\n| `size[]` | `object (`[ValueDimension](/optimization/middlemileoptimization/reference/rest/v1/ValueDimension)`)` Optional. Used with vehicle and hub capacities. |\n| `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). |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------------------|---------------------------------|\n| ### [delete](/optimization/middlemileoptimization/reference/rest/v1/networks.shipments/delete) | Deletes a Shipment. |\n| ### [get](/optimization/middlemileoptimization/reference/rest/v1/networks.shipments/get) | Gets the details of a Shipment. |\n| ### [list](/optimization/middlemileoptimization/reference/rest/v1/networks.shipments/list) | Lists the Shipments. |\n| ### [route](/optimization/middlemileoptimization/reference/rest/v1/networks.shipments/route) | Route a new shipment. |"]]