---
title: "Updates a given product based on a given Id from the client store."
method: PUT
path: "/v1/pvt/Product/{id}"
tags: ["Product"]
---

# Updates a given product based on a given Id from the client store.

`PUT /v1/pvt/Product/{id}`

## Request

- Base URL: `https://api.bonifiq.com.br`
- URL: `https://api.bonifiq.com.br/v1/pvt/Product/{id}`
- Auth: HTTP basic

## Path parameters

- `id` string, required

## Request body

- CreateProductRequest: Product model.
  - `OriginalId` string: Id from the client store.
  - `Title` string: Product Name
  - `Url` string, nullable: Direct url to the product on the client store.
  - `ImageUrl` string, nullable: Product img url.
  - `IsActive` boolean: if true the product is active on the store.
  - `ProductPrice` number, nullable: How much the customer paid for this product. If it is not null and not zero it can be used with extra points for products rule
  - `ProductBrand` CreateProductBrandRequest
    - `OriginalId` string: Id from the client store
    - `Name` string: Brand Name
  - `ProductCategory` CreateProductCategoryRequest: Product Category model with support for hierarchical categories.
    - `OriginalId` string: Id from the client store
    - `Name` string: Category Name
    - `Description` string, nullable: Category Description
    - `ParentCategory` CreateProductCategoryRequest (recursive)

## Response `200`

- BaseExternalApiResponseOfCreateProductResponse: Standard response envelope used by the External API.
  - `ErrorMessage` string, nullable: Error message returned when the request fails validation or processing. For warnings and successful responses, consumers should usually inspect `Result`, `Code` and `Severity` first.
  - `ErrorCode` integer, nullable: Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use `ApiResponseErrorDescription`.
  - `Result` CreateProductResponse: Create Product Response model
    - `OriginalId` string: Id from the client store
    - `Title` string: Product Title/Name
    - `Url` string, nullable: Url from the client store from the product.
    - `ImageUrl` string, nullable: Url from where the Product image is hosted.
    - `IsActive` boolean: If true the product is active.
    - `ProductPrice` number, nullable
  - `Code` string, nullable: Endpoint-specific business code formatted as a two-digit string, such as `03` or `07`. This field is available for success, warning and error outcomes.
  - `CodeName` string, nullable: Symbolic enum name associated with `Code`, such as `CheckoutNotFound`.
  - `Severity` 0 | 1 | 2: 0 = Success 1 = Warning 2 = Error
  - `HasWarning` boolean: Convenience flag that is `true` when `Severity` is `Warning`. Warnings are valid `200 OK` business outcomes and should not be handled as transport or validation errors.
  - `HasError` boolean: Indicates whether the request failed and should be handled as an error response. This flag is reserved for real API errors; warnings must keep this property as `false`.

---

[API](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis.md) - [All operations](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/revisions/bac0977b23d5?raw)