Skip to main content
PUT
/
v1
/
pvt
/
Product
/
{id}
Updates a given product based on a given Id from the client store.
curl --request PUT \
  --url https://api.bonifiq.com.br/v1/pvt/Product/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "OriginalId": "<string>",
  "Title": "<string>",
  "Url": "<string>",
  "ImageUrl": "<string>",
  "IsActive": true,
  "ProductPrice": 123,
  "ProductBrand": {
    "OriginalId": "<string>",
    "Name": "<string>"
  },
  "ProductCategory": {
    "OriginalId": "<string>",
    "Name": "<string>",
    "Description": "<string>",
    "ParentCategory": "<unknown>"
  }
}
'
{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "OriginalId": "<string>",
    "Title": "<string>",
    "Url": "<string>",
    "ImageUrl": "<string>",
    "IsActive": true,
    "ProductPrice": 123
  },
  "Code": "<string>",
  "CodeName": "<string>",
  "HasWarning": true,
  "HasError": true
}

Authorizations

​
Authorization
string
header
required

Use API Basic Auth Keys

Path Parameters

​
id
string
required

Id of the Product from the client store

Body

application/json

Product Data

Product model.

​
OriginalId
string

Id from the client store.

​
Title
string

Product Name

​
Url
string | null

Direct url to the product on the client store.

​
ImageUrl
string | null

Product img url.

​
IsActive
boolean

if true the product is active on the store.

​
ProductPrice
number<decimal> | null

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
object

Product Brand

​
ProductCategory
object

Product Category. Supports hierarchical categories with parent references.

Response

200 - application/json

Standard response envelope used by the External API.

​
ErrorMessage
string | null

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<int32> | null

Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use ApiResponseErrorDescription.

​
Result
object

Business payload returned by the endpoint.

​
Code
string | null

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 | null

Symbolic enum name associated with Code, such as CheckoutNotFound.

​
Severity
enum<integer>

Final severity of the response. Success means the action completed as expected, Warning means the request was valid but the business outcome is informational or non-ideal, and Error means the request should be treated as a failure.

Available options:
0,
1,
2
​
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.