Method: networks.shipments.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://middlemileoptimization.googleapis.com/v1/{parent=networks/*}/shipments
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent, which owns this collection of shipments. Format: "networks/{network}"
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of shipments to return. The service may return fewer than this value. If unspecified, at most 50 shipments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
|
pageToken |
string
Optional. A page token, received from a previous shipments.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to shipments.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
The response message for shipments.list method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"shipments": [
{
object (Shipment)
}
],
"nextPageToken": string
} |
| Fields |
shipments[] |
object (Shipment)
The shipments from the specified network.
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
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."],[[["Lists shipments associated with a specific network."],["Allows pagination to retrieve large sets of shipments."],["Includes a `nextPageToken` for retrieving subsequent pages of results."],["Returns an array of `Shipment` objects with details of each shipment."],["Requires a `parent` parameter to specify the network."]]],["This document details the `shipments.list` method for retrieving shipments within a network. The `GET` request, directed to a specific network, requires the network's identifier as a path parameter. Optional query parameters `pageSize` (default 50, max 1000) and `pageToken` support pagination. An empty request body is required. The response provides an array of shipment objects and a `nextPageToken` for retrieving subsequent pages if they are available.\n"]]