Method: accounts.products.regionalInventories.list

  • Lists RegionalInventory resources for a given product within a specified merchant account, offering pagination for large result sets.

  • Allows filtering by product using the parent path parameter in the format accounts/{account}/products/{product}.

  • Enables control over the number of results and pagination using pageSize and pageToken query parameters.

  • Returns an array of RegionalInventory objects and a nextPageToken for accessing further results in the response.

  • Requires authorization with the https://www.googleapis.com/auth/content OAuth scope.

Lists the RegionalInventory resources for the given product in your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

RegionalInventory resources are listed per product for a given account.

HTTP request

GET https://merchantapi.googleapis.com/inventories/v1beta/{parent=accounts/*/products/*}/regionalInventories

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the parent product to list RegionalInventory resources for. Format: accounts/{account}/products/{product}

Query parameters

Parameters
pageSize

integer

The maximum number of RegionalInventory resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the pageSize. The default value is 25000. The maximum value is 100000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.
pageToken

string

A page token, received from a previous regionalInventories.list call. Provide the page token to retrieve the subsequent page.

When paginating, all other parameters provided to regionalInventories.list must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

Request body

The request body must be empty.

Response body

Response message for the regionalInventories.list method.

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

JSON representation 
{
  "regionalInventories": [
    {
      object (RegionalInventory)
    }
  ],
  "nextPageToken": string
}
Fields
regionalInventories[]

object (RegionalInventory)

The RegionalInventory resources for the given product from the specified account.
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/content

For more information, see the OAuth 2.0 Overview.