Method: networks.shipments.list

配送を一覧表示します。

HTTP リクエスト

GET https://middlemileoptimization.googleapis.com/v1/{parent=networks/*}/shipments

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。この配送コレクションを所有する親。形式: networks/{network}

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返品可能な配送の最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 件の配送が返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

pageToken

string

省略可。前回の shipments.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、shipments.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

shipments.list メソッドに対するレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{
  "shipments": [
    {
      object (Shipment)
    }
  ],
  "nextPageToken": string
}
フィールド
shipments[]

object (Shipment)

指定したネットワークからの配送。

nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。