Method: billingAccounts.orders.list

Lists Order resources that the user has access to, within the scope of the parent resource.

HTTP request

GET https://cloudcommerceconsumerprocurement.googleapis.com/v1alpha1/{parent=billingAccounts/*}/orders

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource to query for orders. This field has the form billingAccounts/{billing-account-id}.

Query parameters

Parameters
pageSize

integer

The maximum number of entries requested. The default page size is 25 and the maximum page size is 200.

pageToken

string

The token for fetching the next page.

filter

string

Filter that you can use to limit the list request.

A query string that can match a selected set of attributes with string values. For example, displayName=abc. Supported query attributes are

  • displayName

If the query contains special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, displayName="foo:bar", where the display name needs to be quoted because it contains special character colon.

Queries can be combined with OR, and NOT to form more complex queries. You can also group them to force a desired evaluation order. For example, displayName=abc OR displayName=def.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for ConsumerProcurementService.ListOrders.

JSON representation
{
  "orders": [
    {
      object (Order)
    }
  ],
  "nextPageToken": string
}
Fields
orders[]

object (Order)

The list of orders in this response.

nextPageToken

string

The token for fetching the next page.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • consumerprocurement.orders.list

For more information, see the IAM documentation.