Documentación Front-Office

Document

billingInformation

Emite la informacion del documento de facturacion

Parameters

Variable Type Default Required
document SDKDtosDocumentsDocument null true
Documento base para emitir la informacion
fields array |name, |nif, |address, |city, |state, |country, |email, |mobile| false
Informacion de fields para emitir en el documento, tienen que coincidir

Example


{% import macrosCore.document as documentMacros %}
{{ documentMacros.billingInformation({
document: order,
}) }}

Related

macros/modes/{{coreMode}}/document/billingInformation.html.twig

Macro principal, importada segun el 'mode' que se haya definido en el Theme

View Helper

FWK/ViewHelpers/Document/Macro/BillingInformation.php

buttons

Configura los botones que se muestran al realizar la compra

Parameters

Variable Type Default Required
orderID int 0 false
Id de la compra
showBackButton bool true false
Muestra el boton de volver atras
showPrintButton bool true false
Muestra el boton para imprimir pdf
classList string '' false
Añade una clase html adicional
token string '' false
Pinta el documento token

Example


{% import macrosCore.document as documentMacros %}
{{ documentMacros.buttons({
orderId: controllerItem.id
}) }}

Related

macros/modes/{{coreMode}}/document/buttons.html.twig

Macro principal, importada segun el 'mode' que se haya definido en el Theme

View Helper

FWK/ViewHelpers/Document/Macro/Buttons.php

confirmOrder

Confirma la salida del pedido

Parameters

Variable Type Default Required
order SDKDtosDocumentsOrder null true
Objeto order, con la informacion del pedido realizado
confirmOrderPlugins array [] false
Objeto ElementCollection, con posibles plugins tipo CONFIRM_ORDER
showTansactionId bool true false
Muestra la id de la transaccion
showAuthNumber bool true false
Muestra el numero de autenticacion

Example


{% import macrosCore.document as documentMacros %}
{{ documentMacros.confirmOrder({
order: controllerItem,
confirmOrderPlugins: confirmOrderPlugins
}) }}

Related

macros/modes/{{coreMode}}/document/confirmOrder.html.twig

Macro principal, importada segun el 'mode' que se haya definido en el Theme

View Helper

FWK/ViewHelpers/Document/Macro/ConfirmOrder.php

document

Muestra el documento cuando se realiza la compra

Parameters

Variable Type Default Required
document SDKDtosDocumentsDocument null true
Objeto docuement, documento base a mostrar
additionalItems string FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::ADDITIONAL_ITEMS_PRESENTATION false
Añade articulos adicionales al documento de compra
mode string FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::MODE_DISCLOSURE false
Modo de la salida de la cesta
Available values

FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::MODE_DISCLOSURE

La sesta sale de forma divulgada

FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::MODE_CASH_TICKET

La cesta sale en modo billete de efectivo

linkable bool true false
Define si los productos tienen links o no
showOptions bool true false
Define si mostrar o no las opciones del producto
showOptionValuesName string FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::SHOW_OPTION_VALUES_NAME_SHOW_NAME false
Define que se muestra en las opciones del producto
Available values

FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::SHOW_OPTION_VALUES_NAME_NOT_SHOW

No mostrar el nombre de los parametros de las opciones del producto

FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::SHOW_OPTION_VALUES_NAME_SHOW_NAME

Muestra el nombre de los parametros de las opciones del producto

FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::SHOW_OPTION_VALUES_NAME_SHOW_DESCRIPTION

Mostrar descripcion de los parametros de las opciones del producto

showOptionValuesSku bool false false
Mostrar en las opciones del producto Sku
showZeroDiscount bool false false
Mostrar o no el descuento 0
showBrand bool false false
Mostrar o no la marca del producto
giftsPresentation string FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::GIFTS_PRESENTATION_PRODUCTS_BLOCK false
Define como mostrar los regalos
Available values

FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::GIFTS_PRESENTATION_PRODUCTS_BLOCK

Mostrar los productos en bloques

FWK/Core/ViewHelpers/Basket/Macro/BaseOutput::GIFTS_PRESENTATION_INDEPENDENT

Mostrar los productos independientes

showTaxDisclosure bool true false
Mostrar o no la declaracion de impuestos
showTaxIncluded bool null false
Muestra el precio con los impuestos incluidos
showTaxName bool true false
Mostrar o no el nombre de los impuestos
tableClass string '' false
Define la tabla de clases para el html
showPrices bool true false
Mostrar o no los precios
showImage bool true false
Mostrar o no las imagenes de los productos
showSku bol false false
Mostrar o no el codigo Sku del producto
showManufacturerSku bool false false
Mostrar o no el codigo Sku de la manufacturacion
showCustomTags bool false false
Mostrar o no las etiquetas personalizadas
showDevolutionButton bool false false
Muestra o no el boton para realizar devoluciones
showDiscounts bool true false
Mostrar o no los descuentos de los productos
showDiscountName bool false false
Muestra o no el nombre de los descuentos
showDiscountValue bool true false
Muestra o no el valor de los descuentos
showZeroShipping bool true false
Mostrar la los envios cero(sin contaminacion) de los productos
showZeroPayment bool true false
showFreeTaxMessage bool false false
Mostrar el mensage de libre de impuestos
showPreviousPrice bool false false
Mostrar o no el precio anterior
showPercentDifference bool false false
Mostrar o no la diferencia de precios en porcentaje
showPriceDifference bool false false
Mostrar o no la diferencia de los precios
showProductStockId bool false false
Mostrar o no el id del producto en stock
showFooter bool true false
Mostrar o no el pie de pagina
productTemplate string null false
Define la plantilla para los productos
productsBundleTemplate string null false
Define la plantilla para bundle
productsBundleItemTemplate string null false
Define la plantilla para productos en bundle
productsGiftTemplate string null false
Define la plantilla para los productos de regalo
productSelectableGiftTemplate string null false
Define la plantilla para la seleccion de productos de regalo
routeType string '' false
Define el path del tipo que es
totalProductDiscounts float 0 false
Define los descuentos totales del productos
showTaxesZeroTotalIncrement bool false false
Mostrar o no el incremento total del libre de impuestos
mergeRows bool false false
Fusiona las filas de tipo PRODUCT que sean del mismo producto pero con distintas opciones

Example


{% import macrosCore.document as documentMacros %}
{{- documentMacros.document({
document: order
}) -}}

Related

macros/modes/{{coreMode}}/document/document.html.twig

Macro principal, importada segun el 'mode' que se haya definido en el Theme

View Helper

FWK/ViewHelpers/Document/Macro/Document.php

documentInformation

Genera un documento de informacion del pedido

Parameters

Variable Type Default Required
document SDKDtosDocumentsDocument null true
Objeto documento, con la informacion base necesaria
showTransactionId bool false false
Muestra la id de la transaccion
showAuthNumber bool false false
Muestra el numero de autenticacion
documentType string FWK/ViewHelpers/Document/Macro/DocumentInformation::TYPE_ORDER false
Define el tipo del documento
Available values

FWK/ViewHelpers/Document/Macro/DocumentInformation::TYPE_ORDER

Genera un documento de tipo pedido

FWK/ViewHelpers/Document/Macro/DocumentInformation::TYPE_RMA

Genera un documento de autorizacion de devolucion de mercancia

FWK/ViewHelpers/Document/Macro/DocumentInformation::TYPE_RETURN

Genera un documento de pedido devuelto

FWK/ViewHelpers/Document/Macro/DocumentInformation::TYPE_CORRECTIVE_INVOICE

Genera un documento de factura correctiva

Example


{% import macrosCore.document as documentMacros %}
{{ documentMacros.documentInformation({
document: returns,
documentType: constant('FWKViewHelpersDocumentMacroDocumentInformation::TYPE_RETURN'),
}) }}

Related

macros/modes/{{coreMode}}/document/documentInformation.html.twig

Macro principal, importada segun el 'mode' que se haya definido en el Theme

View Helper

FWK/ViewHelpers/Document/Macro/DocumentInformation.php

headquarterInformation

Emite la informacion de la sede

Parameters

Variable Type Default Required
document SDKDtosDocumentsDocument null false
Documento base para emitir la informacion

Example


{% import macrosCore.document as documentMacros %}
{{ documentMacros.headquarterInformation({
document: controllerItem
}) }}

Related

macros/modes/{{coreMode}}/document/headquarterInformation.html.twig

Macro principal, importada segun el 'mode' que se haya definido en el Theme

View Helper

FWK/ViewHelpers/Document/Macro/HeadquarterInformation.php

rewardPoints

Muestra el resumen puntos de recompensa aplicados y/o ganados en el pedido

Parameters

Variable Type Default Required
document SDKDtosDocumentsDocument null true
Objeto document, cesta con los productos que contenga
class string '' false
Nombre de clase personalizado que se ve en el html
showHeader bool true false
Muestra o no el nombre y descripcion de los reward points
showTotalRedeemed bool true false
Muestra o no el total de points gastados
showTotalEarned bool true false
Muestra o no el total de points ganado

Example


{% import macrosCore.document as documentMacros %}
{{ documentMacros.rewardPoints({
document: session.document, rewardPoints: userRewardPoints, maxAvailableRewardPoints: {'ePoint_1': 100, 'ePoint_2': 200}
}) }}

Related

macros/modes/{{coreMode}}/document/rewardPoints.html.twig

Macro principal, importada segun el 'mode' que se haya definido en el Theme

View Helper

FWK/ViewHelpers/Document/Macro/RewardPoints.php

shippingInformation

Emite la informacion de envio si la hubiera

Parameters

Variable Type Default Required
document SDKDtosDocumentsDocument null true
Documento base para emitir la informacion
fields array |name, |nif, |address, |city, |state, |country, |email, |mobile| false
Informacion de fields para emitir en el documento, deben coincidir
pickingFields array |name, |address, |city, |state, |country, |email, |phone| false
Informacion de picking fields para emitir en el documento, deben coincidir

Example


{% import macrosCore.document as documentMacros %}
{{ documentMacros.shippingInformation({
document: controllerItem,
}) }}

Related

macros/modes/{{coreMode}}/document/shippingInformation.html.twig

Macro principal, importada segun el 'mode' que se haya definido en el Theme

View Helper

FWK/ViewHelpers/Document/Macro/ShippingInformation.php

pickingInformation

Emite la informacion de 'recogida en tienda' si la hubiera

Parameters

Variable Type Default Required
document SDKDtosDocumentsDocument null true
Documento base para emitir la informacion
fields array |name, |address, |city, |state, |country, |email, |phone| false
Informacion de fields para emitir en el documento, deben coincidir

Example


{% import macrosCore.document as documentMacros %}
{{ documentMacros.pickingInformation({
document: controllerItem,
}) }}

Related

macros/modes/{{coreMode}}/document/pickingInformation.html.twig

Macro principal, importada segun el 'mode' que se haya definido en el Theme

View Helper

FWK/ViewHelpers/Document/Macro/PickingInformation.php