O ID do pedido na sua loja, com até 255 caracteres. Os números são armazenados como strings. Armazenado como external_id. Você também pode enviá-lo como external_id ou order_id.

O endereço de e-mail do comprador. Armazenado em minúsculas. O Emailit o usa para encontrar o contato e para atribuir o pedido a um e-mail enviado para esse endereço. customer.email também é aceito.

O contato do comprador (con_...). Se nenhum contato tiver esse ID, o Emailit procura o contato pelo email.

O nome do comprador, com até 191 caracteres. Usado quando o Emailit cria o contato. customer.first_name também é aceito.

O sobrenome do comprador, com até 191 caracteres. Usado quando o Emailit cria o contato. customer.last_name também é aceito.

placed (padrão), paid, fulfilled, canceled ou refunded. Na primeira vez que um pedido tiver paid, fulfilled, canceled ou refunded, o Emailit define o paid_at, fulfilled_at, canceled_at ou refunded_at correspondente com o horário atual. Os pedidos cancelados não contam na receita.

Código ISO 4217 de três letras. O padrão é a moeda do workspace nas configurações de e-commerce. Os valores nunca são convertidos: os relatórios agrupam a receita por moeda.

Total do pedido. Obrigatório para um novo pedido sem itens. Sem ele, o Emailit calcula a soma dos totais dos itens, menos discount, mais shipping e tax, e nunca abaixo de 0.

Os valores são números ou strings numéricas, não podem ser negativos e são armazenados com até 4 casas decimais.

Valor antes do desconto, do frete e dos impostos. O padrão é a soma dos totais dos itens quando o pedido tem itens.

Valor do desconto, como número positivo.

Valor do frete.

Valor dos impostos.

Valor reembolsado. O padrão é 0, ou total quando status é refunded. A receita é total menos refunded_amount.

Até 20 códigos de cupom ou de desconto usados no pedido. Um código que corresponde a um código de cupom do workspace, sem diferenciar maiúsculas de minúsculas, é marcado como resgatado por este pedido. coupon_code e discount_codes também são aceitos.

O ID do carrinho ou do checkout na sua loja de onde o pedido veio. O carrinho com esse ID passa a ser converted.

Quando o pedido foi feito: uma data e hora ISO 8601 ou um timestamp Unix em segundos (milissegundos também funcionam). O padrão é o horário atual. Não pode estar mais de 24 horas no futuro. created_at também é aceito.

Até 250 itens. line_items também é aceito. Cada item tem:

• product_id (string ou número): o ID do produto na sua loja. Os itens sem title, url, image_url ou categories recebem esses valores do catálogo. id também é aceito.

• variant_id, sku (string): até 255 caracteres.

• title (string): até 500 caracteres. Obrigatório quando o item não tem product_id nem sku. name também é aceito.

• quantity (inteiro): 1 ou mais. O padrão é 1.

• price (número ou string): o preço unitário. O padrão é 0. unit_price também é aceito.

• total (número ou string): o total do item. O padrão é price vezes quantity.

• categories (string[]): até 50 nomes de categorias.

• url, image_url (string): URLs http ou https.

Os seus próprios dados de chave e valor, com até 16 KB em JSON. Nas atualizações, as chaves que você envia são mescladas ao objeto armazenado.

Padrão true: quando nenhum contato corresponde a contact_id ou email, o Emailit cria um a partir de email, first_name e last_name e emite contact.created. O novo contato não é inscrito em nenhuma lista de contatos, então as campanhas não o alcançam. Defina como false para nunca criar um contato: o pedido então só é vinculado a um contato que já existe.

Defina como true, junto com audience_id, quando o comprador aceitou receber marketing. O Emailit então inscreve o contato nessa lista de contatos, a menos que o contato já esteja nela. Padrão false.

A lista de contatos (aud_...) em que o comprador é inscrito quando accepts_marketing é true. Se a lista não existir ou o limite de inscritos do seu plano tiver sido atingido, o pedido é armazenado mesmo assim e o contato não é inscrito.

O e-mail de campanha (eml_...) de onde o comprador veio, se a sua loja o rastrear. Usado só para novos pedidos, e só são lidos os IDs que começam com eml_. O pedido é atribuído a esse e-mail quando ele é um e-mail de campanha do workspace e tem um clique dentro da janela de cliques antes do pedido ou foi enviado dentro dessa janela. Caso contrário, o Emailit atribui o pedido normalmente. attribution.email_id também é aceito.

O ID do pedido (ord_...) ou o ID do pedido na sua loja (external_id). Codifique para URL os IDs da loja que contêm caracteres especiais.

Sempre order.

ID do pedido no Emailit (ord_...).

O ID do pedido na sua loja: o id que você enviou.

O contato do comprador (con_...), ou null quando o pedido não está vinculado a um contato.

O endereço de e-mail do comprador, em minúsculas.

placed, paid, fulfilled, canceled ou refunded.

Código ISO 4217 de três letras dos valores.

Soma dos itens antes do desconto, do frete e dos impostos.

Valor do desconto.

Valor do frete.

Valor dos impostos.

Total do pedido. A receita nos relatórios é total menos refunded_amount, e os pedidos cancelados não contam.

Valor reembolsado até agora. 0 quando nada foi reembolsado.

Códigos de cupom ou de desconto usados no pedido.

O ID do carrinho ou do checkout na sua loja de onde o pedido veio.

Como o pedido chegou ao Emailit: api, js (o script de rastreamento) ou import (importação em massa).

Quando o pedido foi feito, em ISO 8601 UTC.

Quando o Emailit armazenou o pedido pela primeira vez com esse status. Definido uma vez e não é limpo quando o status muda de novo.

O e-mail ao qual o pedido é atribuído, ou null. Definido uma vez, quando o pedido é armazenado pela primeira vez. Consulte Como os pedidos são atribuídos aos e-mails.

• email_id (string): o e-mail ao qual o pedido é atribuído.

• campaign_id, campaign_name (string ou null): a campanha dele.

• variant_id (string ou null): a versão do teste A/B (cvr_...) que o comprador recebeu.

• automation_id, automation_name (string ou null): a automação dele.

• type (string): click ou open.

• touched_at (string ou null): quando o clique ou a abertura aconteceu.

Itens. Cada um tem product_id (o ID do produto na sua loja), variant_id, sku, title, quantity, unit_price, total, categories, url e image_url.

Os seus próprios dados de chave e valor.

Quando o Emailit armazenou o pedido e quando ele mudou pela última vez, em ISO 8601 UTC.

O ID do pedido (ord_...) ou o ID do pedido na sua loja.

placed, paid, fulfilled, canceled ou refunded. Na primeira vez que o pedido receber paid, fulfilled, canceled ou refunded, o paid_at, fulfilled_at, canceled_at ou refunded_at correspondente é definido com o horário atual. Os pedidos cancelados não contam na receita.

Valor total reembolsado até agora, e não o valor deste reembolso. Não pode ser negativo. A receita é total menos refunded_amount. Se você definir status como refunded sem refunded_amount e nada tiver sido reembolsado antes, o total inteiro conta como reembolsado.

Chaves a mesclar aos metadados do pedido. Até 16 KB em JSON.

Número da página para a paginação (mínimo: 1, padrão: 1).

Número de pedidos a retornar (mínimo: 1, máximo: 100, padrão: 25).

Busca sem diferenciar maiúsculas de minúsculas no ID do pedido na sua loja ou no endereço de e-mail do comprador.

Só os pedidos deste contato (con_...).

Só os pedidos com este endereço de e-mail do comprador, sem diferenciar maiúsculas de minúsculas.

Só os pedidos com este status: placed, paid, fulfilled, canceled ou refunded.

Só os pedidos atribuídos a esta campanha (cmp_...).

Só os pedidos atribuídos a esta automação (aut_...).

true para os pedidos atribuídos a um e-mail, false para os que não são.

Só os pedidos feitos neste momento ou depois dele. Uma data ou data e hora ISO 8601; qualquer outro valor retorna 422.

Só os pedidos feitos neste momento ou antes dele. Uma data ou data e hora ISO 8601; qualquer outro valor retorna 422.

all (padrão) exige que todos os filtros key.condition correspondam. or aceita qualquer um deles. Consulte Filtragem.

Chave de ordenação: placed_at (padrão), total ou created_at.

Direção da ordenação: asc ou desc (padrão).

De 1 a 1.000 pedidos, cada um com os campos de Criar ou atualizar um pedido.

Padrão true: sem atribuição e sem eventos de pedido. Defina como false para tratar os pedidos como pedidos enviados um a um: os novos pedidos são atribuídos aos e-mails e emitem order.placed, e os pedidos atualizados emitem order.updated.

Número de pedidos novos.

Número de pedidos que já estavam armazenados e foram atualizados.

Pedidos que não foram armazenados. Cada item tem o index do pedido no seu array orders e errors, indexado pelo caminho do campo, como orders.4.currency. Um pedido que passou na validação mas não pôde ser salvo tem o erro could not be stored em orders.<index>.

O ID do pedido (ord_...) ou o ID do pedido na sua loja.