Method: orders.patch

Updates an existing order.

  • Returns the updated order if successful.
  • Returns error code NOT_FOUND if the order does not exist.
  • Returns error code INVALID_ARGUMENT if an immutable field is specified in updateMask.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Output only. The resource name of the order in the format: orders/{id}`.

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 Order.

Response body

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

Authorization Scopes

Requires the following OAuth scope:


For more information, see the OAuth 2.0 Overview.