Referência do modelo de dados do Klaviyo

Nesta página, listamos os dados transferidos para o BigQuery quando você executa uma transferência de dados do Klaviyo. Os dados são organizados em tabelas que listam cada nome de campo, o tipo de dados de destino associado e o caminho JSON dos dados de origem.

Contas

Informações e metadados da conta do Klaviyo.

  • Nome da tabela: Accounts
  • Endpoint: /accounts
  • Referência da API do Klaviyo: Get Accounts (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre account).
id STRING $.id Identificador exclusivo da conta.
test_account STRING $.attributes.test_account Indica se esta é uma conta de teste.
default_sender_name STRING $.attributes.contact_information.default_sender_name Nome padrão usado como remetente de e-mails.
default_sender_email STRING $.attributes.contact_information.default_sender_email Endereço de e-mail padrão usado como remetente.
website_url STRING $.attributes.contact_information.website_url URL do site da organização.
organization_name STRING $.attributes.contact_information.organization_name Nome da organização.
address1 STRING $.attributes.contact_information.street_address.address1 Linha de endereço 1.
address2 STRING $.attributes.contact_information.street_address.address2 Linha 2 do endereço.
city STRING $.attributes.contact_information.street_address.city Cidade da organização.
region STRING $.attributes.contact_information.street_address.region Estado, província ou região.
country STRING $.attributes.contact_information.street_address.country País.
zip STRING $.attributes.contact_information.street_address.zip Código postal ou CEP.
industry STRING $.attributes.industry Segmento do setor da conta.
timezone STRING $.attributes.timezone Configuração de fuso horário da conta.
preferred_currency STRING $.attributes.preferred_currency Moeda principal usada pela conta.
public_api_key STRING $.attributes.public_api_key Chave de API pública (ID do site) para integrações do lado do cliente.
locale STRING $.attributes.locale Configuração de localidade (por exemplo, en-US).

Cupons

Cupons para descontos e promoções.

  • Nome da tabela: Coupons
  • Endpoint: /coupons
  • Referência da API do Klaviyo: Get Coupons (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre coupon).
id STRING $.id Identificador interno exclusivo do cupom.
external_id STRING $.attributes.external_id Identificador externo (geralmente o mesmo que nome/ID).
description STRING $.attributes.description Descrição da oferta do cupom.
low_balance_threshold STRING $.attributes.monitor_configuration.low_balance_threshold Limite para acionar alertas de saldo baixo.

CouponCode

Códigos exclusivos individuais gerados para cupons específicos.

  • Nome da tabela: CouponCode
  • Endpoint: /coupon-codes
  • Referência da API Klaviyo: Get Coupon Codes (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre coupon-code).
id STRING $.id Identificador exclusivo desta instância de código específica.
unique_code STRING $.attributes.unique_code A string de código alfanumérico real.
expires_at TIMESTAMP $.attributes.expires_at Carimbo de data/hora em que este código expira.
status STRING $.attributes.status Status do código (por exemplo, ASSIGNED, UNASSIGNED).
coupon_id STRING $.relationships.coupon.data.id ID da definição de cupom principal.

Eventos

Eventos de atividade monitorados para perfis (por exemplo, Pedido feito, Produto visualizado).

  • Nome da tabela: Events
  • Endpoint: /events
  • Referência da API do Klaviyo: Get Events (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre event).
id STRING $.id Identificador exclusivo do evento.
timestamp FLOAT $.attributes.timestamp Carimbo de data/hora Unix de quando o evento ocorreu.
event_properties JSON $.attributes.event_properties Propriedades JSON personalizadas específicas do tipo de evento (por exemplo, itens no pedido).
datetime TIMESTAMP $.attributes.datetime Carimbo de data/hora ISO 8601 do evento.
uuid STRING $.attributes.uuid Identificador universalmente exclusivo do evento.
profile_id STRING $.relationships.profile.data.id ID do perfil (cliente) associado ao evento.
metric_id STRING $.relationships.metric.data.id ID da definição da métrica (tipo de evento).
attribution_ids REPEATED STRING $.relationships.attributions.data[*].id IDs das campanhas/fluxos atribuídos a esse evento.

Flows

Fluxos de marketing automatizados acionados por eventos ou condições específicas.

  • Nome da tabela: Flows
  • Endpoint: /flows
  • Referência da API do Klaviyo: Get Flows (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre flow).
id STRING $.id Identificador exclusivo do fluxo.
name STRING $.attributes.name Nome do fluxo.
status STRING $.attributes.status Status operacional (por exemplo, ativo, rascunho).
archived BOOLEANO $.attributes.archived Indica se o fluxo está arquivado.
created TIMESTAMP $.attributes.created Carimbo de data/hora da criação.
updated TIMESTAMP $.attributes.updated Carimbo de data/hora da última modificação.
trigger_type STRING $.attributes.trigger_type Mecanismo que aciona o fluxo (por exemplo, "Adicionado à lista", "Métrica").
flow_actions_ids REPEATED STRING $.relationships.flow-actions.data[*].id IDs das ações (etapas) neste fluxo.
tag_ids REPEATED STRING $.relationships.tags.data[*].id IDs das tags atribuídas a esse fluxo.

Formulários

Formulários de inscrição para coletar informações de assinantes.

  • Nome da tabela: Forms
  • Endpoint: /forms
  • Referência da API Klaviyo: Get Forms (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre form).
id STRING $.id Identificador exclusivo do formulário.
name STRING $.attributes.name Nome do formulário.
status STRING $.attributes.status Status do formulário (por exemplo, ativo, rascunho).
ab_test BOOLEANO $.attributes.ab_test Se o formulário está executando um teste A/B.
created_at TIMESTAMP $.attributes.created_at Carimbo de data/hora da criação.
updated_at TIMESTAMP $.attributes.updated_at Carimbo de data/hora da última modificação.

Imagens

Imagens enviadas ao Klaviyo para uso em campanhas e modelos.

  • Nome da tabela: Images
  • Endpoint: /images
  • Referência da API Klaviyo: Get Images
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre image).
id STRING $.id Identificador exclusivo.
name STRING $.attributes.name Nome do arquivo ou da imagem.
image_url STRING $.attributes.image_url URL público para acessar a imagem.
format STRING $.attributes.format Formato do arquivo de imagem (por exemplo, jpeg, png).
size FLOAT $.attributes.size Tamanho do arquivo em bytes.
hidden BOOLEANO $.attributes.hidden Indica se a imagem está oculta na UI.
updated_at TIMESTAMP $.attributes.updated_at Carimbo de data/hora da última modificação.

Listas

Listas estáticas de contatos/perfis.

  • Nome da tabela: Lists
  • Endpoint: /lists
  • Referência da API Klaviyo: Get Lists
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre list).
id STRING $.id Identificador exclusivo da lista.
name STRING $.attributes.name Nome da lista de contatos.
created TIMESTAMP $.attributes.created Carimbo de data/hora da criação.
updated TIMESTAMP $.attributes.updated Carimbo de data/hora da última modificação.
opt_in_process STRING $.attributes.opt_in_process Configuração de ativação (por exemplo, 'single_opt_in' ou 'double_opt_in').
tag_ids REPEATED STRING $.relationships.tags.data[*].id IDs das tags atribuídas a esta lista.
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id IDs dos fluxos acionados ao adicionar perfis a essa lista.

Métricas

Tipos de eventos que podem ser rastreados (por exemplo, "E-mail recebido").

  • Nome da tabela: Metrics
  • Endpoint: /metrics
  • Referência da API do Klaviyo: Get Metrics (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre metric).
id STRING $.id Identificador exclusivo (por exemplo, Código de seis caracteres para UUID genérico e longo para personalização.
name STRING $.attributes.name Nome legível (por exemplo, "Pedido feito").
created TIMESTAMP $.attributes.created Carimbo de data/hora da criação.
updated TIMESTAMP $.attributes.updated Carimbo de data/hora da última modificação.
integration JSON $.attributes.integration Informações sobre a integração que fornece essa métrica (por exemplo, nome, categoria, imagem).
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id IDs dos fluxos acionados por essa métrica.

Perfis

Perfis de clientes abrangentes com atributos e histórico de atividades.

  • Nome da tabela: Profiles
  • Endpoint: /profiles
  • Referência da API Klaviyo: Get Profiles (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre profile).
id STRING $.id ID exclusivo do perfil no Klaviyo.
email STRING $.attributes.email Endereço de e-mail principal.
phone_number STRING $.attributes.phone_number Número de telefone no formato E.164.
external_id STRING $.attributes.external_id ID de um sistema externo.
first_name STRING $.attributes.first_name Nome
last_name STRING $.attributes.last_name Sobrenome
organization STRING $.attributes.organization Nome da empresa ou organização.
locale STRING $.attributes.locale Configuração de localidade/idioma.
title STRING $.attributes.title Cargo.
image STRING $.attributes.image URL da imagem do perfil.
created TIMESTAMP $.attributes.created Carimbo de data/hora da criação do perfil.
updated TIMESTAMP $.attributes.updated Carimbo de data/hora da última atualização.
last_event_date TIMESTAMP $.attributes.last_event_date Carimbo de data/hora do evento mais recente.
address1 STRING $.attributes.location.address1 Linha de endereço 1.
address2 STRING $.attributes.location.address2 Linha de endereço 2.
city STRING $.attributes.location.city Cidade.
country STRING $.attributes.location.country País.
latitude STRING $.attributes.location.latitude Coordenadas de latitude.
longitude STRING $.attributes.location.longitude Coordenadas de longitude.
region STRING $.attributes.location.region Estado ou região.
zip STRING $.attributes.location.zip Código postal ou CEP.
timezone STRING $.attributes.location.timezone Fuso horário.
ip STRING $.attributes.location.ip sem precisar de endereço IP externo.
properties JSON $.attributes.properties Pares de chave-valor de propriedades personalizadas.
email_marketing_can_receive_email_marketing BOOLEANO $.attributes.subscriptions.email.marketing.can_receive_email_marketing Se o perfil pode receber e-mail marketing.
email_marketing_consent STRING $.attributes.subscriptions.email.marketing.consent Status de consentimento (por exemplo, SUBSCRIBED, UNSUBSCRIBED).
email_marketing_consent_timestamp TIMESTAMP $.attributes.subscriptions.email.marketing.consent_timestamp Quando o consentimento foi dado.
email_marketing_last_updated TIMESTAMP $.attributes.subscriptions.email.marketing.last_updated Quando o consentimento por e-mail foi atualizado pela última vez.
email_marketing_method STRING $.attributes.subscriptions.email.marketing.method Método de consentimento (por exemplo, FORM).
email_marketing_method_detail STRING $.attributes.subscriptions.email.marketing.method_detail Origem específica do método.
email_marketing_custom_method_detail STRING $.attributes.subscriptions.email.marketing.custom_method_detail Detalhes personalizados para o método de consentimento.
email_marketing_double_optin BOOLEANO $.attributes.subscriptions.email.marketing.double_optin Se a dupla confirmação foi concluída.
sms_marketing_can_receive_sms_marketing BOOLEANO $.attributes.subscriptions.sms.marketing.can_receive_sms_marketing Se o perfil pode receber marketing por SMS.
sms_marketing_consent STRING $.attributes.subscriptions.sms.marketing.consent Status de consentimento para SMS.
sms_marketing_consent_timestamp TIMESTAMP $.attributes.subscriptions.sms.marketing.consent_timestamp Quando o consentimento para envio de SMS foi dado.
sms_marketing_last_updated TIMESTAMP $.attributes.subscriptions.sms.marketing.last_updated Quando o consentimento para SMS foi atualizado pela última vez.
sms_marketing_method STRING $.attributes.subscriptions.sms.marketing.method Método de consentimento por SMS.
sms_marketing_method_detail STRING $.attributes.subscriptions.sms.marketing.method_detail Detalhes do método de consentimento por SMS.
sms_transactional_can_receive_sms_transactional BOOLEANO $.attributes.subscriptions.sms.transactional.can_receive_sms_transactional Se o perfil pode receber SMS transacionais.
sms_transactional_consent STRING $.attributes.subscriptions.sms.transactional.consent Status de consentimento para SMS transacionais.
sms_transactional_consent_timestamp TIMESTAMP $.attributes.subscriptions.sms.transactional.consent_timestamp Quando o consentimento transacional foi dado.
sms_transactional_last_updated TIMESTAMP $.attributes.subscriptions.sms.transactional.last_updated Quando o status transacional foi atualizado pela última vez.
sms_transactional_method STRING $.attributes.subscriptions.sms.transactional.method Método de SMS transacional.
sms_transactional_method_detail STRING $.attributes.subscriptions.sms.transactional.method_detail Detalhes do método de SMS transacional.
mobile_push_can_receive_push_marketing BOOLEANO $.attributes.subscriptions.mobile_push.marketing.can_receive_push_marketing Se o perfil pode receber marketing por push.
mobile_push_consent STRING $.attributes.subscriptions.mobile_push.marketing.consent Envie o status de consentimento.
mobile_push_consent_timestamp TIMESTAMP $.attributes.subscriptions.mobile_push.marketing.consent_timestamp Quando o consentimento para notificações push foi concedido.
predictive_analytics_historic_number_of_orders FLOAT $.attributes.predictive_analytics.historic_number_of_orders Total de pedidos históricos.
predictive_analytics_predicted_number_of_orders FLOAT $.attributes.predictive_analytics.predicted_number_of_orders Pedidos futuros previstos.
predictive_analytics_average_days_between_orders FLOAT $.attributes.predictive_analytics.average_days_between_orders Média de dias entre os pedidos.
predictive_analytics_average_order_value FLOAT $.attributes.predictive_analytics.average_order_value Valor médio histórico do pedido.
predictive_analytics_historic_clv FLOAT $.attributes.predictive_analytics.historic_clv Valor histórico de vida útil do cliente.
predictive_analytics_predicted_clv FLOAT $.attributes.predictive_analytics.predicted_clv Valor da vida útil do cliente estimado.
predictive_analytics_total_clv FLOAT $.attributes.predictive_analytics.total_clv CLV histórico e previsto.
predictive_analytics_churn_probability FLOAT $.attributes.predictive_analytics.churn_probability Probabilidade de desistência (0 a 1).
predictive_analytics_expected_date_of_next_order TIMESTAMP $.attributes.predictive_analytics.expected_date_of_next_order Data prevista do próximo pedido.
email_marketing_suppression_reason JSON REPETIDO $.attributes.subscriptions.email.marketing.suppression[*] Motivos para a supressão de e-mails (por exemplo, devolução).
email_marketing_list_suppressions_reason JSON REPETIDO $.attributes.subscriptions.email.marketing.list_suppressions[*] Motivos de supressão específicos da lista.
push_tokens_ids REPEATED STRING $.relationships.push-tokens.data[*].id IDs de token de envio por push associados.

Avaliações

Avaliações de produtos enviadas por clientes.

  • Nome da tabela: Reviews
  • Endpoint: /reviews
  • Referência da API do Klaviyo: Get Reviews
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre review).
id STRING $.id Identificador exclusivo da avaliação.
email STRING $.attributes.email E-mail do avaliador.
value STRING $.attributes.status.value Valor do status (por exemplo, publicado, rejeitado).
reason STRING $.attributes.status.rejection_reason.reason Motivo da rejeição, se aplicável.
status_explanation STRING $.attributes.status.rejection_reason.status_explanation Explicação detalhada do status.
verified BOOLEANO $.attributes.verified Se a compra foi verificada.
review_type STRING $.attributes.review_type Tipo de avaliação (por exemplo, avaliação do produto).
created TIMESTAMP $.attributes.created Carimbo de data/hora da criação.
updated TIMESTAMP $.attributes.updated Carimbo de data/hora da última modificação.
images REPEATED STRING $.attributes.images[*] URLs das imagens anexadas à avaliação.
product_url STRING $.attributes.product.url URL do produto avaliado.
product_name STRING $.attributes.product.name Nome do produto.
product_image_url STRING $.attributes.product.image_url URL da imagem do produto.
product_external_id STRING $.attributes.product.external_id ID externo do produto.
rating INTEGER $.attributes.rating Pontuação da classificação.
author STRING $.attributes.author Nome do avaliador.
content STRING $.attributes.content Conteúdo de texto da avaliação.
title STRING $.attributes.title Título da avaliação.
smart_quote STRING $.attributes.smart_quote Citação destacada da avaliação.
public_reply_content STRING $.attributes.public_reply.content Conteúdo da resposta pública do comerciante.
public_reply_author STRING $.attributes.public_reply.author Autor da resposta.
public_reply_updated STRING $.attributes.public_reply.updated Carimbo de data/hora da atualização da resposta.
event_ids REPEATED STRING $.relationships.events.data[*].id IDs de evento associados.

Segmentos

Grupos dinâmicos de perfis com base em critérios específicos.

  • Nome da tabela: Segments
  • Endpoint: /segments
  • Referência da API do Klaviyo: Get Segments (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre segment).
id STRING $.id Identificador exclusivo do segmento.
name STRING $.attributes.name Nome do segmento.
created TIMESTAMP $.attributes.created Carimbo de data/hora da criação.
updated TIMESTAMP $.attributes.updated Carimbo de data/hora da última modificação.
is_active BOOLEANO $.attributes.is_active Indica se o segmento está ativo.
is_processing BOOLEANO $.attributes.is_processing Se o segmento está sendo processado.
is_starred BOOLEANO $.attributes.is_starred Se o segmento foi marcado com estrela/adicionado aos favoritos.
tag_ids REPEATED STRING $.relationships.tags.data[*].id IDs das tags associadas.
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id IDs dos fluxos acionados por esse segmento.
condition_groups REGISTRO REPETIDO $.attributes.definition.condition_groups[*] Grupos de condições lógicas que definem o segmento.

ConditionGroup

Nome do campo Tipo Caminho de JSON Descrição
conditions Condição REPEATED conditions[*] Lista de condições individuais no grupo.

Condição

Nome do campo Tipo Caminho de JSON Descrição
type STRING type Tipo de condição (por exemplo, perfil-propriedade).
value JSON N/A Valor/configuração da condição.

Tags

Tags usadas para organizar campanhas, fluxos e listas.

  • Nome da tabela: Tags
  • Endpoint: /tags
  • Referência da API do Klaviyo: Get Tags (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre tag).
id STRING $.id Identificador exclusivo da tag.
name STRING $.attributes.name Nome da tag.
tag_group_id STRING $.relationships.tag-group.data.id ID do grupo a que a tag pertence.

Modelos

Modelos de e-mail e mensagem.

  • Nome da tabela: Templates
  • Endpoint: /templates
  • Referência da API do Klaviyo: Get Templates
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre template).
id STRING $.id Identificador exclusivo.
name STRING $.attributes.name Nome do modelo.
editor_type STRING $.attributes.editor_type Editor usado (por exemplo, arrastar e soltar).
html STRING $.attributes.html Conteúdo HTML
text STRING $.attributes.text Versão de texto do modelo.
amp STRING $.attributes.amp Versão AMP do modelo.
created TIMESTAMP $.attributes.created Carimbo de data/hora da criação.
updated TIMESTAMP $.attributes.updated Carimbo de data/hora da última atualização.

WebFeeds

Feeds da Web usados para preencher o conteúdo das mensagens.

  • Nome da tabela: WebFeeds
  • Endpoint: /web-feeds
  • Referência da API do Klaviyo: Get Web Feeds (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre web-feed).
id STRING $.id Identificador exclusivo.
name STRING $.attributes.name Nome do feed.
url STRING $.attributes.url URL da origem do feed.
request_method STRING $.attributes.request_method Método HTTP (GET/POST).
content_type STRING $.attributes.content_type Tipo de conteúdo (por exemplo, JSON).
status STRING $.attributes.status Status do feed.
created TIMESTAMP $.attributes.created Carimbo de data/hora da criação.
updated TIMESTAMP $.attributes.updated Carimbo de data/hora da última atualização.

DataSources

Fontes de dados integradas ao Klaviyo.

  • Nome da tabela: DataSources
  • Endpoint: /data-sources
  • Referência da API do Klaviyo: Get Data Sources (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre data-source).
id STRING $.id Identificador exclusivo.
title STRING $.attributes.title Título da fonte de dados.
visibility STRING $.attributes.visibility Nível de visibilidade.
description STRING $.attributes.description Texto da descrição.

Campanhas

Campanhas de marketing enviadas para listas ou segmentos.

  • Nome da tabela: Campaigns
  • Endpoint: /campaigns
  • Referência da API do Klaviyo: Get Campaigns (Acessar campanhas)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre campaign).
id STRING $.id Identificador exclusivo.
name STRING $.attributes.name Nome da campanha.
status STRING $.attributes.status Status da campanha (por exemplo, Enviadas, Programação).
archived BOOLEANO $.attributes.archived Indica se a campanha está arquivada.
included REPEATED STRING $.attributes.audiences.included IDs das listas/segmentos incluídos.
excluded REPEATED STRING $.attributes.audiences.excluded IDs de listas/segmentos excluídos.
send_options JSON $.attributes.send_options Configuração para envio (por exemplo, envio inteligente).
tracking_options JSON $.attributes.tracking_options Configuração para acompanhamento (por exemplo, parâmetros utm).
send_strategy JSON $.attributes.send_strategy Estratégia para o tempo de entrega.
created_at TIMESTAMP $.attributes.created_at Carimbo de data/hora da criação.
scheduled_at TIMESTAMP $.attributes.scheduled_at Quando a campanha está programada para ser enviada.
updated_at TIMESTAMP $.attributes.updated_at Carimbo de data/hora da última atualização.
send_time TIMESTAMP $.attributes.send_time Hora real do envio.
tag_ids REPEATED STRING $.relationships.tags.data[*].id IDs das tags associadas.
campaign_message_ids REPEATED STRING $.relationships.campaign-messages.data[*].id IDs das mensagens contidas nesta campanha.

CampaignMessages

Mensagens individuais (e-mail/SMS) em uma campanha.

  • Nome da tabela: CampaignMessages
  • Endpoint: /campaign-messages
  • Referência da API Klaviyo: Get Campaign Message (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso (sempre campaign-message).
id STRING $.id Identificador exclusivo.
definition JSON $.attributes.definition Conteúdo e configuração da mensagem.
send_times JSON REPETIDO $.attributes.send_times[*] Horários de envio programado.
created_at TIMESTAMP $.attributes.created_at Carimbo de data/hora da criação.
updated_at TIMESTAMP $.attributes.updated_at Carimbo de data/hora da última atualização.
campaign_id STRING $.relationships.campaign.data.id ID da campanha principal.
template_id STRING $.relationships.template.data.id ID do modelo usado.
image_id STRING $.relationships.image.data.id ID da imagem anexada.

Categorias

Categorias de produtos do seu catálogo.

  • Nome da tabela: Categories
  • Endpoint: /catalog-categories
  • Referência da API Klaviyo: Get Catalog Categories (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso.
id STRING $.id Identificador exclusivo.
name STRING $.attributes.name Nome da categoria.
external_id STRING $.attributes.external_id ID do sistema externo.
updated TIMESTAMP $.attributes.updated Carimbo de data/hora da última atualização.

Itens

Produtos ou itens individuais no seu catálogo.

  • Nome da tabela: Items
  • Endpoint: /catalog-items
  • Referência da API Klaviyo: Get Catalog Items (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso.
id STRING $.id Identificador exclusivo.
external_id STRING $.attributes.external_id ID do sistema externo.
title STRING $.attributes.title Título/nome do item.
description STRING $.attributes.description Descrição disponível.
price FLOAT $.attributes.price Preço do item.
url STRING $.attributes.url URL do item.
image_full_url STRING $.attributes.image_full_url URL da imagem em tamanho original.
image_thumbnail_url STRING $.attributes.image_thumbnail_url URL da imagem em miniatura.
images REPEATED STRING $.attributes.images[*] Lista de URLs de imagens adicionais.
custom_metadata JSON $.attributes.custom_metadata Chaves-valor de metadados personalizados.
published BOOLEANO $.attributes.published Status da publicação.
created TIMESTAMP $.attributes.created Carimbo de data/hora da criação.
updated TIMESTAMP $.attributes.updated Carimbo de data/hora da última atualização.
variants_ids REPEATED STRING $.relationships.variants.data[*].id IDs das variantes deste item.

Variantes

Variantes específicas de itens do catálogo (por exemplo, tamanhos e cores).

  • Nome da tabela: Variants
  • Endpoint: /catalog-variants
  • Referência da API Klaviyo: Get Catalog Variants (em inglês)
Nome do campo Tipo Caminho de JSON Descrição
type STRING $.type Tipo de recurso.
id STRING $.id Identificador exclusivo.
external_id STRING $.attributes.external_id ID do sistema externo.
title STRING $.attributes.title Título da variante.
description STRING $.attributes.description Descrição disponível.
sku STRING $.attributes.sku Unidade de manutenção de estoque.
inventory_policy FLOAT $.attributes.inventory_policy Política de gerenciamento de inventário.
inventory_quantity FLOAT $.attributes.inventory_quantity Quantidade atual em estoque.
price FLOAT $.attributes.price Preço.
url STRING $.attributes.url URL da variante.
image_full_url BOOLEANO $.attributes.image_full_url URL da imagem completa disponível (booleano).
image_thumbnail_url STRING $.attributes.image_thumbnail_url URL da imagem em miniatura.
images REPEATED STRING $.attributes.images[*] Lista de imagens.
published BOOLEANO $.attributes.published Status da publicação.
created TIMESTAMP $.attributes.created Carimbo de data/hora da criação.
updated TIMESTAMP $.attributes.updated Carimbo de data/hora da última atualização.