Tiendanube (Nuvemshop)

Creating the data source

Instructions

  1. Log in to the Kondado platform > click CREATE + > Connector > Tiendanube
  2. On the connector page, click Authenticate
  3. You'll be redirected to your store's page (login may be required) click Accept and start using
  4. You'll be redirected back to Kondado - just click SAVE

Pipelines

Summary

Relationship chart

Click to expand

Abandoned checkouts

Main object

Campo Tipo

id

text

[pt] Identificador único do checkout abandonado.

abandoned_checkout_url

text

[pt] URL para o cliente recuperar o checkout abandonado.

billing_address

text

[pt] Endereço de faturamento do cliente ou empresa.

billing_business_name

text

[pt] Nome comercial da empresa associada ao faturamento.

billing_city

text

[pt] Cidade do endereço de faturamento.

billing_country

text

[pt] Código do país associado ao endereço de faturamento.

billing_customer_type

text

[pt] Tipo de cliente para faturamento (exemplo: pessoa física ou empresa).

billing_document_type

text

[pt] Tipo de documento fiscal utilizado para faturamento (exemplo: CPF, CNPJ).

billing_fiscal_regime

float

[pt] Regime fiscal da empresa associada ao faturamento.

billing_floor

text

[pt] Andar do endereço de faturamento, se aplicável.

billing_invoice_use

text

[pt] Código de uso da nota fiscal para faturamento.

billing_locality

text

[pt] Localidade do endereço de faturamento.

billing_name

text

[pt] Nome do cliente ou empresa associado ao faturamento do pedido.

billing_number

text

[pt] Número do endereço de faturamento.

billing_phone

text

[pt] Número de telefone associado ao faturamento do pedido.

billing_province

text

[pt] Estado ou província do endereço de faturamento.

billing_state_registration

text

[pt] Número de inscrição estadual da empresa associada ao faturamento.

billing_trade_name

text

[pt] Nome fantasia da empresa associada ao faturamento.

billing_zipcode

text

[pt] Código postal do endereço de faturamento.

checkout_enabled

boolean

[pt] Indica se o checkout está ativado para este pedido.

completed_at

timestamp

[pt] Data e hora em que o pedido foi concluído.

contact_accepts_marketing

boolean

[pt] Indica se o contato aceitou receber comunicações de marketing da loja.

contact_accepts_marketing_updated_at

timestamp

[pt] Data e hora da última atualização sobre a aceitação de comunicações de marketing pelo contato.

contact_email

text

[pt] E-mail de contato do cliente que iniciou o checkout.

contact_identification

text

[pt] Documento de identificação do cliente que iniciou o checkout (CPF ou CNPJ).

contact_name

text

[pt] Nome do cliente que iniciou o checkout.

contact_phone

text

[pt] Número de telefone do cliente que iniciou o checkout.

created_at

timestamp

[pt] Data e hora em que o pedido foi criado no sistema.

currency

text

[pt] Moeda utilizada na transação do pedido.

customer_id

text

[pt] Identificador único do cliente na loja.

    Customers > > id

customer_visit_created_at

timestamp

customer_visit_landing_page

text

customer_visit_utm_parameters_utm_campaign

text

[pt] Nome da campanha de marketing associada ao checkout abandonado.

customer_visit_utm_parameters_utm_content

text

[pt] Conteúdo específico utilizado para diferenciar variações de um mesmo anúncio ou campanha.

customer_visit_utm_parameters_utm_medium

text

[pt] Meio de comunicação usado na campanha, como e-mail, CPC, banner, etc.

customer_visit_utm_parameters_utm_source

text

[pt] Origem do tráfego, como Google, Facebook ou um site de referência.

customer_visit_utm_parameters_utm_term

text

[pt] Palavra-chave paga ou termo específico associado ao anúncio que gerou o tráfego.

discount

float

[pt] Valor total do desconto aplicado ao pedido.

discount_coupon

float

[pt] Valor do desconto concedido por um cupom promocional aplicado ao pedido.

discount_gateway

float

[pt] Valor do desconto aplicado pelo provedor de pagamento.

extra_key

text

free_shipping_config

text

[pt] Configuração de frete grátis aplicada ao pedido.

gateway

text

[pt] Nome do provedor de pagamento utilizado na transação.

gateway_id

text

[pt] Identificador do provedor de pagamento associado ao pedido.

gateway_name

text

[pt] Nome do método de pagamento específico utilizado no pedido.

has_stock_available

boolean

[pt] Indica se os produtos no checkout ainda possuem estoque disponível para compra.

language

text

[pt] Idioma utilizado pelo cliente ao realizar o pedido.

next_action

text

[pt] Próxima ação esperada para o pedido no fluxo de processamento.

note

text

[pt] Nota ou comentário associado ao pedido, geralmente adicionada pelo cliente ou vendedor.

order_origin

text

[pt] Origem do pedido, indicando como foi gerado (exemplo: manual, API, marketplace).

payment_count

float

[pt] Número de pagamentos registrados para o pedido.

payment_details_credit_card_company

text

[pt] Nome da operadora de cartão de crédito utilizada para o pagamento, se aplicável.

payment_details_installments

float

[pt] Número de parcelas em que o pagamento foi dividido.

payment_details_method

text

[pt] Método de pagamento utilizado no pedido (exemplo: boleto, cartão de crédito, transferência).

payment_status

text

[pt] Status atual do pagamento do pedido (exemplo: pending, paid, refunded).

promotional_discount_created_at

timestamp

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

promotional_discount_id

text

[pt] Identificador único do desconto promocional aplicado ao pedido.

promotional_discount_order_id

text

[pt] Identificador único do pedido ao qual o desconto promocional foi aplicado.

promotional_discount_store_id

text

[pt] Identificador único da loja onde o desconto promocional foi aplicado.

promotional_discount_total_discount_amount

float

[pt] Valor total do desconto promocional aplicado ao pedido.

same_billing_and_shipping_address

boolean

[pt] Indica se o endereço de faturamento é o mesmo do endereço de entrega.

shipping

text

[pt] Identificador do método de envio utilizado para o pedido.

shipping_address

text

[pt] Endereço de entrega informado pelo cliente no checkout.

shipping_city

text

[pt] Cidade do endereço de entrega.

shipping_cost_customer

float

[pt] Custo do frete pago pelo cliente.

shipping_cost_owner

float

[pt] Custo do frete assumido pelo lojista.

shipping_country

text

[pt] País do endereço de entrega.

shipping_floor

text

[pt] Andar do endereço de entrega, se aplicável.

shipping_locality

text

[pt] Localidade do endereço de entrega.

shipping_max_days

float

[pt] Número máximo de dias estimados para a entrega.

shipping_min_days

float

[pt] Número mínimo de dias estimados para a entrega.

shipping_name

text

[pt] Nome do destinatário informado para o envio.

shipping_number

text

[pt] Número do endereço de entrega informado pelo cliente.

shipping_option

text

[pt] Nome da opção de envio escolhida pelo cliente ou atribuída ao pedido.

shipping_option_code

text

[pt] Código da opção de envio utilizada, geralmente para identificação interna.

shipping_option_reference

text

[pt] Referência única para a opção de envio selecionada.

shipping_phone

text

[pt] Número de telefone do destinatário do envio.

shipping_pickup_details

text

[pt] Detalhes sobre a retirada do pedido, caso seja um pedido para retirada na loja ou outro local.

shipping_pickup_type

text

[pt] Tipo de retirada do pedido, podendo ser envio convencional ou retirada na loja.

shipping_province

text

[pt] Estado ou província do endereço de entrega.

shipping_store_branch_extra

text

[pt] Informações adicionais sobre a filial da loja onde o pedido será retirado.

shipping_store_branch_name

text

[pt] Nome da filial da loja onde o pedido será retirado, se aplicável.

shipping_tracking_number

text

[pt] Número de rastreamento fornecido pela transportadora para acompanhar a entrega do pedido.

shipping_tracking_url

text

[pt] URL do rastreamento do pedido, permitindo ao cliente acompanhar a entrega.

shipping_zipcode

text

[pt] Código postal do endereço de entrega.

store_id

text

[pt] Identificador único da loja onde o checkout foi realizado.

storefront

text

[pt] Origem da compra, indicando se foi realizada na loja virtual, aplicativo ou outro canal.

subtotal

float

[pt] Valor total dos produtos no pedido antes de descontos e taxas adicionais.

token

text

[pt] Token de autenticação do checkout abandonado.

total

float

[pt] Valor final do pedido após aplicação de descontos e taxas.

total_usd

float

[pt] Valor final do pedido convertido para dólares americanos (USD).

updated_at

timestamp

[pt] Data e hora da última atualização do pedido no sistema.

was_notified

boolean

[pt] Indica se o cliente foi notificado sobre o checkout abandonado.

weight

float

[pt] Peso total dos produtos no pedido, em quilogramas.

nuvemshop_abandoned_checkouts_extra

Campo Tipo

abandoned_checkout_id

text

[pt] Identificador único do carrinho abandonado.

extra_key

text

[pt] Chave do valor customizável de cliente.

extra_value

text

[pt] Chave do valor customizável de cliente.

Abandoned checkouts: coupons

nuvemshop_abandoned_checkouts_coupon

Campo Tipo

abandoned_checkout_id

text

[pt] Identificador único do carrinho abandonado.

    Abandoned checkouts > > id

coupon_id

text

[pt] Identificador único do cupom.

    Coupons > > id

coupon_code

text

[pt] Código de uso do cupom.

coupon_combines_with_other_discounts

boolean

[pt] Indica se o cupom pode ser combinado com outros descontos.

coupon_end_date

timestamp

[pt] Data de término da validade do cupom de desconto.

coupon_first_consumer_purchase

boolean

[pt] Indica se o cupom é válido apenas para a primeira compra do consumidor.

coupon_includes_shipping

boolean

[pt] Indica se o cupom cobre os custos de envio.

coupon_is_deleted

boolean

[pt] Indica se o cupom foi deletado.

coupon_max_uses

float

[pt] Indica número máximo de usos.

coupon_max_uses_per_client

float

[pt] Indica número máximo de usos por cliente.

coupon_min_price

float

[pt] Valor mínimo de compra necessário para utilizar o cupom de desconto.

coupon_start_date

timestamp

[pt] Data de início da validade do cupom de desconto.

coupon_type

text

[pt] Indica o tipo do cupom.

coupon_used

float

[pt] Indica se o cupom foi utilizado.

coupon_valid

text

[pt] Indica se o cupom é valido.

coupon_value

float

[pt] Valor do cupom.

nuvemshop_abandoned_checkouts_coupon_products

Campo Tipo

abandoned_checkout_id

text

[pt] Identificador único do carrinho abandonado.

    Abandoned checkouts > > id

coupon_products_id

text

[pt] Identificador único do produto associado ao cupom de desconto.

    Products > > id

coupon_products_name_key

text

[pt] Nome do produto elegível para o cupom.

coupon_products_name_value

text

[pt] Nome do produto elegível para o cupom.

nuvemshop_abandoned_checkouts_coupon_categories

Campo Tipo

abandoned_checkout_id

text

[pt] Identificador único do carrinho abandonado.

    Abandoned checkouts > > id

coupon_categories_id

text

[pt] Identificador único da categoria do cupom.

    Categories > > id

coupon_categories_name_key

text

[pt] Nome do produto elegível para o cupom.

coupon_categories_name_value

text

[pt] Nome do produto elegível para o cupom.

Abandoned checkouts: products

nuvemshop_abandoned_checkouts_products

Campo Tipo

abandoned_checkout_id

text

[pt] Identificador único do carrinho abandonado.

    Abandoned checkouts > > id

products_barcode

text

[pt] Código de barras do produto.

products_compare_at_price

float

[pt] Preço original do produto antes de descontos.

products_depth

float

[pt] Profundidade do produto em centímetros.

products_free_shipping

boolean

[pt] Indica se o frete do produto é gratuito.

products_height

float

[pt] Altura do produto em centímetros.

product_id

text

[pt] Identificador único do produto na ordem de compra.

    Products > > id

products_image_alt_key

text

products_image_created_at

timestamp

[pt] Data e hora de criação da imagem do produto.

products_image_height

float

[pt] Altura da imagem do produto em pixels.

products_image_id

text

[pt] Identificador único da imagem do produto.

products_image_position

float

[pt] Posição da imagem dentro da galeria do produto.

products_image_product_id

text

[pt] Identificador do produto ao qual a imagem pertence.

products_image_src

text

[pt] URL da imagem do produto.

products_image_thumbnails_generated

boolean

[pt] Indica se miniaturas foram geradas para a imagem do produto.

products_image_updated_at

timestamp

[pt] Data e hora da última atualização da imagem do produto.

products_image_width

float

[pt] Largura da imagem do produto em pixels.

products_name

text

[pt] Nome do produto conforme cadastrado na loja.

products_name_without_variants

text

[pt] Nome do produto sem variações ou atributos adicionais.

products_price

float

[pt] Preço atual do produto sem descontos aplicados.

products_product_id

text

[pt] Identificador único do produto na loja.

    Abandoned checkouts: products > > id

products_quantity

float

[pt] Quantidade do produto incluído na compra.

products_sku

text

[pt] Código SKU do produto.

products_variant_id

text

[pt] Identificador da variante do produto.

    Products: variants > > product_variant_id

products_variant_values

text

[pt] Lista de valores que descrevem a variante do produto.

products_weight

float

[pt] Peso do produto em quilogramas.

products_width

float

[pt] Largura do produto em centímetros.

nuvemshop_abandoned_checkouts_products_properties

Campo Tipo

abandoned_checkout_id

text

[pt] Identificador único do pedido.

    Abandoned checkouts > > id

product_id

text

[pt] Identificador único do produto no pedido.

    Abandoned checkouts: products > > id

products_properties_key

text

[pt] Chave da propriedade do produto.

products_properties_value

text

[pt] Valor da propriedade do produto.

Abandoned checkouts: promotion applied

Campo Tipo

abandoned_checkout_id

text

[pt] Identificador único do carrinho abandonado.

    Abandoned checkouts > > id

promotional_discount_applied_discount_script_type

text

[pt] Tipo de regra de desconto aplicada na promoção.

promotional_discount_applied_scope_value_id

text

[pt] Identificador do escopo da promoção aplicada.

promotional_discount_applied_scope_value_name

text

[pt] Nome do escopo da promoção aplicada.

promotional_discount_applied_selected_threshold_decimal_per

float

[pt] Percentual de desconto aplicado, representado em formato decimal.

promotional_discount_applied_selected_threshold_quantity

float

[pt] Quantidade mínima de itens necessária para ativar o desconto da promoção.

promotional_discount_applied_total_discount_amount

float

[pt] Valor total do desconto aplicado na promoção.

promotional_discount_applied_total_discount_amount_long

text

[pt] Valor do desconto aplicado, formatado em longo (exemplo: 'R$1,00').

promotional_discount_applied_total_discount_amount_short

text

[pt] Valor do desconto aplicado, formatado em curto (exemplo: 'R$1,00').

promotional_discount_applied_total_discount_amount_to_cents

float

[pt] Valor do desconto convertido para centavos.

Abandoned checkouts: promotion discount contents

Campo Tipo

abandoned_checkout_id

text

[pt] Identificador único do carrinho abandonado.

    Abandoned checkouts > > id

promotional_discount_contents_id

text

[pt] Identificador único do item ao qual o desconto foi aplicado.

promotional_discount_contents_begin_date

timestamp

[pt] Data e hora de início da aplicação do desconto.

promotional_discount_contents_buy

float

[pt] Quantidade mínima de itens que precisam ser comprados para que o desconto seja aplicado.

promotional_discount_contents_discount_amount

float

[pt] Valor do desconto aplicado ao item.

promotional_discount_contents_discount_script_type

text

[pt] Tipo de regra de desconto aplicada ao item.

promotional_discount_contents_end_date

timestamp

[pt] Data e hora de término da aplicação do desconto.

promotional_discount_contents_final_price

float

[pt] Preço final do item após o desconto.

promotional_discount_contents_original_price

float

[pt] Preço original do item antes do desconto.

promotional_discount_contents_pay

float

[pt] Quantidade de itens pelo qual o cliente efetivamente paga após o desconto.

promotional_discount_contents_quantity

float

[pt] Quantidade de itens que receberam o desconto.

promotional_discount_contents_scope_type

text

[pt] Escopo do desconto aplicado (exemplo: 'all' para todos os produtos).

promotional_discount_contents_scope_value_id

text

[pt] Identificador do escopo do desconto aplicado.

promotional_discount_contents_scope_value_name

text

[pt] Nome do escopo do desconto aplicado.

promotional_discount_contents_total_discount_amount

float

[pt] Valor total do desconto aplicado ao item.

Categories

Campo Tipo

id

text

[pt] Identificador único da categoria de produto.

created_at

timestamp

[pt] Data e hora de criação da categoria no formato ISO 8601.

description

text

[pt] Descrição da categoria.

google_shopping_category

text

[pt] Categoria associada ao Google Shopping para melhor categorização de produtos.

handle

text

[pt] Identificador amigável da categoria, utilizado em URLs e SEO.

name

text

[pt] Nome da categoria.

parent

text

[pt] Identificador da categoria pai. Se for 0, significa que não possui categoria pai.

seo_description

text

[pt] Descrição de SEO da categoria para otimização nos motores de busca.

seo_title

text

[pt] Título de SEO da categoria para otimização nos motores de busca.

subcategories

text

[pt] Lista de identificadores das subcategorias associadas a esta categoria.

updated_at

timestamp

[pt] Data e hora da última atualização da categoria.

visibility

text

[pt] Estado de visibilidade da categoria. Pode ser 'visible' ou 'hidden'.

visibility_updated_at

timestamp

[pt] Data e hora da última atualização do estado de visibilidade da categoria.

campo_personalizado_x

text

campo_personalizado_y

text

campo_personalizado_z

text

Coupons

Main object

Campo Tipo

id

text

[pt] Identificador único do cupom de desconto.

code

text

[pt] Código do cupom utilizado na compra.

combines_with_other_discounts

boolean

[pt] Indica se o cupom pode ser combinado com outros descontos.

end_date

date

[pt] Data de expiração do cupom.

first_consumer_purchase

boolean

[pt] Indica se o cupom é válido apenas para a primeira compra do cliente.

includes_shipping

boolean

[pt] Indica se o cupom cobre os custos de envio.

is_deleted

boolean

[pt] Indica se o cupom foi excluído e não está mais disponível.

max_uses

float

[pt] Número máximo de vezes que o cupom pode ser utilizado.

max_uses_per_client

float

[pt] Número máximo de vezes que um cliente pode usar este cupom.

min_price

float

[pt] Valor mínimo da compra necessário para usar o cupom.

start_date

date

[pt] Data de início da validade do cupom.

type

text

[pt] Tipo de desconto aplicado pelo cupom (exemplo: percentual, valor fixo).

used

float

[pt] Número de vezes que o cupom já foi utilizado.

valid

text

[pt] Indica se o cupom está ativo e pode ser utilizado.

value

float

[pt] Valor do desconto oferecido pelo cupom.

nuvemshop_coupons_products

Campo Tipo

coupon_id

text

[pt] Identificador único do cupom de desconto.

products_id

text

[pt] Identificador único do produto associado ao cupom.

    Products > > id

products_name

text

nuvemshop_coupons_categories

Campo Tipo

coupon_id

text

[pt] Identificador único do cupom de desconto.

categories_id

text

[pt] Identificador único da categoria associada ao cupom.

    Categories > > id

categories_name

text

categories_parent

float

[pt] Identificador da categoria pai, se aplicável.

Custom fields

Campo Tipo

id

text

[pt] Identificador único do campo personalizado.

created_at

timestamp

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

description

text

[pt] Descrição do propósito ou conteúdo do campo personalizado.

key

text

[pt] Chave que identifica o nome lógico do campo personalizado.

namespace

text

[pt] Categoria ou domínio ao qual o campo pertence, usado para organização lógica (por exemplo, 'nfe').

owner_id

text

[pt] Identificador do recurso (por exemplo, uma ordem) ao qual este campo personalizado está vinculado.

owner_resource

text

[pt] Tipo de recurso ao qual o campo personalizado pertence (por exemplo, 'Order').

updated_at

timestamp

[pt] Data e hora da última atualização do campo personalizado.

value

text

[pt] Valor atribuído ao campo personalizado.

Customers

Main object

Campo Tipo

id

text

[pt] Identificador único do cliente.

accepts_marketing

boolean

[pt] Indica se o cliente aceitou receber comunicações de marketing.

accepts_marketing_updated_at

timestamp

[pt] Data e hora da última atualização sobre a aceitação de marketing.

active

boolean

[pt] Indica se o cliente está ativo.

billing_address

text

[pt] Endereço de faturamento do cliente.

billing_city

text

[pt] Cidade do endereço de faturamento.

billing_country

text

[pt] País do endereço de faturamento.

billing_floor

text

[pt] Andar do endereço de faturamento, se aplicável.

billing_locality

text

[pt] Bairro do endereço de faturamento.

billing_name

text

[pt] Nome de faturamento do cliente.

billing_number

text

[pt] Número do endereço de faturamento.

billing_phone

text

[pt] Telefone de faturamento do cliente.

billing_province

text

[pt] Estado ou província do endereço de faturamento.

billing_zipcode

text

[pt] Código postal do endereço de faturamento.

business_activity

text

[pt] Atividade econômica do cliente, se aplicável.

business_name

text

[pt] Nome empresarial do cliente, se aplicável.

created_at

timestamp

[pt] Data e hora de criação do cliente na base de dados.

customer_type

text

[pt] Tipo de cliente (exemplo: pessoa física ou jurídica).

default_address_address

text

default_address_city

text

default_address_country

text

default_address_created_at

timestamp

default_address_default

boolean

default_address_floor

text

default_address_id

text

default_address_locality

text

default_address_name

text

default_address_number

text

default_address_phone

text

default_address_province

text

default_address_updated_at

timestamp

default_address_zipcode

text

document_type

text

[pt] Tipo de documento do cliente (exemplo: CPF, CNPJ).

email

text

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

first_interaction

timestamp

[pt] Data e hora da primeira interação do cliente com a loja.

fiscal_regime

text

[pt] Regime fiscal ao qual o cliente está vinculado.

identification

text

[pt] Número de identificação (CPF ou CNPJ) do cliente.

invoice_use

text

[pt] Finalidade do uso da nota fiscal do cliente.

last_order_id

text

[pt] Identificador do último pedido realizado pelo cliente.

name

text

[pt] Nome completo do cliente.

note

text

[pt] Anotações adicionais sobre o cliente.

phone

text

[pt] Número de telefone do cliente.

state_registration

text

[pt] Registro estadual do cliente, se aplicável.

total_spent

float

[pt] Total gasto pelo cliente em compras.

total_spent_currency

text

[pt] Moeda do valor total gasto pelo cliente.

trade_name

text

[pt] Nome fantasia do cliente, se aplicável.

updated_at

timestamp

[pt] Data e hora da última atualização dos dados do cliente.

nuvemshop_customers_addresses

Campo Tipo

customer_id

text

[pt] Identificador único do cliente.

addresses_id

text

[pt] Identificador único do endereço do cliente.

addresses_address

text

[pt] Endereço do cliente.

addresses_city

text

[pt] Cidade do endereço do cliente.

addresses_country

text

[pt] País do endereço do cliente.

addresses_created_at

timestamp

[pt] Data e hora de criação do endereço.

addresses_default

boolean

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

addresses_floor

text

[pt] Andar do endereço do cliente, se aplicável.

addresses_locality

text

[pt] Bairro do endereço do cliente.

addresses_name

text

[pt] Nome associado ao endereço do cliente.

addresses_number

text

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

addresses_phone

text

[pt] Telefone associado ao endereço do cliente.

addresses_province

text

[pt] Estado ou província do endereço do cliente.

addresses_updated_at

timestamp

[pt] Data e hora da última atualização do endereço.

addresses_zipcode

text

[pt] Código postal do endereço do cliente.

nuvemshop_customers_extra

Campo Tipo

customer_id

text

[pt] Identificador único do cliente.

extra_key

text

[pt] Chave do valor customizável de cliente.

extra_value

text

[pt] Chave do valor customizável de cliente.

Customers: custom fields

Main object

Campo Tipo

id

text

[pt] Identificador único do cliente.

accepts_marketing

boolean

[pt] Indica se o cliente aceitou receber comunicações de marketing.

accepts_marketing_updated_at

timestamp

[pt] Data e hora da última atualização sobre a aceitação de marketing.

active

boolean

[pt] Indica se o cliente está ativo.

billing_address

text

[pt] Endereço de faturamento do cliente.

billing_city

text

[pt] Cidade do endereço de faturamento.

billing_country

text

[pt] País do endereço de faturamento.

billing_floor

text

[pt] Andar do endereço de faturamento, se aplicável.

billing_locality

text

[pt] Bairro do endereço de faturamento.

billing_name

text

[pt] Nome de faturamento do cliente.

billing_number

text

[pt] Número do endereço de faturamento.

billing_phone

text

[pt] Telefone de faturamento do cliente.

billing_province

text

[pt] Estado ou província do endereço de faturamento.

billing_zipcode

text

[pt] Código postal do endereço de faturamento.

business_activity

text

[pt] Atividade econômica do cliente, se aplicável.

business_name

text

[pt] Nome empresarial do cliente, se aplicável.

created_at

timestamp

[pt] Data e hora de criação do cliente na base de dados.

customer_type

text

[pt] Tipo de cliente (exemplo: pessoa física ou jurídica).

default_address_address

text

default_address_city

text

default_address_country

text

default_address_created_at

timestamp

default_address_default

boolean

default_address_floor

text

default_address_id

text

default_address_locality

text

default_address_name

text

default_address_number

text

default_address_phone

text

default_address_province

text

default_address_updated_at

timestamp

default_address_zipcode

text

document_type

text

[pt] Tipo de documento do cliente (exemplo: CPF, CNPJ).

email

text

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

first_interaction

timestamp

[pt] Data e hora da primeira interação do cliente com a loja.

fiscal_regime

text

[pt] Regime fiscal ao qual o cliente está vinculado.

identification

text

[pt] Número de identificação (CPF ou CNPJ) do cliente.

invoice_use

text

[pt] Finalidade do uso da nota fiscal do cliente.

last_order_id

text

[pt] Identificador do último pedido realizado pelo cliente.

name

text

[pt] Nome completo do cliente.

note

text

[pt] Anotações adicionais sobre o cliente.

phone

text

[pt] Número de telefone do cliente.

state_registration

text

[pt] Registro estadual do cliente, se aplicável.

total_spent

float

[pt] Total gasto pelo cliente em compras.

total_spent_currency

text

[pt] Moeda do valor total gasto pelo cliente.

trade_name

text

[pt] Nome fantasia do cliente, se aplicável.

updated_at

timestamp

[pt] Data e hora da última atualização dos dados do cliente.

campo_personalizado_x

text

campo_personalizado_y

text

campo_personalizado_z

text

nuvemshop_customers_addresses_cf

Campo Tipo

customer_id

text

[pt] Identificador único do cliente.

addresses_id

text

[pt] Identificador único do endereço do cliente.

addresses_address

text

[pt] Endereço do cliente.

addresses_city

text

[pt] Cidade do endereço do cliente.

addresses_country

text

[pt] País do endereço do cliente.

addresses_created_at

timestamp

[pt] Data e hora de criação do endereço.

addresses_default

boolean

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

addresses_floor

text

[pt] Andar do endereço do cliente, se aplicável.

addresses_locality

text

[pt] Bairro do endereço do cliente.

addresses_name

text

[pt] Nome associado ao endereço do cliente.

addresses_number

text

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

addresses_phone

text

[pt] Telefone associado ao endereço do cliente.

addresses_province

text

[pt] Estado ou província do endereço do cliente.

addresses_updated_at

timestamp

[pt] Data e hora da última atualização do endereço.

addresses_zipcode

text

[pt] Código postal do endereço do cliente.

nuvemshop_customers_extra_cf

Campo Tipo

customer_id

text

[pt] Identificador único do cliente.

extra_key

text

[pt] Chave do valor customizável de cliente.

extra_value

text

[pt] Chave do valor customizável de cliente.

Orders

Main object

Campo Tipo

id

text

[pt] Identificador único do pedido.

app_id

text

[pt] Identificador do aplicativo associado ao pedido.

billing_address

text

[pt] Endereço de cobrança.

billing_business_activity

text

[pt] Atividade empresarial associada ao faturamento.

billing_business_name

text

[pt] Nome empresarial para fins de faturamento.

billing_city

text

[pt] Cidade do endereço de cobrança.

billing_country

text

[pt] País do endereço de cobrança.

billing_customer_type

text

[pt] Tipo de cliente para fins de cobrança.

billing_document_type

text

[pt] Tipo de documento utilizado para faturamento.

billing_fiscal_regime

text

[pt] Regime fiscal da empresa para faturamento.

billing_floor

text

[pt] Andar do endereço de cobrança.

billing_invoice_use

text

[pt] Finalidade da fatura emitida.

billing_locality

text

[pt] Localidade do endereço de cobrança.

billing_name

text

[pt] Nome do titular da cobrança.

billing_number

text

[pt] Número do endereço de cobrança.

billing_phone

text

[pt] Telefone do titular da cobrança.

billing_province

text

[pt] Estado/Província do endereço de cobrança.

billing_state_registration

text

[pt] Registro estadual da empresa para faturamento.

billing_trade_name

text

[pt] Nome fantasia da empresa para faturamento.

billing_zipcode

text

[pt] Código postal do endereço de cobrança.

cancel_reason

text

[pt] Motivo do cancelamento do pedido, se aplicável.

cancelled_at

timestamp

[pt] Data e hora do cancelamento do pedido, se aplicável.

checkout_enabled

boolean

[pt] Indica se o checkout está habilitado para este pedido.

client_details_browser_ip

text

[pt] Endereço IP do cliente ao fazer o pedido.

client_details_user_agent

text

[pt] User agent do navegador do cliente ao fazer o pedido.

closed_at

timestamp

[pt] Data e hora de fechamento do pedido.

completed_at_date

timestamp

[pt] Data e hora de conclusão do pedido.

completed_at_timezone

text

[pt] Fuso horário da data de conclusão do pedido.

completed_at_timezone_type

float

[pt] Tipo de fuso horário associado à data de conclusão.

contact_email

text

[pt] E-mail de contato associado ao pedido.

contact_identification

text

[pt] Identificação do contato associado ao pedido.

contact_name

text

[pt] Nome do contato associado ao pedido.

contact_phone

text

[pt] Telefone do contato associado ao pedido.

created_at

timestamp

[pt] Data e hora de criação do pedido.

currency

text

[pt] Moeda utilizada no pedido.

customer_accepts_marketing

boolean

[pt] Indica se o cliente aceita receber marketing.

customer_accepts_marketing_updated_at

timestamp

[pt] Data e hora da última atualização da aceitação de marketing pelo cliente.

customer_active

boolean

[pt] Indica se o cliente está ativo no sistema.

customer_billing_address

text

[pt] Endereço de cobrança do pedido.

customer_billing_city

text

[pt] Cidade de cobrança do pedido.

customer_billing_country

text

[pt] País de cobrança do pedido.

customer_billing_floor

text

[pt] Piso de cobrança do pedido.

customer_billing_locality

text

[pt] Localidade de cobrança do pedido.

customer_billing_name

text

[pt] Nome de cobrança do pedido.

customer_billing_number

text

[pt] Número de cobrança do pedido.

customer_billing_phone

text

[pt] Telefone de cobrança do pedido.

customer_billing_province

text

[pt] Província de cobrança do pedido.

customer_billing_zipcode

text

[pt] CEP de cobrança do pedido.

customer_business_activity

text

[pt] Atividade empresarial do cliente, se aplicável.

customer_business_name

text

[pt] Nome da empresa do cliente, se aplicável.

customer_created_at

timestamp

[pt] Data e hora em que o cliente foi criado no sistema.

customer_customer_type

text

[pt] Tipo de cliente, como pessoa física ou jurídica.

customer_default_address_address

text

[pt] Endereço principal cadastrado pelo cliente.

customer_default_address_city

text

[pt] Cidade principal cadastrada pelo cliente.

customer_default_address_country

text

[pt] País principal cadastrado pelo cliente.

customer_default_address_created_at

timestamp

[pt] Data e hora de criação do endereço principal do cliente.

customer_default_address_default

boolean

[pt] Indica se este é o endereço principal do cliente (true/false).

customer_default_address_floor

text

[pt] Andar do endereço principal do cliente, se aplicável.

customer_default_address_id

text

[pt] Identificador único do endereço principal do cliente.

customer_default_address_locality

text

[pt] Bairro ou região do endereço principal do cliente.

customer_default_address_name

text

[pt] Nome associado ao endereço principal do cliente.

customer_default_address_number

text

[pt] Número do endereço principal do cliente.

customer_default_address_phone

text

[pt] Telefone do endereço principal do cliente.

customer_default_address_province

text

[pt] Província do endereço principal do cliente.

customer_default_address_updated_at

timestamp

[pt] Data e hora da última atualização do endereço principal do cliente.

customer_default_address_zipcode

text

[pt] Código postal (CEP) do endereço principal do cliente.

customer_document_type

text

[pt] Tipo de documento associado ao cliente.

customer_email

text

[pt] E-mail do cliente.

customer_first_interaction

timestamp

[pt] Data e hora da primeira interação do cliente com a loja.

customer_fiscal_regime

text

[pt] Regime fiscal do cliente, se aplicável.

customer_id

text

[pt] Identificador único do cliente.

    Customers > > id

customer_identification

text

[pt] Documento do cliente.

customer_invoice_use

text

[pt] Finalidade da fatura para o cliente.

customer_last_order_id

text

[pt] Identificador do último pedido feito pelo cliente.

customer_name

text

[pt] Nome completo do cliente.

customer_note

text

[pt] Nota deixada sobre o cliente.

customer_phone

text

[pt] Telefone do cliente.

customer_state_registration

text

[pt] Registro estadual do cliente, se aplicável.

customer_total_spent

float

[pt] Valor total gasto pelo cliente.

customer_total_spent_currency

text

[pt] Valor total gasto pelo cliente.

customer_trade_name

text

[pt] Nome fantasia da empresa do cliente, se aplicável.

customer_updated_at

timestamp

[pt] Data e hora da última atualização do cadastro do cliente.

customer_visit_created_at

timestamp

[pt] Data e hora da visita do cliente ao site.

customer_visit_landing_page

text

[pt] Página de destino da visita do cliente.

customer_visit_utm_parameters_utm_campaign

text

[pt] Campanha de marketing associada ao pedido.

customer_visit_utm_parameters_utm_content

text

[pt] Conteúdo de marketing associado ao pedido.

customer_visit_utm_parameters_utm_medium

text

[pt] Meio de marketing associado ao pedido.

customer_visit_utm_parameters_utm_source

text

[pt] Fonte do marketing associada ao pedido.

customer_visit_utm_parameters_utm_term

text

[pt] Termo de busca associado ao pedido.

discount

float

[pt] Valor total dos descontos aplicados.

discount_coupon

text

[pt] Desconto aplicado via cupom.

discount_gateway

float

[pt] Desconto aplicado via meio de pagamento.

free_shipping_config

text

[pt] Configuração de frete grátis aplicada ao pedido.

gateway

text

[pt] Nome do meio de pagamento utilizado.

gateway_id

text

[pt] Identificador do meio de pagamento.

gateway_link

text

[pt] Link de pagamento fornecido pelo gateway.

gateway_name

text

[pt] Nome do meio de pagamento.

has_shippable_products

boolean

[pt] Indica se há produtos enviáveis no pedido.

landing_url

text

[pt] URL de origem do cliente antes da compra.

language

text

[pt] Idioma utilizado no pedido.

next_action

text

[pt] Próxima ação esperada para este pedido.

note

text

[pt] Nota deixada sobre o pedido.

number

text

[pt] Número sequencial do pedido.

order_origin

text

[pt] Origem do pedido, como loja virtual ou API.

owner_note

text

[pt] Nota interna do lojista sobre o pedido.

paid_at

text

[pt] Data e hora em que o pedido foi pago.

payment_count

float

[pt] Número total de pagamentos registrados para este pedido.

payment_details_credit_card_company

text

[pt] Bandeira do cartão de crédito, se aplicável.

payment_details_installments

float

[pt] Número de parcelas no pagamento.

payment_details_method

text

[pt] Método de pagamento utilizado.

payment_status

text

[pt] Status atual do pagamento do pedido.

promotional_discount_created_at

timestamp

[pt] Data e hora em que o desconto promocional foi aplicado.

promotional_discount_id

text

[pt] Identificador único do desconto promocional aplicado ao pedido.

promotional_discount_order_id

text

[pt] Identificador do pedido ao qual o desconto foi aplicado.

promotional_discount_store_id

text

[pt] Identificador da loja onde o desconto promocional foi aplicado.

promotional_discount_total_discount_amount

float

[pt] Valor total do desconto promocional aplicado ao pedido.

read_at

timestamp

[pt] Data e hora em que o pedido foi lido pelo sistema.

same_billing_and_shipping_address

boolean

[pt] Indica se os endereços de cobrança e entrega são os mesmos.

shipped_at

timestamp

[pt] Data e hora em que o pedido foi enviado.

shipping

text

[pt] Método de envio utilizado.

shipping_address_address

text

[pt] Endereço de entrega do pedido.

shipping_address_city

text

[pt] Cidade do endereço de entrega.

shipping_address_country

text

[pt] País do endereço de entrega.

shipping_address_created_at

timestamp

[pt] Data e hora da criação do endereço de entrega.

shipping_address_default

boolean

[pt] Indica se este é o endereço de entrega padrão.

shipping_address_floor

text

[pt] Andar do endereço de entrega.

shipping_address_id

text

[pt] Identificador único do endereço de entrega.

shipping_address_locality

text

[pt] Bairro ou região do endereço de entrega.

shipping_address_name

text

[pt] Nome associado ao endereço de entrega.

shipping_address_number

text

[pt] Número do endereço de entrega.

shipping_address_phone

text

[pt] Telefone associado ao endereço de entrega.

shipping_address_province

text

[pt] Estado/Província do endereço de entrega.

shipping_address_updated_at

timestamp

[pt] Data e hora da última atualização do endereço de entrega.

shipping_address_zipcode

text

[pt] Código postal do endereço de entrega.

shipping_carrier_name

text

[pt] Nome da transportadora responsável pelo envio.

shipping_cost_customer

float

[pt] Custo de envio pago pelo cliente.

shipping_cost_owner

float

[pt] Custo de envio pago pelo lojista.

shipping_max_days

float

[pt] Número máximo de dias estimados para entrega.

shipping_min_days

float

[pt] Número mínimo de dias estimados para entrega.

shipping_option

text

[pt] Opção de envio escolhida pelo cliente.

shipping_option_code

text

[pt] Código da opção de envio escolhida.

shipping_option_reference

text

[pt] Referência da opção de envio escolhida para o pedido.

shipping_pickup_details

text

[pt] Detalhes sobre a retirada do pedido pelo cliente.

shipping_pickup_type

text

[pt] Tipo de retirada do pedido, como 'pickup'.

shipping_status

text

[pt] Status do envio do pedido.

shipping_store_branch_extra

text

[pt] Informações adicionais sobre a filial da loja onde o pedido será retirado.

shipping_store_branch_name

text

[pt] Nome da filial da loja onde o pedido será retirado.

shipping_tracking_number

text

[pt] Número de rastreamento do pedido.

shipping_tracking_url

text

[pt] URL para rastreamento do pedido.

status

text

[pt] Status atual do pedido.

store_id

text

[pt] Identificador único da loja onde o pedido foi feito.

storefront

text

[pt] Origem do pedido.

subtotal

float

[pt] Valor total do pedido antes de descontos e taxas.

token

text

[pt] Token associado ao pedido.

total

float

[pt] Valor total do pedido após descontos e taxas.

total_usd

float

[pt] Valor total do pedido convertido para dólares americanos.

updated_at

timestamp

[pt] Data e hora da última atualização do pedido.

weight

float

[pt] Peso total do pedido.

nuvemshop_orders_customer_addresses

Campo Tipo

order_id

text

[pt] Identificador único do pedido.

customer_addresses_id

text

[pt] Identificador único de um dos endereços do cliente.

customer_id

text

[pt] Identificador único do cliente.

    Customers > > id

customer_addresses_address

text

[pt] Lista de endereços do cliente.

customer_addresses_city

text

[pt] Cidade associada a um dos endereços do cliente.

customer_addresses_country

text

[pt] País associado a um dos endereços do cliente.

customer_addresses_created_at

timestamp

[pt] Data e hora de criação de um dos endereços do cliente.

customer_addresses_default

boolean

[pt] Indica se este é o endereço principal do cliente (true/false).

customer_addresses_floor

text

[pt] Andar do endereço do cliente, se aplicável.

customer_addresses_locality

text

[pt] Bairro ou região de um dos endereços do cliente.

customer_addresses_name

text

[pt] Nome do endereço do cliente.

customer_addresses_number

float

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

customer_addresses_phone

text

[pt] Telefone do endereço do cliente.

customer_addresses_province

text

[pt] Estado ou província de um dos endereços do cliente.

customer_addresses_updated_at

timestamp

[pt] Data e hora de atualização de um dos endereços do cliente.

customer_addresses_zipcode

text

[pt] CEP do endereço do cliente.

nuvemshop_orders_customer_extra

Campo Tipo

order_id

text

[pt] Identificador único do pedido.

customer_id

text

[pt] Identificador único do cliente.

    Customers > > id

customer_extra_key

text

[pt] Chave do valor customizável de cliente.

customer_extra_value

text

[pt] Chave do valor customizável de cliente.

nuvemshop_orders_extra

Campo Tipo

order_id

text

[pt] Identificador único do pedido.

extra_key

text

[pt] Chave do valor customizável de cliente.

extra_value

text

[pt] Chave do valor customizável de cliente.

Orders: coupons

nuvemshop_orders_coupon

Campo Tipo

order_id

text

[pt] Identificador único do pedido.

    Orders > > id

coupon_id

text

[pt] Identificador único do cupom de desconto.

    Coupons > > id

coupon_code

text

[pt] Código do cupom utilizado na compra.

coupon_combines_with_other_discounts

boolean

[pt] Indica se o cupom pode ser combinado com outros descontos (true/false).

coupon_end_date

timestamp

[pt] Data e hora de término da validade do cupom.

coupon_first_consumer_purchase

boolean

[pt] Indica se o cupom é válido apenas para a primeira compra do cliente (true/false).

coupon_includes_shipping

boolean

[pt] Indica se o desconto do cupom inclui o valor do frete (true/false).

coupon_is_deleted

boolean

[pt] Indica se o cupom foi excluído (true/false).

coupon_max_uses

float

[pt] Quantidade máxima de usos permitidos para o cupom.

coupon_max_uses_per_client

float

[pt] Número máximo de vezes que um mesmo cliente pode usar o cupom.

coupon_min_price

float

[pt] Valor mínimo de compra necessário para utilizar o cupom.

coupon_start_date

timestamp

[pt] Data e hora de início da validade do cupom.

coupon_type

text

[pt] Tipo de desconto aplicado pelo cupom (exemplo: percentual, valor fixo).

coupon_used

float

[pt] Número de vezes que o cupom foi utilizado.

coupon_valid

text

[pt] Indica se o cupom ainda é válido (true/false).

coupon_value

float

[pt] Valor do desconto oferecido pelo cupom.

nuvemshop_orders_coupon_products

Campo Tipo

order_id

text

[pt] Identificador único do pedido.

    Orders > > id

coupon_products_coupon_id

text

[pt] Identificador único do cupom de desconto.

    Orders: coupons > > id

coupon_products_id

text

[pt] Identificador único do produto elegível para o cupom.

coupon_products_name_key

text

[pt] Nome do produto elegível para o cupom.

coupon_products_name_value

text

[pt] Nome do produto elegível para o cupom.

nuvemshop_orders_coupon_categories

Campo Tipo

order_id

text

[pt] Identificador único do pedido.

    Orders > > id

coupon_categories_coupon_id

text

[pt] Identificador único do cupom de desconto.

    Orders: coupons > > id

coupon_categories_id

text

[pt] Identificador único da categoria de produtos vinculada ao cupom.

coupon_categories_name_key

text

[pt] Nome da categoria de produtos vinculada ao cupom.

coupon_categories_name_value

text

[pt] Valor da categoria de produtos vinculada ao cupom.

coupon_categories_parent

float

[pt] Identificador da categoria principal à qual a categoria pertence (0 se não houver).

Orders: custom fields

Main object

Campo Tipo

id

text

[pt] Identificador único do pedido.

app_id

text

[pt] Identificador do aplicativo associado ao pedido.

billing_address

text

[pt] Endereço de cobrança.

billing_business_activity

text

[pt] Atividade empresarial associada ao faturamento.

billing_business_name

text

[pt] Nome empresarial para fins de faturamento.

billing_city

text

[pt] Cidade do endereço de cobrança.

billing_country

text

[pt] País do endereço de cobrança.

billing_customer_type

text

[pt] Tipo de cliente para fins de cobrança.

billing_document_type

text

[pt] Tipo de documento utilizado para faturamento.

billing_fiscal_regime

text

[pt] Regime fiscal da empresa para faturamento.

billing_floor

text

[pt] Andar do endereço de cobrança.

billing_invoice_use

text

[pt] Finalidade da fatura emitida.

billing_locality

text

[pt] Localidade do endereço de cobrança.

billing_name

text

[pt] Nome do titular da cobrança.

billing_number

text

[pt] Número do endereço de cobrança.

billing_phone

text

[pt] Telefone do titular da cobrança.

billing_province

text

[pt] Estado/Província do endereço de cobrança.

billing_state_registration

text

[pt] Registro estadual da empresa para faturamento.

billing_trade_name

text

[pt] Nome fantasia da empresa para faturamento.

billing_zipcode

text

[pt] Código postal do endereço de cobrança.

cancel_reason

text

[pt] Motivo do cancelamento do pedido, se aplicável.

cancelled_at

timestamp

[pt] Data e hora do cancelamento do pedido, se aplicável.

checkout_enabled

boolean

[pt] Indica se o checkout está habilitado para este pedido.

client_details_browser_ip

text

[pt] Endereço IP do cliente ao fazer o pedido.

client_details_user_agent

text

[pt] User agent do navegador do cliente ao fazer o pedido.

closed_at

timestamp

[pt] Data e hora de fechamento do pedido.

completed_at_date

timestamp

[pt] Data e hora de conclusão do pedido.

completed_at_timezone

text

[pt] Fuso horário da data de conclusão do pedido.

completed_at_timezone_type

float

[pt] Tipo de fuso horário associado à data de conclusão.

contact_email

text

[pt] E-mail de contato associado ao pedido.

contact_identification

text

[pt] Identificação do contato associado ao pedido.

contact_name

text

[pt] Nome do contato associado ao pedido.

contact_phone

text

[pt] Telefone do contato associado ao pedido.

created_at

timestamp

[pt] Data e hora de criação do pedido.

currency

text

[pt] Moeda utilizada no pedido.

customer_accepts_marketing

boolean

[pt] Indica se o cliente aceita receber marketing.

customer_accepts_marketing_updated_at

timestamp

[pt] Data e hora da última atualização da aceitação de marketing pelo cliente.

customer_active

boolean

[pt] Indica se o cliente está ativo no sistema.

customer_billing_address

text

[pt] Endereço de cobrança do pedido.

customer_billing_city

text

[pt] Cidade de cobrança do pedido.

customer_billing_country

text

[pt] País de cobrança do pedido.

customer_billing_floor

text

[pt] Piso de cobrança do pedido.

customer_billing_locality

text

[pt] Localidade de cobrança do pedido.

customer_billing_name

text

[pt] Nome de cobrança do pedido.

customer_billing_number

text

[pt] Número de cobrança do pedido.

customer_billing_phone

text

[pt] Telefone de cobrança do pedido.

customer_billing_province

text

[pt] Província de cobrança do pedido.

customer_billing_zipcode

text

[pt] CEP de cobrança do pedido.

customer_business_activity

text

[pt] Atividade empresarial do cliente, se aplicável.

customer_business_name

text

[pt] Nome da empresa do cliente, se aplicável.

customer_created_at

timestamp

[pt] Data e hora em que o cliente foi criado no sistema.

customer_customer_type

text

[pt] Tipo de cliente, como pessoa física ou jurídica.

customer_default_address_address

text

[pt] Endereço principal cadastrado pelo cliente.

customer_default_address_city

text

[pt] Cidade principal cadastrada pelo cliente.

customer_default_address_country

text

[pt] País principal cadastrado pelo cliente.

customer_default_address_created_at

timestamp

[pt] Data e hora de criação do endereço principal do cliente.

customer_default_address_default

boolean

[pt] Indica se este é o endereço principal do cliente (true/false).

customer_default_address_floor

text

[pt] Andar do endereço principal do cliente, se aplicável.

customer_default_address_id

text

[pt] Identificador único do endereço principal do cliente.

customer_default_address_locality

text

[pt] Bairro ou região do endereço principal do cliente.

customer_default_address_name

text

[pt] Nome associado ao endereço principal do cliente.

customer_default_address_number

text

[pt] Número do endereço principal do cliente.

customer_default_address_phone

text

[pt] Telefone do endereço principal do cliente.

customer_default_address_province

text

[pt] Província do endereço principal do cliente.

customer_default_address_updated_at

timestamp

[pt] Data e hora da última atualização do endereço principal do cliente.

customer_default_address_zipcode

text

[pt] Código postal (CEP) do endereço principal do cliente.

customer_document_type

text

[pt] Tipo de documento associado ao cliente.

customer_email

text

[pt] E-mail do cliente.

customer_first_interaction

timestamp

[pt] Data e hora da primeira interação do cliente com a loja.

customer_fiscal_regime

text

[pt] Regime fiscal do cliente, se aplicável.

customer_id

text

[pt] Identificador único do cliente.

    Customers > > id

customer_identification

text

[pt] Documento do cliente.

customer_invoice_use

text

[pt] Finalidade da fatura para o cliente.

customer_last_order_id

text

[pt] Identificador do último pedido feito pelo cliente.

customer_name

text

[pt] Nome completo do cliente.

customer_note

text

[pt] Nota deixada sobre o cliente.

customer_phone

text

[pt] Telefone do cliente.

customer_state_registration

text

[pt] Registro estadual do cliente, se aplicável.

customer_total_spent

float

[pt] Valor total gasto pelo cliente.

customer_total_spent_currency

text

[pt] Valor total gasto pelo cliente.

customer_trade_name

text

[pt] Nome fantasia da empresa do cliente, se aplicável.

customer_updated_at

timestamp

[pt] Data e hora da última atualização do cadastro do cliente.

customer_visit_created_at

timestamp

[pt] Data e hora da visita do cliente ao site.

customer_visit_landing_page

text

[pt] Página de destino da visita do cliente.

customer_visit_utm_parameters_utm_campaign

text

[pt] Campanha de marketing associada ao pedido.

customer_visit_utm_parameters_utm_content

text

[pt] Conteúdo de marketing associado ao pedido.

customer_visit_utm_parameters_utm_medium

text

[pt] Meio de marketing associado ao pedido.

customer_visit_utm_parameters_utm_source

text

[pt] Fonte do marketing associada ao pedido.

customer_visit_utm_parameters_utm_term

text

[pt] Termo de busca associado ao pedido.

discount

float

[pt] Valor total dos descontos aplicados.

discount_coupon

text

[pt] Desconto aplicado via cupom.

discount_gateway

float

[pt] Desconto aplicado via meio de pagamento.

free_shipping_config

text

[pt] Configuração de frete grátis aplicada ao pedido.

gateway

text

[pt] Nome do meio de pagamento utilizado.

gateway_id

text

[pt] Identificador do meio de pagamento.

gateway_link

text

[pt] Link de pagamento fornecido pelo gateway.

gateway_name

text

[pt] Nome do meio de pagamento.

has_shippable_products

boolean

[pt] Indica se há produtos enviáveis no pedido.

landing_url

text

[pt] URL de origem do cliente antes da compra.

language

text

[pt] Idioma utilizado no pedido.

next_action

text

[pt] Próxima ação esperada para este pedido.

note

text

[pt] Nota deixada sobre o pedido.

number

text

[pt] Número sequencial do pedido.

order_origin

text

[pt] Origem do pedido, como loja virtual ou API.

owner_note

text

[pt] Nota interna do lojista sobre o pedido.

paid_at

text

[pt] Data e hora em que o pedido foi pago.

payment_count

float

[pt] Número total de pagamentos registrados para este pedido.

payment_details_credit_card_company

text

[pt] Bandeira do cartão de crédito, se aplicável.

payment_details_installments

float

[pt] Número de parcelas no pagamento.

payment_details_method

text

[pt] Método de pagamento utilizado.

payment_status

text

[pt] Status atual do pagamento do pedido.

promotional_discount_created_at

timestamp

[pt] Data e hora em que o desconto promocional foi aplicado.

promotional_discount_id

text

[pt] Identificador único do desconto promocional aplicado ao pedido.

promotional_discount_order_id

text

[pt] Identificador do pedido ao qual o desconto foi aplicado.

promotional_discount_store_id

text

[pt] Identificador da loja onde o desconto promocional foi aplicado.

promotional_discount_total_discount_amount

float

[pt] Valor total do desconto promocional aplicado ao pedido.

read_at

timestamp

[pt] Data e hora em que o pedido foi lido pelo sistema.

same_billing_and_shipping_address

boolean

[pt] Indica se os endereços de cobrança e entrega são os mesmos.

shipped_at

timestamp

[pt] Data e hora em que o pedido foi enviado.

shipping

text

[pt] Método de envio utilizado.

shipping_address_address

text

[pt] Endereço de entrega do pedido.

shipping_address_city

text

[pt] Cidade do endereço de entrega.

shipping_address_country

text

[pt] País do endereço de entrega.

shipping_address_created_at

timestamp

[pt] Data e hora da criação do endereço de entrega.

shipping_address_default

boolean

[pt] Indica se este é o endereço de entrega padrão.

shipping_address_floor

text

[pt] Andar do endereço de entrega.

shipping_address_id

text

[pt] Identificador único do endereço de entrega.

shipping_address_locality

text

[pt] Bairro ou região do endereço de entrega.

shipping_address_name

text

[pt] Nome associado ao endereço de entrega.

shipping_address_number

text

[pt] Número do endereço de entrega.

shipping_address_phone

text

[pt] Telefone associado ao endereço de entrega.

shipping_address_province

text

[pt] Estado/Província do endereço de entrega.

shipping_address_updated_at

timestamp

[pt] Data e hora da última atualização do endereço de entrega.

shipping_address_zipcode

text

[pt] Código postal do endereço de entrega.

shipping_carrier_name

text

[pt] Nome da transportadora responsável pelo envio.

shipping_cost_customer

float

[pt] Custo de envio pago pelo cliente.

shipping_cost_owner

float

[pt] Custo de envio pago pelo lojista.

shipping_max_days

float

[pt] Número máximo de dias estimados para entrega.

shipping_min_days

float

[pt] Número mínimo de dias estimados para entrega.

shipping_option

text

[pt] Opção de envio escolhida pelo cliente.

shipping_option_code

text

[pt] Código da opção de envio escolhida.

shipping_option_reference

text

[pt] Referência da opção de envio escolhida para o pedido.

shipping_pickup_details

text

[pt] Detalhes sobre a retirada do pedido pelo cliente.

shipping_pickup_type

text

[pt] Tipo de retirada do pedido, como 'pickup'.

shipping_status

text

[pt] Status do envio do pedido.

shipping_store_branch_extra

text

[pt] Informações adicionais sobre a filial da loja onde o pedido será retirado.

shipping_store_branch_name

text

[pt] Nome da filial da loja onde o pedido será retirado.

shipping_tracking_number

text

[pt] Número de rastreamento do pedido.

shipping_tracking_url

text

[pt] URL para rastreamento do pedido.

status

text

[pt] Status atual do pedido.

store_id

text

[pt] Identificador único da loja onde o pedido foi feito.

storefront

text

[pt] Origem do pedido.

subtotal

float

[pt] Valor total do pedido antes de descontos e taxas.

token

text

[pt] Token associado ao pedido.

total

float

[pt] Valor total do pedido após descontos e taxas.

total_usd

float

[pt] Valor total do pedido convertido para dólares americanos.

updated_at

timestamp

[pt] Data e hora da última atualização do pedido.

weight

float

[pt] Peso total do pedido.

campo_personalizado_x

text

campo_personalizado_y

text

campo_personalizado_z

text

nuvemshop_orders_customer_addresses_cf

Campo Tipo

order_id

text

[pt] Identificador único do pedido.

customer_addresses_id

text

[pt] Identificador único de um dos endereços do cliente.

customer_id

text

[pt] Identificador único do cliente.

    Customers > > id

customer_addresses_address

text

[pt] Lista de endereços do cliente.

customer_addresses_city

text

[pt] Cidade associada a um dos endereços do cliente.

customer_addresses_country

text

[pt] País associado a um dos endereços do cliente.

customer_addresses_created_at

timestamp

[pt] Data e hora de criação de um dos endereços do cliente.

customer_addresses_default

boolean

[pt] Indica se este é o endereço principal do cliente (true/false).

customer_addresses_floor

text

[pt] Andar do endereço do cliente, se aplicável.

customer_addresses_locality

text

[pt] Bairro ou região de um dos endereços do cliente.

customer_addresses_name

text

[pt] Nome do endereço do cliente.

customer_addresses_number

float

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

customer_addresses_phone

text

[pt] Telefone do endereço do cliente.

customer_addresses_province

text

[pt] Estado ou província de um dos endereços do cliente.

customer_addresses_updated_at

timestamp

[pt] Data e hora de atualização de um dos endereços do cliente.

customer_addresses_zipcode

text

[pt] CEP do endereço do cliente.

nuvemshop_orders_customer_extra_cf

Campo Tipo

order_id

text

[pt] Identificador único do pedido.

customer_id

text

[pt] Identificador único do cliente.

    Customers > > id

customer_extra_key

text

[pt] Chave do valor customizável de cliente.

customer_extra_value

text

[pt] Chave do valor customizável de cliente.

nuvemshop_orders_extra_cf

Campo Tipo

order_id

text

[pt] Identificador único do pedido.

extra_key

text

[pt] Chave do valor customizável de cliente.

extra_value

text

[pt] Chave do valor customizável de cliente.

Orders: fulfillment events

Campo Tipo

order_id

text

[pt] Identificador único do evento de entrega.

    Orders > > id

event_id

text

[pt] Identificador único do pedido.

    Orders > > id

city

text

[pt] Cidade onde o evento de entrega ocorreu.

country

text

[pt] Código do país onde o evento de entrega ocorreu (formato ISO).

created_at

timestamp

[pt] Data e hora em que o evento foi registrado no sistema.

description

text

[pt] Descrição detalhada do evento ocorrido durante o processo de entrega.

estimated_delivery_at

timestamp

[pt] Data e hora estimada para a entrega no momento do evento.

happened_at

timestamp

[pt] Data e hora em que o evento de entrega efetivamente ocorreu.

province

text

[pt] Estado ou província onde o evento de entrega ocorreu.

status

text

[pt] Status do evento de entrega, como 'delivered', 'shipped', etc.

updated_at

timestamp

[pt] Data e hora da última atualização do evento.

Orders: fulfillments

Campo Tipo

order_id

text

[pt] Identificador único do pedido.

    Orders > > id

fulfillments_id

text

[pt] Identificador do processamento logístico.

    Orders: fulfillment events > > event_id

fulfillments_assigned_location_location_id

text

[pt] Identificador do local de processamento logístico.

    Warehouses > > id

fulfillments_assigned_location_name

text

[pt] Nome do local de processamento logístico.

fulfillments_number

float

[pt] Número de processamentos.

fulfillments_shipping_carrier_name

text

[pt] Nome da transportadora responsável pelo envio.

fulfillments_shipping_extras_shippable

boolean

[pt] Indica se o pedido pode ser enviado.

fulfillments_shipping_option_name

text

[pt] Nome da opção de envio escolhida.

fulfillments_shipping_type

text

[pt] Tipo de envio logístico.

fulfillments_status

text

[pt] Status do processamento logístico.

fulfillments_tracking_info_code

text

[pt] Código de rastreamento do envio.

Orders: products

nuvemshop_orders_products

Campo Tipo

order_id

text

[pt] Identificador único do pedido.

    Orders > > id

product_id

text

[pt] Identificador único do produto no pedido.

    Products > > id

products_barcode

text

[pt] Código de barras do produto.

products_compare_at_price

float

[pt] Preço original do produto antes de descontos.

products_cost

float

[pt] Custo do produto para a loja.

products_depth

float

[pt] Profundidade do produto em centímetros.

products_free_shipping

boolean

[pt] Indica se o produto tem frete grátis.

products_height

float

[pt] Altura do produto em centímetros.

products_image_created_at

timestamp

[pt] Data e hora de criação da imagem.

products_image_alt

text

[pt] Data e hora de criação da imagem.

products_image_height

float

[pt] Altura da imagem em pixels.

products_image_id

text

[pt] Identificador único da imagem do produto.

products_image_position

float

[pt] Posição da imagem na galeria do produto.

products_image_product_id

text

[pt] Identificador do produto associado à imagem.

    Orders: products > > id

products_image_src

text

[pt] URL da imagem do produto.

products_image_thumbnails_generated

float

[pt] Indica se miniaturas foram geradas para a imagem.

products_image_updated_at

timestamp

[pt] Data e hora da última atualização da imagem.

products_image_width

float

[pt] Largura da imagem em pixels.

products_name

text

[pt] Nome do produto conforme cadastrado na loja.

products_name_without_variants

text

[pt] Nome do produto sem considerar variações.

products_price

float

[pt] Preço unitário do produto no pedido.

products_quantity

float

[pt] Quantidade do produto no pedido.

products_sku

text

[pt] Código SKU do produto.

products_variant_id

text

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

    Products: variants > > product_variant_id

products_variant_values

text

[pt] Lista de valores personalizados das variações do produto.

products_weight

float

[pt] Peso do produto em quilogramas.

products_width

float

[pt] Largura do produto em centímetros.

nuvemshop_orders_products_properties

Campo Tipo

order_id

text

[pt] Identificador único do pedido.

    Orders > > id

product_id

text

[pt] Identificador único do produto no pedido.

    Orders: products > > id

products_properties_key

text

[pt] Chave da propriedade do produto.

products_properties_value

text

[pt] Valor da propriedade do produto.

Orders: promotion applied

Campo Tipo

order_id

text

[pt] Identificador único do pedido.

    Orders > > id

promotional_discount_applied_scope_value_id

text

[pt] Identificador do escopo ao qual o desconto se aplica.

promotional_discount_applied_discount_script_type

text

[pt] Tipo de script de desconto aplicado na promoção.

promotional_discount_applied_scope_value_name

text

[pt] Nome do escopo da promoção aplicada.

promotional_discount_applied_selected_threshold_decimal

float

[pt] Percentual do desconto aplicado com base no critério mínimo de ativação.

promotional_discount_applied_selected_threshold_quantity

float

[pt] Quantidade mínima exigida para ativar o desconto da promoção.

promotional_discount_applied_total_discount_amount

float

[pt] Valor total do desconto aplicado na promoção.

promotional_discount_applied_total_discount_amount_long

text

[pt] Valor do desconto formatado em moeda local (extenso).

promotional_discount_applied_total_discount_amount_short

text

[pt] Valor do desconto formatado em moeda local (curto).

promotional_discount_applied_total_discount_amoun

float

[pt] Valor do desconto convertido para centavos.

Orders: promotion discount contents

Campo Tipo

order_id

text

[pt] Identificador único do pedido.

    Orders > > id

id

text

[pt] Identificador único do item no desconto promocional.

promotional_discount_contents_begin_date

timestamp

[pt] Data de início da validade do desconto.

promotional_discount_contents_buy

float

[pt] Quantidade mínima de itens necessária para ativar o desconto.

promotional_discount_contents_discount_amount

float

[pt] Valor do desconto aplicado ao item.

promotional_discount_contents_discount_script_type

text

[pt] Tipo de script de desconto aplicado (exemplo: percentual, valor fixo).

promotional_discount_contents_end_date

timestamp

[pt] Data de término da validade do desconto.

promotional_discount_contents_final_price

float

[pt] Preço final do item após o desconto.

promotional_discount_contents_original_price

float

[pt] Preço original do item antes do desconto.

promotional_discount_contents_pay

float

[pt] Quantidade de itens pelo qual o cliente realmente paga ao ativar o desconto.

promotional_discount_contents_quantity

float

[pt] Quantidade de itens que receberam o desconto.

promotional_discount_contents_scope_type

text

[pt] Tipo de escopo do desconto aplicado (exemplo: todos os produtos, categorias específicas).

promotional_discount_contents_scope_value_id

text

[pt] Identificador do escopo ao qual o desconto se aplica.

promotional_discount_contents_scope_value_name

text

[pt] Nome do escopo ao qual o desconto se aplica.

promotional_discount_contents_total_discount_amount

float

[pt] Valor total do desconto aplicado ao item.

Products

Main object

Campo Tipo

id

text

[pt] Identificador único do produto.

brand

text

[pt] Marca do produto.

created_at

timestamp

[pt] Data e hora de criação do produto.

description

text

free_shipping

boolean

[pt] Indica se o produto possui frete grátis.

handle

text

name

text

published

boolean

[pt] Indica se o produto está publicado na loja.

seo_description

text

[pt] Descrição otimizada para SEO do produto.

seo_title

text

[pt] Título otimizado para SEO do produto.

tags

text

[pt] Lista de tags associadas ao produto.

updated_at

timestamp

[pt] Data e hora da última atualização do produto.

video_url

text

[pt] URL de um vídeo associado ao produto.

nuvemshop_products_categories

Campo Tipo

product_id

text

[pt] Identificador único do produto.

categories_created_at

timestamp

[pt] Data e hora de criação da categoria.

categories_description

text

[pt] Descrição da categoria em português.

categories_google_shopping_category

text

[pt] Nome da categoria conforme o Google Shopping.

categories_handle

text

[pt] Identificador da categoria em português.

categories_id

text

[pt] Identificador único da categoria.

    Categories > > id

categories_name

text

categories_parent

float

[pt] ID da categoria pai, caso seja uma subcategoria.

categories_subcategories

text

[pt] Lista de IDs de subcategorias associadas à categoria.

categories_updated_at

timestamp

[pt] Data e hora da última atualização da categoria.

Products: custom fields

Main object

Campo Tipo

id

text

[pt] Identificador único do produto.

brand

text

[pt] Marca do produto.

created_at

timestamp

[pt] Data e hora de criação do produto.

description

text

free_shipping

boolean

[pt] Indica se o produto possui frete grátis.

handle

text

name

text

published

boolean

[pt] Indica se o produto está publicado na loja.

seo_description

text

[pt] Descrição otimizada para SEO do produto.

seo_title

text

[pt] Título otimizado para SEO do produto.

tags

text

[pt] Lista de tags associadas ao produto.

updated_at

timestamp

[pt] Data e hora da última atualização do produto.

video_url

text

[pt] URL de um vídeo associado ao produto.

campo_personalizado_x

text

campo_personalizado_y

text

campo_personalizado_z

text

nuvemshop_products_categories_cf

Campo Tipo

product_id

text

[pt] Identificador único do produto.

categories_created_at

timestamp

[pt] Data e hora de criação da categoria.

categories_description

text

[pt] Descrição da categoria em português.

categories_google_shopping_category

text

[pt] Nome da categoria conforme o Google Shopping.

categories_handle

text

[pt] Identificador da categoria em português.

categories_id

text

[pt] Identificador único da categoria.

    Categories > > id

categories_name

text

categories_parent

float

[pt] ID da categoria pai, caso seja uma subcategoria.

categories_subcategories

text

[pt] Lista de IDs de subcategorias associadas à categoria.

categories_updated_at

timestamp

[pt] Data e hora da última atualização da categoria.

Products: variants

Main object

Campo Tipo

product_id

text

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

    Products > > id

product_variant_id

text

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

    Warehouses: inventory > > variant_id

product_variant_values

text

[pt] Lista de propriedades associadas à variação do produto, como cor ou tamanho.

age_group

text

[pt] Grupo etário recomendado para o produto (exemplo: newborn, toddler, adult).

barcode

text

[pt] Código de barras (EAN, UPC) associado à variação do produto.

compare_at_price

float

[pt] Preço original do produto antes de descontos ou promoções.

cost

float

[pt] Custo unitário da variação do produto para o lojista.

created_at

timestamp

[pt] Data e hora em que a variação do produto foi criada.

depth

float

[pt] Profundidade da variação do produto, em centímetros.

gender

text

[pt] Gênero associado à variação do produto (exemplo: male, female, unisex).

height

float

[pt] Altura da variação do produto, em centímetros.

image_id

text

[pt] Identificador da imagem associada à variação do produto.

mpn

text

[pt] Número de peça do fabricante (MPN) para identificação única da variação do produto.

position

float

[pt] Posição da variação na listagem de variações do produto.

price

float

[pt] Preço atual da variação do produto.

promotional_price

float

[pt] Preço promocional da variação do produto.

sku

text

[pt] Código SKU (Stock Keeping Unit) da variação do produto, usado para controle de estoque.

stock

float

[pt] Quantidade disponível em estoque para esta variação do produto.

stock_management

boolean

[pt] Indica se o gerenciamento de estoque está ativado para esta variação.

updated_at

timestamp

[pt] Data e hora da última atualização da variação do produto.

visible

boolean

[pt] Indica se a variação do produto está visível para os clientes na loja.

weight

float

[pt] Peso da variação do produto, em quilogramas.

width

float

[pt] Largura da variação do produto, em centímetros.

nuvemshop_product_variants_inventory_levels

Campo Tipo

product_id

text

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

    Products > > id

product_variant_id

text

[pt] Identificador único do produto.

    Warehouses: inventory > > variant_id

inventory_levels_id

text

[pt] Identificador único do nível de estoque.

inventory_levels_location_id

text

[pt] Identificador do local onde o estoque desta variação está armazenado.

inventory_levels_stock

float

[pt] Quantidade disponível da variação do produto neste local de estoque.

inventory_levels_variant_id

text

[pt] Identificador da variação do produto associada a este nível de estoque.

Products: variants: custom fields

Main object

Campo Tipo

product_id

text

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

    Products > > id

product_variant_id

text

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

    Warehouses: inventory > > variant_id

product_variant_values

text

[pt] Lista de propriedades associadas à variação do produto, como cor ou tamanho.

age_group

text

[pt] Grupo etário recomendado para o produto (exemplo: newborn, toddler, adult).

barcode

text

[pt] Código de barras (EAN, UPC) associado à variação do produto.

compare_at_price

float

[pt] Preço original do produto antes de descontos ou promoções.

cost

float

[pt] Custo unitário da variação do produto para o lojista.

created_at

timestamp

[pt] Data e hora em que a variação do produto foi criada.

depth

float

[pt] Profundidade da variação do produto, em centímetros.

gender

text

[pt] Gênero associado à variação do produto (exemplo: male, female, unisex).

height

float

[pt] Altura da variação do produto, em centímetros.

image_id

text

[pt] Identificador da imagem associada à variação do produto.

mpn

text

[pt] Número de peça do fabricante (MPN) para identificação única da variação do produto.

position

float

[pt] Posição da variação na listagem de variações do produto.

price

float

[pt] Preço atual da variação do produto.

promotional_price

float

[pt] Preço promocional da variação do produto.

sku

text

[pt] Código SKU (Stock Keeping Unit) da variação do produto, usado para controle de estoque.

stock

float

[pt] Quantidade disponível em estoque para esta variação do produto.

stock_management

boolean

[pt] Indica se o gerenciamento de estoque está ativado para esta variação.

updated_at

timestamp

[pt] Data e hora da última atualização da variação do produto.

visible

boolean

[pt] Indica se a variação do produto está visível para os clientes na loja.

weight

float

[pt] Peso da variação do produto, em quilogramas.

width

float

[pt] Largura da variação do produto, em centímetros.

campo_personalizado_x

text

campo_personalizado_y

text

campo_personalizado_z

text

nuvemshop_product_variants_inventory_levels_cf

Campo Tipo

product_id

text

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

    Products > > id

product_variant_id

text

[pt] Identificador único do produto.

    Warehouses: inventory > > variant_id

inventory_levels_id

text

[pt] Identificador único do nível de estoque.

inventory_levels_location_id

text

[pt] Identificador do local onde o estoque desta variação está armazenado.

inventory_levels_stock

float

[pt] Quantidade disponível da variação do produto neste local de estoque.

inventory_levels_variant_id

text

[pt] Identificador da variação do produto associada a este nível de estoque.

Shipping carriers

Main object

Campo Tipo

id

text

[pt] Identificador único do transportador personalizado.

active

boolean

[pt] Indica se o transportador está ativo e disponível no checkout.

callback_url

text

[pt] URL de callback para onde a loja enviará a requisição de cálculo de frete.

created_at

timestamp

[pt] Data e hora de criação do transportador personalizado.

name

text

[pt] Nome da empresa de transporte personalizada exibida para o cliente no checkout.

types

text

[pt] Modos de entrega oferecidos pelo transportador. Pode incluir 'ship' (entrega) e/ou 'pickup' (retirada).

updated_at

timestamp

[pt] Data e hora da última atualização do transportador personalizado.

nuvemshop_shipping_carriers_options

Campo Tipo

shipping_carrier_id

text

[pt] Identificador único do transportador personalizado.

options_id

text

[pt] Identificador único da opção de frete da transportadora personalizada.

options_active

boolean

[pt] Indica se a opção de frete está ativa e disponível para seleção no checkout.

options_additional_cost

float

[pt] Valor adicional ao custo do frete calculado para essa opção de entrega.

options_additional_days

float

[pt] Número de dias adicionais ao prazo de entrega estimado pela transportadora.

options_allow_free_shipping

boolean

[pt] Indica se essa opção permite frete grátis em promoções ou regras da loja.

options_code

text

[pt] Código interno único que identifica essa opção de frete na integração.

options_created_at

timestamp

[pt] Data e hora em que a opção de frete foi criada.

options_name

text

[pt] Nome da opção de frete exibida para o cliente no checkout.

options_updated_at

timestamp

[pt] Data e hora da última atualização da opção de frete.

Warehouses

Campo Tipo

id

text

[pt] Identificador único do centro de distribuição.

address_between_streets

text

address_city

text

address_country_code

text

address_country_name

text

address_floor

text

address_locality

text

address_number

float

address_province_code

text

address_province_name

text

address_reference

text

address_region_code

text

address_region_name

text

address_street

text

address_verified_at

timestamp

address_zipcode

float

created_at

timestamp

[pt] Data e hora em que o centro de distribuição foi criado.

is_default

boolean

[pt] Indica se este é o centro de distribuição padrão da loja.

name

text

priority

float

[pt] Prioridade de uso do centro de distribuição. Quanto menor o número, maior a prioridade.

store_id

text

[pt] Identificador da loja associada ao centro de distribuição.

tags

text

[pt] Lista de tags associadas ao centro de distribuição, usada para classificação ou filtragem (pode ser nulo).

updated_at

timestamp

[pt] Data e hora da última atualização do centro de distribuição.

Warehouses: inventory

Campo Tipo

id

text

[pt] Identificador único do registro do nível de estoque.

location_id

text

[pt] Identificador do centro de distribuição onde o estoque está localizado.

stock

float

[pt] Quantidade disponível da variante no centro de distribuição. Pode ser nulo se o estoque não estiver definido.

variant_id

text

[pt] Identificador da variante do produto associada ao nível de estoque.

Notes

Field Descriptions

Due to the absence of descriptions for certain fields in the API documentation, some descriptions were generated using artificial intelligence based on examples of returned values