Method: products.patch

Updates an existing product.

  • Returns the updated product if successful.
  • Returns error code NOT_FOUND if the product does not exist.
  • Returns error code INVALID_ARGUMENT if an immutable field is specified in updateMask.
  • Returns error code ABORTED if the product was updated in the system after the provided updateTime timestamp.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



The resource name of the product in the format: products/{id}. For example products/product123.

Query parameters


string (FieldMask format)

Required. The mask to control which fields to update. An immutable field cannot be specified here.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Product.

Response body

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

Authorization Scopes

Requires the following OAuth scope:


For more information, see the OAuth 2.0 Overview.