- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
- Try it!
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 | |
---|---|
product |
Required. Full resource name of If the caller does not have permission to access the |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "placeIds": [ string ], "removeTime": string, "allowMissing": boolean } |
Fields | |
---|---|
placeIds[] |
Required. A list of place IDs to have their inventory deleted. At most 3000 place IDs are allowed per request. |
removeTime |
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: |
allowMissing |
If set to true, and the |
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.