Products
Update a Product
Atualiza um produto.
Atualiza um
product com semântica de merge: campos ausentes ficam como
estão; envie null para limpar campos opcionais. metadata, quando enviado,
substitui o objeto inteiro.
A resposta direta não carrega diff; quem precisa de diff lê o webhook
product.updated.
Autenticação
A API key da própria organização atua diretamente. A API key de plataforma exige o headerOrganization: <organization_id> apontando para uma organização
conectada ativa.
Parâmetros de caminho
ID do produto (
prod_*).Attributes
Todos os campos são opcionais.Aponta o
default_price_id para outro preço existente do mesmo produto.
Envie null para limpar.Nova descrição. Envie
null para limpar.Nova imagem. Use a URL retornada por
POST /v1/files com
purpose=product_image. Envie null para limpar. URLs externas não são
aceitas.false tira o produto de novos fluxos de compra. true reativa.Ajusta a flag tributável.
Substitui completamente o
metadata atual quando enviado.Novo nome. Quando enviado, não pode ser vazio.
Resposta
200 OK com o objeto product completo (mesmo shape de
GET /v1/products/:id).
Erros comuns
| Status | code | Quando ocorre |
|---|---|---|
400 | invalid_request | name enviado vazio; is_tax_applicable/is_active não-boolean; metadata não-objeto; default_price_id não pertence ao produto |
400 | invalid_request | image_url não aponta para um file ativo de purpose=product_image da organização |
404 | resource_missing | Produto não existe nesta organização |
Webhook
A atualização disparaproduct.updated
com o product completo em data.object e o diff em data.previous_attributes.
