Ir al contenido principal
Versión: 2.x

Datos del recibo

Administración de WP: las plantillas se editan en WP Admin → POS → Templates; esta página enumera los campos que pueden imprimir.

Para imprimir un recibo o enviarlo por correo electrónico, consulte Recibos y pantalla de pago completado; para elegir una plantilla o pedir a la IA que la modifique, consulte Personalizar el recibo.

Esta página está dirigida a quienes editan manualmente el código de una plantilla. Todas las plantillas, tanto HTML como térmicas, imprimen a partir de los mismos datos del recibo: la tienda, el pedido, los artículos, los totales y los pagos. La página explica cómo imprimir un campo, ofrece tres ejemplos habituales y enumera todos los campos.

Ir a: Buscar un campo · Ejemplos habituales · Si algo sale mal

  1. Abra la plantilla en WP Admin → POS → Plantillas (en Editar manualmente encontrará los detalles).
  2. Donde deba imprimirse el campo, escriba su ruta entre llaves dobles, como {{store.name}}, {{order.number}} o {{totals.total_display}}, o insértelo desde la lista de campos situada junto al código.
  3. Revise la vista previa debajo del código y haga clic en Actualizar para guardar.

Para una lista, como la de artículos, incluya la fila dentro de una sección para que se repita una vez por artículo:

{{#lines}}
{{name}} x {{qty}} —
{{line_total_display}}
{{/lines}}

Una sección también omite su contenido cuando el campo está vacío, es cero o es falso, por lo que {{#customer.id}}…{{/customer.id}} solo se imprime para un cliente identificado. Para imprimir importes, utilice el campo que termina en _display; consulte Campos monetarios.

Los recibos también se imprimen sin conexión: la aplicación genera una copia de los datos del recibo a partir del pedido almacenado en el dispositivo.

Por qué pueden diferir los recibos

De dónde proceden los datos​

El servidor de su tienda genera los datos del recibo de cada pedido, y la aplicación genera una copia reducida a partir del pedido almacenado en el dispositivo: no incluye cashier, ni horarios, notas o políticas de la tienda, ni totals.paid_total o totals.change_total. Las plantillas HTML y térmicas se abren de inmediato con la copia del dispositivo y pasan a utilizar la del servidor cuando llega; sin conexión, se imprime la copia del dispositivo, por lo que esos campos quedan vacíos. Con WCPOS Pro, la copia del dispositivo también incluye el logotipo de la tienda; sin Pro, el logotipo llega con la copia del servidor. Las plantillas PHP heredadas siempre se renderizan en el servidor. Por eso las plantillas utilizan los campos siguientes y nunca métodos PHP del pedido. Algunos campos solo se imprimen cuando el servidor renderiza la plantilla, como ocurre al descargar un PDF; se enumeran en Si algo sale mal.

Mapa del recibo​

Cada parte de un recibo impreso procede de una sección de los datos del recibo. Pase el puntero por una parte del recibo o por su tarjeta para resaltar ambas; haga clic o pulse cualquiera de ellas para ir a los campos de esa sección. En un teléfono, las tarjetas aparecen después del recibo en el mismo orden, de arriba abajo.

El recibo siguiente, los dos primeros ejemplos y el desglose de precios utilizan el mismo pedido de ejemplo. Los importes de sus artículos son anteriores a la aplicación del cupón (line_subtotal_display); las plantillas de recibo de la galería los imprimen después de aplicarlo (line_total_display, 26.10 para el café espresso).

Ejemplos habituales​

La mayoría de las modificaciones manuales corresponden a uno de estos dos ejemplos, que se muestran para una plantilla HTML; debajo hay un tercero sobre la reimpresión de pedidos antiguos. Cada tarjeta muestra las nuevas filas en un recibo, después su código y, por último, dónde añadirlo en la plantilla. El nombre del artículo, el importe y el TOTAL proceden del resto de la plantilla.

Utilizar estos ejemplos en una plantilla térmica

Los mismos campos y secciones funcionan sin cambios: coloque cada línea impresa en un elemento <text> y omita <s>, porque el XML térmico no admite el tachado e imprime el precio sin ese formato (Plantillas térmicas).

2 × Café espresso en grano26.10
34.00 · Ahorro −5.00
Tachar el precio normal
{{#lines}}
{{#line_savings}}
  <s>{{line_regular_total_display}}</s>
  {{i18n.savings}}:
  -{{line_savings_display}}
{{/line_savings}}
{{/lines}}
Dentro de la sección {{#lines}} existente en su plantilla, añada el bloque {{#line_savings}} después de la fila del artículo. 34.00 de precio normal − 5.00 de ahorro por oferta − 2.90 de cupón = 26.10 pagados. El bloque omite ambas filas en los pedidos sin historial de precios registrado.
TOTAL59.97
Total ahorrado10.28
Añadir una fila de total ahorrado
{{#totals.total_saved_complete}}
{{#totals.total_saved}}
  {{i18n.total_saved}}:
  {{totals.total_saved_display}}
{{/totals.total_saved}}
{{/totals.total_saved_complete}}
Añada estas líneas después de la fila TOTAL. Hay dos secciones: la fila se omite cuando el historial de precios está incompleto o cuando no hubo ningún ahorro.
Reimprimir un pedido realizado antes de WCPOS 1.9.0
1 × Café espresso en grano14.50
17.00 Descuento −2.50
Reimprimir de forma segura un pedido anterior a v1.9
{{#lines}}
{{#line_savings}}
  <s>{{line_regular_total_display}}</s>
  {{^savings_in_discounts}}
    {{i18n.savings}}:
    -{{line_savings_display}}
  {{/savings_in_discounts}}
{{/line_savings}}
{{#discounts}}
  {{i18n.discount}}:
  -{{discounts_display}}
{{/discounts}}
{{/lines}}
Para un pedido realizado antes de WCPOS 1.9.0, no para el pedido de ejemplo. Dentro de la sección {{#lines}} existente en su plantilla, añada los bloques {{#line_savings}} y {{#discounts}} después de la fila del artículo. El ahorro ya está incluido en el descuento, por lo que se imprime el descuento y se omite el ahorro.

Referencia de campos​

Despliegue una sección para ver sus campos. El primer apartado enumera todas las secciones y sus tipos.

Todas las secciones y sus tipos

Secciones de nivel superior​

SecciónContenido
order (objeto)Identificación, estado, fechas, nota e información de la URL de pago del pedido
store (objeto)Identificación, dirección, datos de contacto, identificadores fiscales, logotipo, horarios y texto del pie del recibo de la tienda
cashier (objeto)Usuario que procesó el pedido
customer (objeto)Nombre para mostrar, direcciones e identificadores fiscales del cliente
lines (matriz)Líneas de productos
fees (matriz)Filas de cargos
shipping (matriz)Filas de envío
discounts (matriz)Filas de cupones/descuentos
totals (objeto)Totales del pedido, totales de pagos, resumen de reembolsos y recuentos de artículos
tax (objeto)Indicadores del modo de visualización de impuestos para las condiciones de las secciones
tax_summary (matriz)Filas de resumen de impuestos por tipo impositivo
has_tax_summary (booleano)Condición auxiliar para tax_summary
payments (matriz)Filas de pagos
refunds (matriz)Registros de reembolso aplicados al pedido
fiscal (objeto)Campos de la instantánea fiscal que rellenan las integraciones fiscales
register (objeto)La caja que registró la venta: id y name. Cadenas vacías cuando se desconoce
software (objeto)El software que emitió el recibo: name (WCPOS), plugin_version, app_version, app_build, platform
presentation_hints (objeto)Indicaciones de formato y renderizado
i18n (objeto)Etiquetas traducidas para las plantillas incluidas y las personalizadas
Número, estado y fechas del pedido — order

order​

CampoTipoEjemplo / descripción
order.idnúmero1042
order.numbercadenaNúmero de pedido visible para el usuario, p. ej., "1042"
order.currencycadenaCódigo ISO de la moneda, p. ej., "USD"
order.customer_notecadenaNota del cliente/pedido
order.wc_statuscadenaSlug del estado de WooCommerce sin procesar, p. ej., "processing"
order.status_labelcadenaEtiqueta de estado traducida, incluidos los estados personalizados
order.created_viacadenaOrigen/canal, p. ej., "woocommerce-pos"
order.needs_paymentbooleanoIndica si debe mostrarse una sección de pago
order.payment_urlcadenaURL de pago del pedido, cuando esté disponible
order.createdobjeto de fechaFecha de creación del pedido
order.paidobjeto de fechaFecha de pago; cadenas vacías si no está pagado
order.completedobjeto de fechaFecha de finalización; cadenas vacías si no está completado
order.printedobjeto de fechaMarca de tiempo de impresión/reimpresión en el momento del renderizado
Nombre, dirección, contacto y horarios de la tienda — store

store​

CampoTipoEjemplo / descripción
store.idnúmeroID de la tienda, o ID histórico de las tiendas eliminadas
store.namecadenaNombre para mostrar de la tienda
store.address.address_1cadenaLínea 1 de la dirección postal
store.address.address_2cadenaLínea del piso/local
store.address.citycadenaCiudad/localidad
store.address.statecadenaEstado/región
store.address.postcodecadenaCódigo postal
store.address.countrycadenaCódigo ISO del país
store.address_linesmatrizLíneas de dirección con formato; recomendado para la mayoría de las plantillas
store.tax_idsmatrizIdentificadores fiscales de la empresa estructurados; recórralos en un bucle en lugar de utilizar un único identificador fiscal
store.phonecadenaTeléfono de la tienda
store.emailcadenaCorreo electrónico de la tienda
store.logocadena/nuloURL o URI de datos del logotipo de la tienda: el logotipo propio de la tienda o, en su defecto, el del sitio de WordPress, salvo que la tienda desactive esa opción. null si no hay ninguno
store.opening_hourscadena/nuloTexto compacto del horario de apertura
store.opening_hours_verticalcadena/nuloBloque de horario de apertura en varias líneas
store.opening_hours_inlinecadena/nuloTexto del horario de apertura separado por comas
store.opening_hours_notescadena/nuloNotas de texto libre sobre el horario de apertura
store.personal_notescadena/nuloPie del recibo/nota personal
store.policies_and_conditionscadena/nuloTexto sobre reembolsos, devoluciones o condiciones
store.footer_imprintcadena/nuloAviso legal al pie del recibo

Objetos de identificadores fiscales​

store.tax_ids y customer.tax_ids contienen objetos con la misma estructura:

CampoTipoDescripción
typecadenaIdentificador como eu_vat, de_steuernummer, au_abn, br_cpf, us_ein u other
valuecadenaValor del identificador fiscal que se imprimirá
countrycadena/nuloCódigo ISO del país; nulo para eu_vat y other
labelcadenaEtiqueta de visualización traducida, resuelta antes del renderizado

Ejemplo:

{{#store.tax_ids}}
{{label}}: {{value}}
{{/store.tax_ids}}
Quién atendió al cliente — cashier

cashier​

CampoTipoEjemplo / descripción
cashier.idnúmeroID de usuario de WordPress; 0 cuando se desconoce
cashier.namecadenaNombre para mostrar del cajero
Nombre, direcciones e identificadores fiscales del cliente — customer

customer​

CampoTipoEjemplo / descripción
customer.idnúmero/nuloID del cliente, o null para invitados
customer.namecadenaNombre para mostrar del cliente, o etiqueta de invitado
customer.first_namecadenaNombre de pila de la dirección de facturación, para un saludo como «Gracias, Nia». Vacío para invitados que no tengan uno
customer.billing_address.*objetoCampos de la dirección de facturación de WooCommerce
customer.shipping_address.*objetoCampos de la dirección de envío de WooCommerce
customer.tax_idsmatrizIdentificadores fiscales del cliente estructurados, capturados del pedido

Entre las claves habituales de dirección se incluyen first_name, last_name, company, address_1, address_2, city, state, postcode, country, email y phone.

Artículos vendidos — lines

lines​

Recorra la matriz con {{#lines}}...{{/lines}}. Los valores de ejemplo corresponden a la línea de café espresso del pedido de ejemplo.

Cada campo monetario tiene dos versiones: el número, para una sección {{#…}} (cero y null la ocultan, y un campo null no tiene campo _display), y el texto _display, para imprimir. Los campos marcados como incl/excl también tienen versiones _incl y _excl, cada una con su propio _display.

keycadena
Clave estable de la línea / ID del artículo del pedido.
key"412"
skucadena
SKU del producto.
sku"ESP-500"
namecadena
Nombre para mostrar del producto o de la línea.
name"Espresso Beans"
qtynúmero
Cantidad vendida.
qty2
qty_refundednúmero
Cantidad reembolsada de esta línea.
qty_refunded0
regular_pricenúmerodineroadmite nulosincl./excl.
Precio normal unitario registrado. null en los pedidos sin historial de precios de WCPOS; inclúyalo en una sección.
regular_price17
regular_price_display"$17.00"
selling_pricenúmerodineroadmite nulosincl./excl.
Precio de venta unitario antes del cupón: el precio registrado en WCPOS, si está disponible; en caso contrario, se deriva del subtotal almacenado de la línea.
selling_price14.5
selling_price_display"$14.50"
unit_savingsnúmerodineroadmite nulosincl./excl.
Precio normal menos precio de venta, con un mínimo de cero. Cero se evalúa como falso, por lo que las filas condicionadas se ocultan.
unit_savings2.5
unit_savings_display"$2.50"
line_regular_totalnúmerodineroadmite nulosincl./excl.
Precio normal registrado multiplicado por la cantidad.
line_regular_total34
line_regular_total_display"$34.00"
line_selling_totalnúmerodineroadmite nulosincl./excl.
Precio de venta antes del cupón multiplicado por la cantidad.
line_selling_total29
line_selling_total_display"$29.00"
line_savingsnúmerodineroadmite nulosincl./excl.
Ahorro total entre el precio normal y el de venta para esta línea.
line_savings5
line_savings_display"$5.00"
savings_in_discountsbooleano
Verdadero cuando el ahorro de la línea ya está incluido en discounts, como en los pedidos realizados antes de v1.9.0. Utilícelo para que el ahorro no se imprima dos veces.
savings_in_discountsfalse
unit_subtotalnúmerodineroincl./excl.
Valor unitario de WooCommerce antes de los descuentos. No lo utilice como precio normal.
unit_subtotal14.5
unit_subtotal_display"$14.50"
unit_pricenúmerodineroincl./excl.
Valor unitario final después de los descuentos de WooCommerce.
unit_price13.05
unit_price_display"$13.05"
line_subtotalnúmerodineroincl./excl.
Antes del cupón: subtotal de la línea de WooCommerce antes de los descuentos, el importe que aparece junto a cada artículo en el recibo de ejemplo anterior.
line_subtotal29
line_subtotal_display"$29.00"
discountsnúmerodineroincl./excl.
Descuento nativo de WooCommerce para la línea, como valor positivo; en los pedidos actuales solo incluye cupones.
discounts2.9
discounts_display"$2.90"
line_totalnúmerodineroincl./excl.
Después del cupón: total final de la línea, el que imprimen las plantillas de recibo de la galería junto a cada artículo.
line_total26.1
line_total_display"$26.10"
total_refundednúmerodinero
Total reembolsado de esta línea como valor positivo.
total_refunded0
total_refunded_display""
taxesmatriz
Filas de impuestos por tipo impositivo para esta línea.
—
metamatriz
Metadatos del artículo del pedido como pares {key, value}.
—
attributesmatriz
Atributos del producto/variación como pares {key, value}.
—

Mostrar el precio normal y el ahorro​

En un diseño con precios unitarios, muestre el precio normal registrado, el precio de venta y el ahorro de esta manera:

{{#lines}}
{{#unit_savings}}
<span style="text-decoration: line-through;">{{regular_price_display}}</span>
<span>{{selling_price_display}}</span>
<span>{{i18n.savings}}: -{{unit_savings_display}}</span>
{{/unit_savings}}
{{/lines}}

Utilice los campos de total de línea cuando la cantidad sea relevante:

{{#lines}}
{{#line_savings}}
<span style="text-decoration: line-through;">{{line_regular_total_display}}</span>
<span>{{i18n.savings}}: -{{line_savings_display}}</span>
{{/line_savings}}
{{/lines}}

selling_price es el precio antes de los cupones. Utilice unit_price o line_total para el importe final después de los descuentos de WooCommerce.

Reimpresión de pedidos creados antes de v1.9.0

Los pedidos antiguos de WCPOS pueden incluir ya la reducción del precio normal al precio de venta en discounts. Si su plantilla personalizada imprime tanto el ahorro como el descuento de la línea, utilice savings_in_discounts para evitar mostrar la misma reducción dos veces:

{{#lines}}
{{#line_savings}}
<span style="text-decoration: line-through;">{{line_regular_total_display}}</span>
{{^savings_in_discounts}}
<span>{{i18n.savings}}: -{{line_savings_display}}</span>
{{/savings_in_discounts}}
{{/line_savings}}
{{#discounts}}
<span>{{i18n.discount}}: -{{discounts_display}}</span>
{{/discounts}}
{{/lines}}

Si la plantilla no imprime una fila discounts por línea, siga mostrando line_savings aunque savings_in_discounts sea verdadero. Las plantillas incluidas gestionan esta distinción automáticamente.

Cargos y envío — fees, shipping

fees y shipping​

Recorra las matrices con {{#fees}}...{{/fees}} y {{#shipping}}...{{/shipping}}.

CampoTipoDescripción
labelcadenaEtiqueta del cargo o nombre del método de envío
method_idcadenaID del método de envío (solo para envíos)
total / _incl / _exclnúmeroTotales según la configuración de visualización, con impuestos y sin impuestos
taxesmatrizFilas de impuestos por tipo impositivo
metamatrizPares de metadatos {key, value}

Variantes con formato: total_display, total_incl_display y total_excl_display.

Cupones y descuentos — discounts

discounts​

Recorra la matriz con {{#discounts}}...{{/discounts}}.

CampoTipoDescripción
labelcadenaDescripción del cupón o, en su defecto, su código. Un descuento añadido en el carrito de WCPOS muestra Discount, o Discount (10%) si es porcentual
codecadenaCódigo del cupón
discount_typecadenaSlug del tipo de cupón de WooCommerce, por ejemplo, fixed_cart, percent o fixed_product. Vacío cuando el cupón ya no existe.
total / _incl / _exclnúmeroImporte del descuento como valor positivo

Variantes con formato: total_display, total_incl_display y total_excl_display. Añada un signo menos en la plantilla si desea que los descuentos aparezcan como filas negativas.

discount_type se añadió en la v1.2 de Datos del recibo. Las instantáneas de recibos fiscales capturadas antes no lo incluyen.

Totales, importes pagados, reembolsos y recuentos de artículos — totals

totals​

Los valores proceden del pedido de ejemplo, que posteriormente recibió un reembolso parcial de $7.25.

Los campos monetarios siguen el mismo esquema de pares que las líneas de artículos: un número sin formato para las condiciones y una cadena _display para imprimir, con variantes _incl/_excl donde se indica.

subtotalnúmerodineroincl./excl.
Subtotal del pedido antes de los descuentos.
subtotal52.75
subtotal_display"$52.75"
discount_totalnúmerodineroincl./excl.
Descuento total del pedido como valor positivo; en los pedidos actuales solo incluye cupones.
discount_total5.28
discount_total_display"$5.28"
sale_savings_totalnúmerodineroadmite nulosincl./excl.
Ahorro total registrado entre el precio normal y el de venta en las líneas de productos, incluidas las ofertas del catálogo y los cambios de precio en caja.
sale_savings_total5
sale_savings_total_display"$5.00"
total_savednúmerodineroadmite nulosincl./excl.
Suma de los descuentos de WooCommerce y del ahorro respecto al precio normal, sin las duplicaciones de versiones anteriores. Una única cifra para mostrar al cliente todo lo ahorrado.
total_saved10.28
total_saved_display"$10.28"
total_saved_completebooleano
Indica si el recibo dispone de suficientes datos de precios registrados para calcular los totales completos de ahorro.
total_saved_completetrue
tax_totalnúmerodinero
Importe total de impuestos.
tax_total0
tax_total_display"$0.00"
totalnúmerodineroincl./excl.
Total general del pedido según la configuración de visualización de impuestos: si los precios se muestran sin impuestos, es el total menos los impuestos. total_incl siempre es el importe cobrado.
total59.97
total_display"$59.97"
paid_totalnúmerodinero
Importe pagado / aplicado.
paid_total59.97
paid_total_display"$59.97"
change_totalnúmerodinero
Cambio devuelto al cliente.
change_total0
change_total_display""
refund_totalnúmerodinero
Total reembolsado como valor positivo.
refund_total7.25
refund_total_display"$7.25"
net_totalnúmerodinero
Total menos reembolsos, con un mínimo de cero. 0 cuando no hubo reembolsos, por lo que debe condicionarse con refund_total.
net_total52.72
net_total_display"$52.72"
total_qtynúmero
Suma de las cantidades de las líneas de artículos.
total_qty4
line_countnúmero
Número de filas de líneas de productos.
line_count3

Utilice total_saved cuando desee mostrar al cliente una única cifra con todo lo ahorrado. No lo calcule sumando discount_total y sale_savings_total en la plantilla: los pedidos creados antes de v1.9.0 pueden incluir ya el ahorro de precio de WCPOS en el descuento total de WooCommerce. El campo canónico total_saved detecta y elimina esa duplicación.

Los totales de ahorro son null y total_saved_complete es falso cuando alguna línea de producto carece de suficientes datos de precios registrados para obtener un total fiable. Condicione la fila con total_saved_complete y después utilice total_saved para ocultar los valores de cero:

{{#totals.total_saved_complete}}
{{#totals.total_saved}}
<span>{{i18n.total_saved}}: {{totals.total_saved_display}}</span>
{{/totals.total_saved}}
{{/totals.total_saved_complete}}

Las plantillas incluidas imprimen Total ahorrado a partir de la variante con impuestos, totals.total_saved_incl_display, dentro de una única condición {{#totals.total_saved_incl}}. Esa condición es suficiente porque el valor es null cuando el historial de precios está incompleto y cero cuando no hubo ahorro.

Filas de impuestos — tax, tax_summary

tax y tax_summary​

Utilice tax para las condiciones del modo de visualización y tax_summary para las filas desglosadas por tipo impositivo.

Campo de impuestosTipoDescripción
tax.displaycadenaincl o excl
tax.display_inclbooleanoVerdadero cuando los precios se muestran con impuestos
tax.display_exclbooleanoVerdadero cuando los precios se muestran sin impuestos
tax.breakdowncadenahidden, single o itemized
tax.breakdown_hiddenbooleanoVerdadero cuando deben ocultarse las filas de impuestos
tax.breakdown_singlebooleanoVerdadero cuando se prefiere un único total de impuestos
tax.breakdown_itemizedbooleanoVerdadero cuando se prefieren filas por tipo impositivo
has_tax_summarybooleanoVerdadero cuando tax_summary contiene filas

Recorra tax_summary con {{#tax_summary}}...{{/tax_summary}}.

CampoTipoDescripción
codecadenaID/código del tipo impositivo
ratenúmero/nuloPorcentaje del tipo impositivo, cuando se haya resuelto
labelcadenaEtiqueta del tipo impositivo
compoundbooleanoIndica si el tipo impositivo es compuesto
taxable_amount_exclnúmero/nuloBase imponible sin impuestos
tax_amountnúmeroImpuestos recaudados
taxable_amount_inclnúmero/nuloBase imponible con impuestos

Variantes con formato: taxable_amount_excl_display, tax_amount_display y taxable_amount_incl_display.

Pagos recibidos — payments

payments​

Recorra la matriz con {{#payments}}...{{/payments}}.

CampoTipoDescripción
method_idcadenaIdentificador del método de pago
method_titlecadenaTítulo para mostrar del método de pago
amountnúmeroImporte aplicado al pedido
transaction_idcadenaID de transacción de la pasarela de pago
tenderednúmeroImporte en efectivo entregado, cuando esté presente
changenúmeroCambio devuelto en efectivo, cuando esté presente

Variantes con formato: amount_display, tendered_display y change_display.

Reembolsos — refunds

refunds​

Recorra la matriz con {{#refunds}}...{{/refunds}}. Los importes de los reembolsos son números positivos: la plantilla añade un signo menos o los imprime en un bloque propio de artículos devueltos.

CampoTipoDescripción
idnúmeroID del registro de reembolso
dateobjeto de fechaFecha de creación del reembolso
amountnúmeroTotal del reembolso
subtotalnúmeroSubtotal de las líneas reembolsadas
tax_totalnúmeroImpuestos reembolsados
shipping_totalnúmeroImporte de envío reembolsado
shipping_taxnúmeroImpuestos de envío reembolsados
reasoncadenaMotivo del reembolso
refunded_by_idnúmero/nuloID del usuario que emitió el reembolso
refunded_by_namecadenaNombre para mostrar del usuario que emitió el reembolso
refunded_paymentbooleanoIndica si el pago se reembolsó a través de la pasarela de pago
destinationcadenaDestino del dinero devuelto: original_method, cash o manual para un reembolso realizado en WCPOS; vacío en los demás casos
gateway_idcadenaID de la pasarela de pago utilizada para el reembolso
gateway_titlecadenaTítulo para mostrar de la pasarela de pago
processing_modecadenaModo de procesamiento del proveedor/manual
linesmatrizFilas de productos reembolsados
feesmatrizFilas de cargos reembolsados
shippingmatrizFilas de envíos reembolsados

Los campos de las líneas de reembolso incluyen name, sku, qty, total, total_incl, total_excl y taxes; las plantillas renderizadas en la aplicación WCPOS también reciben line_total y unit_total. Las filas de cargos y envíos reembolsados utilizan label, total, total_incl, total_excl y taxes, y las filas de envío añaden method_id. Se añaden variantes de visualización para los totales y los importes de impuestos.

Registros fiscales — fiscal

fiscal​

Las integraciones fiscales y WCPOS Pro rellenan los campos de identificación, como el número de recibo, el hash y el contenido del QR. Los campos del documento indican qué tipo de documento se está imprimiendo, de modo que una plantilla puede imprimir un reembolso o un informe de caja de forma distinta a una venta.

CampoTipoDescripción
fiscal.document_typecadenasale de forma predeterminada; también refund, void, cancellation, closure, xreport o handover
fiscal.is_sale_documentbooleanoVerdadero para una venta. Utilice los indicadores is_… como condiciones de sección
fiscal.is_refund_documentbooleanoVerdadero para un reembolso
fiscal.is_void_documentbooleanoVerdadero para una anulación: una venta cancelada antes de completarse
fiscal.is_cancellation_documentbooleanoVerdadero para una cancelación: una venta completada que se cancela posteriormente
fiscal.is_closure_documentbooleanoVerdadero para un cierre de caja
fiscal.is_x_reportbooleanoVerdadero para un informe X
fiscal.is_handoverbooleanoVerdadero para un comprobante de entrega de caja
fiscal.correctscadenaEn un reembolso, la identificación de la venta que corrige
fiscal.sale_timeobjeto de fecha/nuloMomento en que la caja registró la venta, en la zona horaria de la caja
fiscal.sale_tzcadenaZona horaria de la caja, p. ej., "Europe/Berlin"
fiscal.received_atobjeto de fecha/nuloMomento en que el servidor de la tienda recibió la venta
fiscal.sale_counternúmero/nuloContador de ventas propio de la caja
fiscal.immutable_idcadenaIdentificador fiscal inmutable
fiscal.receipt_numbercadenaNúmero de recibo fiscal
fiscal.sequencenúmero/nuloContador de secuencia
fiscal.hashcadenaValor de hash/firma
fiscal.qr_payloadcadenaContenido del QR para la verificación fiscal
fiscal.tax_agency_codecadenaCódigo de la autoridad tributaria
fiscal.signed_atcadenaMarca de tiempo de la firma fiscal
fiscal.signature_excerptcadenaFirma truncada para su visualización
fiscal.document_labelcadenaEtiqueta del documento, p. ej., Factura fiscal
fiscal.is_reprintbooleanoIndica si este renderizado es una reimpresión
fiscal.reprint_countnúmeroNúmero de reimpresiones
fiscal.extra_fieldsmatriz/objetoValores específicos de la jurisdicción, normalmente una lista de filas {label, value}

Imprima los campos adicionales con un bucle:

{{#fiscal.extra_fields}}
{{label}}: {{value}}
{{/fiscal.extra_fields}}
Formato — presentation_hints

presentation_hints​

Estos campos están destinados principalmente a la aplicación y al servidor, que los utilizan para dar formato al recibo. Las plantillas renderizadas por el servidor pueden imprimirlos todos; las plantillas renderizadas en la aplicación WCPOS solo reciben display_tax, prices_entered_with_tax, rounding_mode, locale y order_barcode_type.

CampoTipoDescripción
presentation_hints.display_taxcadenaincl o excl. Lo rellena la aplicación; el servidor lo omite
presentation_hints.hour12booleano/nuloVerdadero cuando el formato de hora de la tienda utiliza un reloj de 12 horas
presentation_hints.hour_tokencadena/nuloPatrón de hora del formato horario de la tienda: h, hh, H o HH
presentation_hints.prices_entered_with_taxbooleanoIndica si los precios del catálogo incluyen impuestos
presentation_hints.rounding_modecadenaAjuste de redondeo de impuestos de WooCommerce
presentation_hints.localecadenaConfiguración regional utilizada para el formato
presentation_hints.timezonecadenaZona horaria del recibo
presentation_hints.currency_positioncadenaPosición del símbolo de moneda
presentation_hints.currency_symbolcadenaSímbolo de moneda
presentation_hints.price_thousand_separatorcadenaSeparador de miles
presentation_hints.price_decimal_separatorcadenaSeparador decimal
presentation_hints.price_num_decimalsnúmeroNúmero de decimales
presentation_hints.price_display_suffixcadenaSufijo de visualización del precio de WooCommerce
presentation_hints.order_barcode_typecadenaTipo de código de barras para una plantilla que lo utilice: code128 (predeterminado), qrcode, ean13, ean8 o upca. Lo rellena la aplicación; el servidor lo omite, y las plantillas de la galería establecen el tipo de código de barras en la propia plantilla

Los campos monetarios con formato previo (los valores *_display, como totals.total_display) muestran los importes con el símbolo de moneda de la moneda del pedido, utilizando la posición y los separadores anteriores; por eso los recibos muestran $12.00, no USD 12.00. El campo sin procesar order.currency conserva el código ISO para cualquier lógica de la plantilla.

Textos del recibo — i18n

i18n​

Utilice etiquetas i18n en lugar de escribir texto fijo siempre que sea posible:

{{i18n.order}} #{{order.number}}
{{i18n.cashier}}: {{cashier.name}}
{{i18n.total}}: {{totals.total_display}}

Entre las claves habituales se incluyen order, date, cashier, customer, item, sku, qty, unit_price, regular_price, selling_price, savings, discount, subtotal, total_saved, total, tax, paid, tendered, change, tax_summary, refunded, net_total, customer_note, thank_you_purchase, opening_hours, las etiquetas fiscales copy (imprime COPIA), reprint, register, sale_time, software, document_refund, document_void y document_cancellation, y las claves de etiquetas de identificadores fiscales, como store_tax_id_label_eu_vat y customer_tax_id_label_other. Las extensiones pueden añadir claves adicionales.

Cómo se relacionan los precios​

Un artículo del recibo tiene varios precios, y sus nombres se entienden mejor al ver los propios importes. Esta es la línea de café espresso del pedido de ejemplo: un producto de $17.00 en oferta a $14.50, con un cupón adicional del 10%:

Café espresso en grano — una unidad (el pedido tiene dos)
0precio normal 17.00
Lo que paga el clienteunit_price → 13.05 · line_total → 26.10
Descuento del cupón (SUMMER10)lines[].discounts → 2.90 en esta línea
Ahorro respecto al precio normalunit_savings → 2.50 · line_savings → 5.00
Ahorro por ofertas en todo el pedidototals.sale_savings_total = 5.00
Todos los descuentos de cupones del pedidototals.discount_total = 5.28
Ahorro + descuentos, sin duplicaciones de versiones anteriorestotals.total_saved = 10.28

El ahorro por oferta es la diferencia entre el precio normal y el precio de venta. El descuento es lo que resta un cupón según el cálculo de WooCommerce. Los totales de pedidos y los informes de WooCommerce solo contienen los descuentos, por lo que total_saved suma ambos conceptos en una única cifra para el cliente.

Reglas de renderizado​

Cómo se imprimen los importes, los precios con o sin impuestos y las fechas. Abra el apartado que necesite.

Imprimir importes y ocultar los de valor cero

Campos monetarios​

Los campos monetarios siguen siendo números, y cada uno tiene un campo _display con formato según el idioma y la moneda de la tienda:

Campo numéricoCampo de visualización
totals.totaltotals.total_display
lines[].line_totallines[].line_total_display
payments[].amountpayments[].amount_display
tax_summary[].tax_amounttax_summary[].tax_amount_display

Imprima el campo _display. Utilice el número solo para una sección o para una salida legible por máquinas: {{#totals.change_total}}…{{/totals.change_total}} omite su fila cuando el importe es cero.

Imprimir precios con o sin impuestos

Campos que respetan la visualización de impuestos​

Varios campos tienen tres versiones: con impuestos (_incl), sin impuestos (_excl) y una sin sufijo que sigue el ajuste de la tienda para mostrar los precios del carrito con o sin impuestos.

Campo auxiliarCampo con impuestosCampo sin impuestos
lines[].regular_pricelines[].regular_price_incllines[].regular_price_excl
lines[].selling_pricelines[].selling_price_incllines[].selling_price_excl
lines[].unit_savingslines[].unit_savings_incllines[].unit_savings_excl
lines[].line_regular_totallines[].line_regular_total_incllines[].line_regular_total_excl
lines[].line_selling_totallines[].line_selling_total_incllines[].line_selling_total_excl
lines[].line_savingslines[].line_savings_incllines[].line_savings_excl
lines[].unit_pricelines[].unit_price_incllines[].unit_price_excl
lines[].unit_subtotallines[].unit_subtotal_incllines[].unit_subtotal_excl
lines[].line_subtotallines[].line_subtotal_incllines[].line_subtotal_excl
lines[].discountslines[].discounts_incllines[].discounts_excl
lines[].line_totallines[].line_total_incllines[].line_total_excl
fees[].totalfees[].total_inclfees[].total_excl
shipping[].totalshipping[].total_inclshipping[].total_excl
discounts[].totaldiscounts[].total_incldiscounts[].total_excl
totals.subtotaltotals.subtotal_incltotals.subtotal_excl
totals.discount_totaltotals.discount_total_incltotals.discount_total_excl
totals.sale_savings_totaltotals.sale_savings_total_incltotals.sale_savings_total_excl
totals.total_savedtotals.total_saved_incltotals.total_saved_excl
totals.totaltotals.total_incltotals.total_excl
Imprimir fechas y horas

Objetos de fecha​

Cada fecha se ofrece ya formateada de varias maneras, por lo que la plantilla nunca necesita darle formato.

CampoDescripción
datetime, date, timeCadenas predeterminadas de fecha/hora
datetime_short, datetime_long, datetime_fullFormatos combinados adaptados a la configuración regional
date_short, date_long, date_fullFormatos solo de fecha adaptados a la configuración regional
date_ymd, date_dmy, date_mdyFormatos de fecha con orden fijo
weekday_short, weekday_longNombres de los días
day, month, month_short, month_long, yearComponentes individuales de la fecha

Objetos de fecha disponibles: order.created, order.paid, order.completed, order.printed, refunds[].date, fiscal.sale_time y fiscal.received_at. order.printed se actualiza al renderizar, lo que resulta útil para las reimpresiones. Las dos fechas de fiscal son null cuando el recibo no tiene registro fiscal, por lo que deben incluirse en una sección.

Ampliar los datos del recibo​

Un plugin puede añadir sus propios campos a los datos del recibo mediante el filtro wcpos_receipt_data.

El filtro: sus argumentos, los seis modos y un ejemplo

WCPOS mantiene los campos anteriores libres de datos específicos de plugins. Cuando un plugin necesita que el recibo contenga información que WooCommerce no contempla, la añade mediante el filtro wcpos_receipt_data, del mismo modo que los plugins filtran los propios totales de pedidos de WooCommerce. El filtro se ejecuta en cada recibo que genera el servidor: recibos en tiempo real, instantáneas fiscales en el momento del pago, descargas de PDF y plantillas PHP heredadas. Antes de WCPOS 2.0, este filtro se llamaba woocommerce_pos_receipt_data; ese nombre sigue funcionando, pero está obsoleto desde 2.0 y se eliminará como pronto en 2.2 (consulte Nombres de los hooks).

El tercer argumento, $mode, indica qué documento se está generando: live, fiscal, refund, preview (recibos de ejemplo del editor de plantillas y la galería), closure o xreport (documentos de cierre de caja e informe X). En preview, closure y xreport, el pedido no está guardado y su ID es 0; un plugin que necesite un pedido guardado debe devolver $data sin cambios cuando $order->get_id() sea 0.

add_filter( 'wcpos_receipt_data', function ( array $data, WC_Abstract_Order $order, string $mode ) {
foreach ( $data['discounts'] as &$row ) {
if ( 'smart_coupon' === $row['discount_type'] ) {
$row['gift_card'] = true;
}
}
return $data;
}, 10, 3 );

La plantilla puede entonces utilizar la nueva clave como condición, igual que en cualquier otra sección:

{{#discounts}}
{{#gift_card}}Gift Card{{/gift_card}}{{^gift_card}}{{i18n.discount}}{{/gift_card}}{{#label}}: {{label}}{{/label}}
{{/discounts}}

Las claves definidas en el esquema deben conservar sus tipos documentados. Las claves añadidas no forman parte del esquema, por lo que no aparecen en el selector de campos del editor de plantillas, y las instantáneas fiscales solo contienen lo que el filtro añadió en el momento del pago del pedido. El filtro está disponible desde WCPOS 1.10.8.

Qué recibos imprimen una clave añadida

Todas las claves añadidas llegan a los recibos que renderiza el propio servidor: descargas de PDF y plantillas PHP heredadas. Las plantillas HTML y térmicas renderizadas en la aplicación WCPOS reconstruyen primero los datos: una clave añadida dentro de order, store, cashier o customer se conserva, pero una añadida en cualquier otro lugar, como en la fila de descuentos anterior, se omite. En un recibo en tiempo real con una instantánea fiscal, la identificación fiscal, register y software se copian de la instantánea después de ejecutar el filtro, por lo que modificarlos en este filtro no tiene efecto; amplíe la instantánea en su lugar.

Si algo sale mal​

Una fila imprime $0.00 en un recibo y nada en otro. Algunos campos _display, como totals.change_total_display, totals.refund_total_display y payments[].tendered_display, están vacíos cuando su valor es cero si el servidor renderiza el recibo, y muestran $0.00 si lo hace la aplicación. Incluya la fila en una sección condicionada por el número para que se omita en ambos casos: {{#totals.change_total}}…{{/totals.change_total}}.

Falta la fila Total ahorrado. totals.total_saved_complete es falso: al menos un artículo no tiene un precio normal registrado, por lo que no puede calcularse el ahorro. Suele ocurrir con pedidos registrados antes de WCPOS 1.9.0.

El total es inferior a lo que pagó el cliente. La tienda muestra los precios sin impuestos, por lo que totals.total es el total antes de impuestos. Imprima totals.total_incl_display para mostrar el importe cobrado. El recibo PHP heredado incluido en WCPOS imprime ese importe.

Un campo se imprime en la descarga de PDF, pero no en WCPOS. Las plantillas renderizadas en la aplicación reconstruyen primero los datos y omiten algunos campos, que solo se imprimen en las descargas de PDF y las plantillas PHP heredadas. Imprima los campos de la lista siguiente solo en esos casos, o condiciónelos con una sección para que el recibo de WCPOS los omita.

Campos que difieren entre los recibos en PDF y los de WCPOS
  • lines[].attributes, lines[].total_refunded_display y lines[].unit_subtotal_display (con sus variantes _incl y _excl)
  • software.platform
  • presentation_hints salvo display_tax, prices_entered_with_tax, rounding_mode, locale y order_barcode_type
  • identificadores fiscales del cliente de tipo alemán, neerlandés, francés, de empresa del Reino Unido y suizo
  • claves que un plugin añade fuera de order, store, cashier y customer; consulte Ampliar los datos del recibo

Versiones​

Los datos del recibo tienen su propio número de versión, independiente del plugin. Los recibos antiguos, como una instantánea fiscal capturada antes de que existiera un campo, carecen de los campos más recientes; por eso deben condicionarse con una sección.

VersiónIncorporaciones
1.1Precio normal, precio de venta y ahorro de cada artículo, y totales de ahorro del pedido, incluido Total ahorrado. Ninguno modifica los totales del pedido ni los informes de WooCommerce
1.2discounts[].discount_type
1.3customer.first_name y las etiquetas de visualización del cliente en i18n
1.4register, software, los campos del documento fiscal (fiscal.document_type, los indicadores is_…, sale_time, received_at, sale_tz, sale_counter, corrects) y sus etiquetas i18n