Skip to main content
POST
/
v1
/
pvt
/
Product
creates a new product register.
curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/Product \
  --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>"
  }
}
'
{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "OriginalId": "<string>",
    "Title": "<string>",
    "Url": "<string>",
    "ImageUrl": "<string>",
    "IsActive": true,
    "ProductPrice": 123
  },
  "HasError": true
}

Authorizations

Authorization
string
header
required

Use API Basic Auth Keys

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

Response

200 - application/json
ErrorMessage
string | null

Error message or description

ErrorCode
integer<int32> | null

Optional error code, if available

Result
object

Create Product Response model

HasError
boolean

If true the request had an error.