Pular para o conteúdo principal
PUT
Update product

📌 Endpoint

PUT /stores/{storeId}/products/{productId} Atualiza os dados de um produto existente.

🔐 Autenticação

  • Rota privada.
  • Requer header Authorization com sua API key e plano ativo.

🧾 Parâmetros de rota


🧍 Body (JSON)

Todos os campos são opcionais (enviar null mantém o valor atual do campo), mas devem respeitar as regras abaixo quando enviados:
  • name (3-32)
  • image (string até 512 caracteres; enviar "" remove a imagem, enquanto null mantém inalterada)
  • description (12-256)
  • categoryIds (array de IDs de categorias da loja)
  • delivery (DIGITAL ou PHYSICAL)
  • price (0.5 a 9999)
  • stock (inteiro -1 a 9999, -1 ilimitado)
  • disabled (true ou false)
  • position (inteiro maior ou igual a 1)
  • metadata (objeto)

✅ Exemplo de requisição


Snippet padrao (cURL)

Use o exemplo cURL da secao Exemplo de requisicao acima como snippet oficial.

📦 Resposta de sucesso (200)


⚠️ Possíveis erros

  • 400 INVALID_DATA → body, parâmetros ou item de categoryIds inválido
  • 400 INVALID_DATA_NAME_MIN → name com menos de 3 caracteres
  • 400 INVALID_DATA_NAME_MAX → name com mais de 32 caracteres
  • 400 INVALID_DATA_IMAGE → image com mais de 512 caracteres
  • 400 INVALID_DATA_DESCRIPTION_MIN → description com menos de 12 caracteres
  • 400 INVALID_DATA_DESCRIPTION_MAX → description com mais de 256 caracteres
  • 400 INVALID_DATA_DELIVERY → delivery diferente de DIGITAL ou PHYSICAL
  • 400 INVALID_DATA_PRICE → price fora do intervalo 0.5 a 9999
  • 400 INVALID_DATA_STOCK → stock fora do intervalo -1 a 9999
  • 400 INVALID_DATA_POSITION → position menor que 1
  • 400 CATEGORY_NOT_FOUND → uma ou mais categorias em categoryIds não encontradas na loja
  • 400 NAME_ALREADY_EXISTS → nome já utilizado
  • 401 API_KEY_NOT_PROVIDED → header Authorization não enviado (ou TOKEN_NOT_PROVIDED via Bearer)
  • 401 INVALID_API_KEY → API Key inválida (ou INVALID_TOKEN / TOKEN_EXPIRED / SESSION_NOT_FOUND / SESSION_EXPIRED / UNAUTHENTICATED via Bearer)
  • 403 USER_DISABLED → usuário desativado ou excluído
  • 403 NO_ACTIVE_SUBSCRIPTION → plano inativo ou expirado (ou PENDING_2FA via Bearer)
  • 404 STORE_NOT_FOUND → loja não encontrada
  • 404 PRODUCT_NOT_FOUND → produto não encontrado
  • 429 RATE_LIMIT_EXCEEDED → limite de requisições por minuto excedido
  • 500 INTERNAL_SERVER_ERROR → erro interno
  • 503 SERVICE_UNAVAILABLE → serviço ou banco de dados indisponível

Autorizações

Authorization
string
header
padrão:YOUR_API_KEY_HERE
obrigatório

Parâmetros de caminho

storeId
string
obrigatório
Required string length: 1 - 50
productId
string
obrigatório
Required string length: 1 - 50

Corpo

application/json

Product fields to update.

name
string
Required string length: 3 - 32
image
string | null
Maximum string length: 512
description
string
Required string length: 12 - 256
categoryIds
string[]
Required string length: 1 - 50
delivery
enum<string>
Opções disponíveis:
DIGITAL,
PHYSICAL
price
number
Intervalo obrigatório: 0.5 <= x <= 9999
stock
integer
Intervalo obrigatório: -1 <= x <= 9999
position
integer
Intervalo obrigatório: x >= 1
metadata
object
disabled
boolean

Resposta

Update product.

code
string
obrigatório
Exemplo:

"SUCCESS"

product
object
obrigatório

Store product.