Engage / API v1
Produtos

Buscar por ID

Retorna os dados completos de um produto a partir do seu identificador único.

GET/v1/products/id/:id

Use este endpoint quando você já conhece o id do produto — geralmente recebido na resposta de POST /v1/products ou armazenado no seu sistema. A resposta inclui os dados principais do produto e o objeto customFields com os campos customizados configurados para a entidade.

Obrigatório

Apenas o parâmetro de path id é obrigatório. Não há body nem query string.

Exemplo

http
GET /v1/products/id/f7e8d9c0-1a2b-3c4d-5e6f-7a8b9c0d1e2f

Parâmetros de path

  • idstring (uuid)obrigatório
    Identificador único do produto na sua conta. Recebido no campo id da resposta de criação.

Campos da resposta

  • idstringopcional
    Identificador único do produto.
  • skustringopcional
    Código único do produto.
  • namestringopcional
    Nome do produto.
  • descriptionstring | nullopcional
    Descrição livre, ou null se não foi preenchida.
  • pricenumberopcional
    Preço em decimal.
  • createdAtstring (ISO 8601)opcional
    Data e hora de criação.
  • customFieldsobjectopcional
    Mapa { <nome do campo>: valor } com os campos customizados preenchidos. Vazio se nenhum campo foi definido.