Vertex AI Search for Retail API (retail:v2)

2022-03-29

2 new methods

Additions

    Methods
  • retail.projects.locations.catalogs.branches.products.removeLocalInventories

      Description : 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 GetProduct or ListProducts. Local inventory information can only be removed using this method. CreateProduct and UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Path : v2/{+product}:removeLocalInventories

      Parameter Order : product

      Parameters :

        product

          Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$

          Description : 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.

          Type : string

          Location : path

          Required : Yes

      HTTP Method : POST

      Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeLocalInventories

  • retail.projects.locations.catalogs.branches.products.addLocalInventories

      Flat Path : v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addLocalInventories

      Description : Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by GetProduct or ListProducts. Local inventory information can only be modified using this method. CreateProduct and UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

      Path : v2/{+product}:addLocalInventories

      HTTP Method : POST

      Parameter Order : product

      Parameters :

        product

          Required : Yes

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$

          Location : path

          Description : 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.

      Scopes : https://www.googleapis.com/auth/cloud-platform