Engage / API v1
Produtos

Criar produto

Cadastra um novo produto no catálogo da sua conta.

POST/v1/products

Cria um produto vinculado à empresa dona da chave de API. O sku precisa ser único na sua conta — tentativas com um valor já existente retornam 409 Conflict.

Obrigatório

sku, name e price são obrigatórios. Os demais campos do body são opcionais.

Exemplo mínimo

json
{
  "sku": "PROD-001",
  "name": "Camiseta Básica",
  "price": 49.9
}

Exemplo completo

json
{
  "sku": "PROD-001",
  "name": "Camiseta Básica",
  "description": "100% algodão, gola redonda",
  "price": 49.9,
  "customFields": {
    "color": "vermelha",
    "weight": "150"
  }
}

Parâmetros do body

  • skustringobrigatório
    Código único do produto na sua conta. Não pode se repetir.
  • namestringobrigatório
    Nome do produto.
  • pricenumberobrigatório
    Preço em decimal. Mínimo 0.
  • descriptionstringopcional
    Descrição livre do produto.
  • customFieldsobjectopcional
    Mapa { <nome do campo>: valor } com os campos customizados da entidade Produto. Cada chave deve bater exatamente com o nome do campo configurado no painel — chaves desconhecidas retornam 400 Bad Request. Veja campos customizados para detalhes de validação.

Campos da resposta

  • idstring (uuid)opcional
    Identificador único gerado pelo Engage. Use-o em chamadas subsequentes.
  • skustringopcional
    SKU enviado.
  • namestringopcional
    Nome enviado.
  • descriptionstring | nullopcional
    Descrição enviada, ou null se omitida.
  • pricenumberopcional
    Preço enviado.
  • createdAtstring (ISO 8601)opcional
    Data e hora de criação.

Possíveis erros

  • 400
    Unknown custom fields: <nomes>Alguma chave do customFields não corresponde a um campo cadastrado para a entidade Produto.
  • 400
    ValidaçãoAlgum campo obrigatório está ausente, ou um campo enviou um tipo incompatível (ex.: price negativo, name vazio).
  • 401
    Invalid API keyHeader x-api-key ausente, inválido ou revogado.
  • 409
    Este SKU já está em uso por outro produtoO sku informado já existe em outro produto da sua conta.