id

text

[pt] O identificador do checkout.

abandoned_checkout_url

text

[pt] A URL de recuperação enviada ao cliente para que ele possa retomar e concluir o checkout abandonado.

billing_address_address1

text

[pt] O logradouro (rua e número) do endereço de cobrança.

billing_address_address2

text

[pt] Campo adicional opcional para o logradouro do endereço de cobrança (complemento).

billing_address_city

text

[pt] A cidade do endereço de cobrança.

billing_address_company

text

[pt] A empresa associada ao endereço de cobrança.

billing_address_country

text

[pt] O nome do país do endereço de cobrança.

billing_address_country_code

text

[pt] O código de duas letras do país do endereço de cobrança (formato ISO 3166-1 alpha-2).

billing_address_first_name

text

[pt] O primeiro nome da pessoa associada ao meio de pagamento.

billing_address_last_name

text

[pt] O sobrenome da pessoa associada ao meio de pagamento.

billing_address_latitude

float

[pt] A latitude do endereço de cobrança.

billing_address_longitude

float

[pt] A longitude do endereço de cobrança.

billing_address_name

text

[pt] O nome completo da pessoa associada ao meio de pagamento.

billing_address_phone

text

[pt] O telefone do endereço de cobrança.

billing_address_province

text

[pt] O nome do estado ou província do endereço de cobrança.

billing_address_province_code

text

[pt] A abreviação de duas letras do estado ou província do endereço de cobrança.

billing_address_zip

text

[pt] O CEP ou código postal do endereço de cobrança.

cart_token

text

[pt] O identificador do carrinho vinculado a este checkout.

completed_at

timestamp

[pt] A data e hora (formato ISO 8601) em que o checkout foi concluído. Em checkouts abandonados, este valor permanece nulo até que o cliente conclua a compra pela URL de recuperação.

created_at

timestamp

[pt] A data e hora (formato ISO 8601) em que o checkout foi criado.

currency

text

[pt] O código de três letras (formato ISO 4217) da moeda padrão da loja no momento do checkout. Para a moeda que o cliente utilizou no checkout, consulte presentment_currency.

customer_admin_graphql_api_id

text

[pt] O identificador global (GID) do cliente na API GraphQL.

customer_created_at

timestamp

[pt] A data e hora (formato ISO 8601) em que o cadastro do cliente foi criado.

customer_default_address_province

text

[pt] O nome do estado ou província do endereço padrão do cliente.

customer_default_address_address1

text

[pt] O logradouro (rua e número) do endereço padrão do cliente.

customer_default_address_address2

text

[pt] Campo adicional opcional para o logradouro do endereço padrão do cliente (complemento).

customer_default_address_city

text

[pt] A cidade do endereço padrão do cliente.

customer_default_address_company

text

[pt] A empresa associada ao endereço padrão do cliente.

customer_default_address_country

text

[pt] O nome do país do endereço padrão do cliente.

customer_default_address_country_code

text

[pt] O código de duas letras do país do endereço padrão do cliente (formato ISO 3166-1 alpha-2).

customer_default_address_country_name

text

[pt] O nome normalizado do país do endereço padrão do cliente.

customer_default_address_customer_id

text

[pt] O identificador do cliente ao qual o endereço padrão pertence.

    Clientes > > customer_id

customer_default_address_first_name

text

[pt] O primeiro nome da pessoa associada ao endereço padrão do cliente.

customer_default_address_id

text

[pt] O identificador do endereço padrão do cliente.

    Clientes > > customer_id

customer_default_address_last_name

text

[pt] O sobrenome da pessoa associada ao endereço padrão do cliente.

customer_default_address_name

text

[pt] O nome completo da pessoa associada ao endereço padrão do cliente.

customer_default_address_phone

text

[pt] O telefone do endereço padrão do cliente.

customer_default_address_province_code

text

[pt] A abreviação de duas letras do estado ou província do endereço padrão do cliente.

customer_default_address_zip

text

[pt] O CEP ou código postal do endereço padrão do cliente.

customer_email

text

[pt] O endereço de e-mail do cliente.

customer_first_name

text

[pt] O primeiro nome do cliente.

customer_id

text

[pt] O identificador único do cliente.

    Clientes > > customer_id

customer_last_name

text

[pt] O sobrenome do cliente.

customer_last_order_id

text

[pt] O identificador do último pedido realizado pelo cliente.

customer_last_order_name

text

[pt] O nome (número) do último pedido do cliente, diretamente relacionado ao campo name do pedido.

customer_multipass_identifier

text

[pt] Um identificador único do cliente utilizado no login via Multipass.

customer_note

text

[pt] Uma observação sobre o cliente.

customer_orders_count

float

[pt] A quantidade de pedidos associados a este cliente. Pedidos de teste e arquivados não são contabilizados.

customer_phone

text

[pt] O telefone único do cliente (formato E.164).

customer_sms_marketing_consent

text

[pt] As informações de consentimento de marketing por SMS, indicando quando e de que forma o cliente autorizou o recebimento de mensagens promocionais.

customer_state

text

[pt] A situação da conta do cliente na loja. Valores possíveis incluem: disabled (sem conta ativa), invited (convidado a criar uma conta), enabled (conta criada) e declined (recusou o convite para criar conta).

customer_tags

text

[pt] Marcadores (tags) que o lojista atribuiu ao cliente, no formato de uma lista de valores separados por vírgula.

customer_tax_exempt

boolean

[pt] Indica se o cliente é isento do pagamento de impostos em seus pedidos.

customer_tax_exemptions

text

[pt] A lista de isenções fiscais específicas aplicáveis ao cliente (aplicável apenas a impostos canadenses).

customer_total_spent

float

[pt] O valor total gasto pelo cliente em todo o seu histórico de pedidos.

customer_updated_at

timestamp

[pt] A data e hora (formato ISO 8601) da última atualização das informações do cliente.

customer_verified_email

boolean

[pt] Indica se o cliente verificou seu endereço de e-mail.

customer_locale

text

[pt] O código de idioma de duas ou três letras, opcionalmente seguido por um modificador de região. Exemplos: en, en-CA, pt-BR.

name

text

[pt] Um identificador legível do checkout, exibido como um número precedido pelo símbolo #.

note

text

[pt] O texto de uma nota opcional que o lojista pode anexar ao checkout.

presentment_currency

text

[pt] O código de três letras (formato ISO 4217) da moeda que o cliente utilizou no checkout. Para a moeda padrão da loja, consulte currency.

shipping_address_address1

text

[pt] O logradouro (rua e número) do endereço de entrega.

shipping_address_address2

text

[pt] Campo adicional opcional para o logradouro do endereço de entrega (complemento).

shipping_address_city

text

[pt] A cidade do endereço de entrega.

shipping_address_company

text

[pt] A empresa associada ao endereço de entrega.

shipping_address_country

text

[pt] O nome do país do endereço de entrega.

shipping_address_country_code

text

[pt] O código de duas letras do país do endereço de entrega (formato ISO 3166-1 alpha-2).

shipping_address_first_name

text

[pt] O primeiro nome da pessoa associada ao endereço de entrega.

shipping_address_last_name

text

[pt] O sobrenome da pessoa associada ao endereço de entrega.

shipping_address_latitude

float

[pt] A latitude do endereço de entrega.

shipping_address_longitude

float

[pt] A longitude do endereço de entrega.

shipping_address_name

text

[pt] O nome completo da pessoa associada ao endereço de entrega.

shipping_address_phone

text

[pt] O telefone do endereço de entrega.

shipping_address_province

text

[pt] O nome do estado ou província do endereço de entrega.

shipping_address_province_code

text

[pt] A abreviação de duas letras do estado ou província do endereço de entrega.

shipping_address_zip

text

[pt] O CEP ou código postal do endereço de entrega.

subtotal_price

float

[pt] O valor do checkout (na moeda da loja) antes do frete e dos impostos.

taxes_included

boolean

[pt] Indica se os impostos já estão incluídos no preço.

total_discounts

float

[pt] O valor total dos descontos aplicados ao checkout, na moeda da loja.

total_duties

text

[pt] O total de taxas alfandegárias (duties) do checkout, na moeda da loja.

total_line_items_price

float

[pt] A soma dos preços de todos os itens do checkout, na moeda da loja.

total_price

float

[pt] A soma dos preços dos itens, descontos, frete e impostos do checkout, na moeda da loja.

total_tax

float

[pt] A soma de todos os impostos aplicados ao checkout, na moeda da loja.

updated_at

timestamp

[pt] A data e hora (formato ISO 8601) da última modificação do checkout.

checkout_id

text

[pt] ID do checkout abandonado ao qual este codigo de desconto pertence.

    Carrinhos abandonados > > id

discount_codes_amount

float

[pt] O valor total de desconto aplicado ao checkout abandonado, expresso na moeda de apresentacao (a moeda exibida ao cliente no checkout). Valor monetario reportado como decimal; quando o checkout tem mais de um codigo de desconto, este total no nivel do checkout se repete em cada linha de codigo.

discount_codes_code

text

[pt] Um codigo de desconto aplicado ao checkout abandonado (o codigo informado pelo cliente para obter o desconto). Quando mais de um codigo e aplicado ao mesmo checkout, cada codigo e reportado em sua propria linha.

checkout_id

text

[pt] Identificador unico do checkout abandonado ao qual este item pertence.

    Carrinhos abandonados > > id

compare_at_price

float

[pt] Preco "de" (compare at) da variacao: preco unitario original ou de referencia exibido ao lado do preco de venda para indicar desconto, expresso na moeda base da loja. Pode vir vazio quando nao ha preco de comparacao definido.

gift_card

boolean

[pt] Indica se o produto deste item e um vale-presente (gift card). Verdadeiro para produtos do tipo vale-presente, falso caso contrario.

grams

float

[pt] Peso de uma unidade do item, expresso em gramas.

key

text

[pt] Identificador unico deste item dentro do checkout abandonado.

line_price

float

[pt] Preco unitario original do item, expresso na moeda de exibicao apresentada ao cliente (presentment).

presentment_title

text

[pt] Titulo do produto conforme apresentado ao cliente.

presentment_variant_title

text

[pt] Titulo da variacao do produto conforme apresentado ao cliente.

price

float

[pt] Preco unitario original do item, expresso na moeda base da loja.

product_id

text

[pt] Identificador unico do produto associado a este item.

quantity

float

[pt] Quantidade de unidades do item adicionadas ao checkout.

sku

text

[pt] SKU (unidade de manutencao de estoque) do item: codigo definido pelo lojista que identifica a variacao do produto.

taxable

boolean

[pt] Indica se o item esta sujeito a impostos. Verdadeiro quando ha incidencia de impostos sobre o item, falso caso contrario.

title

text

[pt] Titulo do produto associado a este item.

variant_id

text

[pt] Identificador unico da variacao do produto associada a este item.

    Produtos: variantes > > id

variant_price

float

[pt] Preco "de" (compare at) da variacao: preco unitario original ou de referencia na moeda base da loja. Pode vir vazio quando nao ha preco de comparacao definido.

variant_title

text

[pt] Titulo da variacao do produto associada a este item.

vendor

text

[pt] Nome do fornecedor ou fabricante do produto.

checkout_id

float

[pt] O ID do checkout abandonado ao qual este atributo de observacao pertence; relaciona cada par nome/valor ao seu checkout.

    Carrinhos abandonados > > id

note_attributes_name

text

[pt] Chave (nome) de um atributo personalizado de nome/valor anexado ao checkout abandonado. Sao campos de formato livre definidos pela loja ou por seus aplicativos para guardar informacoes extras coletadas durante o checkout (por exemplo, um rotulo de mensagem de presente, uma instrucao de entrega ou um campo de endereco adicional). O conjunto de nomes possiveis nao e fixo e varia conforme a loja.

note_attributes_value

text

[pt] Valor em texto associado ao nome do atributo correspondente no checkout abandonado. O conteudo e de formato livre e definido pela loja ou por seus aplicativos; nao possui formato fixo nem conjunto enumerado de valores.

customer_id

text

[pt] Identificador único do cliente.

accepts_marketing

boolean

[pt] Indica se o cliente consentiu em receber material de marketing por e-mail.

accepts_marketing_updated_at

timestamp

[pt] Data e hora em que o cliente consentiu ou se opôs a receber material de marketing por e-mail.

created_at

timestamp

[pt] Data e hora (formato ISO 8601) em que o cliente foi criado.

currency

text

[pt] Código de três letras (formato ISO 4217) da moeda que o cliente utilizou ao pagar seu último pedido.

default_address_address1

text

[pt] Endereço de correspondência do cliente.

default_address_address2

text

[pt] Campo adicional (complemento) para o endereço de correspondência do cliente.

default_address_city

text

[pt] Cidade, município ou localidade do cliente.

default_address_company

text

[pt] Empresa associada ao endereço do cliente.

default_address_country

text

[pt] País do cliente.

default_address_country_code

text

[pt] Código de duas letras do país correspondente ao país do cliente.

default_address_country_name

text

[pt] Nome normalizado do país do cliente.

default_address_customer_id

text

[pt] Identificador único do cliente ao qual este endereço pertence.

default_address_default

boolean

[pt] Indica se este endereço é o endereço padrão do cliente.

default_address_first_name

text

[pt] Primeiro nome associado a este endereço do cliente.

default_address_id

text

[pt] Identificador único do endereço.

default_address_last_name

text

[pt] Sobrenome associado a este endereço do cliente.

default_address_name

text

[pt] Primeiro nome e sobrenome associados ao endereço do cliente.

default_address_phone

text

[pt] Número de telefone do cliente neste endereço.

default_address_province

text

[pt] Nome da região do cliente. Normalmente um estado, província ou prefeitura.

default_address_province_code

text

[pt] Código da região do endereço, como estado, província ou distrito.

default_address_zip

text

[pt] Código postal do cliente (no Brasil, o CEP), também conhecido como zip, postcode, Eircode, etc.

email

text

[pt] Endereço de e-mail único do cliente. Tentar atribuir o mesmo e-mail a múltiplos clientes resulta em erro.

email_marketing_consent_consent_updated_at

timestamp

[pt] Data e hora em que o cliente consentiu em receber material de marketing por e-mail.

email_marketing_consent_opt_in_level

text

[pt] Nível de consentimento (opt-in) da assinatura de marketing, conforme as Sender Best Common Practices da M3AAWG, informado pelo cliente ao consentir em receber material de marketing por e-mail. Valores possíveis: single_opt_in, confirmed_opt_in e unknown.

email_marketing_consent_state

text

[pt] Estado atual do consentimento de marketing por e-mail do cliente. Valores possíveis: subscribed (inscrito), not_subscribed (não inscrito), pending (pendente) e unsubscribed (cancelado).

first_name

text

[pt] Primeiro nome do cliente.

last_name

text

[pt] Sobrenome do cliente.

last_order_id

text

[pt] ID do último pedido do cliente.

last_order_name

text

[pt] Nome do último pedido do cliente. Relaciona-se diretamente ao campo name do recurso Pedido (Order).

marketing_opt_in_level

text

[pt] Nível de consentimento (opt-in) da assinatura de marketing, conforme as Sender Best Common Practices da M3AAWG, informado pelo cliente ao consentir em receber material de marketing por e-mail. Valores possíveis: single_opt_in, confirmed_opt_in e unknown.

multipass_identifier

text

[pt] Identificador único do cliente utilizado no login via Multipass.

note

text

[pt] Anotação sobre o cliente.

orders_count

float

[pt] Número de pedidos associados a este cliente. Pedidos de teste e arquivados não são contabilizados.

state

text

[pt] Situação da conta do cliente na loja. Valores possíveis: disabled (a conta nunca foi criada), invited (o cliente recebeu um convite por e-mail para criar a conta), enabled (o cliente criou a conta) e declined (o cliente recusou o convite para criar a conta).

tags

text

[pt] Tags que o lojista atribuiu ao cliente, formatadas como uma string de valores separados por vírgula.

tax_exempt

boolean

[pt] Indica se o cliente é isento de pagar impostos em seus pedidos.

total_spent

float

[pt] Valor total gasto pelo cliente em todo o seu histórico de pedidos, na moeda da loja.

updated_at

timestamp

[pt] Data e hora (formato ISO 8601) em que as informações do cliente foram atualizadas pela última vez.

verified_email

boolean

[pt] Indica se o cliente verificou seu endereço de e-mail.

event_id

text

[pt] O identificador unico do evento.

arguments

text

[pt] Valores citados na mensagem do evento, como o numero do pedido, o nome do cliente ou o titulo do recurso. Fornecidos pela API como uma lista.

author

text

[pt] Quem originou o evento: o nome de um membro da equipe, o nome da loja, ou "Shopify" quando o evento foi gerado automaticamente pelo sistema.

created_at

timestamp

[pt] A data e a hora em que o evento foi criado.

message

text

[pt] Descricao legivel do evento. Pode conter alguma formatacao em HTML, como links para o recurso relacionado.

path

text

[pt] URL relativa do recurso a que o evento se refere, quando aplicavel. Pode vir vazia para eventos sem um recurso navegavel.

subject_id

text

[pt] O ID do recurso que gerou o evento (por exemplo, o pedido, produto ou regra de preco relacionado).

    Produtos > > id

    Pedidos > > id

subject_type

text

[pt] O tipo de recurso que gerou o evento, como Order (pedido), Product (produto), Collection (colecao), PriceRule (regra de preco) ou Article (artigo).

verb

text

[pt] A acao descrita pelo evento. Cada tipo de recurso emite acoes distintas, como create (criacao), update (atualizacao), destroy (exclusao), confirmed (confirmado), cancelled (cancelado), closed (fechado), placed (realizado), published (publicado) ou unpublished (despublicado).

inventory_item_id

text

[pt] Identificador único do item de inventário. Cada item de inventário corresponde a uma variação de produto e é usado para acompanhar seu estoque.

    Produtos: variantes > > inventory_item_id

available

float

[pt] Quantidade disponível (vendável) do item de inventário. Retorna nulo quando o item não está configurado para rastrear estoque.

location_id

text

[pt] ID do local (location) associado a este registro de inventário. Cada linha representa um item de inventário em um único local de estoque.

updated_at

timestamp

[pt] Data e hora (formato ISO 8601) em que o nível de inventário neste local foi modificado pela última vez.

event_id

text

[pt] O ID do evento.

order_id

text

[pt] O ID do pedido que gerou o evento.

    Pedidos > > id

arguments

text

[pt] Valores que referenciam os recursos envolvidos no evento (como nomes de itens ou colecoes), apresentados como um unico texto.

author

text

[pt] Quem gerou o evento. Pode ser a propria plataforma, em eventos automaticos/de sistema, ou o nome do usuario ou aplicativo responsavel pela acao.

created_at

timestamp

[pt] A data e hora em que o evento foi criado.

description

text

[pt] Uma descricao do evento em linguagem natural.

message

text

[pt] Uma descricao do evento em linguagem natural. Pode conter alguma formatacao HTML.

path

text

[pt] Uma URL relativa para o recurso ao qual o evento se refere, quando aplicavel.

verb

text

[pt] O tipo de acao representada pelo evento. Abrange o ciclo de vida do pedido (ex.: criado, confirmado, fechado, cancelado), pagamentos (ex.: venda, pago, pago externamente), processamento/envio (ex.: enviado, etiqueta de envio comprada, itens reabastecidos), devolucoes (ex.: produtos devolvidos, devolucao aprovada) e comentarios manuais, entre outros. Recursos diferentes geram tipos diferentes de evento.

id

text

[pt] O identificador do pedido utilizado pela API. É diferente de order_number, que é o número visível para o lojista e o cliente

app_id

text

[pt] O identificador do aplicativo que criou o pedido

browser_ip

text

[pt] O endereço IP do navegador utilizado pelo cliente no momento em que o pedido foi feito

buyer_accepts_marketing

boolean

[pt] Indica se o cliente consentiu em receber comunicações por e-mail da loja

cancel_reason

text

[pt] O motivo pelo qual o pedido foi cancelado. Valores possíveis: customer (cancelado pelo cliente), fraud (pedido fraudulento), inventory (itens sem estoque), declined (pagamento recusado), other (outro motivo não listado)

cancelled_at

timestamp

[pt] A data e hora em que o pedido foi cancelado, no fuso horário do pedido

closed_at

timestamp

[pt] A data e hora em que o pedido foi fechado, no fuso horário do pedido

confirmed

boolean

[pt] Indica se o pedido foi confirmado

contact_email

text

[pt] O endereço de e-mail de contato do cliente utilizado no pedido

created_at

timestamp

[pt] A data e hora em que o pedido foi criado na Shopify, gerada automaticamente, no fuso horário do pedido

currency

text

[pt] O código de três letras (padrão ISO 4217) da moeda da loja

currentsubtotalpricepresentmentamount

float

[pt] O subtotal atual do pedido (refletindo edições, devoluções e reembolsos), expresso na moeda de apresentação exibida ao cliente no checkout

currentsubtotalpricepresentmentcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda de apresentação do subtotal atual

currentsubtotalpriceshopamount

float

[pt] O subtotal atual do pedido (refletindo edições, devoluções e reembolsos), expresso na moeda padrão da loja

currentsubtotalpriceshopcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda da loja do subtotal atual

current_total_discounts

float

[pt] O total atual de descontos do pedido na moeda da loja. Reflete edições, devoluções e reembolsos do pedido

currenttotaldiscountspresentmentamount

float

[pt] O total atual de descontos do pedido (refletindo edições, devoluções e reembolsos), expresso na moeda de apresentação exibida ao cliente no checkout

currenttotaldiscountspresentmentcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda de apresentação do total atual de descontos

currenttotaldiscountsshopamount

float

[pt] O total atual de descontos do pedido (refletindo edições, devoluções e reembolsos), expresso na moeda padrão da loja

currenttotaldiscountsshopcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda da loja do total atual de descontos

currenttotaldutiespresentmentamount

float

[pt] O total atual de taxas alfandegárias (impostos de importação) do pedido (refletindo edições, devoluções e reembolsos), expresso na moeda de apresentação exibida ao cliente no checkout

currenttotaldutiespresentmentcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda de apresentação do total atual de taxas alfandegárias

currenttotaldutiesshopamount

float

[pt] O total atual de taxas alfandegárias (impostos de importação) do pedido (refletindo edições, devoluções e reembolsos), expresso na moeda padrão da loja

currenttotaldutiesshopcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda da loja do total atual de taxas alfandegárias

current_total_price

float

[pt] O preço total atual do pedido na moeda da loja. Reflete edições, devoluções e reembolsos do pedido

currenttotalpricepresentmentamount

float

[pt] O preço total atual do pedido (refletindo edições, devoluções e reembolsos), expresso na moeda de apresentação exibida ao cliente no checkout

currenttotalpricepresentmentcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda de apresentação do preço total atual

currenttotalpriceshopamount

float

[pt] O preço total atual do pedido (refletindo edições, devoluções e reembolsos), expresso na moeda padrão da loja

currenttotalpriceshopcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda da loja do preço total atual

current_total_tax

float

[pt] O total atual de impostos cobrados no pedido na moeda da loja. Reflete edições, devoluções e reembolsos do pedido

currenttotaltaxpresentmentamount

float

[pt] O total atual de impostos do pedido (refletindo edições, devoluções e reembolsos), expresso na moeda de apresentação exibida ao cliente no checkout

currenttotaltaxpresentmentcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda de apresentação do total atual de impostos

currenttotaltaxshopamount

float

[pt] O total atual de impostos do pedido (refletindo edições, devoluções e reembolsos), expresso na moeda padrão da loja

currenttotaltaxshopcode

text

[pt] O código de moeda de três letras (ISO 4217) da moeda da loja do total atual de impostos

customer_locale

text

[pt] O código de idioma de duas ou três letras do cliente, opcionalmente seguido de um modificador de região

email

text

[pt] O endereço de e-mail do cliente

financial_status

text

[pt] O status dos pagamentos associados ao pedido. Valores possíveis: pending (pagamento pendente, ainda pode falhar), authorized (pagamento autorizado), partially_paid (pago parcialmente), paid (pago), partially_refunded (reembolsado parcialmente), refunded (reembolsado), voided (estornado/cancelado)

fulfillment_status

text

[pt] O status do pedido quanto ao processamento (fulfillment) dos itens. Valores possíveis: fulfilled (todos os itens foram processados), partial (ao menos um item foi processado), restocked (todos os itens retornaram ao estoque e o pedido foi cancelado), vazio/nulo (nenhum item foi processado)

gateway

text

[pt] O gateway de pagamento utilizado

landing_site

text

[pt] A URL da página em que o comprador chegou ao entrar na loja

landing_site_ref

text

[pt] A URL da página de onde o cliente clicou em um link que o direcionou à loja online

location_id

text

[pt] O identificador da localização física onde o pedido foi processado. Refere-se à localização de PDV (ponto de venda); fica vazio para pedidos online

name

text

[pt] O nome do pedido, gerado combinando order_number com o prefixo e o sufixo definidos nas configurações gerais do lojista. É diferente de id, que é o identificador do pedido usado pela API

note

text

[pt] Uma observação opcional que o lojista pode anexar ao pedido

order_number

text

[pt] A posição do pedido na contagem de pedidos da loja, começando em 1001. Os números são sequenciais

order_status_url

text

[pt] A URL em que o cliente pode acompanhar o status atual do pedido

originaltotaldutiespresentmentamount

float

[pt] O total original de taxas alfandegárias (impostos de importação) do pedido no momento de sua criação, expresso na moeda de apresentação exibida ao cliente no checkout

originaltotaldutiespresentmentcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda de apresentação do total original de taxas alfandegárias

originaltotaldutiesshopamount

float

[pt] O total original de taxas alfandegárias (impostos de importação) do pedido no momento de sua criação, expresso na moeda padrão da loja

originaltotaldutiesshopcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda da loja do total original de taxas alfandegárias

phone

text

[pt] O número de telefone do cliente para recebimento de notificações por SMS

presentment_currency

text

[pt] A moeda de apresentação utilizada para exibir os preços ao cliente

processed_at

timestamp

[pt] A data e hora em que o pedido foi efetivado/processado. É a data que aparece nos pedidos e é usada nos relatórios analíticos; por padrão coincide com created_at, mas pode ser definida no passado ao importar pedidos de outra plataforma. No fuso horário do pedido

referring_site

text

[pt] O site a partir do qual o cliente clicou em um link para a loja

source_identifier

text

[pt] O identificador do pedido na plataforma ou canal de origem. Não corresponde ao ID da Shopify gerado a partir de um rascunho (draft) concluído

source_name

text

[pt] A origem do pedido. Só pode ser definida na criação do pedido e não é alterável depois. Valores dos canais Shopify são protegidos: web, pos, shopify_draft_order, iphone e android. Pedidos criados via API podem receber outros valores

source_url

text

[pt] A URL da origem de onde o pedido foi gerado, quando encontrada no registro de domínios

subtotal_price

float

[pt] O valor do pedido na moeda da loja após descontos, mas antes de frete, impostos e gorjetas

subtotalpricepresentmentamount

float

[pt] O subtotal do pedido (após descontos, antes de frete, impostos e gorjetas), expresso na moeda de apresentação exibida ao cliente no checkout

subtotalpricepresentmentcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda de apresentação do subtotal

subtotalpriceshopamount

float

[pt] O subtotal do pedido (após descontos, antes de frete, impostos e gorjetas), expresso na moeda padrão da loja

subtotalpriceshopcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda da loja do subtotal

tags

text

[pt] Etiquetas (tags) atribuídas ao pedido, no formato de texto com valores separados por vírgula. São descritores curtos usados para filtrar e pesquisar; cada tag é limitada a 40 caracteres

taxes_included

boolean

[pt] Indica se os impostos estão incluídos no subtotal do pedido

test

boolean

[pt] Indica se este é um pedido de teste

total_discounts

float

[pt] O total de descontos aplicados ao preço do pedido na moeda da loja

totaldiscountspresentmentamount

float

[pt] O total de descontos aplicados ao pedido, expresso na moeda de apresentação exibida ao cliente no checkout

totaldiscountspresentmentcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda de apresentação do total de descontos

totaldiscountsshopamount

float

[pt] O total de descontos aplicados ao pedido, expresso na moeda padrão da loja

totaldiscountsshopcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda da loja do total de descontos

total_line_items_price

float

[pt] A soma dos preços de todos os itens do pedido na moeda da loja

totallineitemspricepresentmentamount

float

[pt] A soma dos preços de todos os itens do pedido, expressa na moeda de apresentação exibida ao cliente no checkout

totallineitemspricepresentmentcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda de apresentação da soma dos preços dos itens

totallineitemspriceshopamount

float

[pt] A soma dos preços de todos os itens do pedido, expressa na moeda padrão da loja

totallineitemspriceshopcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda da loja da soma dos preços dos itens

total_outstanding

float

[pt] O valor total em aberto (a receber) do pedido na moeda da loja

total_price

float

[pt] A soma de todos os itens, descontos, frete, impostos e gorjetas na moeda da loja. Deve ser positivo

totalpricepresentmentamount

float

[pt] O preço total do pedido (itens, descontos, frete, impostos e gorjetas), expresso na moeda de apresentação exibida ao cliente no checkout

totalpricepresentmentcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda de apresentação do preço total

totalpriceshopamount

float

[pt] O preço total do pedido (itens, descontos, frete, impostos e gorjetas), expresso na moeda padrão da loja

totalpriceshopcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda da loja do preço total

totalshippingpricepresentmentamount

float

[pt] O custo total de frete do pedido, expresso na moeda de apresentação exibida ao cliente no checkout

totalshippingpricepresentmentcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda de apresentação do total de frete

totalshippingpriceshopamount

float

[pt] O custo total de frete do pedido, expresso na moeda padrão da loja

totalshippingpriceshopcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda da loja do total de frete

total_tax

float

[pt] A soma de todos os impostos aplicados ao pedido na moeda da loja. Deve ser positivo

totaltaxpresentmentamount

float

[pt] O total de impostos aplicados ao pedido, expresso na moeda de apresentação exibida ao cliente no checkout

totaltaxpresentmentcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda de apresentação do total de impostos

totaltaxshopamount

float

[pt] O total de impostos aplicados ao pedido, expresso na moeda padrão da loja

totaltaxshopcurrency

text

[pt] O código de moeda de três letras (ISO 4217) da moeda da loja do total de impostos

total_tip_received

float

[pt] A soma de todas as gorjetas do pedido na moeda da loja

total_weight

float

[pt] A soma dos pesos de todos os itens do pedido, em gramas

updated_at

timestamp

[pt] A data e hora da última modificação do pedido. Pode mudar mesmo quando nenhum campo visível do pedido foi alterado

order_id

text

[pt] Identificador numerico unico do pedido atribuido pela Shopify.

    Pedidos > > id

billing_address_address1

text

[pt] Logradouro (rua e numero) do endereco de cobranca vinculado a forma de pagamento do pedido.

billing_address_address2

text

[pt] Linha complementar do endereco de cobranca, como apartamento, sala ou unidade.

billing_address_city

text

[pt] Cidade, municipio ou localidade do endereco de cobranca.

billing_address_company

text

[pt] Nome da empresa ou organizacao do endereco de cobranca.

billing_address_country

text

[pt] Nome completo do pais do endereco de cobranca.

billing_address_country_code

text

[pt] Codigo do pais do endereco de cobranca em duas letras, no formato ISO 3166-1 alpha-2 (ex.: BR, US).

billing_address_first_name

text

[pt] Primeiro nome da pessoa associada ao endereco de cobranca.

billing_address_last_name

text

[pt] Sobrenome da pessoa associada ao endereco de cobranca.

billing_address_latitude

text

[pt] Coordenada de latitude do endereco de cobranca.

billing_address_longitude

text

[pt] Coordenada de longitude do endereco de cobranca.

billing_address_name

text

[pt] Nome completo (primeiro nome e sobrenome) da pessoa associada ao endereco de cobranca.

billing_address_phone

text

[pt] Numero de telefone do endereco de cobranca.

billing_address_province

text

[pt] Nome da regiao (como estado, provincia ou prefeitura) do endereco de cobranca.

billing_address_province_code

text

[pt] Codigo abreviado da regiao (como estado ou provincia) do endereco de cobranca (ex.: SP).

billing_address_zip

text

[pt] Codigo postal (CEP) do endereco de cobranca.

customer_accepts_marketing

boolean

[pt] Indica se o cliente consentiu em receber material de marketing por e-mail.

customer_accepts_marketing_updated_at

timestamp

[pt] Data e hora (formato ISO 8601) da ultima atualizacao do consentimento de marketing do cliente.

customer_created_at

timestamp

[pt] Data e hora (formato ISO 8601) em que o cadastro do cliente foi criado.

customer_default_address_address1

text

[pt] Logradouro (rua e numero) do endereco padrao do cliente.

customer_default_address_address2

text

[pt] Linha complementar do endereco padrao do cliente, como apartamento, sala ou unidade.

customer_default_address_city

text

[pt] Cidade, municipio ou localidade do endereco padrao do cliente.

customer_default_address_company

text

[pt] Nome da empresa ou organizacao do endereco padrao do cliente.

customer_default_address_country

text

[pt] Nome completo do pais do endereco padrao do cliente.

customer_default_address_country_code

text

[pt] Codigo do pais do endereco padrao do cliente em duas letras, no formato ISO 3166-1 alpha-2 (ex.: BR, US).

customer_default_address_country_name

text

[pt] Nome completo e normalizado do pais do endereco padrao do cliente.

customer_default_address_customer_id

text

[pt] Identificador unico do cliente ao qual este endereco padrao pertence.

customer_default_address_default

boolean

[pt] Indica se este e o endereco padrao do cliente.

customer_default_address_first_name

text

[pt] Primeiro nome da pessoa no endereco padrao do cliente.

customer_default_address_id

text

[pt] Identificador unico do endereco padrao do cliente.

customer_default_address_last_name

text

[pt] Sobrenome da pessoa no endereco padrao do cliente.

customer_default_address_name

text

[pt] Nome completo (primeiro nome e sobrenome) da pessoa no endereco padrao do cliente.

customer_default_address_phone

text

[pt] Numero de telefone do endereco padrao do cliente.

customer_default_address_province

text

[pt] Nome da regiao (como estado, provincia ou prefeitura) do endereco padrao do cliente.

customer_default_address_province_code

text

[pt] Codigo abreviado da regiao (como estado ou provincia) do endereco padrao do cliente (ex.: RJ).

customer_default_address_zip

text

[pt] Codigo postal (CEP) do endereco padrao do cliente.

customer_email

text

[pt] Endereco de e-mail do cliente.

customer_first_name

text

[pt] Primeiro nome do cliente.

customer_id

text

[pt] Identificador unico do cliente.

    Clientes > > customer_id

customer_last_name

text

[pt] Sobrenome do cliente.

customer_last_order_id

text

[pt] Identificador unico do pedido mais recente do cliente.

customer_last_order_name

text

[pt] Nome (numero do pedido, como #1001) do pedido mais recente do cliente.

customer_multipass_identifier

text

[pt] Identificador unico utilizado pelo cliente para autenticar via Multipass.

customer_note

text

[pt] Anotacao em texto livre que o lojista vinculou ao cliente.

customer_orders_count

float

[pt] Quantidade de pedidos associados a este cliente. Pedidos de teste e arquivados nao sao contabilizados.

customer_phone

text

[pt] Numero de telefone do cliente, no formato E.164.

customer_state

text

[pt] Situacao da conta do cliente na loja. Os valores possiveis incluem: 'disabled', 'invited', 'enabled' e 'declined'.

customer_tags

text

[pt] Lista de tags (separadas por virgula) aplicadas ao cliente para categorizacao e filtragem.

customer_tax_exempt

boolean

[pt] Indica se o cliente e isento do pagamento de impostos em seus pedidos.

customer_tax_exemptions

text

[pt] Lista de codigos de isencao fiscal aplicados ao cliente (por exemplo, isencoes regionais ou por tipo de status).

customer_total_spent

float

[pt] Valor total gasto pelo cliente ao longo de todo o seu historico de pedidos.

customer_updated_at

timestamp

[pt] Data e hora (formato ISO 8601) da ultima atualizacao das informacoes do cliente.

customer_verified_email

boolean

[pt] Indica se o cliente verificou seu endereco de e-mail.

payment_gateway_names

text

[pt] Lista de gateways de pagamento utilizados para processar as transacoes do pedido.

shipping_address_address1

text

[pt] Logradouro (rua e numero) do endereco de entrega do pedido.

shipping_address_address2

text

[pt] Linha complementar do endereco de entrega, como apartamento, sala ou unidade.

shipping_address_city

text

[pt] Cidade, municipio ou localidade do endereco de entrega.

shipping_address_company

text

[pt] Nome da empresa ou organizacao do endereco de entrega.

shipping_address_country

text

[pt] Nome completo do pais do endereco de entrega.

shipping_address_country_code

text

[pt] Codigo do pais do endereco de entrega em duas letras, no formato ISO 3166-1 alpha-2 (ex.: BR, US).

shipping_address_first_name

text

[pt] Primeiro nome da pessoa associada ao endereco de entrega.

shipping_address_last_name

text

[pt] Sobrenome da pessoa associada ao endereco de entrega.

shipping_address_latitude

float

[pt] Coordenada de latitude do endereco de entrega.

shipping_address_longitude

float

[pt] Coordenada de longitude do endereco de entrega.

shipping_address_name

text

[pt] Nome completo (primeiro nome e sobrenome) da pessoa associada ao endereco de entrega.

shipping_address_phone

text

[pt] Numero de telefone do endereco de entrega.

shipping_address_province

text

[pt] Nome da regiao (como estado, provincia ou prefeitura) do endereco de entrega.

shipping_address_province_code

text

[pt] Codigo abreviado da regiao (como estado ou provincia) do endereco de entrega (ex.: SP).

shipping_address_zip

text

[pt] Codigo postal (CEP) do endereco de entrega.

order_id

text

[pt] ID do pedido ao qual esta aplicacao de desconto pertence.

    Pedidos > > id

allocation_method

text

[pt] Como o valor do desconto e distribuido entre as linhas a que se aplica. Os valores possiveis incluem ACROSS (o valor e distribuido proporcionalmente entre todas as linhas elegiveis), EACH (o valor e aplicado a cada linha elegivel individualmente) e ONE (o valor e aplicado uma unica vez).

code

text

[pt] Identificador do desconto aplicado ao pedido. Para descontos por codigo, e o codigo informado no checkout; para descontos manuais, via script ou automaticos, traz o nome/titulo do desconto. Fica vazio quando o desconto nao possui codigo ou titulo associado.

target_selection

text

[pt] A quais linhas do pedido o desconto se aplica. Os valores possiveis incluem ALL (todas as linhas sao elegiveis), ENTITLED (apenas as linhas que atendem as condicoes do desconto) e EXPLICIT (apenas linhas especificas escolhidas explicitamente para o desconto).

target_type

text

[pt] Se o desconto incide sobre os produtos ou sobre o frete do pedido. Os valores possiveis incluem LINE_ITEM (o desconto se aplica aos itens de produto) e SHIPPING_LINE (o desconto se aplica ao frete).

type

text

[pt] O tipo/origem da aplicacao do desconto. Os valores possiveis incluem DiscountCodeApplication (desconto acionado por um codigo informado no checkout), ManualDiscountApplication (desconto aplicado manualmente pelo lojista), ScriptDiscountApplication (desconto aplicado por um Shopify Script) e AutomaticDiscountApplication (desconto aplicado automaticamente por uma regra da loja).

value

float

[pt] A magnitude do desconto. Quando value_type e fixed_amount, e um valor monetario na moeda da loja; quando value_type e percentage, e o percentual do preco que sera descontado.

value_type

text

[pt] Indica como o campo value deve ser interpretado. Os valores possiveis sao fixed_amount (o desconto e um valor monetario na moeda da loja) e percentage (o desconto e um percentual do preco).

order_id

text

[pt] ID do pedido ao qual este codigo de desconto pertence.

    Pedidos > > id

amount

float

[pt] A magnitude do desconto aplicado por este codigo. Quando type e fixed_amount, e um valor monetario na moeda da loja deduzido do pedido; quando type e percentage, e o percentual do pedido que e descontado.

code

text

[pt] O identificador do desconto aplicado ao pedido. Para descontos por codigo, e o codigo informado no checkout; para descontos manuais ou via script, traz o titulo do desconto. Pode ficar vazio em descontos automaticos que nao possuem codigo nem titulo associado.

type

text

[pt] Como o valor do desconto deve ser interpretado. Os valores possiveis sao fixed_amount (amount e um valor monetario na moeda da loja deduzido do pedido) e percentage (amount e o percentual do pedido que e descontado).

order_id

text

[pt] Identificador do pedido ao qual esta remessa (fulfillment) pertence.

    Pedidos > > id

id

text

[pt] Identificador único da remessa (fulfillment), atribuído pela plataforma.

created_at

timestamp

[pt] Data e hora em que a remessa (fulfillment) foi criada (formato ISO 8601, com fuso horário).

location_id

text

[pt] Identificador do local de onde os itens são despachados (por exemplo, o depósito ou a loja).

name

text

[pt] Nome legível da remessa, derivado do número do pedido (por exemplo, o nome do pedido seguido de uma sequência da remessa).

service

text

[pt] Serviço de fulfillment responsável pela remessa (por exemplo, manual ou um provedor de logística terceirizado).

status

text

[pt] Status atual da remessa (fulfillment). Valores possíveis incluem: pending (pendente), open (em andamento), success (concluída com sucesso), cancelled (cancelada), error (erro) e failure (falha).

tracking_company

text

[pt] Nome da transportadora responsável pelo transporte da remessa (por exemplo, o serviço de correio ou courier).

tracking_number

text

[pt] Número de rastreamento fornecido pela transportadora para a remessa.

tracking_url

text

[pt] URL onde a remessa pode ser rastreada no site da transportadora.

updated_at

timestamp

[pt] Data e hora da última atualização da remessa (fulfillment) (formato ISO 8601, com fuso horário).

order_id

text

[pt] ID do pedido pai ao qual este item de linha pertence.

    Pedidos > > id

id

text

[pt] ID do item de linha (identificador único do item dentro do pedido).

fulfillment_status

text

[pt] Status de processamento (fulfillment) do item de linha. Um de: 'fulfilled' (toda a quantidade já foi processada/enviada), 'partial' (apenas parte da quantidade foi processada) ou vazio/null (nada processado ainda).

gift_card

boolean

[pt] Retorna verdadeiro (true) se o produto associado ao item de linha for um vale-presente (gift card).

grams

float

[pt] Peso de uma unidade do item de linha, em gramas.

name

text

[pt] Nome do produto, incluindo a variante, como aparece no pedido — combinação do título do produto e do título da variante, separados por hífen.

destination_location_address1

text

[pt] Primeira linha do endereço do local de destino: para onde o item de linha é enviado.

destination_location_address2

text

[pt] Segunda linha (complemento) do endereço do local de destino (para onde o item de linha é enviado).

destination_location_city

text

[pt] Cidade do local de destino (para onde o item de linha é enviado).

destination_location_country_code

text

[pt] Código do país (ISO 3166-1 alfa-2, duas letras) do local de destino.

destination_location_id

text

[pt] Identificador do local de destino (para onde o item de linha é enviado).

destination_location_name

text

[pt] Nome do local de destino (para onde o item de linha é enviado).

destination_location_province

text

[pt] Estado/província (nome ou sigla) do local de destino.

destination_location_zip

text

[pt] CEP/código postal do local de destino.

origin_location_address1

text

[pt] Primeira linha do endereço do local de origem: de onde o item de linha é enviado.

origin_location_address2

text

[pt] Segunda linha (complemento) do endereço do local de origem (de onde o item de linha é enviado).

origin_location_city

text

[pt] Cidade do local de origem (de onde o item de linha é enviado).

origin_location_country_code

text

[pt] Código do país (ISO 3166-1 alfa-2, duas letras) do local de origem.

origin_location_id

text

[pt] Identificador do local de origem (de onde o item de linha é enviado).

origin_location_name

text

[pt] Nome do local de origem (de onde o item de linha é enviado).

origin_location_province

text

[pt] Estado/província (nome ou sigla) do local de origem.

origin_location_zip

text

[pt] CEP/código postal do local de origem.

price

float

[pt] Preço unitário do item de linha, na moeda da loja, antes de descontos e impostos.

price_set_presentment_money_currency_code

text

[pt] Código da moeda (ISO 4217) do preço unitário na moeda de apresentação (presentment) — a moeda exibida ao cliente.

price_set_presentment_money_amount

float

[pt] Valor do preço unitário na moeda de apresentação (presentment) — a moeda exibida ao cliente.

price_set_shop_money_currency_code

text

[pt] Código da moeda (ISO 4217) do preço unitário na moeda da loja (shop).

price_set_shop_money_amount

text

[pt] Valor do preço unitário na moeda da loja (shop).

product_exists

boolean

[pt] Retorna verdadeiro (true) se o produto associado ao item de linha ainda existe na loja; falso (false) se ele foi excluído.

product_id

text

[pt] ID do produto ao qual este item de linha se refere.

    Produtos > > id

quantity

float

[pt] Quantidade de unidades deste item de linha que foram pedidas.

requires_shipping

boolean

[pt] Retorna verdadeiro (true) se a variante associada ao item de linha exige envio (frete); falso (false) caso contrário.

sku

text

[pt] SKU (código de controle de estoque) da variante associada ao item de linha.

taxable

boolean

[pt] Retorna verdadeiro (true) se devem incidir impostos sobre o item de linha; falso (false) caso contrário.

title

text

[pt] Título do item de linha: combinação do título do produto e do título da variante, separados por hífen.

total_discount

float

[pt] Valor total de descontos alocados a este item de linha, na moeda da loja.

total_discount_set_presentment_money_currency_code

text

[pt] Código da moeda (ISO 4217) do desconto total do item de linha na moeda de apresentação (presentment).

total_discount_set_presentment_money_amount

float

[pt] Valor do desconto total do item de linha na moeda de apresentação (presentment).

total_discount_set_shop_money_currency_code

text

[pt] Código da moeda (ISO 4217) do desconto total do item de linha na moeda da loja (shop).

total_discount_set_shop_money_amount

float

[pt] Valor do desconto total do item de linha na moeda da loja (shop).

variant_id

text

[pt] ID da variante do produto associada ao item de linha.

    Produtos: variantes > > id

variant_title

text

[pt] Título da variante do produto associada ao item de linha (por exemplo, tamanho ou cor).

vendor

text

[pt] Fornecedor (vendor) do produto/variante associado ao item de linha.

order_id

text

[pt] Identificador do pedido que contém o item de linha ao qual esta propriedade personalizada pertence

    Pedidos: itens > > order_id

order_line_item_id

text

[pt] Identificador do item de linha (entrada de produto/variante dentro do pedido) que carrega esta propriedade personalizada

    Pedidos: itens > > id

property_name

text

[pt] Nome/chave de uma propriedade personalizada anexada ao item de linha, definida pela loja ou pelo tema (por exemplo, texto de gravação, mensagem de presente, cor customizada, componente de bundle ou detalhe de assinatura)

property_value

text

[pt] Valor associado ao nome/chave correspondente da propriedade personalizada anexada ao item de linha

order_id

text

[pt] Identificador do pedido ao qual este atributo personalizado está associado

    Pedidos > > id

name

text

[pt] Nome/chave de um atributo personalizado (par nome/valor) anexado ao pedido pela loja ou pelo tema, como mensagem de presente, data de entrega ou campo customizado do checkout

value

text

[pt] Valor correspondente ao nome/chave do atributo personalizado (par nome/valor) anexado ao pedido

order_id

text

[pt] ID do pedido ao qual o reembolso pertence.

    Pedidos > > id

id

text

[pt] Identificador unico do reembolso.

created_at

timestamp

[pt] Data e hora em que o reembolso foi criado.

note

text

[pt] Nota opcional anexada ao reembolso, geralmente descrevendo o motivo ou os detalhes do reembolso.

processed_at

timestamp

[pt] Data e hora em que o reembolso foi processado. E o carimbo de tempo usado como data efetiva do reembolso em relatorios.

order_id

text

[pt] Identificador do pedido ao qual esta linha de frete pertence.

    Pedidos > > id

id

text

[pt] Identificador unico desta linha de frete.

carrier_identifier

text

[pt] Referencia ao servico de transportadora que forneceu a cotacao de frete. Presente quando a tarifa foi calculada por um servico de transportadora de terceiros; caso contrario, pode ficar vazio.

code

text

[pt] Codigo de referencia que identifica a tarifa de frete, conforme definido pelo servico de frete ou pela transportadora.

delivery_category

text

[pt] Classificacao geral do tipo de entrega desta linha de frete, por exemplo um envio padrao versus uma entrega local. Frequentemente vazio.

discounted_price

float

[pt] Preco desta linha de frete apos a aplicacao dos descontos no nivel da linha, na moeda da loja.

discounted_price_set_presentment_money_amount

float

[pt] Preco com desconto desta linha de frete na moeda de apresentacao (a moeda exibida ao cliente no checkout).

discounted_price_set_presentment_money_currency_code

text

[pt] Codigo de moeda no padrao ISO 4217 da moeda de apresentacao para o preco com desconto do frete (a moeda exibida ao cliente no checkout).

discounted_price_set_shop_money_currency_code

text

[pt] Codigo de moeda no padrao ISO 4217 da moeda da loja para o preco com desconto do frete (a moeda padrao da loja).

discounted_price_set_shop_money_amount

float

[pt] Preco com desconto desta linha de frete na moeda da loja (a moeda padrao da loja).

phone

text

[pt] Telefone associado a esta linha de frete, quando informado, usado por algumas transportadoras como contato de entrega. Frequentemente vazio.

price

float

[pt] Preco desta linha de frete antes de descontos, na moeda da loja. Nao pode ser negativo.

price_set_presentment_money_amount

float

[pt] Preco desta linha de frete antes de descontos, na moeda de apresentacao (a moeda exibida ao cliente no checkout).

price_set_presentment_money_currency_code

text

[pt] Codigo de moeda no padrao ISO 4217 da moeda de apresentacao para o preco do frete (a moeda exibida ao cliente no checkout).

price_set_shop_money_amount

float

[pt] Preco desta linha de frete antes de descontos, na moeda da loja (a moeda padrao da loja).

price_set_shop_money_currency_code

text

[pt] Codigo de moeda no padrao ISO 4217 da moeda da loja para o preco do frete (a moeda padrao da loja).

requested_fulfillment_service_id

text

[pt] Referencia ao servico de fulfillment (logistica de expedicao) solicitado para este metodo de frete.

source

text

[pt] Origem da tarifa de frete, ou seja, o canal ou aplicativo que a gerou (como a loja virtual no checkout ou um aplicativo de frete de terceiros).

title

text

[pt] Titulo do metodo de frete exibido ao cliente no checkout (por exemplo, o nome da transportadora ou da tarifa).

order_id

float

[pt] ID do pedido ao qual a transacao esta associada.

    Pedidos > > id

transaction_id

float

[pt] Identificador unico da transacao.

amount

float

[pt] Valor monetario envolvido na transacao, na moeda da loja.

authorization

text

[pt] Codigo de autorizacao retornado pelo provedor de pagamento para a transacao.

created_at

timestamp

[pt] Data e hora em que a transacao foi criada.

currency

text

[pt] Codigo de tres letras (ISO 4217) da moeda usada na transacao.

error_code

text

[pt] Codigo de erro padronizado, presente quando a transacao falha (por exemplo: incorrect_number, card_declined, expired_card, processing_error).

gateway

text

[pt] Nome do gateway de pagamento por onde a transacao foi processada.

kind

text

[pt] Tipo da transacao. Um de: authorization (reserva do valor), sale (autorizacao e captura juntas), capture (captura de um valor previamente autorizado), void (cancelamento de uma autorizacao) e refund (estorno de um valor capturado).

location_id

text

[pt] ID do local fisico (ponto de venda) onde a transacao foi processada, quando aplicavel.

parent_id

text

[pt] ID da transacao relacionada que originou esta — por exemplo, a autorizacao correspondente a uma captura, cancelamento ou estorno.

processed_at

timestamp

[pt] Data e hora em que a transacao foi processada pelo gateway.

receipt_x_account_id

text

[pt] Campo do recibo retornado pelo gateway: identificador da conta de pagamento informado pelo provedor. O conteudo do recibo varia conforme o gateway que processou a transacao.

receipt_x_amount

float

[pt] Campo do recibo do gateway: o valor da transacao conforme informado pelo provedor de pagamento.

receipt_x_currency

text

[pt] Campo do recibo do gateway: codigo de tres letras da moeda informado pelo provedor de pagamento.

receipt_x_gateway_reference

text

[pt] Campo do recibo do gateway: identificador de referencia da transacao no proprio provedor de pagamento.

receipt_x_reference

float

[pt] Campo do recibo do gateway: identificador de referencia que o provedor associa a transacao.

receipt_x_result

text

[pt] Campo do recibo do gateway: resultado da transacao informado pelo provedor (por exemplo, 'completed', 'pending').

receipt_x_signature

text

[pt] Campo do recibo do gateway: assinatura/hash retornada pelo provedor para validar a autenticidade do recibo.

receipt_x_test

text

[pt] Campo do recibo do gateway: indica se o provedor processou a transacao em modo de teste.

receipt_x_timestamp

text

[pt] Campo do recibo do gateway: data/hora registrada pelo provedor para a transacao.

source_name

text

[pt] Origem/canal de vendas da transacao (por exemplo, 'web' para a loja online, 'pos' para ponto de venda, ou um identificador do aplicativo/canal de vendas).

status

text

[pt] Situacao da transacao. Um de: success, failure, pending e error.

test

boolean

[pt] Indica se a transacao e uma transacao de teste.

order_id

float

[pt] O identificador único do pedido ao qual estes parâmetros UTM estão associados

    Pedidos > > id

utmparameters_campaign

text

[pt] O nome da campanha de marketing que originou a visita (parâmetro utm_campaign), como uma promoção sazonal ou um lançamento de produto

utmparameters_content

text

[pt] Identifica o conteúdo específico de uma campanha de marketing (parâmetro utm_content). Usado para diferenciar links ou anúncios semelhantes dentro de uma mesma campanha e medir qual é o mais efetivo

utmparameters_medium

text

[pt] O meio pelo qual a visita chegou à loja (parâmetro utm_medium), como banner, boletim de e-mail, custo por clique (cpc) ou rede social

utmparameters_source

text

[pt] A origem do tráfego que levou o visitante à loja (parâmetro utm_source), como um buscador, uma rede social ou um boletim de e-mail

utmparameters_term

float

[pt] Os termos de busca paga associados à campanha de marketing (parâmetro utm_term), normalmente as palavras-chave de um anúncio de busca paga

occurred_at

timestamp

[pt] A data e hora em que ocorreu a sessão do cliente que gerou estes parâmetros UTM

id

text

[pt] Identificador unico do produto, atribuido automaticamente pela loja.

body_html

text

[pt] Descricao do produto. Pode conter marcacao HTML.

created_at

timestamp

[pt] Data e hora (formato ISO 8601) em que o produto foi criado.

handle

text

[pt] Texto unico e amigavel que identifica o produto, gerado automaticamente a partir do titulo e usado como slug na URL da pagina do produto.

image_alt

text

[pt] Texto alternativo que descreve a imagem principal (primeira) do produto, usado para acessibilidade e SEO. Pode estar vazio.

image_created_at

timestamp

[pt] Data e hora (formato ISO 8601) em que a imagem principal (primeira) do produto foi criada.

image_height

float

[pt] Altura da imagem principal (primeira) do produto, em pixels.

image_id

text

[pt] Identificador unico da imagem principal (primeira) do produto.

image_position

float

[pt] Posicao desta imagem na galeria do produto, comecando em 1 (a posicao 1 e a imagem principal).

image_src

text

[pt] URL publica da imagem principal (primeira) do produto.

image_updated_at

timestamp

[pt] Data e hora (formato ISO 8601) da ultima modificacao da imagem principal (primeira) do produto.

image_width

float

[pt] Largura da imagem principal (primeira) do produto, em pixels.

product_type

text

[pt] Categoria do produto, definida pelo lojista, usada para filtrar e buscar produtos. Pode estar vazia.

published_at

timestamp

[pt] Data e hora (formato ISO 8601) em que o produto foi publicado. Fica nula quando o produto nao esta publicado no canal da loja online.

published_scope

boolean

[pt] Indica se o produto esta publicado tambem no canal de ponto de venda (PDV/POS), alem da loja online.

status

text

[pt] Situacao do produto. Valores comuns: active (ativo), archived (arquivado), draft (rascunho).

tags

text

[pt] Lista de etiquetas (tags) separadas por virgula, usadas para filtrar e buscar produtos. Um produto pode ter ate 250 etiquetas.

template_suffix

text

[pt] Sufixo do template Liquid usado na pagina do produto. Quando preenchido, a pagina usa o template 'product.<sufixo>.liquid'; quando vazio ou nulo, usa o template padrao 'product.liquid'.

title

text

[pt] Nome do produto.

updated_at

timestamp

[pt] Data e hora (formato ISO 8601) da ultima modificacao do produto.

vendor

text

[pt] Nome do fornecedor ou fabricante do produto.

product_id

text

[pt] Identificador unico do produto ao qual esta imagem pertence.

    Produtos > > id

alt

text

[pt] Texto alternativo que descreve a imagem, usado para acessibilidade e SEO. Pode estar vazio.

created_at

timestamp

[pt] Data e hora (formato ISO 8601) em que a imagem foi adicionada ao produto.

height

float

[pt] Altura da imagem, em pixels.

id

text

[pt] Identificador unico da imagem do produto.

position

float

[pt] Posicao desta imagem na galeria de imagens do produto, comecando em 1 (a posicao 1 e a imagem principal).

src

text

[pt] URL publica onde a imagem do produto esta hospedada.

updated_at

timestamp

[pt] Data e hora (formato ISO 8601) da ultima atualizacao da imagem.

width

float

[pt] Largura da imagem, em pixels.

product_id

text

[pt] Identificador do produto ao qual esta opção pertence.

    Produtos > > id

option_id

text

[pt] Identificador único da opção do produto.

options_name

text

[pt] Nome/rótulo da opção do produto, como Tamanho, Cor ou Material. Produtos que não possuem opções configuradas trazem uma única opção padrão chamada "Title", cujo valor é "Default Title".

options_position

float

[pt] Posição ordinal desta opção dentro do produto, começando em 1. Um produto pode ter até três opções, então este valor varia de 1 a 3 e define a ordem em que as opções são apresentadas.

options_values

text

[pt] Lista dos possíveis valores que esta opção pode assumir (por exemplo, para uma opção Tamanho: P, M, G; para uma opção Cor: Preto, Marrom), serializada como texto. Cada combinação de valores entre as opções do produto corresponde a uma variante do produto.

product_id

text

[pt] Identificador numérico único do produto ao qual esta variante pertence

    Produtos > > id

id

text

[pt] Identificador numérico único da variante do produto

inventory_item_id

text

[pt] Identificador numérico único do item de estoque associado à variante, usado para controlar a quantidade disponível

sku

text

[pt] Código de referência (SKU) que identifica a variante no estoque da loja. Pode estar vazio

barcode

text

[pt] Código de barras, UPC ou ISBN da variante do produto. Pode estar vazio

compare_at_price

float

[pt] Preço original (de referência) da variante antes de um desconto ou promoção, na moeda da loja. Fica vazio quando não há preço de comparação

created_at

timestamp

[pt] Data e hora em que a variante do produto foi criada

grams

float

[pt] Peso da variante do produto em gramas

image_id

text

[pt] Identificador numérico único da imagem do produto associada à variante. Fica vazio quando nenhuma imagem está atribuída

inventory_policy

text

[pt] Define se o cliente pode comprar a variante quando ela está sem estoque. Assume 'deny' (bloqueia a compra) ou 'continue' (permite a compra)

inventory_quantity

float

[pt] Quantidade total da variante em estoque, somada entre todos os locais

option1

text

[pt] Valor da primeira opção do produto (por exemplo, tamanho ou cor) para esta variante. Assume 'Default Title' quando o produto não possui opções

option2

text

[pt] Valor da segunda opção do produto para esta variante. Fica vazio quando o produto tem menos de duas opções

option3

text

[pt] Valor da terceira opção do produto para esta variante. Fica vazio quando o produto tem menos de três opções

position

float

[pt] Posição da variante na lista de variantes do produto, começando em 1

price

float

[pt] Preço de venda da variante do produto, na moeda da loja

taxable

boolean

[pt] Indica se há cobrança de imposto na venda da variante do produto

title

text

[pt] Título da variante do produto, formado pela junção dos valores de option1, option2 e option3

updated_at

timestamp

[pt] Data e hora da última modificação da variante do produto

weight

float

[pt] Peso da variante do produto na unidade definida em weight_unit

weight_unit

text

[pt] Unidade de medida do peso da variante. Assume 'g', 'kg', 'oz' ou 'lb'