Method: networks.shipments.get
Stay organized with collections
Save and categorize content based on your preferences.
Gets the details of a Shipment.
HTTP request
GET https://middlemileoptimization.googleapis.com/v1/{name=networks/*/shipments/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the shipment to retrieve. Format: "networks/{network}/shipments/{shipment}"
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of 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 2024-08-06 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 2024-08-06 UTC."],[[["\u003cp\u003eRetrieves detailed information about a specific shipment within a network.\u003c/p\u003e\n"],["\u003cp\u003eUses a GET request with the shipment's name specified in the URL path.\u003c/p\u003e\n"],["\u003cp\u003eRequires an empty request body.\u003c/p\u003e\n"],["\u003cp\u003eReturns a \u003ccode\u003eShipment\u003c/code\u003e object containing the shipment details if successful.\u003c/p\u003e\n"]]],["This document describes how to retrieve shipment details using a GET request. The request URL follows a specific format: `https://middlemileoptimization.googleapis.com/v1/{name=networks/*/shipments/*}`, with the shipment's name as a required path parameter. The `name` parameter uses the format: \"networks/{network}/shipments/{shipment}\". No request body is needed. A successful request returns a `Shipment` object in the response body. The request utilizes gRPC Transcoding syntax.\n"],null,["# Method: networks.shipments.get\n\nGets the details of a Shipment.\n\n### HTTP request\n\n`GET https://middlemileoptimization.googleapis.com/v1/{name=networks/*/shipments/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the shipment to retrieve. Format: \"networks/{network}/shipments/{shipment}\" |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Shipment](/optimization/middlemileoptimization/reference/rest/v1/networks.shipments#Shipment)."]]