Changelog

Este documento describe los cambios realizados en la documentación de la API de QRwey!. Las versiones aquí listadas corresponden a la versión del documento, no necesariamente a un cambio en el endpoint o versión de la API pública.

Se simplificaron las guías y los ejemplos para reflejar únicamente el payload mínimo necesario para timbrar cada comprobante, separando los campos requeridos de los opcionales:

• Notas de crédito y Complementos de pago: se removieron campos opcionales y valores null decorativos de los ejemplos, y se movieron a una sección Campos opcionales.
• Se aclaró que sat_payment_form y sat_payment_method no los valida el contrato pero el SAT los exige en comprobantes de Egreso (notas de crédito).
• apis/QRwey.yaml: se agregaron ejemplos propios por tipo de comprobante en POST /v1/qrs/invoices/credit-notes (tipo E) y POST /v1/qrs/invoices/payment-complements (tipo P), que antes heredaban el ejemplo genérico de Ingreso del esquema compartido.

Se corrigió la documentación del endpoint de cancelación para reflejar el contrato real del código: la cancelación se realiza por UUID fiscal (folio fiscal), no por un identificador interno de la factura.

• DELETE /v1/qrs/invoices/{uuid} — antes documentado erróneamente como /{invoiceId}

Se actualizó la referencia OpenAPI (apis/QRwey.yaml) y la guía Cancelar CFDI.

Se documentó el endpoint para obtener el XML (CFDI 4.0) de un comprobante a partir de su UUID fiscal, devuelto en Base64:

• GET /v1/qrs/invoices/uuid/{uuid}/xml — Descargar XML de CFDI en Base64

Se agregó el esquema InvoiceXmlResponse y la sección correspondiente en la guía Detalle de CFDI.

Se documentó el endpoint para obtener la representación impresa (PDF) de un CFDI a partir de su UUID fiscal, devuelta en Base64:

• GET /v1/qrs/invoices/uuid/{uuid}/pdf — Descargar PDF de CFDI en Base64

Se agregó el esquema InvoicePdfResponse y la sección correspondiente en la guía Detalle de CFDI.

Se documentó el nuevo recurso Productos de la Gestión de Clientes, con los endpoints para administrar el catálogo de productos de cada comercio:

• POST /v1/qrs/merchants/{merchantId}/products — Crear productos (acepta una lista)
• GET /v1/qrs/merchants/{merchantId}/products — Listar productos (paginado, filtro search)
• GET /v1/qrs/merchants/{merchantId}/products/{merchantProductId} — Obtener producto por ID
• PUT /v1/qrs/merchants/{merchantId}/products/{merchantProductId} — Actualizar producto

Se agregó la guía Catálogo de productos del comercio y los esquemas CreateMerchantProductRequest, UpdateMerchantProductRequest y MerchantProductResponse.

Se agregaron los siguientes campos:

• subtotal
• operation_data[x].amount

Se agregaron los siguientes campos:

• subtotal
• sat_payment_method_desc
• operation_data[x].amount
• operation_data[x].sat_unit_desc
• operation_data[x].sat_product_service_desc
• operation_data[x].sat_tax_object_desc

Estos cambios permiten devolver información más descriptiva y completa al momento de resolver un código QR.

1. Nueva cabecera Idempotency-Key
2. Nuevo campo sat_payment_method
3. Cambios en el objeto operation_data
4. Incorporación de credenciales de pruebas
5. Nueva sección taxes dentro de operation_data

Estos cambios mejoran la confiabilidad de las operaciones, agregan soporte fiscal adicional y fortalecen los flujos de integración.

• Primera versión de la especificación de la API de QRwey!
• Definición de flujos básicos de generación y resolución de códigos QR
• Estructura inicial de objetos y validaciones

• Este changelog aplica únicamente a la documentación.
• Para el contrato técnico exacto, consulta siempre la Referencia del API