Method: projects.locations.workspaces.shipments.list

Lists the shipments within a workspace.

HTTP request

GET https://cloudoptimization.googleapis.com/v1/{parent}/shipments

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of shipments. Format: "projects/{project}/locations/{location}/workspaces/{workspace}"

Query parameters

Parameters
pageSize

integer

The maximum number of shipments to return. The service may return fewer than this value. If unspecified, at most 50 vehicles will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken

string

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.
filter

string

Filter expression that matches a subset of the Shipments to show. For more information about filter syntax, see https://google.aip.dev/160.

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 workspace.
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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.