Objetos são variáveis determinadas pela plataforma. E cada objeto tem diferentes atributos que são separados por um ponto. Podemos chamar esses objetos de duas maneiras:
{% ... %} y {{ ... }}. O primeiro é usado para executar sentenças como loops (for) e a segunda gera o resultado da expressão (entendendo expressão como o grupo de objeto mais atributo, por exemplo: store.nome).
store
Este objeto representa a loja e é geralmente utilizado em combinação com outros objetos. Você pode usá-lo de duas maneiras: apenas para mostrar as informações ou para perguntar algo.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
store.name | string | n/a | É o nome da loja. |
store.url | string | n/a | É a URL da loja. |
store.logo | string | n/a | É a URL do logo da loja. |
store.address | string | n/a | É o endereço físico da loja. |
store.phone | string | n/a | É o teléfone da loja. |
store.email | string | n/a | É o e-mail da loja. |
store.blog | string | n/a | É a URL do blog da loja. |
store.twitter | string | n/a | É a URL do perfil de Twitter da loja. |
store.twitter_user | string | n/a | É o usuário da loja no Twitter. |
store.facebook | string | n/a | É a URL da página de Facebook da loja. |
store.instagram | string | n/a | É a URL do perfil de Instagram da loja. |
store.whatsapp | É o Whatsapp da loja. | ||
store.contact_intro | string | false | É informação extra para exibir dentro da página de contato da loja. |
store.country | string | n/a | É o código ISO 3166-1 do país da loja (AR = Argentina, BR = Brasil, MX = México, etc.). |
store.currency | string | n/a | É o código ISO 4217 da moeda da loja (ARS = Pesos Argentinos, BRL = Reais, MXN = Pesos Mexicanos, etc.). |
store.live_chat | string | n/a | É o código de integração do serviço de chat online da loja. |
store.business_id | string | n/a | É o identificador da empresa que opera a loja (isso depende do páis) (disponível unicamente no Brasil únicamente e Brasil). |
store.business_name | string | n/a | É o nome da empresa que opera a loja (disponível somente no Brasil). |
afip | string | n/a | Formulario Nº 960/NM – Dados fiscais da AFIP (Únicamente disponível na Argentina). |
store.analytics_account | string | n/a | É a conta de Google Analytics da loja. |
store.domain | string | n/a | É o domínio atribuído à loja no momento do registro na Nuvemshop. (dominio.lojavirtualnuvem.com) |
store.has_custom_domain | boolean | false | É true se a loja tem domínio próprio. False em o caso oposto. |
store.has_accounts | boolean | true | Isso é true se a loja tem suporte para contas de usuários. |
store.is_catalog | boolean | false | É true se a loja é um catálogo e não suporta compras. False em o caso oposto. |
store.products_url | string | n/a | É a URL que aponta a página onde são exibido todos os produtos. |
store.cart_url | string | n/a | É a URL que aponta a página do carrinho de compras. |
store.contact_url | string | n/a | É a URL que aponta a página de contato. |
store.search_url | string | n/a | É a URL que aponta página de Es la URL que apunta a la página de pesquisa. |
store.has_shipping | boolean | false | É true se a loja tem meios de envio ativados. False em o caso oposto. |
store.branches | boolean | false | É true se a loja tem loja física. False em o caso oposto |
store.shipping_calculator_url | string | n/a | É a URL que aponta a página de cálculos de frete. É utilizada pelo Javascript do snipplet do calculador de frete. |
store.checkout_url | string | n/a | É a URL que aponta a página do checkout da loja. |
store.customer_home_url | string | n/a | É a URL que aponta a página de inicio. |
store.customer_register_url | string | n/a | É a URL que aponta a página para criar uma conta na loja. |
store.customer_login_url | string | n/a | É a URL que aponta a página de login da loja. |
store.customer_logout_url | string | n/a | É a URL que aponta a página de logout para os clientes da loja. |
store.customer_reset_password_url | string | n/a | É a URL que aponta a página para recuperar a senha de uma conta criada na loja. |
store.customer_order_url | string | n/a | É a URL que aponta a página de pedidos gerados pelos clientes da loja. |
store.customer_info_url | string | n/a | É a URL que aponta a página de editar informação pessoal de cada cliente da loja. |
store.customer_addresses_url | string | n/a | É a URL que aponta a página de endereços criados pelos clientes. |
store.customer_address_url | string | n/a | É a URL que aponta a página de endereço do cliente na loja. |
store.customer_new_address_url | string | n/a | É a URL que aponta a página onde o cliente pode adicionar um novo endereço na sua conta. |
store.customer_main_address_url | string | n/a | É a URL que aponta a página onde o cliente pode escolher um endereço como principal. |
store.customer_accounts | boolean | optional | 'optional' se os clientes podem fazer uma compra sem ficar registrados na loja. 'mandatory' se é obrigatório ficar registrados para fazer uma compra. |
Você pode combinar vários filtros para obter um código mais complexo:
{{ store.logo | img_tag | a_tag(store.url) }}
Para ter mais informação sobre os métodos que pode utilizar, recomendamos ler este artigo.
O exemplo anterior combina o objeto logo com filtros para exibir o seguinte código:
<a href="http://yourstore.com" title=""><img src="//your-store-logo.png" alt="yourstore-name" title="yourstore-name"></a>
Também pode ser utilizado para exibir conteúdo com base a uma condição:
{% if store.has_accounts %} <div class="accounts-div"></div> {% endif %}
Outros exemplos deste objeto e como pode ser utilizado:
Para verificar se a loja foi criada no Brasil.
{% if store.country == 'BR' %} <div class="br-only-div"></div> {% endif %}
Para verificar se a loja utiliza login e suscrição.
{% if store.has_accounts %} <div class="accounts-div"></div> {% endif %}
Para verificar se a loja tem um domínio próprio.
{% if store.has_custom_domain %} {% endif %}
Para verificar se a loja é só um catálogo.
{% if store.is_catalog %} <div class="catalog-only-div"></div> {% endif %}
Para verificar se a loja tem Facebook configurado. Também aplica para: store.google_plus, store.pinterest, store.instagram
{% if store.facebook %} <div class="facebook-div"></div> {% endif %}
Para verificar se a loja tem um chat online configurado.
{% if store.live_chat %} <div class="chat-div"></div> {% endif %}
Para verificar se na loja usuários sem uma conta criada podem comprar.
{% if store.customer_accounts %} <div class="customer-accounts-div"></div> {% endif %}
section
Este objeto representa uma seção do design da loja definida no sections.txt.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
section.id | string | n/a | Código da seção. |
section.name | string | n/a | Nome da seção. |
section.description | string | n/a | Descrição da seção. |
section.products | array | n/a | Array de objetos Product que representa aos produtos que ficam na seção. |
settings
Este objeto representa as configurações do design da loja.
Os atributos destes objetos são definidos no settings.txt
Por exemplo, se no settings são definidos os seguintes objetos:
checkbox name = banner_show description = Mostrar banner i18n_input name = banner_title description = Título
Logo são utilizados da seguinte maneira:
{% if setttings.banner_show %} {{ setttings.banner_title }} {% endif %}
language
Este objeto representa um das linguagens habilitados na loja.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
language.id | string | n/a | Código ISO 639-1 da linguagem e Código ISO 3166-1 do país (Ejemplo: es_AR). |
language.code | string | n/a | Código ISO 639-1 da linguagem seguido por um hífen baixo e seu código ISO 3166-1 do país (Exemplo: es_AR para el Espanhol da Argentina, pt_BR para o Português do Brasil, etc.). |
language.name | string | n/a | Nome da linguagem. |
language.active | boolean | false | true se é a linguagem ativo na loja. false em outro caso. |
language.country | string | n/a | Código ISO 3166-1 do país. |
navigation
navigation_item
Este objeto representa ao item da navegação da loja.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
item.name | string | n/a | Nome do item. |
item.url | string | n/a | URL do item. |
item.subitems | array | n/a | Array de Navigation_Item que representa aos subitems aninhados ao item de navegação. |
item.current | boolean | false | true se a página atual é a mesma a qual faz referência do item de navegação. |
breadcrumb
Este objeto representa ao breadcrumb que descreve o caminho de como a página atual foi atingida.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
breadcrumb.name | string | n/a | Nome do breadcrumb. |
breadcrumb.url | string | n/a | URL do breadcrumb. |
breadcrumb.last | boolean | false | true si es el último breadcrumb. false en otro caso. |
É utilizado no snipplet breadcrumbs.tpl
category
Este objeto representa uma categoria da loja.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
category.id | string | n/a | Id da categoria. |
category.name | string | n/a | Nome da categoria. |
category.description | string | n/a | Descrição da categoria. |
category.url | string | URL da categoria. | |
category.parent | object | n/a | Objeto Category correspondente a categoria pai. |
category.subcategories | array | n/a | Array de objetos Category que contém as subcategorias desta categoria. |
category.images | array | n/a | Array de objetos Category_Image que contém a imagem da categoria. |
category.featured_image (descontinuado) | object | n/a | Imagem de um produto da categoria. |
category.active | boolean | false | true se a URL atual e a URL da categoría. false em o caso oposto. |
category.top | object | n/a | Objeto Category que representa a primeira categoria da sua hierarquia. |
category.products | array | n/a | Array de objetos Product com os produtos los productos pertenecentes a esta categoria. |
category.products_count | string | n/a | Quantidade de produtos pertenecentes a esta categoria. |
category.seo_title | string | n/a | Título para SEO. |
category.seo_description | string | n/a | Descrição para SEO. |
category.handle | string | n/a | URL da categoria. |
Pages / Pagination
Este objeto representa a página atual de uma categoría/pesquisa na loja.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
pages.previous | string | n/a | URL da página anterior |
pages.next | string | n/a | URL da seguinte página. |
pages.current | string | n/a | Número da página atual. |
pages.amount | string | n/a | Quantidade de páginas da categoría/pesquisa. |
pages.numbers | array | n/a | Array com todas as páginas. Para cada página contém os objetos embaixo |
pages.numbers contém os seguintes objetos:
Objeto | Tipo | Default | Descrição |
---|---|---|---|
pages.number | string | n/a | Número desta página |
pages.url | string | n/a | URL desta página |
pages.selected | boolean | false | true se é página atual. false em o caso oposto. |
product
Este objeto representa a um produto da loja.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
product.brand | string | n/a | Nome da marca do produto. |
product.name | string | n/a | Nome do producto. |
product.price | string | n/a | Preço do produto del producto em centavos (que dizer, se o preço é R$100, o valor de price é 10000). Se compare_at_price fica defnido, price representa o preço promocional do produto. |
product.compare_at_price | string | n/a | O preço original que tinha o produto em centavos (que dizer, se o preço é R$100 o valor de compare_at_price é 10000) se é que existe. false em o caso oposto. |
product.display_price | boolean | true | true se o produto tem um preço para exibir. false em outro caso. |
product.min_price | string | n/a | O preço mínimo de todas as Product_Variant do produto, em centavos (que dizer que, se o preço é R$100 o valor de min_price é 10000). null se nenhuma variante tem preço. |
product.max_price | string | n/a | El preço máximo de todas as Product_Variant do produto, em centavos (que dizer, se o preço é R$100 o valor de max_price é 10000). null se nenhuma variante tem preço. |
product.canonical_url | string | n/a | URL canônica do produto. |
product.social_url | string | n/a | URL social do produto (é utilizada para compartilhar no Facebook, Twitter, G+, Pinterest, etc.). |
product.description | string | n/a | Descrição do produto. |
product.stock_control | boolean | false | true se o estoque do produto fica controlado pela Nuvemshop. false em outro caso. |
product.stock | string | n/a | Estoque do produto. |
product.weight | string | n/a | Peso do produto. |
product.weight_unit | string | n/a | Unidade de medida do peso. Por agora, o valor sempre é KG. |
product.sku | string | n/a | SKU do produto. |
product.tags | array | n/a | Array que contém os tags do produto. |
product.currency | string | n/a | Código ISO 4217 da moeda na qual é exibido o preço do produto (ARS = Pesos Argentinos, BRL = Reais, etc, MXN - Pesos Mexicanos.). |
product.images | array | n/a | Array de objetos Product_Image que contém as imagens do produto. |
product.images_count | string | n/a | Quantidade de imagens do produto. |
product.featured_image | object | n/a | Objeto Product_Image con la imagen principal del producto. |
product.default_options | array | n/a | Array que contém os nomes das três opções da variante default. |
product.variations | array | n/a | Array de objetos Variation que contém as propriedades do produto. |
product.other_images | array | n/a | Array de objetos Product_Image que contém as imagens secundárias do produto (que dizer, todas exceto a primeira). |
product.installments | string | n/a | Quantidade de parcelas máximas com as quais o produto pode ser pagado. (Só disponível no Brasil) |
product.category | object | n/a | Objeto Category que representa uma das categorias próximas do produto (que dizer, se o produto pertence a categoria Roupas > Vestidos product.category retorna a categoria Vestidos. |
product.variants_object | array | n/a | Array de objetos com todas as variantes. |
product.seo_title | string | n/a | Título para SEO. |
product.seo_description | string | n/a | Descrição para SEO. |
product.handle | string | n/a | URL do produto. |
product.promotional_offer | boolean | false | true se a loja tem promoções ativadas. false em o caso oposto. |
product.promotional_offer.script.is_percentage_off | boolean | false | true se a loja tem promoções percentuais ativadas. false em o caso oposto. |
product.promotional_offer.parameters.percent * 100 | string | n/a | O a porcentagem da promoção ativada |
product.promotional_offer.script.is_discount_for_quantity | boolean | false | true se a loja tem promoções percentuais levando X ou mais unidades de um produto. |
product.promotional_offer.selected_threshold.discount_decimal_percentage * 100 | string | n/a | A porcentagem de disconto levando X ou mais unidades de um produto |
product.promotional_offer | boolean | false | true se a loja tem promoções do tipo 2x1 ou 3x2 ativadas. false em o caso oposto. |
product.free_shipping | boolean | false | True se o produto tiver o label para anunciar frete grátis ativado. |
product.is_non_shippable | boolean | false | True se for um produto que não necessita de envio físico. Por exemplo, um produto digital ou serviço. |
product.variants_object contém
Objeto | Tipo | Default | Descrição |
---|---|---|---|
price_short | string | n/a | Texto com o preço da variante e o símbolo da moeda. Se compare_at_price_short fica definido, a propriedade utiliza o preço promocional. |
price_long | string | n/a | Texto com el preço da variante e o símbolo da moeda acompanhado por o Código ISO 4217 da moeda. Se compare_at_price_long fica definido, esta propiedade utiliza o preço promocional. |
compare_at_price_short | string | n/a | Texto que tem o preço com o qual a variante era vendida originalmente e o símbolo da moeda. |
compare_at_price_long | string | n/a | Texto com o preço com o qual a variante era vendida e o el símbolo da moeda acompanhada pelo Código ISO 4217 da moeda. |
stock | string | n/a | Estoque da variante. |
sku | string | n/a | SKU da variante. |
available | boolean | n/a | true se a variante tem estoque disponível. false em outro caso. |
contact | boolean | n/a | true se o produto é de contato. false em outro caso. |
option0 | string | n/a | Texto com o valor da primeira propiedade da variante. |
option1 | string | n/a | Texto com o valor da segunda propiedade da variante. |
option2 | string | n/a | Texto com o valor da terceira propiedade da variante. |
product_image
Este objeto representa a imagem de um produto da loja.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
id | string | n/a | Id da imagem. |
name | string | n/a | Nome da imagem. |
alt | string | n/a | Texto alternativo. |
position | string | n/a | Posição da imagem na lista de imagens do produto. A primeira imagem tem o valor 1 (um) e é a imagem principal do produto. |
variation
Este objeto representa a propriedade de um produto da loja.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
id | string | n/a | Id da propriedade. |
name | string | n/a | Nome da propriedade. |
options | string | n/a | Array de objetos Variation_Option que contçem os valores desta propiedade. |
product_variant
Este objeto representa uma variante de um produto da loja.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
name | string | n/a | Nome da variante |
option1 | string | n/a | Valor da primeira opção da variante |
option2 | string | n/a | Valor da segunda opção da variante |
option3 | string | n/a | Valor da terceira opção da variante |
options | array | n/a | Array com as opções da variante |
price | string | n/a | Preço da variante |
compare_at_price | string | n/a | O preço original com o qual era vendida a variante (em centavos). |
display_price | boolean | true | true se a variante tem um preço para exibir. false em outro caso. |
currency | string | n/a | Código ISO 4217 da moeda na qual é exibido o preço do produto (ARS = Pesos Argentinos, BRL = Reais, etc.). |
sku | string | n/a | SKU da variante. |
weight | string | n/a | Peso da variante. |
weight_unit | string | n/a | Unidade do peso da variante (Ex. Kg). |
stock | string | n/a | Estoque da variante |
stock_control | boolean | false | true se o estoque da variante se encontra controlado pela Nuvemshop. false em outro caso. |
available | boolean | n/a | true se a variante tem estoque disponíveis. false em outro caso. |
variant_option
Este objeto representa ao valor da propriedade de um produto da loja.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
id | string | n/a | Id do valor da propriedade. |
name | string | n/a | Nome do valor da propriedade. |
shipping
Opções de entrega
Representa ao item de entrega da loja dentro do for de options no arquivo shipping_options.tpl.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
option.name | string | n/a | Nome e tempos da opção de entrega. |
option.short_name | string | n/a | Somente o nome da opção de entrega |
option.time | string | n/a | Tempos de entrega da opção no formato "X dias úteis" |
option.date | string | n/a | Tempos de entrega da opção no formato de datas exatas, por exemplo "Chega a segunda XX/YY " |
option.show_price | boolean | true | True se a opção exibe o preço |
option.cost | string | n/a | O custo da opção incluindo a moeda e seus decimais |
option.cost.value | string | n/a | O custo da opção sem incluir a moeda e seus decimais |
option.old_cost.value | string | n/a | Somente aplica no frete grátis. Exibe o preço velho que a opção tinha antes de ter frete grátis |
option.method | string | n/a | O método de entrega. Para loja física é branch, para o frete personalizado é table. |
option.shipping_type | string | n/a | O tipo de entrega. Para entrega a domicilio é delivery e pickup para um ponto de retirada |
option.code | string | n/a | Código utilizado pelo Javascript na funcionalidad da calculadora de frete |
option.payment_rules | string | n/a | Messágem para entregas com condições. Por exemplo Mercado Envios trabalha só com Mercado Pago |
option.suboptions | array | n/a | Utilizado para o for de subopções se o meio de entrega permitir |
option.warning['enable'] | boolean | false | true se o meio de entrega exibe uma mensagem para comunicar algo extra |
option.warning['message'] | string | n/a | A mensagem em caso que o medio de entrega precisa comunicar algo extra |
Frete grátis
Só aplica com base as configurações feitas na seção do Administrador Nuvem: Descontos > Frete grátis
Objeto | Tipo | Default | Descrição |
---|---|---|---|
cart.free_shipping.cart_has_free_shipping | boolean | false | true se o carrinho tem frete grátis. |
cart.free_shipping.min_price_free_shipping.min_price | string | n/a | Exibe o subtotal minimo para ter frete grátis, incluindo moeda e decimais |
cart.free_shipping.min_price_free_shipping.min_price_raw | string | n/a | Exibe o subtotal minimo para ter frete grátis, sem incluir a moeda e seus decimais |
payments
Parcelas
Aplica-se às parcelas oferecidas pela loja no arquivo installments.tpl
Objeto | Tipo | Default | Descrição |
---|---|---|---|
product.show_installments | boolean | false | true se a loja tem parcelas ativadas |
product.get_max_installments | array | n/a | Exibe as parcelas com juros |
product.get_max_installments(false) | array | n/a | Exibe as parcelas sem juros |
max_installments_with_interests.installment | string | n/a | Exibe o valor de uma parcela com juros |
max_installments_without_interests.installment | string | n/a | Exibe o valor de uma parcela sem juros |
max_installments_with_interests.installment_data.installment_value_cents | money | string | n/a | Exibe o valor de uma parcela com juros incluindo a moeda e seus decimais |
max_installments_without_interests.installment_data.installment_value_cents | money | string | n/a | Exibe o valor de uma parcela sem juros incluindo a moeda e seus decimais |
cart.installments.max_installments_with_interest | string | n/a | Exibe o valor das parcelas com juros para o total do carrinho |
cart.installments.max_installments_without_interest | string | n/a | Exibe o valor das parcelas sem juros para o total do carrinho |
Meios de pagamento
Aplica-se às informações exibidas para os detalhes de pagamento nos arquivos payments.tpl, payments-info-banks.tpl e payments-info.tpl
Objeto | Tipo | Default | Descrição |
---|---|---|---|
installments_data['cards'] | array | n/a | Serve para saber se o meio de pagamento tem cartão de crédito. Somente aplica a lojas do Brasil e meios de pagamento que não sejam Mercado Pago em lojas Argentinas. |
installments_data['max_with_interests'] | array | n/a | Serve para a quantidade máxima com juros de um meio de pagamento. Somente aplica a lojas do Brasil e meios de pagamento que não sejam Mercado Pago em lojas Argentinas. |
installments_data['direct'] | array | n/a | Serve para saber se o meio de pagamento tem cartão de débito ou à vista. Somente aplica a lojas do Brasil e meios de pagamento que não sejam Mercado Pago em lojas Argentinas. |
data_installment.installment_value | array | n/a | É o valor de cada parcela dentro do for {% for installment, data_installment in installments %} Somente aplica as lojas do Brasil |
gateways.cc | array | n/a | Serve para saber se o meio de pagamento tem cartão de crédito. Por exemplo: {% if gateways.cc is not null %} |
gateways.cc.interest | array | n/a | Serve para saber se o meio de pagamento tem cartão de crédito com juros. |
gateways.cc.no_interest | array | n/a | Serve para saber se o meio de pagamento tem cartão de crédito sem juros. |
gateways.debit | array | n/a | Serve para saber se o meio de pagamento tem cartão de debito. |
gateways.cash | array | n/a | Serve para saber se o meio de pagamento tem pagamento à vista. |
gateways.transfer | array | n/a | Serve para saber se o meio de pagamento tem transferência bancária. |
page
Este objeto representa a uma página criada pelo dono da loja.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
page.id | string | n/a | Id da página. |
page.name | string | n/a | Nome da página. |
page.content | HTML | n/a | Conteúdo da página. |
page.URL | string | n/a | URL da página. |
page.seo_title | string | n/a | Título para SEO. |
page.seo_description | string | n/a | Descrição para SEO. |
page.handle | string | n/a | URL da página. |
cart
Este objeto representa ao carrinho de compras da loja.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
cart.total | string | n/a | Total do carrinho. |
cart.subtotal | string | n/a | Subtotal do carrinho (por agora é igual ao total). |
cart.currency | string | n/a | Código ISO 4217 da moeda na qual fica visualizado o total do carrinho. |
cart.weight | string | n/a | Peso de todos os itens do carrinho. |
cart.has_shippable_products | boolean | true | True se todo o carrinho tiver produtos que exigem envio físico. False se forem todos produtos digitais ou serviços. |
cart.items_count | string | n/a | Quantidade de itens do carrinho (não tem em conta a quantidade de cada item). |
cart.items | array | n/a | Array de objetos Cart_Item que representa aos itens do carrinho. |
cart_item
Este objeto representa ao item do carrinho de compras.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
item.id | string | n/a | Id do item do carrinho. |
item.name | string | n/a | Nome do item do carrinho. |
item.unit_price | string | n/a | O preço do item em centavos (que dizer que, se o preço é R$100 o valor de unit_price é 10000). |
item.quantity | string | n/a | Quantidade do item no carrinho. |
item.subtotal | string | n/a | Subtotal deste item no carrinho (básicamente unit_price * quantity) em centavos (que dizer que, se o preço é R$100 o valor do subtotal é 10000). |
item.product | object | n/a | Objeto Product que representa ao produto deste item. |
item.url | string | n/a | URL canônica do produto deste item. |
item.featured_image | object | n/a | Objeto Product_Image que representa as imagens destacadas do produto deste item. |
item.product.free_shipping | boolean | false | true se o produto tem frete grátis. false em outro caso. |
item.product.is_non_shippable | boolean | n/a | Truse se é um produto que não necessita de envio físico. Por exemplo, um produto digital ou serviço |
customer
Este objeto representa um cliente da loja.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
customer.id | string | n/a | Id do cliente. |
customer.name | string | n/a | Nome do cliente. |
customer.email | string | n/a | E-mail do cliente. |
customer.phone | string | n/a | Teléfono do cliente. |
customer.password | boolean | false | true se o cliente tem uma senha. false se ainda não fica registrado. |
customer.tags | array | n/a | Array que contém os tags do cliente. |
customer.total_spent | string | n/a | Total consumido pelo cliente da loja em centavos (que dizer, se o total consumido é de R$100 o valor de total_spent é 10000). |
customer.total_spent_currency | string | n/a | Código ISO 4217 da moeda na qual fica expressado o total consumido pelo cliente na loja. |
customer.default_address | object | n/a | Objeto Address que representa o endereço do cliente. |
customer.cpf_cnpj | string | n/a | CPF/CNPJ do cliente (só para Brasil). |
customer.orders | array | n/a | Array de objetos Order que são apresentados em todos os pedidos do cliente. |
customer.addresses | array | n/a | Array de objetos Address que representam todos os endereços do cliente. |
address
Este objeto representa o endereço de um cliente na loja.
Objeto | Tipo | Descrição |
---|---|---|
address.id | string | Id do endereço. |
address.name | string | Nome do endereço. |
address.address | string | Calle do endereço. |
address.number | string | Número do endereço. |
address.floor | string | Piso do endereço. |
address.locality | string | Localidade do endereço. |
address.zipcode | string | CEP do endereço. |
address.city | string | Cidade do endereço. |
address.province | string | Província do endereço. |
address.country | string | País do endereço. |
address.phone | string | Teléfono do endereço. |
order
Este objeto representa o pedido de um cliente na loja.
Este objeto extiende do objeto Cart o que quer dizer que também tem todos seus atributos.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
order.id | string | n/a | Id do pedido. |
order.number | string | n/a | Número do pedido. |
order.date | string | n/a | Data de criação do pedido. |
order.status | ??? | n/a | Estado do pedido (open - closed - cancelled). |
order.payment_status | ??? | n/a | Estado do frete do pedido (unpacked - unfulfilled - fulfilled). |
order.shipping_status | ??? | n/a | Estado del envío de la orden (unpacked - unfulfilled - fulfilled). |
order.shipping | String | n/a | Custo de frete em centavos (quer dizer que, se o custo é R$100 o valor de shipping é 10000). |
order.shipping_name | string | n/a | Nome do meio de frete escolhido. |
order.payment_name | string | n/a | Nome do meio de pagamento escolhido. |
order.discount | string | n/a | Desconto realizado em centavos (que dizer que, se o desconto é de R$100 o valor de discount é 10000). |
order.coupon | string | n/a | Código do cupão de desconto que foi aplicado. |
order.total | string | n/a | Precio total de la orden en centavos (es decir, si el precio es de $100 el valor de discount será 10000). |
order.total_in_usd | string | n/a | Precio total de la orden en centavos de USD (es decir, si el precio es de $100 el valor de discount será 10000). |
order.currency | string | n/a | Código ISO 4217 de la moneda en la que se pagó la orden(ARS = Pesos Argentinos, BRL = Reales, etc.). |
order.address | object | n/a | Objeto Address que representa o endereço do cliente. |
contact_Result
Este objeto representa um resultado ao enviar o formulário de contato na loja.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
name | string | n/a | Contenido del input con id name. |
last_name | string | n/a | Contenido del input con id last_name. |
string | false | Conteúdo do input com o id e-mail (obrigatorio). | |
phone | string | n/a | Contenido del input con id phone. |
message | string | n/a | Conteúdo do input com id message. |
prodId | string | n/a | Conteúdo do input com id prodId. |
product | object | n/a | Objeto Product que representa ao produto pelo qual o cliente está consultando. |
success | false | true se o contato foi realizado com sucesso. false em o caso oposto. |
fb_app
Este objeto representa o aplicativo de Facebook da Nuvemshop.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
id | string | n/a | Id do aplicativo de Facebook. |
namespace | string | n/a | Namespace do aplicativo de Facebook (utilizado para Open Graph). |