Saltar para o conteúdo principal
PATCH
/
v1
/
products
/
{id}
Atualizar produto
curl --request PATCH \
  --url https://api.vendaze.com/v1/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Plano Empresarial Plus",
  "currency": "BRL",
  "price_cts": 149900,
  "description": "Versão atualizada do plano empresarial.",
  "code": "PLANO-EMP-PLUS",
  "is_active": false,
  "billing_cycle": "annually",
  "image": "https://exemplo.com/nova-imagem.png"
}
'
import requests

url = "https://api.vendaze.com/v1/products/{id}"

payload = {
"name": "Plano Empresarial Plus",
"currency": "BRL",
"price_cts": 149900,
"description": "Versão atualizada do plano empresarial.",
"code": "PLANO-EMP-PLUS",
"is_active": False,
"billing_cycle": "annually",
"image": "https://exemplo.com/nova-imagem.png"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Plano Empresarial Plus',
currency: 'BRL',
price_cts: 149900,
description: 'Versão atualizada do plano empresarial.',
code: 'PLANO-EMP-PLUS',
is_active: false,
billing_cycle: 'annually',
image: 'https://exemplo.com/nova-imagem.png'
})
};

fetch('https://api.vendaze.com/v1/products/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vendaze.com/v1/products/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Plano Empresarial Plus',
'currency' => 'BRL',
'price_cts' => 149900,
'description' => 'Versão atualizada do plano empresarial.',
'code' => 'PLANO-EMP-PLUS',
'is_active' => false,
'billing_cycle' => 'annually',
'image' => 'https://exemplo.com/nova-imagem.png'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.vendaze.com/v1/products/{id}"

payload := strings.NewReader("{\n \"name\": \"Plano Empresarial Plus\",\n \"currency\": \"BRL\",\n \"price_cts\": 149900,\n \"description\": \"Versão atualizada do plano empresarial.\",\n \"code\": \"PLANO-EMP-PLUS\",\n \"is_active\": false,\n \"billing_cycle\": \"annually\",\n \"image\": \"https://exemplo.com/nova-imagem.png\"\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.vendaze.com/v1/products/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Plano Empresarial Plus\",\n \"currency\": \"BRL\",\n \"price_cts\": 149900,\n \"description\": \"Versão atualizada do plano empresarial.\",\n \"code\": \"PLANO-EMP-PLUS\",\n \"is_active\": false,\n \"billing_cycle\": \"annually\",\n \"image\": \"https://exemplo.com/nova-imagem.png\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.vendaze.com/v1/products/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Plano Empresarial Plus\",\n \"currency\": \"BRL\",\n \"price_cts\": 149900,\n \"description\": \"Versão atualizada do plano empresarial.\",\n \"code\": \"PLANO-EMP-PLUS\",\n \"is_active\": false,\n \"billing_cycle\": \"annually\",\n \"image\": \"https://exemplo.com/nova-imagem.png\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Plano Empresarial",
    "price_cts": 99900,
    "currency": "BRL",
    "description": "Plano completo para grandes equipes.",
    "image_url": "https://storage.vendaze.com/client/workspaces/abc/products/xyz/image/avatar_Ab1Cd2Ef3G.webp",
    "code": "PLANO-EMP",
    "is_active": true,
    "billing_cycle": "monthly",
    "created_at": "2023-11-07T05:31:56Z"
  }
}
{
"error": {
"code": "bad_request",
"message": "Request body must be valid JSON.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"error": {
"code": "insufficient_scope",
"message": "This endpoint requires the 'webhooks:read' scope.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"error": {
"code": "not_found",
"message": "Webhook not found.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"error": {
"code": "conflict",
"message": "A record with this value already exists.",
"fields": {
"key": "Value already in use."
},
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"error": {
"code": "validation_error",
"message": "Validation failed.",
"fields": {
"url": "url must use HTTPS.",
"events": "At least one event is required."
},
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded. Try again in 60 seconds.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}

Autorizações

Authorization
string
header
obrigatório

Access token OAuth 2.1.

Parâmetros de caminho

id
string<uuid>
obrigatório

UUID do recurso.

Corpo

application/json

Todos os campos são opcionais. Apenas os campos enviados no body são alterados.

name
string

Novo nome do produto.

Required string length: 1 - 80
Exemplo:

"Plano Empresarial Plus"

currency
enum<string>

Código ISO 4217 de moeda suportado pela Vendaze.

Opções disponíveis:
AED,
ARS,
AUD,
BRL,
CAD,
CHF,
CLP,
CNY,
COP,
DKK,
EGP,
EUR,
GBP,
HKD,
ILS,
INR,
JPY,
KWD,
MAD,
MXN,
MYR,
NGN,
NOK,
NZD,
PEN,
QAR,
SAR,
SEK,
SGD,
TRY,
USD,
UYU,
ZAR
Exemplo:

"BRL"

price_cts
integer

Novo preço em centavos.

Intervalo necessário: 0 <= x <= 1000000000000000
Exemplo:

149900

description
string | null

Nova descrição. Envie null para remover.

Maximum string length: 1000
Exemplo:

"Versão atualizada do plano empresarial."

code
string | null

Novo código interno. Envie null para remover.

Maximum string length: 60
Exemplo:

"PLANO-EMP-PLUS"

is_active
boolean

Atualiza o status de ativo.

Exemplo:

false

billing_cycle
enum<string>

Novo ciclo de cobrança.

Opções disponíveis:
one_time,
monthly,
quarterly,
annually
Exemplo:

"annually"

image
string

Nova imagem do produto. Substitui a imagem atual.

Exemplo:

"https://exemplo.com/nova-imagem.png"

Resposta

Produto atualizado com sucesso.

data
object