Skip to main content
PATCH
Atualizar produto

Autorizações

Authorization
string
header
obrigatório

Chave secreta da conta: Authorization: Bearer sk_test_… ou sk_live_…. Use só no servidor.

Cabeçalhos

Idempotency-Key
string

Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original.

Parâmetros de caminho

productID
string<uuid>
obrigatório

ID do produto.

Corpo

application/json
name
string
obrigatório

Nome do produto.

description
string | null

Descrição do produto. Omitir ou enviar null apaga a descrição atual.

status
enum<string>

active ou archived. Sempre envie.

Opções disponíveis:
active,
archived
imageObjectKey
string | null

O objectKey devolvido por POST /catalog/images/presign. Ausente mantém a foto atual; "" remove a foto. É recusado se a chave não foi gerada para a sua conta.

requiresShipping
boolean | null

Se a compra exige entrega física. Quando true, o checkout pede o endereço de entrega. Ausente mantém o valor atual.

Resposta

O produto atualizado.

Um item do catálogo. O preço fica nas versões do produto.

id
string<uuid>
key
string | null

Chave estável que você escolhe para o produto, única na sua conta. Permite criar o mesmo produto de novo sem duplicar.

name
string
type
enum<string>

item (padrão) ou agent.

Opções disponíveis:
agent,
item
description
string | null
pricingModel
enum<string>

Como o produto é cobrado: subscription, one_time, usage ou prepaid.

Opções disponíveis:
subscription,
one_time,
usage,
prepaid
currency
string

Código ISO 4217 de 3 letras, como BRL.

Exemplo:

"BRL"

status
string

active ou archived.

Exemplo:

"active"

imageUrl
string | null

Endereço público da foto do produto.

requiresShipping
boolean

Se a compra exige entrega física; quando true, o checkout pede endereço.

createdAt
string<date-time>
updatedAt
string<date-time>