2024-06-14
▼ ▲ merchantapi.accounts.products.localInventories.list
Path: inventories/v1beta/{+parent}/localInventories
Flat Path: inventories/v1beta/accounts/{accountsId}/products/{productsId}/localInventories
HTTP Method: GET
Parameters:
parent
Description: Required. The `name` of the parent product to list local inventories for. Format: `accounts/{account}/products/{product}`
Pattern: ^accounts/[^/]+/products/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: 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
Location: query
Type: integer
Format: int32
pageToken
Description: A page token, received from a previous `ListLocalInventories` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListLocalInventories` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: 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.
▼ ▲ merchantapi.accounts.products.localInventories.insert
Path: inventories/v1beta/{+parent}/localInventories:insert
Flat Path: inventories/v1beta/accounts/{accountsId}/products/{productsId}/localInventories:insert
HTTP Method: POST
Parameters:
parent
Description: Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}`
Pattern: ^accounts/[^/]+/products/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Inserts a `LocalInventory` resource to a product in your merchant account. Replaces the full `LocalInventory` resource if an entry with the same `storeCode` already exists for the product. It might take up to 30 minutes for the new or updated `LocalInventory` resource to appear in products.
▼ ▲ merchantapi.accounts.products.localInventories.delete
Path: inventories/v1beta/{+name}
Flat Path: inventories/v1beta/accounts/{accountsId}/products/{productsId}/localInventories/{localInventoriesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the local inventory for the given product to delete. Format: `accounts/{account}/products/{product}/localInventories/{store_code}`
Pattern: ^accounts/[^/]+/products/[^/]+/localInventories/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Deletes the specified `LocalInventory` from the given product in your merchant account. It might take a up to an hour for the `LocalInventory` to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.
▼ ▲ merchantapi.accounts.products.regionalInventories.list
Path: inventories/v1beta/{+parent}/regionalInventories
Flat Path: inventories/v1beta/accounts/{accountsId}/products/{productsId}/regionalInventories
HTTP Method: GET
Parameters:
parent
Description: Required. The `name` of the parent product to list `RegionalInventory` resources for. Format: `accounts/{account}/products/{product}`
Pattern: ^accounts/[^/]+/products/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: 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.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token, received from a previous `ListRegionalInventories` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegionalInventories` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: 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.
▼ ▲ merchantapi.accounts.products.regionalInventories.insert
Path: inventories/v1beta/{+parent}/regionalInventories:insert
Flat Path: inventories/v1beta/accounts/{accountsId}/products/{productsId}/regionalInventories:insert
HTTP Method: POST
Parameters:
parent
Description: Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}`
Pattern: ^accounts/[^/]+/products/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Inserts a `RegionalInventory` to a given product in your merchant account. Replaces the full `RegionalInventory` resource if an entry with the same `region` already exists for the product. It might take up to 30 minutes for the new or updated `RegionalInventory` resource to appear in products.
▼ ▲ merchantapi.accounts.products.regionalInventories.delete
Path: inventories/v1beta/{+name}
Flat Path: inventories/v1beta/accounts/{accountsId}/products/{productsId}/regionalInventories/{regionalInventoriesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the `RegionalInventory` resource to delete. Format: `accounts/{account}/products/{product}/regionalInventories/{region}`
Pattern: ^accounts/[^/]+/products/[^/]+/regionalInventories/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Deletes the specified `RegionalInventory` resource from the given product in your merchant account. It might take up to an hour for the `RegionalInventory` to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.