Method: accounts.products.localInventories.list
Lists the LocalInventory 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.
LocalInventory resources are listed per product for a given account.
HTTP request
GET https://merchantapi.googleapis.com/inventories/v1beta/{parent=accounts/*/products/*}/localInventories
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The name of the parent product to list local inventories for. Format: accounts/{account}/products/{product}
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of LocalInventory 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 25000; 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 localInventories.list call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to localInventories.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 localInventories.list method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"localInventories": [
{
object (LocalInventory)
}
],
"nextPageToken": string
} |
| Fields |
localInventories[] |
object (LocalInventory)
The LocalInventory 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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-25 UTC.
[null,null,["Last updated 2025-02-25 UTC."],[[["Lists `LocalInventory` resources for a given product within your merchant account, potentially returning results across multiple pages."],["Allows filtering by product with the `parent` path parameter and pagination control through `pageSize` and `pageToken` query parameters."],["The response provides a list of `LocalInventory` resources and a `nextPageToken` if additional pages are available."],["Requires authorization with the `https://www.googleapis.com/auth/content` scope."]]],["This content outlines how to retrieve `LocalInventory` resources for a specific product within a merchant account. A `GET` request is sent to the specified URL, using the product's `name` in the `parent` path parameter. Optional `pageSize` and `pageToken` query parameters manage result pagination. The request body is empty, while the response body returns a list of `LocalInventory` objects, and a `nextPageToken` for further pages. Access requires the `https://www.googleapis.com/auth/content` OAuth scope.\n"]]
