Method: projects.locations.catalogs.branches.products.removeLocalInventories

Remove local inventory information for a Product at a list of places at a removal timestamp.

This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by products.get or products.list.

Local inventory information can only be removed using this method. products.create and products.patch has no effect on local inventories.

This feature is only available for users who have Retail placements.search enabled. Please enable Retail placements.search on Cloud Console before using this feature.

HTTP request

POST https://retail.googleapis.com/v2alpha/{product=projects/*/locations/*/catalogs/*/branches/*/products/**}:removeLocalInventories

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`product`	`string` Required. Full resource name of `Product`, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the `Product`, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

product

string

Required. Full resource name of Product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id.

If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Request body

The request body contains data with the following structure:

JSON representation
{ "placeIds": [ string ], "removeTime": string, "allowMissing": boolean }

Fields

Fields
`placeIds[]`	`string` Required. A list of place IDs to have their inventory deleted. At most 3000 place IDs are allowed per request.
`removeTime`	`string (Timestamp format)` The time when the inventory deletions are issued. Used to prevent out-of-order updates and deletions on local inventory fields. If not provided, the internal system time will be used. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`allowMissing`	`boolean` If set to true, and the `Product` is not found, the local inventory removal request will still be processed and retained for at most 1 day and processed once the `Product` is created. If set to false, a NOT_FOUND error is returned if the `Product` is not found.

placeIds[]

string

Required. A list of place IDs to have their inventory deleted. At most 3000 place IDs are allowed per request.

removeTime

string (Timestamp format)

The time when the inventory deletions are issued. Used to prevent out-of-order updates and deletions on local inventory fields. If not provided, the internal system time will be used.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

allowMissing

boolean

If set to true, and the Product is not found, the local inventory removal request will still be processed and retained for at most 1 day and processed once the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found.

Response body

If successful, the response body contains an instance of Operation.

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 product resource:

retail.products.update

For more information, see the IAM documentation.