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

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• IAM Permissions
• Try it!

Deletes a Product.

HTTP request

DELETE https://retail.googleapis.com/v2alpha/{name=projects/*/locations/*/catalogs/*/branches/*/products/**}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

name

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 delete the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to delete does not exist, a NOT_FOUND error is returned. The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants. Otherwise, an INVALID_ARGUMENT error is returned. All inventory information for the named Product will be deleted.

Query parameters

Parameters
force	boolean This value only applies to the case when the target product is of type PRIMARY. When deleting a product of VARIANT/COLLECTION type, this value will be ignored. When set to true, the subsequent variant products will be deleted. When set to false, if the primary product has active variant products, an error will be returned.

Request body

The request body must be empty.

Response body

If successful, the response body is an empty JSON object.

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

• retail.products.delete

For more information, see the IAM documentation.