Ir para o conteúdo

Metacampos de pedidos da Shopify

Com a integração padrão da Shopify, você pode adicionar metacampos de pedidos selecionados aos eventos de pedidos. Os metacampos de pedidos armazenam seus próprios dados sobre um pedido, como uma mensagem de presente ou uma preferência de entrega.

Você pode selecionar até 20 definições de metacampos de pedidos. A Braze grava esses metacampos nos eventos de pedidos da Shopify compatíveis para que você possa usá-los na segmentação e na personalização.

Como os metacampos de pedidos aparecem nos eventos

Cada metacampo selecionado é adicionado ao objeto metadata do evento como <namespace>_<key>, junto a campos como metadata.tags. Por exemplo, a definição da Shopify custom.gift_note aparece como metadata.custom_gift_note:

{
  "metadata": {
    "order_number": "1234",
    "tags": ["heavy", "heavy2"],
    "custom_gift_note": "Happy birthday!"
  }
}

As tags de pedidos não mudam: a Braze continua enviando todas as tags no evento. Valores de metacampos vazios são omitidos.

Tipos de metacampos de pedidos compatíveis

Somente definições com os tipos a seguir aparecem no seletor. Referências, arquivos, JSON, valores monetários e classificações não são oferecidos.

Tipo na Shopify Armazenado no evento como
Texto de linha única, Texto de várias linhas, Cor, URL, ID String
Inteiro Inteiro
Decimal Número
Verdadeiro ou falso Booleano
Data, Data e hora String ISO 8601 em UTC. Uma data sem hora fica registrada à meia-noite UTC.
Lista de textos de linha única, datas, datas e horas, cores, IDs ou URLs Array de strings

A Braze omite um valor do evento quando:

  • Um valor da string, ou um item de uma lista, tem mais de 255 caracteres.
  • Um valor não pode ser convertido para o tipo da definição, por exemplo, texto em um campo de inteiro.
  • A chave (<namespace>_<key>) tem mais de 255 caracteres ou contém $ ou ..
  • A chave entra em conflito com uma propriedade que a Braze já grava no evento, como order_number ou campos do Shopify Markets.

Eventos compatíveis

Estes eventos incluem os metacampos de pedidos selecionados em metadata:

  • Pedido realizado (ecommerce.order_placed)
  • Pedido cancelado (ecommerce.order_cancelled)
  • shopify_paid_order
  • shopify_fulfilled_order
  • shopify_partially_fulfilled_order

Os eventos de pedido reembolsado (ecommerce.order_refunded) e de checkout não incluem metacampos de pedidos.

Quando a Braze inclui metacampos de pedidos

Fonte Descrição
Webhooks de pedidos da Shopify O valor é um instantâneo do metacampo no momento em que a Shopify envia o webhook do pedido. Os eventos não são reescritos depois de enviados.
Preenchimento histórico Se você selecionar metacampos de pedidos durante a configuração inicial e o preenchimento histórico estiver ativado, os pedidos incluídos no preenchimento histórico terão os metacampos selecionados.

Alterar a seleção afeta apenas os pedidos que chegarem depois da alteração. Os pedidos anteriores não são sincronizados novamente.

Alterar ou remover metacampos

  1. Na página da integração, selecione Editar configurações.
  2. Na etapa Rastrear dados da Shopify, abra Mostrar configurações adicionais de eventos de pedidos.
  3. Atualize Adicionar metacampos de pedidos aos eventos de pedidos. Desmarcar a caixa de seleção limpa a seleção.

Se você excluir uma definição na Shopify, a Braze a remove automaticamente da sua seleção. Os eventos já enviados mantêm seus valores.

Segmentação e personalização

Os valores de metacampos de pedidos são propriedades de evento em metadata, o mesmo lugar das tags. Então, você pode usá-los da mesma forma que já usa metadata.tags. Por exemplo, {{event_properties.${metadata}.custom_gift_note}} retorna Happy birthday! para o exemplo custom.gift_note deste artigo.

New Stuff!