Los objetos son variables determinadas por la plataforma. Y cada objeto tiene diferentes atributos que son separados por un punto. Podemos llamar a estos objetos de dos maneras:
{% ... %} y {{ ... }}. La primera se utiliza para ejecutar sentencias como loops (for) y la segunda genera el resultado de la expresión (entendiendo expresión como el conjunto de objeto más atributo, por ejemplo: store.name)
store
Este objeto representa a la tienda y es generalmente usado en combinación con otros objetos. Podés usarlo de dos formas: sólo para mostrar la información o para preguntar algo.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
store.name | string | n/a | Es el nombre de la tienda. |
store.url | string | n/a | Es la URL de la tienda. |
store.logo | string | n/a | Es la URL del logo de la tienda. |
store.phone | string | n/a | Es el número de teléfono de la tienda. |
store.email | string | n/a | Es el email de la tienda. |
store.blog | string | n/a | Es la URL del blog de la tienda. |
store.twitter | string | n/a | Es la URL del perfil de Twitter de la tienda. |
store.twitter_user | string | n/a | Es el usuario de la tienda en Twitter. |
store.facebook | string | n/a | Es la URL de la página/perfil de Facebook de la tienda. |
store.instagram | string | n/a | Es la URL del perfil de Instagram de la tienda. |
store.contact_intro | string | false | Es Información extra para mostrar dentro de la página de contacto con la tienda. |
store.country | string | n/a | Es el código ISO 3166-1 del país de la tienda (AR = Argentina, BR = Brasil, MX = México, etc.). |
store.currency | string | n/a | Es el código ISO 4217 de la moneda de la tienda (ARS = Pesos Argentinos, BRL = Reales, MXN = Pesos Mexicanos, etc.). |
store.live_chat | string | n/a | Es el código de integración del servicio de chat online de la tienda. |
store.business_id | string | n/a | Es el identificador de la empresa que opera la tienda (depende del país) (disponible únicamente en Brasil). |
store.business_name | string | n/a | Es el nombre de la empresa que opera la tienda (disponible únicamente en Brasil). |
afip | string | n/a | Formulario Nº 960/NM – Data Fiscal de la AFIP (Únicamente disponible en Argentina). |
store.analytics_account | string | n/a | Es la cuenta de Google Analytics de la tienda. |
store.domain | string | n/a | Es el dominio asignado a la tienda al registrarse a Tiendanube (dominio.mitiendanube.com). |
store.has_custom_domain | boolean | false | Esto es true si la tienda tiene un dominio propio. false en otro caso. |
store.has_accounts | boolean | true | Esto es true si la tienda tiene soporte para cuentas de usuario. |
store.is_catalog | boolean | false | Esto es true si la tienda es un catálogo y no soporta compras. false en otro caso. |
store.products_url | string | n/a | Es la URL que apunta a la página en la que se muestran todos los productos. |
store.cart_url | string | n/a | Es la URL que apunta a la página del carrito de compras. |
store.contact_url | string | n/a | Es la URL que apunta a la página de contacto. |
store.search_url | string | n/a | Es la URL que apunta a la página de búsqueda. |
store.has_shipping | boolean | false | Esto es true si la tienda tiene medios de envío activados. false en caso contrario |
store.branches | boolean | false | Esto es true si la tienda tiene locales activados. false en caso contrario |
store.shipping_calculator_url | string | n/a | Es la URL que apunta a la página de cálculos de costos de envío. Es usada por el Javascript del snipplet del calulador de envío. |
store.checkout_url | string | n/a | Es la URL que apunta a la página de checkout de la tienda. |
store.customer_home_url | string | n/a | Es la URL que apunta a la página de inicio para los clientes de la tienda. |
store.customer_register_url | string | n/a | Es la URL que apunta a la página de registro para los clientes de la tienda. |
store.customer_login_url | string | n/a | Es la URL que apunta a la página de login para los clientes de la tienda. |
store.customer_logout_url | string | n/a | Es la URL que apunta a la página de logout para los clientes de la tienda. |
store.customer_reset_password_url | string | n/a | Es la URL que apunta a la página de recuperar contraseña para los clientes de la tienda. |
store.customer_order_url | string | n/a | Es la URL que apunta a la página de órdenes para los clientes de la tienda. |
store.customer_info_url | string | n/a | Es la URL que apunta a la página de editar información personal para los clientes de la tienda. |
store.customer_addresses_url | string | n/a | Es la URL que apunta a la página de direcciones para los clientes de la tienda. |
store.customer_address_url | string | n/a | Es la URL que apunta a la página de una dirección para los clientes de la tienda. |
store.customer_new_address_url | string | n/a | Es la URL que apunta a la página de agregar una dirección para los clientes de la tienda. |
store.customer_main_address_url | string | n/a | Es la URL que apunta a la página para marcar una dirección como principal para los clientes de la tienda. |
store.customer_accounts | boolean | optional | 'optional' si los clientes pueden realizar una compra sin registrar una cuenta en la tienda. 'mandatory' si deben registrarse antes de realizar una compra. |
Podés combinar varios filtros para tener un código más complejo:
{{ store.logo | img_tag | a_tag(store.url) }}
Para tener más información de los métodos que podés utilizar, te recomendamos que leas este artículo.
El ejemplo anterior combina el objeto logo con filtros para mostrar el siguiente código:
<a href="http://yourstore.com" title=""><img src="//your-store-logo.png" alt="yourstore-name" title="yourstore-name"></a>
También se puede usar este objeto para mostrar contenido bajo una condición:
{% if store.has_accounts %} <div class="accounts-div"></div> {% endif %}
Otros ejemplos de este objeto cómo puede ser usado:
Para verificar si la tienda fue creada en Brasil.
{% if store.country == 'BR' %} <div class="br-only-div"></div> {% endif %}
Para verificar si la tienda usa el login y suscripción.
{% if store.has_accounts %} <div class="accounts-div"></div> {% endif %}
Para verificar si la tienda tiene dominio propio.
{% if store.has_custom_domain %} {% endif %}
Para verificar si la tienda es sólo un catálogo.
{% if store.is_catalog %} <div class="catalog-only-div"></div> {% endif %}
Para verificar si la tienda tiene Facebook configurado. También si aplica a: store.google_plus, store.pinterest, store.instagram
{% if store.facebook %} <div class="facebook-div"></div> {% endif %}
Para verificar si la tienda tiene un chat online configurado.
{% if store.live_chat %} <div class="chat-div"></div> {% endif %}
Para verificar si la tienda permite que los usuarios compren sin tener una cuenta creada.
{% if store.customer_accounts %} <div class="customer-accounts-div"></div> {% endif %}
section
Este objeto representa a una sección del diseño de la tienda según definidas en sections.txt.
Cada sección tiene asociada un conjunto de productos destacados.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
section.id | string | n/a | Código de la sección. |
section.name | string | n/a | Nombre de la sección. |
section.description | string | n/a | Descripción de la sección. |
section.products | array | n/a | Arreglo de objetos Product que representa a los productos que pertenecen a la sección. |
settings
Este objeto representa a las configuraciones del diseño de la tienda.
Los atributos de este objetos son los que se definen en settings.txt
Por ejemplo, si en settings se definen los siguientes objetos:
checkbox name = banner_show description = Mostrar banner i18n_input name = banner_title description = Título
Y se utilizan de la siguiente manera:
{% if setttings.banner_show %} {{ setttings.banner_title }} {% endif %}
language
Este objeto representa a uno de los idiomas habilitados en la tienda.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
language.id | string | n/a | Código ISO 639-1 del idioma y Código ISO 3166-1 del país (Ejemplo: es_AR). |
language.code | string | n/a | Código ISO 639-1 del idioma seguido por un guión bajo y el código ISO 3166-1 del país al que pertenece (Ejemplo: es_AR para el Español de Argentina, pt_BR para el Portugués de Brasil, etc.). |
language.name | string | n/a | Nombre del idioma. |
language.active | boolean | false | true si es el idioma activo en la tienda. false en otro caso. |
language.country | string | n/a | Código ISO 3166-1 del país. |
navigation
navigation_item
Este objeto representa a un ítem de la navegación de la tienda.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
item.name | string | n/a | Nombre del ítem. |
item.url | string | n/a | URL del ítem. |
item.subitems | array | n/a | Arreglo de Navigation_Item que representa los subitems anidados a este ítem de la navegación. |
item.current | boolean | false | true si la página actual es la misma a la que hace referencia el ítem de la navegación. |
breadcrumb
Este objeto representa a un breadcrumb que describe el camino de cómo se llegó a la página actual.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
breadcrumb.name | string | n/a | Nombre del breadcrumb. |
breadcrumb.url | string | n/a | URL del breadcrumb. |
breadcrumb.last | boolean | false | true si es el último breadcrumb. false en otro caso. |
Es utilizado en el snipplet breadcrumbs.tpl
category
Este objeto representa a una categoría de la tienda.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
category.id | string | n/a | Id de la categoría. |
category.name | string | n/a | Nombre de la categoría. |
category.description | string | n/a | Descripción de la categoría. |
category.url | string | URL de la categoría. | |
category.parent | object | n/a | Objeto Category correspondiente a la categoría padre. |
category.subcategories | array | n/a | Arreglo de objetos Category que contiene a las subcategorías de esta categoría. |
category.images | array | n/a | Arreglo de objetos Category_Image que contiene la imagen de la categoría. |
category.featured_image (Deprecado) | object | n/a | Imagen de un producto de la categoría. |
category.active | boolean | false | true si la URL actual es la URL de la categoría. false en otro caso. |
category.top | object | n/a | Objeto Category que representa la primer categoría de su jerarquía. |
category.products | array | n/a | Arreglo de objetos Product con los productos pertenecientes a esta categoría. |
category.products_count | string | n/a | Cantidad de productos pertenecientes a esta categoría. |
category.seo_title | string | n/a | Título para SEO. |
category.seo_description | string | n/a | Descripción para SEO. |
category.handle | string | n/a | URL de la categoría. |
Pages / Pagination
Este objeto representa la página actual de una categoría/búsqueda en la tienda.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
pages.previous | string | n/a | URL de la página previa. |
pages.next | string | n/a | URL de la próxima página. |
pages.current | string | n/a | Número de la página actual. |
pages.amount | string | n/a | Cantidad de páginas de la categoría/búsqueda. |
pages.numbers | array | n/a | Arreglo con todas las páginas. Para cada página contiene los objetos debajo. |
pages.numbers contiene los siguientes objetos:
Objeto | Tipo | Default | Descripción |
---|---|---|---|
pages.number | string | n/a | Número de esta página |
pages.url | string | n/a | URL de esta página |
pages.selected | boolean | false | true si es la página actual. false en otro caso. |
product
Este objeto representa a un producto de la tienda.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
product.brand | string | n/a | Nombre de la marca del producto. |
product.name | string | n/a | Nombre del producto. |
product.price | string | n/a | Precio del producto en centavos (es decir, si el precio es $100 el valor de price será 10000). Si compare_at_price está seteado, price representa el precio promocional del producto |
product.compare_at_price | string | n/a | El precio original al que se vendía el producto en centavos (es decir, si el precio es $100 el valor de compare_at_price será 10000) si este existe. false en otro caso. |
product.display_price | boolean | true | true si el producto tiene un precio para mostrar. false en otro caso. |
product.min_price | string | n/a | El precio mínimo de todas las Product_Variant del producto, en centavos (es decir, si el precio es $100 el valor de min_price será 10000). null si ninguna variante tiene precio. |
product.max_price | string | n/a | El precio máximo de todas las Product_Variant del producto, en centavos (es decir, si el precio es $100 el valor de max_price será 10000). null si ninguna variante tiene precio. |
product.canonical_url | string | n/a | URL canónica del producto. |
product.social_url | string | n/a | URL social del producto (debe usarse para compartir en Facebook, Twitter, G+, Pinterest, etc.). |
product.description | string | n/a | Descripción del producto. |
product.stock_control | boolean | false | true si el stock del producto está siendo controlado por Tiendanube. false en otro caso. |
product.stock | string | n/a | Stock del producto |
product.weight | string | n/a | Peso del producto. |
product.weight_unit | string | n/a | Unidad de medida del peso. Por el momento, el valor es siempre KG. |
product.sku | string | n/a | SKU del producto. |
product.tags | array | n/a | Arreglo que contiene los tags del producto. |
product.currency | string | n/a | Código ISO 4217 de la moneda en la que se muestra el precio del producto (ARS = Pesos Argentinos, BRL = Reales, etc, MXN - Pesos Mexicanos.). |
product.images | array | n/a | Arreglo de objetos Product_Image que contiene las imágenes del producto. |
product.images_count | string | n/a | Cantidad de imágenes del producto. |
product.featured_image | object | n/a | Objeto Product_Image con la imagen principal del producto. |
product.default_options | array | n/a | Arreglo que contiene los nombres de las tres opciones de la variante default. |
product.variations | array | n/a | Arreglo de objetos Variation que contiene las propiedades del producto. |
product.other_images | array | n/a | Arreglo de objetos Product_Image que contiene las imágenes secundarias del producto (es decir, todas menos la primera). |
product.installments | string | n/a | Cantidad de cuotas máximas por la que se puede pagar el producto. (Únicamente disponible en Brasil) |
product.category | object | n/a | Objeto Category que representa una de las categorías próximas del producto (es decir, si el producto pertenece a la categoría Ropa > Vestidos product.category retornará la categoría Vestidos. |
product.variants_object | array | n/a | Arreglo de objetos con todas las variantes. |
product.seo_title | string | n/a | Título para SEO. |
product.seo_description | string | n/a | Descripción para SEO. |
product.handle | string | n/a | URL del producto. |
product.promotional_offer | boolean | false | Es true si la tienda tiene promociones activadas. false en caso contrario |
product.promotional_offer.script.is_percentage_off | boolean | false | Es true si la tienda tiene promociones de porcentaje activadas. false en caso contrario |
product.promotional_offer.parameters.percent * 100 | string | n/a | Es el porcentaje de descuento en la promoción activada |
product.promotional_offer.script.is_discount_for_quantity | boolean | false | Es true si la tienda tiene promociones porcentuales llevando X o más unidades de un producto |
product.promotional_offer.selected_threshold.discount_decimal_percentage * 100 | string | n/a | Es el porcentaje de descuento llevando X o más unidades de un producto |
product.promotional_offer | boolean | false | Es true si la tienda tiene promociones del tipo 2x1 o 3x2 activadas. false en caso contrario |
product.free_shipping | boolean | false | Es true si ese producto tiene activado el cartel para anunciar envío gratis. |
product.requires_shipping | boolean | true | Es true is es un producto que requiere un envío físico. Por ejemplo un servicio o un producto digital será false. |
product.variants_object contiene
Objeto | Tipo | Default | Descripción |
---|---|---|---|
price_short | string | n/a | Texto con el precio de la variante y el símbolo de la moneda. Si compare_at_price_short está seteado, esta propiedad utiliza el precio promocional. |
price_long | string | n/a | Texto con el precio de la variante y el símbolo de la moneda acompañado por el Código ISO 4217 de la moneda. Si compare_at_price_long está seteado, esta propiedad utiliza el precio promocional. |
compare_at_price_short | string | n/a | Texto con el precio al que se vendía originalmente la variante y el símbolo de la moneda. |
compare_at_price_long | string | n/a | Texto con el precio al que se vendía originalmente la variante y el símbolo de la moneda acompañado por el Código ISO 4217 de la moneda. |
stock | string | n/a | Stock de la variante. |
sku | string | n/a | SKU de la variante. |
available | boolean | n/a | true si la variante tiene stock disponible. false en otro caso. |
contact | boolean | n/a | true si el producto es de contacto. false en otro caso. |
option0 | string | n/a | Texto con el valor de la primera propiedad de la variante. |
option1 | string | n/a | Texto con el valor de la segunda propiedad de la variante. |
option2 | string | n/a | Texto con el valor de la tercera propiedad de la variante. |
selected_or_first_available_variant | string | n/a | Objeto Product_Variant que representa a la primer variante, o variante default, del producto. |
product_image
Este objeto representa a la imagen de un producto de la tienda.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
id | string | n/a | Id de la imagen. |
name | string | n/a | Nombre de la imagen. |
alt | string | n/a | Texto alternativo. |
position | string | n/a | Posición de la imagen en la lista de imágenes del producto. La primer imagen tiene el valor 1 (uno) y es la imagen principal del producto. |
variation
Este objeto representa a la propiedad de un producto de la tienda.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
id | string | n/a | Id de la propiedad. |
name | string | n/a | Nombre de la propiedad. |
options | string | n/a | Arreglo de objetos Variation_Option que contiene los valores de esta propiedad. |
product_variant
Este objeto representa a una variante de un producto en la tienda.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
name | string | n/a | Nombre de la variante |
option1 | string | n/a | Valor de la primera opción de la variante |
option2 | string | n/a | Valor de la segunda opción de la variante |
option3 | string | n/a | Valor de la tercera opción de la variante |
options | array | n/a | Arreglo con las opciones de la variante |
price | string | n/a | Precio de la variante |
compare_at_price | string | n/a | El precio original al que se vendía la variante (en centavos). |
display_price | boolean | true | true si la variante tiene un precio para mostrar. false en otro caso. |
currency | string | n/a | Código ISO 4217 de la moneda en la que se muestra el precio del producto (ARS = Pesos Argentinos, BRL = Reales, etc.). |
sku | string | n/a | SKU de la variante. |
weight | string | n/a | Peso de la variante. |
weight_unit | string | n/a | Unidad del peso de la variante (Ej. Kg). |
stock | string | n/a | Stock de la variante |
stock_control | boolean | false | true si el stock de la variante está siendo controlado por Tiendanube. false en otro caso. |
available | boolean | n/a | true si la variante tiene stock disponible. false en otro caso |
variant_option
Este objeto representa al valor de la propiedad de un producto de la tienda.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
id | string | n/a | Id del valor de la propiedad. |
name | string | n/a | Nombre del valor de la propiedad. |
shipping
Opciones de entrega
Representa al ítem de entrega en la tienda dentro del for de options en el archivo shipping_options.tpl.
Objeto | Tipo | Default | Descrição |
---|---|---|---|
option.name | string | n/a | Nombre y tiempos de la opción de entrega |
option.short_name | string | n/a | Solamente es el nombre de la opción de entrega |
option.time | string | n/a | Tiempos de entrega de la opción en formato "X dias hábiles" |
option.date | string | n/a | Tiempos de entrega de la opción en formato de fechas exactas, por ejemplo "Llega el lunes XX/YY" |
option.show_price | boolean | true | Es true si la opción tiene precio |
option.cost | string | n/a | Es el costo de la opción incluyendo la moneda y sus decimales |
option.cost.value | string | n/a | Es el costo de la opción sin incluir moneda o decimales |
option.old_cost.value | string | n/a | Solamente aplica al envío gratis. Muestra el precio viejo que la opción tenía antes de ser gratis |
option.method | string | n/a | Es el método de entrega. Para local es branch, para envío personalizado es table. |
option.shipping_type | string | n/a | Es el tipo de entrega. Para entrega a domicílio es delivery y pickup para un punto de retiro |
option.code | string | n/a | Código usado por Javascript en la funcionalidad del calculador de envíos |
option.payment_rules | string | n/a | Mensaje para entregas que tienen ciertas condiciones. Por ejemplo "Mercado Envios trabaja solo con Mercado Pago" |
option.suboptions | array | n/a | Usado para el for de las subopciones si un medio de entrega lo permite. Por ejemplo las sucursales de un correo. |
option.warning['enable'] | boolean | false | Es true si el medio de entrega muestra un mensaje para comunicar algo extra |
option.warning['message'] | string | n/a | El mensaje en caso que el medio de entrega comunique algo extra |
Envío gratis
Sólo aplica en base a las configuraciones hechas en la sección del Administrador Nube: Descuentos > Envío gratis
Objeto | Tipo | Default | Descrição |
---|---|---|---|
cart.free_shipping.cart_has_free_shipping | boolean | false | Es true si el carrito tiene envío gratis |
cart.free_shipping.min_price_free_shipping.min_price | string | n/a | Muestra el subtotal mínimo para tener envío gratis, incluyendo moneda y decimales |
cart.free_shipping.min_price_free_shipping.min_price_raw | string | n/a | Muestra el subtotal mínimo para temer envío gratis. sin incluir moneda o decimales |
payments
Cuotas
Aplica a las cuotas ofrecidas por la tienda en el archivo installments.tpl
Objeto | Tipo | Default | Descrição |
---|---|---|---|
.show_installments | boolean | false | Es true si la tienda tiene cuotas activadas |
product.get_max_installments | array | n/a | Muestra las cuotas con interés |
product.get_max_installments(false) | array | n/a | Muestra las cuotas sin interés |
max_installments_with_interests.installment | string | n/a | Muestra el valor máximo de una cuota con interés |
max_installments_without_interests.installment | string | n/a | Muestra el valor de una cuota sin interés |
max_installments_with_interests.installment_data.installment_value_cents | money | string | n/a | Muestra el valor de una cuota con interés incluyendo la moneda y sus decimales |
max_installments_without_interests.installment_data.installment_value_cents | money | string | n/a | Muestra el valor de una cuota sin interés incluyendo la moneda y sus decimales |
cart.installments.max_installments_with_interest | string | n/a | Muestra el valor de las cuotas con interés basado en el total del carrito |
cart.installments.max_installments_without_interest | string | n/a | Muestra el valor de las cuotas sin interés basado en el total del carrito |
Medios de pago
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 | Sirve para saber si el medio de pago tiene tarjeta de crédito Solamente aplica a tiendas de Brasil y medios de pago que no sean Mercado Pago en tiendas de Argentina |
installments_data['max_with_interests'] | array | n/a | Sirve para la cantidad máxima de cuotas con interés en un medio de pago. Solamente aplica a tiendas de Brasil y medios de pago que no sean Mercado Pago en tiendas de Argentina |
installments_data['direct'] | array | n/a | Sirve para saber si el medio de pago tiene tarjeta de débito o efectivo. Solamente aplica a tiendas de Brasil y medios de pago que no sean Mercado Pago en tiendas de Argentina |
data_installment.installment_value | array | n/a | Es el valor de cada cuota dentro del for {% for installment, data_installment in installments %} Sólo aplica a tiendas de Brasil |
gateways.cc | array | n/a | Sirve para saber si el medio de pago tiene tarjeta de crédito. Por ejemplo: {% if gateways.cc is not null %} |
gateways.cc.interest | array | n/a | Sirve para saber si el medio de pago tiene tarjeta de crédito con interés. |
gateways.cc.no_interest | array | n/a | Sirve para saber si el medio de pago tiene tarjeta de crédito sin interés. |
gateways.debit | array | n/a | Sirve para saber si el medio de pago tiene tarjeta de débito. |
gateways.cash | array | n/a | Sirve para saber si el medio de pago tiene pago en efectivo. |
gateways.transfer | array | n/a | Sirve para saber si el medio de pago tiene transferencia bancária. |
page
Este objeto representa a una página creada por el dueño de la tienda.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
page.id | string | n/a | Id de la página. |
page.name | string | n/a | Nombre de la página. |
page.content | HTML | n/a | Contenido de la página. |
page.URL | string | n/a | URL de la página. |
page.seo_title | string | n/a | Título para SEO. |
page.seo_description | string | n/a | Descripción para SEO. |
page.handle | string | n/a | URL de la página. |
cart
Este objeto representa a un carrito de compras de la tienda.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
cart.total | string | n/a | Total del carrito. |
cart.subtotal | string | n/a | Subtotal del carrito |
cart.currency | string | n/a | Código ISO 4217 de la moneda en la que está expresado el total del carrito. |
cart.weight | string | n/a | Peso de todos los ítems del carrito. |
cart.has_shippable_products | boolean | false | True si al menos un producto del carrito requiere un envío físico. |
cart.has_non_shippable_products | boolean | false | True si al menos un producto del carrito no requiere un envío fisico. |
cart.items_count | string | n/a | Cantidad de ítems en el carrito (no tiene en cuenta la cantidad de cada ítem). |
cart.items | array | n/a | Arreglo de objetos Cart_Item que representa los ítems en el carrito |
cart_item
Este objeto representa a un ítem del carrito de compras.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
item.id | string | n/a | Id del ítem del carrito. |
item.name | string | n/a | Nombre del ítem del carrito. |
item.unit_price | string | n/a | El precio del ítem en centavos (es decir, si el precio es $100 el valor de unit_price será 10000). |
item.quantity | string | n/a | Cantidad del ítem en el carrito |
item.subtotal | string | n/a | Subtotal de este ítem en el carrito (básicamente unit_price * quantity) en centavos (es decir, si el precio es $100 el valor de subtotal será 10000). |
item.product | object | n/a | Objeto Product que representa al producto de este ítem. |
item.url | string | n/a | URL canónica del producto de este ítem. |
item.featured_image | object | n/a | Objeto Product_Image que representa a la imagen destacada del producto de este ítem. |
item.product.free_shipping | boolean | n/a | Es true si el producto tiene envío gratis. false en caso contrario. |
item.product.requires_shipping | boolean | true | Es true si el producto requiere un envío fisico. |
customer
Este objeto representa un cliente de la tienda.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
customer.id | string | n/a | Id del cliente. |
customer.name | string | n/a | Nombre del cliente |
customer.email | string | n/a | Email del cliente. |
customer.phone | string | n/a | Teléfono del cliente. |
customer.password | boolean | false | true si el cliente tiene una contraseña. false si todavía no se ha registrado. |
customer.tags | array | n/a | Arreglo que contiene los tags del cliente. |
customer.total_spent | string | n/a | Total consumido por el cliente en la tienda en centavos (es decir, si el total consumido es de $100 el valor de total_spent será 10000). |
customer.total_spent_currency | string | n/a | Código ISO 4217 de la moneda en la que está expresado el total consumido por el cliente en la tienda. |
customer.default_address | object | n/a | Objeto Address que representa la dirección del cliente. |
customer.cpf_cnpj | string | n/a | CPF/CNPJ del cliente (únicamente para Brasil). |
customer.orders | array | n/a | Arreglo de objetos Order que representan todas las órdenes del cliente. |
customer.addresses | array | n/a | Arreglo de objetos Address que representan todas las direcciones del cliente. |
address
Este objeto representa la dirección de un cliente de la tienda.
Objeto | Tipo | Descripción |
---|---|---|
address.id | string | Id del de la dirección. |
address.name | string | Nombre de la dirección. |
address.address | string | Calle de la dirección. |
address.number | string | Número de la dirección. |
address.floor | string | Piso de la dirección. |
address.locality | string | Localidad de la dirección. |
address.zipcode | string | Código postal de la dirección. |
address.city | string | Ciudad de la dirección. |
address.province | string | Provincia de la dirección. |
address.country | string | País de la dirección. |
address.phone | string | Teléfono de la dirección. |
order
Este objeto representa la orden de un cliente de la tienda. También extiende el objeto cart lo que significa que tiene todos sus atributos.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
order.id | string | n/a | Número de la orden. |
order.number | string | n/a | Número de la orden. |
order.date | string | n/a | Fecha de creación de la orden. |
order.status | ??? | n/a | Estado de la orden (open - closed - cancelled). |
order.payment_status | ??? | n/a | Estado del pago de la orden (pending - authorized - paid - voided - refunded). |
order.shipping_status | ??? | n/a | Estado del envío de la orden (unpacked - unfulfilled - fulfilled). |
order.shipping_name | string | n/a | Nombre del envío seleccionado. |
order.payment_name | string | n/a | Nombre del medio de pago seleccionado. |
order.discount | string | n/a | Descuento realizado en centavos (es decir, si el descuento es de $100 el valor de discount será 10000). |
order.coupon | string | n/a | Código del cupón de descuento que fue 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 la dirección del cliente. |
contact_Result
Este objeto representa un resultado al submitear el formulario de contacto en la tienda.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
name | string | n/a | Contenido del input con id name. |
last_name | string | n/a | Contenido del input con id last_name. |
string | false | Contenido del input con id email (obligatorio). | |
phone | string | n/a | Contenido del input con id phone. |
message | string | n/a | Contenido del input con id message. |
prodId | string | n/a | Contenido del input con id prodId. |
product | object | n/a | Objeto Product que representa al producto que se quiere consultar. |
success | false | true si se realizó el contacto. false en otro caso. |
fb_app
Este objeto representa a la aplicación de Facebook de Tiendanube.
Objeto | Tipo | Default | Descripción |
---|---|---|---|
id | string | n/a | id de la aplicación de Facebook. |
namespace | string | n/a | Namespace de la aplicación de Facebook (se utiliza para Open Graph) |