Skip to main content
PATCH
/
api
/
products
/
{id}
Atualizar Produto
curl --request PATCH \
  --url https://garu.com.br/api/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "value": 123,
  "pix": true,
  "creditCard": true,
  "boleto": true,
  "installments": 123,
  "image": "<string>",
  "returnUrl": "<string>",
  "returnUrlButtonText": "<string>"
}
'

​
Visão Geral

Use este endpoint para atualizar as informações de um produto existente. Apenas os campos enviados serão atualizados.

​
Parâmetros de Path

​
id
number
required
ID do produto a ser atualizado.

​
Parâmetros do Body

Todos os campos são opcionais. Envie apenas os que deseja atualizar.
​
name
string
Novo nome do produto.
​
description
string
Nova descrição do produto.
​
value
number
Novo preço do produto (mínimo R$ 5,00).
​
pix
boolean
Habilitar/desabilitar pagamento via PIX.
​
creditCard
boolean
Habilitar/desabilitar pagamento via cartão de crédito.
​
boleto
boolean
Habilitar/desabilitar pagamento via boleto.
​
installments
number
Novo número máximo de parcelas (1-12).
​
image
string
Nova URL da imagem do produto.
​
returnUrl
string
Nova URL de retorno após pagamento.
​
returnUrlButtonText
string
Novo texto do botão de retorno.

​
Exemplo de Requisição

curl -X PATCH https://garu.com.br/api/products/123 \
  -H "Authorization: Bearer sk_test_sua_chave_api" \
  -H "Content-Type: application/json" \
  -d '{
    "value": 347.00,
    "installments": 6
  }'

​
Resposta de Sucesso (200 OK)

{
  "id": 123,
  "name": "Curso de Marketing Digital",
  "description": "Aprenda marketing digital do zero ao avançado",
  "value": 347.00,
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "pix": true,
  "creditCard": true,
  "boleto": true,
  "installments": [
    { "quantity": 1, "value": 347.00 },
    { "quantity": 2, "value": 179.32 },
    { "quantity": 3, "value": 122.61 },
    { "quantity": 4, "value": 94.28 },
    { "quantity": 5, "value": 77.30 },
    { "quantity": 6, "value": 66.05 }
  ],
  "isActive": true,
  "createdAt": "2024-12-24T10:30:00.000Z",
  "updatedAt": "2024-12-24T14:45:00.000Z"
}
O uuid do produto não muda ao atualizar. O link de pagamento permanece o mesmo.

​
Erros Comuns

{
  "statusCode": 404,
  "message": "Product not found"
}
Solução: Verifique se o ID do produto está correto.
{
  "statusCode": 403,
  "message": "Insufficient permissions"
}
Solução: Você só pode atualizar produtos criados com sua conta.

​
Próximos Passos

Excluir Produto

Desative um produto

Webhooks

Receba notificações de eventos