Method: networks.shipments.list

Liste les expéditions.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Le parent, qui possède cette collection d'envois. Format : "networks/{network}"

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal de livraisons à retourner. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 50 envois au maximum seront renvoyés. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000.
pageToken

string

Facultatif. Jeton de page reçu d'un appel shipments.list précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à shipments.list doivent correspondre à l'appel ayant fourni le jeton de page.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour la méthode shipments.list.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "shipments": [
    {
      object (Shipment)
    }
  ],
  "nextPageToken": string
}
Champs
shipments[]

object (Shipment)

Envois du réseau spécifié.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.