Desarrolladores
Registro de cambios de la API
Cada cambio del contrato /v1: endpoints y campos nuevos, correcciones y obsolescencias. Un cambio dentro de /v1 nunca rompe un cliente que ignora los campos desconocidos.
Política de versiones
Dentro de /v1 nada se elimina ni se renombra, y lo que funcionaba sigue funcionando. Un cambio que rompe llega como una versión nueva, anunciada acá con anticipación.
Versiones de la API →Seguí los cambios
Suscribite al feed Atom en tu lector de feeds o en el chat de tu equipo: cada entrada nueva aparece ahí el mismo día en que se publica.
Feed Atom
Corrección
Las listas devuelven los registros cuya referencia vació una eliminación
Cuando eliminar un registro relacionado vaciaba una referencia de un registro de la lista (el tax_class_id de un producto al eliminar su clase impositiva, el location_id de una cuenta de dinero al eliminar su sucursal) o borraba una de sus filas anidadas (una línea de comprobante de proveedor, de recepción, de devolución al proveedor o de liquidación de consignación, una categoría del producto), el registro no avanzaba en el feed de cambios ni emitía .updated, y la copia de la integración se quedaba con el valor viejo. Ahora ese registro llega en la siguiente sincronización por cursor y, en los recursos con evento .updated, también como evento. El feed no repite los cambios anteriores a esta fecha: si tu copia guarda esas referencias o filas anidadas, leé una vez las listas indicadas de nuevo sin cursor.
Endpoints
- get
/ordersListar los pedidos cambiados desde un momento dado: ítems, totales, estado del pedido y estado del pago - get
/paymentsListar los pagos de pedidos cambiados desde un momento dado - get
/refundsListar las devoluciones de pedidos cambiadas desde un momento dado: ítems y movimientos por pago - get
/customersListar los clientes cambiados desde un momento dado: contactos, consentimiento de marketing, direcciones y grupos; búsqueda por teléfono, email y grupo - get
/locationsListar los locales de la tienda disponibles para la aplicación - get
/categoriesListar las categorías del catálogo cambiadas desde un momento dado - get
/productsListar los productos: categorías, opciones y fotos, sin variantes - get
/variantsListar las variantes: SKU, códigos de barras, precios y unidades - get
/modifier-groupsListar los grupos de modificadores con opciones cambiados desde el momento indicado - get
/recommendation-rulesListar las reglas de recomendaciones cambiadas desde un momento dado - get
/media-importsListar las descargas de fotos por dirección cambiadas desde un momento dado: pendientes, descargadas o con error - get
/lotsLotes de producto: número, vencimiento y estado, modificados desde un momento dado - get
/location-transfersTraslados de mercadería entre locales con sus líneas, modificados desde un momento dado - get
/fiscal-documentsListar los comprobantes fiscales cambiados desde un momento: facturas, notas de crédito y de débito en todos los estados - get
/money-accountsListar las cuentas de dinero de la tienda con su saldo actual: caja, banco, adquirente, billetera - get
/money-categoriesListar las categorías de movimientos de dinero: el árbol de ingresos y egresos con los códigos de las categorías del sistema - get
/pos-cash-movementsDiario del cajón: ventas y devoluciones en efectivo, ingresos, retiros, depósitos en la caja fuerte, cambio y anulaciones - get
/gift-cardsTarjetas de regalo: valor nominal, saldo y deuda de la tienda por cada tarjeta - get
/gift-card-transactionsMovimientos de tarjetas de regalo: emisión, canje, devolución a la tarjeta, ajuste, anulación, bloqueo y traspaso de saldo - get
/supplier-billsComprobantes de proveedores: facturas, notas y deudas por entregas sin factura, con impuestos y líneas - get
/goods-receiptsRecepciones: ingresos de mercadería del proveedor con líneas, precios del remito y correcciones - get
/supplier-returnsDevoluciones a proveedores: mercadería enviada de vuelta y su compensación - get
/consignment-settlementsLiquidaciones de consignación: mercadería en consignación vendida, dada de baja a cargo de la tienda y reajustada en un período
- get
Cambio
Retenciones al pagar comprobantes de proveedor: jurisdicción y moneda
En POST /v1/supplier-bills/{supplier_bill}/payments/out-of-band, una retención turnover o municipal sin jurisdiction ahora se rechaza con 422: esa retención no entraba en la declaración de ninguna provincia. El importe de la retención sigue en la moneda del comprobante y se descuenta del pago al proveedor. Si el comprobante está en otra moneda, tax-withholdings recibe el importe y la base equivalentes en la moneda de la tienda a la cotización del día del pago; antes recibía el número en la moneda del comprobante. Sin cotización para ese día, el pago con retenciones se rechaza con 422.
Endpoints
Nuevo
Traslados entre tiendas del grupo en el diario de stock
El diario de movimientos de stock incorpora los motivos group_transfer_out (envío a otra tienda del grupo), group_transfer_in (recepción desde ella) y group_transfer_return (el faltante de un traslado volvió al stock del remitente) y el tipo de documento group_transfer — la copia del traslado de esta tienda. El filtro document_type=group_transfer devuelve los movimientos de un traslado. /v1 no tiene un recurso propio de traslados.
Endpoints
Nuevo
Comprobante de la caja externa en pedidos
Los pedidos sumaron el campo external_fiscal_document: el comprobante de la venta en una caja externa (FuDo, Poster) que lo emite en lugar de nosotros, con la caja (issuer), el estado pending o issued y el número. El campo llega con el scope fiscal:read; esos pedidos no tienen comprobantes fiscales. Cuando el comprobante aparece o se emite, el pedido avanza en el feed y llega el evento order.updated; los pedidos con historial reciben el campo en una sola carga y también vuelven a pasar por el feed. La operación masiva orders.export incluye el campo si la operación se creó con el scope fiscal:read.
Endpoints
Nuevo
Escritura de comprobantes fiscales
Nuevos scopes fiscal:write y fiscal:annul. Con fiscal:write, POST /v1/orders/{order}/invoice emite la factura de una venta cerrada, POST /v1/fiscal-documents/{document}/reissue reemite un comprobante tras una falla o un rechazo del fisco (una factura rechazada, con receptor corregido o refresh_receptor) y POST /v1/fiscal-documents/{document}/dismiss saca de control un comprobante rechazado. Con fiscal:annul, POST /v1/fiscal-documents/{document}/annul anula una factura emitida con una nota de crédito y un motivo reason. La emisión va al fisco en segundo plano: la respuesta es 202 con el comprobante y el resultado llega con los eventos fiscal_document.issued y fiscal_document.failed. Los comandos que van al fisco exigen el encabezado Idempotency-Key: sin él, 422 idempotency_key_required. Nuevos rechazos invoice_issue_refused, fiscal_document_reissue_refused, fiscal_document_dismiss_refused y fiscal_document_annul_refused. El comprobante fiscal sumó el objeto dismissal y annulment sumó comment; annulment.reason ahora es order_cancelled, advance_applied o manual: la lista anterior describía otros motivos.
Endpoints
- post
/orders/{order}/invoiceEmitir la factura de una venta cerrada: la emisión corre en segundo plano y el resultado llega como evento - post
/fiscal-documents/{document}/reissueReemitir un comprobante tras una falla o un rechazo del fisco - post
/fiscal-documents/{document}/dismissSacar de control un comprobante rechazado: no se va a emitir - post
/fiscal-documents/{document}/annulAnular una factura emitida con una nota de crédito
- post
Nuevo
Listas de precios mayoristas
Nuevo scope orders:wholesale — condiciones mayoristas, el permiso del panel para llevar la venta mayorista; incluye orders:read, catalog:read y costs:read. Con él POST /v1/price-lists crea una lista mayorista, DELETE /v1/price-lists/{price_list} la borra con If-Match (una lista asignada a clientes, con el consentimiento wholesale_price_list_buyers), y PATCH y los comandos de filas escriben una lista mayorista; en una mayorista PATCH cambia también name. POST /v1/customers/{customer}/wholesale-price-list asigna una lista mayorista a un cliente con su If-Match — necesita además customers:write. Los comandos de escritura de listas aceptan catalog:write u orders:wholesale, y se necesita el scope del tipo de lista: lo nombra el rechazo insufficient_scope; en un endpoint con varios scopes el rechazo los lista en accepted_scopes.
Endpoints
Nuevo
Escritura de listas de precios
Con catalog:write una lista de precios se escribe con If-Match de su versión: PATCH /v1/price-lists/{price_list} cambia su regla — adjustment_bp y el redondeo rounding —; los comandos POST /v1/price-lists/{price_list}/items y …/items/remove fijan y quitan precios de variantes, y …/modifier-items y …/modifier-items/remove, recargos de opciones de modificadores, hasta 1000 filas por solicitud en una sola operación. La respuesta es la lista con su nueva versión, y un lote envía un solo evento price_list.updated. Una fila en la moneda de la tienda se escribe con price y compare_at_price; una fila en la moneda de la lista, con list_price y list_compare_at_price. La app gestiona una lista de local si tiene acceso a todos sus locales; las listas mayoristas no se escriben con estos comandos.
Endpoints
- patch
/price-lists/{price_list}Cambiar una lista de precios: ajuste y redondeo, y el nombre de una mayorista; la regla de una lista de local cambia los precios en todos sus locales - post
/price-lists/{price_list}/itemsFijar precios de variantes en una lista de precios, en lote - post
/price-lists/{price_list}/items/removeQuitar precios fijos de variantes de una lista de precios, en lote - post
/price-lists/{price_list}/modifier-itemsFijar recargos de opciones de modificadores en una lista de precios, en lote - post
/price-lists/{price_list}/modifier-items/removeQuitar recargos fijos de opciones de una lista de precios, en lote
- patch
Nuevo
Listas de precios
Con catalog:read hay listas de precios (GET /v1/price-lists) — de local y mayoristas, con su regla adjustment_bp y su redondeo rounding —, sus precios fijos de variantes (GET /v1/price-list-items) y sus recargos fijos de opciones de modificadores (GET /v1/price-list-modifier-items). Una lista mayorista calcula el precio desde el costo y solo se ve con costs:read; una lista de local la ve la app que tiene acceso a al menos uno de sus locales. El local tiene el campo price_list_id; el cliente, wholesale_price_list_id y un filtro del feed de clientes por él. Cambiar un precio o recargo fijo aumenta la versión de la lista. Eventos price_list.created, price_list.updated, price_list.deleted.
Endpoints
- get
/price-listsListar las listas de precios de la tienda: de local y mayoristas, con su regla y redondeo - get
/price-lists/{price_list}Obtener una lista de precios - get
/price-list-itemsListar los precios fijos de variantes en listas de precios modificados desde un momento dado - get
/price-list-items/{price_list_item}Obtener un precio fijo de variante en una lista de precios - get
/price-list-modifier-itemsListar los recargos fijos de opciones de modificadores en listas de precios modificados desde un momento dado - get
/price-list-modifier-items/{price_list_modifier_item}Obtener un recargo fijo de opción en una lista de precios - get
/locationsListar los locales de la tienda disponibles para la aplicación - get
/customersListar los clientes cambiados desde un momento dado: contactos, consentimiento de marketing, direcciones y grupos; búsqueda por teléfono, email y grupo - get
/customers/{customer}Obtener un cliente
- get
Nuevo
Grupos de clientes
Con customers:read ahora hay grupos de clientes (GET /v1/customer-groups) con nombre, descripción y actividad, y el cliente tiene el campo group_ids y el feed de clientes el filtro group_id. Con customers:write los grupos se crean, se cambian con If-Match y se eliminan; eliminar un grupo lo desvincula de las reglas de descuento y de los envíos, y una regla que queda sin audiencia se desactiva. Los clientes se agregan a un grupo y se quitan con POST /v1/customer-groups/{customer_group}/members y …/members/remove. La membresía no mueve la versión del cliente: un cambio mueve al cliente en el feed y envía customer.updated. Eventos customer_group.created, customer_group.updated, customer_group.deleted.
Endpoints
- get
/customer-groupsListar los grupos de clientes de la tienda: nombre, descripción y si están activos - get
/customer-groups/{customer_group}Obtener un grupo de clientes - post
/customer-groupsCrear un grupo de clientes - patch
/customer-groups/{customer_group}Cambiar el nombre, la descripción o la actividad de un grupo - delete
/customer-groups/{customer_group}Eliminar un grupo: sus membresías se van con él, y las reglas de descuento y los envíos dejan de apuntarle - post
/customer-groups/{customer_group}/membersAgregar clientes a un grupo - post
/customer-groups/{customer_group}/members/removeQuitar clientes de un grupo - get
/customersListar los clientes cambiados desde un momento dado: contactos, consentimiento de marketing, direcciones y grupos; búsqueda por teléfono, email y grupo - get
/customers/{customer}Obtener un cliente
- get
Nuevo
Número de seguimiento de un servicio sin integración
POST /v1/orders/{order}/shipment/tracking con orders:write carga el número de seguimiento, el enlace y el nombre del servicio de un pedido que despacha un servicio de envíos sin integración; POST …/shipment/tracking/clear lo quita. El número está en shipment del pedido: carrier sumó el valor courier_service, y shipment y previous_shipments sumaron carrier_name — el servicio como lo nombró la tienda. El cliente ve el número en la página del pedido y lo recibe por mensaje si el pedido ya está en el servicio. Nuevo rechazo shipment_tracking_refused.
Endpoints
- post
/orders/{order}/shipment/trackingCargar el número de seguimiento de un servicio de envíos sin integración: número, enlace y nombre del servicio - post
/orders/{order}/shipment/tracking/clearQuitar un número de seguimiento cargado a mano - get
/ordersListar los pedidos cambiados desde un momento dado: ítems, totales, estado del pedido y estado del pago - get
/orders/{order}Obtener un pedido
- post
Nuevo
Emisión del envío por la API
POST /v1/orders/{order}/shipment emite el envío con el transportista del pedido con orders:write: la respuesta es 202 con el pedido, la emisión corre en segundo plano y el resultado llega con order.updated; si el envío ya existe, la respuesta es 200. shipment_attempt sumó los estados queued y failed y el campo error con el código y el texto del motivo. Nuevos problemas shipment_refused, shipment_in_progress y shipment_outcome_unknown.
Endpoints
- post
/orders/{order}/shipmentEmitir el envío del pedido con su transportista: la solicitud se procesa en segundo plano y el resultado aparece en el pedido y llega con order.updated - get
/ordersListar los pedidos cambiados desde un momento dado: ítems, totales, estado del pedido y estado del pago - get
/orders/{order}Obtener un pedido
- post
Nuevo
Precio de la variante en la moneda de la lista
La variante tiene los campos list_price y list_price_currency: el precio tal como lo fijó el dueño y su moneda, cuando la tienda lleva la lista en otra moneda. En esa variante price en la moneda de la tienda lo calcula el sistema con la cotización de la lista y no se acepta en la entrada: el precio se fija con list_price (moneda de la lista de la tienda o currency). null en list_price_currency: el precio está en la moneda de la tienda, como antes.
Endpoints
- get
/variantsListar las variantes: SKU, códigos de barras, precios y unidades - get
/variants/{variant}Obtener una variante - get
/variants/by-external-id/{external_id}Obtener una variante por su ID externo - post
/variantsAgregar una variante a un producto - patch
/variants/{variant}Modificar una variante de producto - patch
/variants/by-external-id/{external_id}Crear o modificar una variante por su ID en la app - get
/productsListar los productos: categorías, opciones y fotos, sin variantes - get
/products/{product}Obtener un producto - get
/products/by-external-id/{external_id}Obtener un producto por su ID externo - post
/productsCrear un producto con sus variantes - patch
/products/{product}Modificar la ficha de un producto: campos, categorías, ID externo - patch
/products/by-external-id/{external_id}Crear o modificar un producto con sus variantes por su ID en la app
- get
Nuevo
Horario de venta del producto
Los productos tienen el campo sale_schedule — las franjas de la semana, en la zona horaria del comercio, en que se puede pedir el producto: una lista de {days, from, to}, donde days son días ISO (1 es lunes) y from y to son «HH:MM», con «24:00» solo como fin; una franja que termina antes de empezar pasa la medianoche y pertenece a su día de inicio. null significa que el producto se puede pedir siempre. No es la publicación: fuera de la franja el producto sigue visible y se puede agregar al carrito, y el checkout compara el horario con el momento de entrega del pedido. El campo se escribe al crear, editar y hacer upsert de un producto; null borra el horario.
Endpoints
- get
/productsListar los productos: categorías, opciones y fotos, sin variantes - get
/products/{product}Obtener un producto - get
/products/by-external-id/{external_id}Obtener un producto por su ID externo - post
/productsCrear un producto con sus variantes - patch
/products/{product}Modificar la ficha de un producto: campos, categorías, ID externo - patch
/products/by-external-id/{external_id}Crear o modificar un producto con sus variantes por su ID en la app
- get
Nuevo
Envío con el transportista en el pedido
Los pedidos muestran su envío con el transportista: shipment — el transportista, el número y la página de seguimiento, el último estado de un conjunto cerrado y el historial de estados con el texto del transportista; previous_shipments — los envíos reemplazados por una reemisión; shipment_attempt — una emisión en curso o con resultado desconocido. La etiqueta del envío está en GET /v1/orders/{order}/shipment/label, un PDF con orders:read y customers:read porque lleva los datos del destinatario. Nuevos problemas shipment_label_unavailable y carrier_unavailable. Consultar al transportista sin un estado nuevo ya no mueve el pedido en el feed ni envía order.updated.
Endpoints
- get
/ordersListar los pedidos cambiados desde un momento dado: ítems, totales, estado del pedido y estado del pago - get
/orders/{order}Obtener un pedido - get
/orders/{order}/shipment/labelDescargar en PDF la etiqueta del envío actual del pedido; lleva los datos del destinatario, por eso también requiere customers:read
- get
Nuevo
Composición de los descuentos del pedido
Los pedidos muestran de qué se componen sus descuentos: applied_discounts — el registro de descuentos sobre los productos (de dónde viene el descuento, por qué es, nombre de la regla, código promocional, motivo del descuento manual, el ítem en una rebaja de un solo ítem, importe), delivery_discounts — los descuentos del envío, items[].discount_allocations — de qué filas del registro se compone el descuento de un ítem. Las sumas coinciden: Σ applied_discounts = discount, Σ delivery_discounts = delivery_discount, Σ de las partes de un ítem = su discount. Un descuento de la caja externa llega como una fila con source = external_pos. El pedido avanza en el feed y envía order.updated también cuando su composición cambia sin que se escriba el pedido: el registro de descuentos o el costo de los ítems.
Endpoints
Nuevo
Traslados e inventarios
Bajo inventory:read aparecen los traslados entre locales (GET /v1/location-transfers) con sus líneas —variante, lote, cantidad— y los inventarios (GET /v1/stocktakes) con estado, alcance y la marca de conteo ciego. Las líneas de inventario tienen su propio feed, GET /v1/stocktake-lines: stock esperado, contado, diferencia, ajuste aplicado y stock del local después del registro; mientras un conteo ciego es borrador, el esperado y la diferencia son null. Los documentos de movimientos de stock de tipo location_transfer y stocktake ahora se leen con estos recursos. Eventos location_transfer.created, location_transfer.updated, stocktake.created, stocktake.status_changed, stocktake.updated.
Endpoints
- get
/location-transfersTraslados de mercadería entre locales con sus líneas, modificados desde un momento dado - get
/location-transfers/{location_transfer}Traslado entre locales - get
/stocktakesInventarios: alcance, estado y fechas, modificados desde un momento dado - get
/stocktakes/{stocktake}Inventario - get
/stocktake-linesLíneas de inventario: stock esperado, contado, diferencia y ajuste, modificadas desde un momento dado - get
/stocktake-lines/{stocktake_line}Línea de inventario
- get
Cambio
Vinculación de la cotización en la factura del pago
El modo de cotización tender.exchange_rate.mode tiene el valor pegged: la tienda vinculó la moneda del medio a otra moneda (por ejemplo, 1 USDT = 1 USD), y la cotización es la de esa moneda por el coeficiente. El campo nuevo tender.exchange_rate.peg {currency, rate} nombra la vinculación; null si la cotización no está vinculada. Los precios fijados en la moneda vinculada entran en la factura tal cual.
Endpoints
Nuevo
Diario de movimientos de stock y lotes
Con inventory:read ya están el diario de movimientos de stock (GET /v1/stock-movements) — el cambio con signo del stock físico del local, el stock posterior, el motivo, la columna del libro de existencias y el documento primario — y los lotes (GET /v1/lots) con número, vencimiento y estado. Las líneas de recepciones, devoluciones a proveedor y liquidaciones de consignación ahora traen lot_id. Eventos stock_movement.created, stock_movement.updated, lot.created, lot.updated, lot.deleted.
Endpoints
- get
/stock-movementsDiario de movimientos de stock: cada cambio del stock físico de un local - get
/stock-movements/{stock_movement}Movimiento de stock - get
/lotsLotes de producto: número, vencimiento y estado, modificados desde un momento dado - get
/lots/{lot}Lote de producto - get
/goods-receiptsRecepciones: ingresos de mercadería del proveedor con líneas, precios del remito y correcciones - get
/goods-receipts/{goods_receipt}Recepción - get
/supplier-returnsDevoluciones a proveedores: mercadería enviada de vuelta y su compensación - get
/supplier-returns/{supplier_return}Devolución a proveedor - get
/consignment-settlementsLiquidaciones de consignación: mercadería en consignación vendida, dada de baja a cargo de la tienda y reajustada en un período - get
/consignment-settlements/{consignment_settlement}Liquidación de consignación
- get
Nuevo
Libros IVA y paquete del contador como archivo
Las operaciones masivas suman un tercer tipo: el archivo. El tipo libro_iva.export genera los libros del Libro IVA Digital de una razón social para un mes: en params van legal_entity_id, period con formato YYYY-MM y books (ventas, compras o ambos; las compras traen los archivos de importación). El tipo accountant_package.export genera el paquete del contador. Hacen falta bulk:write y fiscal:read, el libro fiscal de Argentina en la tienda y acceso de la aplicación a todos los locales. El resultado es un ZIP con los mismos archivos que el panel; aparece completo en completed, y hasta entonces GET …/result responde con el nuevo 409 bulk_operation_result_unavailable. Una generación rechazada queda failed con el código libro_iva_not_applicable o libro_iva_incomplete; en el segundo, error.documents lista los comprobantes y los motivos.
Endpoints
- post
/bulk-operationsIniciar una operación masiva desde una carga o una dirección de entrada, una exportación del listado o la generación de un archivo - get
/bulk-operations/{operation}/resultObtener el resultado de una operación masiva: NDJSON, una línea por línea de entrada o por elemento exportado, o el ZIP de una operación de archivo; se reanuda con Range
- post
Nuevo
Pago de comprobantes de proveedor fuera del sistema
Nuevo scope procurement:pay: no se otorga por defecto e incluye procurement:read, pero no la escritura ni la aprobación. POST /v1/supplier-bills/{supplier_bill}/payments/out-of-band bajo If-Match marca un comprobante aprobado como pagado fuera del sistema: la deuda se cancela sin una cuenta de dinero de la tienda, y para una razón social agente de retención la lista withholdings es obligatoria. La respuesta es el pago creado, 201 con Location. DELETE /{supplier_bill}/payments/{supplier_bill_payment} bajo If-Match anula un pago con dinero o fuera del sistema junto con sus retenciones; los demás tipos los quita su propio documento: nuevo rechazo supplier_bill_payment_locked. Los pagos y las anulaciones llegan con los eventos supplier_bill_payment.created y .deleted, y el saldo pendiente del comprobante con supplier_bill.updated.
Endpoints
Nuevo
Aprobación de pago de comprobantes de proveedores
Nuevo scope procurementSaleyarove: no se otorga por defecto e incluye procurement:read, pero no la escritura. POST /v1/supplier-bills/{supplier_bill}/approve aprueba el pago de un comprobante registrado bajo If-Match: sin aprobación el comprobante no se paga, y un anticipo registrado en su orden de compra lo cancela en el acto. POST /{supplier_bill}/revoke-approval revoca la aprobación mientras el comprobante no tenga pagos. El rechazo por el estado del comprobante es supplier_bill_refused. La aprobación y su revocación llegan con el evento supplier_bill.updated y el campo approved_at.
Endpoints
Nuevo
Contenido neto de la unidad de la variante
Las variantes tienen el campo net_content — contenido neto de una unidad {quantity, unit}: paquete de 500 g, botella de 1000 ml. La respuesta trae la medida vigente: un pack de varias unidades de otra variante la toma de ella, una unidad envasada, de su propia medida. Se puede escribir al crear o editar una variante y un producto con variantes — solo en una variante común por unidad; null la borra. Con ella un combo cuenta paquetes en una posición «desde 1 kg» y los feeds de vitrina muestran el precio por kilo.
Endpoints
- get
/variantsListar las variantes: SKU, códigos de barras, precios y unidades - get
/variants/{variant}Obtener una variante - get
/variants/by-external-id/{external_id}Obtener una variante por su ID externo - post
/variantsAgregar una variante a un producto - patch
/variants/{variant}Modificar una variante de producto - patch
/variants/by-external-id/{external_id}Crear o modificar una variante por su ID en la app - get
/productsListar los productos: categorías, opciones y fotos, sin variantes - get
/products/{product}Obtener un producto - get
/products/by-external-id/{external_id}Obtener un producto por su ID externo - post
/productsCrear un producto con sus variantes - patch
/products/{product}Modificar la ficha de un producto: campos, categorías, ID externo - patch
/products/by-external-id/{external_id}Crear o modificar un producto con sus variantes por su ID en la app
- get
Nuevo
Escritura de comprobantes de proveedores
Con procurement:write: el borrador de comprobante de proveedor (POST /v1/supplier-bills), los cambios del borrador con If-Match (PATCH /v1/supplier-bills/{supplier_bill}), la eliminación del borrador (DELETE), el registro con POST /{supplier_bill}/post y la anulación con POST /{supplier_bill}/void. Los campos son los de la respuesta: el período fiscal como YYYY-MM, la cotización como texto, los impuestos además del IVA en additional_taxes, los datos de ARCA en ar. La respuesta y la entrada suman ar.import, los datos de una importación de bienes o servicios. El registro puede pedir el consentimiento vendor_tax_id o close_returns. Nuevo rechazo supplier_bill_refused: el comando no corresponde al estado del comprobante.
Endpoints
- post
/supplier-billsCrear un borrador de comprobante de proveedor - patch
/supplier-bills/{supplier_bill}Cambiar un borrador de comprobante de proveedor - delete
/supplier-bills/{supplier_bill}Eliminar un borrador de comprobante de proveedor - post
/supplier-bills/{supplier_bill}/postRegistrar un comprobante de proveedor: entra en las cuentas a pagar y el libro de compras - post
/supplier-bills/{supplier_bill}/voidAnular un comprobante de proveedor junto con sus pagos y compensaciones
- post
Nuevo
Escritura de órdenes de compra
Con procurement:write: el borrador de orden de compra (POST /v1/purchase-orders), los cambios con If-Match (PATCH /v1/purchase-orders/{purchase_order}) — el borrador entero; de la orden colocada, las líneas, la fecha y la nota con revisión y mensaje al proveedor —, el borrado del borrador (DELETE) y las transiciones POST /{purchase_order}/place, /cancel y /close. La cantidad y la unidad de precio de la línea van como texto en la unidad base de la variante, igual que en la respuesta. Funciona en tiendas con compras activadas; si no, 403 capability_disabled. Nuevo error purchase_order_refused: el comando no corresponde al estado de la orden.
Endpoints
- post
/purchase-ordersCrear un borrador de orden de compra - patch
/purchase-orders/{purchase_order}Cambiar una orden de compra: el borrador entero; de la colocada, las líneas, la fecha y la nota con revisión - delete
/purchase-orders/{purchase_order}Borrar un borrador de orden de compra - post
/purchase-orders/{purchase_order}/placeMarcar el borrador como colocado con el proveedor - post
/purchase-orders/{purchase_order}/cancelCancelar una orden de compra colocada - post
/purchase-orders/{purchase_order}/closeCerrar una orden de compra recibida
- post
Nuevo
Modificadores
Grupos de modificadores con opciones bajo catalog:read y catalog:write: el feed GET /v1/modifier-groups, un grupo por ID y por el ID de tu sistema, crear, modificar con If-Match, el upsert PATCH /v1/modifier-groups/by-external-id/{external_id} y archivar con el consentimiento modifier_group_archive. Las opciones son el conjunto del grupo: una fila encuentra su opción por id o external_id; una opción que falta en el conjunto se archiva. Una modificación que baja el mínimo de elección de productos pide el consentimiento modifier_product_minimum. GET y PUT /v1/products/{product}/modifier-groups leen y reemplazan los grupos del producto con la regla de elección y los recargos de opciones por variante; la ficha del producto tiene el nuevo campo modifier_groups. La receta de la variante tiene el nuevo campo option_recipes — las cantidades de opciones por plato. El tope de grupos de la tienda es record_limit_reached.
Endpoints
- get
/modifier-groupsListar los grupos de modificadores con opciones cambiados desde el momento indicado - get
/modifier-groups/{group}Obtener un grupo de modificadores con sus opciones - get
/modifier-groups/by-external-id/{external_id}Obtener un grupo de modificadores por ID externo - post
/modifier-groupsCrear un grupo de modificadores con opciones - patch
/modifier-groups/{group}Modificar un grupo de modificadores y su conjunto de opciones - patch
/modifier-groups/by-external-id/{external_id}Crear o modificar un grupo de modificadores por ID externo - delete
/modifier-groups/{group}Archivar un grupo de modificadores - get
/productsListar los productos: categorías, opciones y fotos, sin variantes - get
/products/{product}Obtener un producto - get
/products/by-external-id/{external_id}Obtener un producto por su ID externo - post
/productsCrear un producto con sus variantes - patch
/products/{product}Modificar la ficha de un producto: campos, categorías, ID externo - patch
/products/by-external-id/{external_id}Crear o modificar un producto con sus variantes por su ID en la app - put
/products/{product}/optionsReemplazar las opciones del producto y distribuir sus variantes - get
/products/{product}/modifier-groupsObtener los grupos de modificadores del producto y los recargos de sus opciones por variante - put
/products/{product}/modifier-groupsReemplazar los grupos de modificadores del producto y los recargos de sus opciones por variante - get
/variants/{variant}/recipeObtener la receta de una variante: componentes y rendimiento del preelaborado - put
/variants/{variant}/recipeReemplazar la receta de una variante: componentes y rendimiento del preelaborado
- get
Nuevo
Escritura de proveedores
Nuevo scope procurement:write. Crear un proveedor (POST /v1/suppliers), actualizarlo bajo If-Match (PATCH /v1/suppliers/{supplier}) y crearlo o actualizarlo por su ID en tu sistema (PATCH /v1/suppliers/by-external-id/{external_id}); buscar un proveedor por ese ID con GET /v1/suppliers/by-external-id/{external_id} bajo procurement:read. Se escriben los mismos campos que llegan en la respuesta, salvo customer_id. Los proveedores tienen el campo external_id. Nuevo error record_limit_reached: la tienda alcanzó el tope de registros de este tipo, que no depende del plan; lo devuelven POST /v1/suppliers y POST /v1/recommendation-rules.
Endpoints
- get
/suppliersProveedores de la tienda: datos fiscales y condiciones de pago - get
/suppliers/{supplier}Proveedor - get
/suppliers/by-external-id/{external_id}Proveedor por su ID externo - post
/suppliersCrear un proveedor: datos fiscales y condiciones de pago - patch
/suppliers/{supplier}Actualizar los datos fiscales, las condiciones de pago y el ID externo de un proveedor - patch
/suppliers/by-external-id/{external_id}Crear o actualizar un proveedor por su ID externo - post
/recommendation-rulesCrear una regla de recomendaciones - get
/eventsListar los eventos de la tienda de los últimos 30 días: qué cambió en pedidos, pagos, devoluciones, comprobantes fiscales, períodos fiscales, productos, stock y clientes, con el registro tal como está ahora
- get
Nuevo
Insumos, preelaborados y recetas
POST /v1/products y el upsert crean insumos y preelaborados (type ingredient, prep) con stock_unit — la unidad base del stock y de las recetas y el envase de compra; cada respuesta de producto trae stock_unit. GET y PUT /v1/variants/{variant}/recipe leen y reemplazan la receta de una variante: componentes con la cantidad en la unidad de cada componente y el rendimiento del preelaborado, bajo la versión del producto. La mano de obra, los pasos de producción, el método de descuento y los subproductos quedan en el panel de la tienda: la API no los toca.
Endpoints
- get
/productsListar los productos: categorías, opciones y fotos, sin variantes - get
/products/{product}Obtener un producto - get
/products/by-external-id/{external_id}Obtener un producto por su ID externo - post
/productsCrear un producto con sus variantes - patch
/products/{product}Modificar la ficha de un producto: campos, categorías, ID externo - patch
/products/by-external-id/{external_id}Crear o modificar un producto con sus variantes por su ID en la app - put
/products/{product}/optionsReemplazar las opciones del producto y distribuir sus variantes - get
/variants/{variant}/recipeObtener la receta de una variante: componentes y rendimiento del preelaborado - put
/variants/{variant}/recipeReemplazar la receta de una variante: componentes y rendimiento del preelaborado
- get
Nuevo
Retenciones y percepciones
Con fiscal:read: el registro de retenciones y percepciones (GET /v1/tax-withholdings, filtro direction): el impuesto que le retuvieron a la tienda (suffered: proveedor de cobros, banco, cliente agente de retención) y el que retuvo la tienda al pagarle a un proveedor (practiced): tipo, impuesto y jurisdicción, importe, base y alícuota, contraparte, impuesto y mes de cómputo, número de certificado, origen y anulación. El certificado que la tienda le entrega a la contraparte es GET /v1/tax-withholdings/{tax_withholding}/certificate (PDF). Los movimientos de cuenta corriente de tipo withholding tienen tax_withholding_id: el certificado en el registro. Eventos nuevos: tax_withholding.created, tax_withholding.updated, tax_withholding.annulled y tax_withholding.deleted.
Endpoints
- get
/tax-withholdingsListar las retenciones y percepciones cambiadas desde un momento: lo que le retuvieron a la tienda, a computar, y lo que retuvo la tienda, a ingresar - get
/tax-withholdings/{tax_withholding}Obtener una retención o percepción - get
/tax-withholdings/{tax_withholding}/certificateDescargar el PDF del certificado de retención que la tienda le entrega a la contraparte - get
/customer-account-entriesMovimientos de las cuentas corrientes de clientes: venta a cuenta, cobro, devolución, baja por incobrable, compensación, retención y anulación - get
/customer-account-entries/{customer_account_entry}Movimiento de la cuenta corriente de un cliente - get
/eventsListar los eventos de la tienda de los últimos 30 días: qué cambió en pedidos, pagos, devoluciones, comprobantes fiscales, períodos fiscales, productos, stock y clientes, con el registro tal como está ahora - post
/webhook-endpointsAgregar un endpoint de webhook y suscribirlo a tipos de evento - patch
/webhook-endpoints/{endpoint}Modificar un endpoint de webhook: URL, descripción, tipos de evento, estado
- get
Nuevo
Liquidaciones de consignación
Con procurement:read: liquidaciones de consignación (GET /v1/consignment-settlements, filtro supplier_id): lo vendido de la mercadería en consignación en un período, lo dado de baja a cargo de la tienda y la diferencia por un precio corregido en la recepción; subtotales por sección y líneas con la variante, la recepción, la cantidad en la unidad base de la variante y el precio de compra, en la moneda de la liquidación y en la de la tienda. Los comprobantes de proveedores ya apuntan a la liquidación con consignment_settlement_id. Eventos nuevos: consignment_settlement.created, consignment_settlement.updated, consignment_settlement.posted y consignment_settlement.voided.
Endpoints
- get
/consignment-settlementsLiquidaciones de consignación: mercadería en consignación vendida, dada de baja a cargo de la tienda y reajustada en un período - get
/consignment-settlements/{consignment_settlement}Liquidación de consignación - get
/eventsListar los eventos de la tienda de los últimos 30 días: qué cambió en pedidos, pagos, devoluciones, comprobantes fiscales, períodos fiscales, productos, stock y clientes, con el registro tal como está ahora - post
/webhook-endpointsAgregar un endpoint de webhook y suscribirlo a tipos de evento - patch
/webhook-endpoints/{endpoint}Modificar un endpoint de webhook: URL, descripción, tipos de evento, estado
- get
Nuevo
Órdenes de compra, recepciones y devoluciones a proveedores
Con procurement:read: órdenes de compra (GET /v1/purchase-orders, filtro supplier_id) con líneas de cantidad pedida, confirmada por el proveedor y recibida; recepciones (GET /v1/goods-receipts, filtros supplier_id y purchase_order_id) con líneas que llevan el precio del remito, el precio en la moneda de la tienda y el costo después del impuesto, y correcciones de antes y después; devoluciones a proveedores (GET /v1/supplier-returns, filtros supplier_id y goods_receipt_id) con líneas, la compensación esperada y la recibida y correcciones. Las cantidades son texto en la unidad base de la variante. Los comprobantes de proveedores sumaron goods_receipt_ids, purchase_order_ids y supplier_return_ids. Eventos nuevos: purchase_order.created, purchase_order.updated, purchase_order.status_changed, purchase_order.deleted, goods_receipt.created, goods_receipt.updated, goods_receipt.voided, supplier_return.created, supplier_return.updated, supplier_return.status_changed y supplier_return.deleted.
Endpoints
- get
/purchase-ordersÓrdenes de compra: lo pedido, lo confirmado por el proveedor y lo recibido por línea - get
/purchase-orders/{purchase_order}Orden de compra - get
/goods-receiptsRecepciones: ingresos de mercadería del proveedor con líneas, precios del remito y correcciones - get
/goods-receipts/{goods_receipt}Recepción - get
/supplier-returnsDevoluciones a proveedores: mercadería enviada de vuelta y su compensación - get
/supplier-returns/{supplier_return}Devolución a proveedor - get
/supplier-billsComprobantes de proveedores: facturas, notas y deudas por entregas sin factura, con impuestos y líneas - get
/supplier-bills/{supplier_bill}Comprobante de proveedor - get
/eventsListar los eventos de la tienda de los últimos 30 días: qué cambió en pedidos, pagos, devoluciones, comprobantes fiscales, períodos fiscales, productos, stock y clientes, con el registro tal como está ahora - post
/webhook-endpointsAgregar un endpoint de webhook y suscribirlo a tipos de evento - patch
/webhook-endpoints/{endpoint}Modificar un endpoint de webhook: URL, descripción, tipos de evento, estado
- get
Nuevo
Saldos, conciliación y compensaciones
Con procurement:read: saldo del proveedor (GET /v1/suppliers/{id}/balance) con los siete componentes de la deuda, la apertura por vencimiento y el total; conciliación de saldos (GET /v1/suppliers/{id}/statement) con saldo inicial y final del período y líneas con saldo acumulado; ambos aceptan legal_entity_id. Compensaciones (GET /v1/settlement-offsets), sus líneas en un feed aparte (GET /v1/settlement-offset-lines) y acuerdos de compensación (GET /v1/settlement-agreements). Los comprobantes de proveedores suman paid_total y outstanding en la moneda del documento. Los movimientos de cuentas corrientes suman settlement_offset_id. El customer_id del proveedor ahora requiere customers:read. Eventos nuevos: settlement_agreement.created, settlement_agreement.updated, settlement_agreement.deleted, settlement_offset.created, settlement_offset.updated y settlement_offset.voided.
Endpoints
- get
/suppliers/{supplier}/balanceSaldo del proveedor: cuánto le debe la tienda ahora, por componente y vencimiento - get
/suppliers/{supplier}/statementConciliación de saldos con el proveedor en un período: saldo inicial y final, líneas con saldo acumulado - get
/suppliersProveedores de la tienda: datos fiscales y condiciones de pago - get
/suppliers/{supplier}Proveedor - get
/settlement-agreementsAcuerdos de compensación: partes, tipo, datos del contrato, vigencia y calendario - get
/settlement-agreements/{settlement_agreement}Acuerdo de compensación - get
/settlement-offsetsCompensaciones: deudas recíprocas de un cliente y un proveedor canceladas con un documento de compensación - get
/settlement-offsets/{settlement_offset}Compensación - get
/settlement-offset-linesLíneas de compensaciones: deudas del cliente y comprobantes de proveedores compensados - get
/settlement-offset-lines/{settlement_offset_line}Línea de compensación - get
/supplier-billsComprobantes de proveedores: facturas, notas y deudas por entregas sin factura, con impuestos y líneas - get
/supplier-bills/{supplier_bill}Comprobante de proveedor - get
/customer-account-entriesMovimientos de las cuentas corrientes de clientes: venta a cuenta, cobro, devolución, baja por incobrable, compensación, retención y anulación - get
/customer-account-entries/{customer_account_entry}Movimiento de la cuenta corriente de un cliente - get
/eventsListar los eventos de la tienda de los últimos 30 días: qué cambió en pedidos, pagos, devoluciones, comprobantes fiscales, períodos fiscales, productos, stock y clientes, con el registro tal como está ahora - post
/webhook-endpointsAgregar un endpoint de webhook y suscribirlo a tipos de evento - patch
/webhook-endpoints/{endpoint}Modificar un endpoint de webhook: URL, descripción, tipos de evento, estado
- get
Nuevo
Proveedores y comprobantes de proveedores
Nuevo scope procurement:read. Proveedores (GET /v1/suppliers): datos fiscales y condiciones de pago, sin persona de contacto ni notas. Comprobantes de proveedores (GET /v1/supplier-bills, filtro supplier_id): facturas, notas y deudas por entregas sin factura (fiscal: false), con el IVA como línea de impuesto común, percepciones y retenciones en la lista additional_taxes, líneas y datos de ARCA en ar. Pagos de comprobantes (GET /v1/supplier-bill-payments, filtro supplier_bill_id): con dinero, compensación, nota de crédito, anticipo de una orden de compra, gasto del libro o fuera del sistema. Nuevos eventos: supplier.created, supplier.updated, supplier.deleted, supplier_bill.created, supplier_bill.updated, supplier_bill.posted, supplier_bill.voided, supplier_bill.deleted, supplier_bill_payment.created, supplier_bill_payment.updated y supplier_bill_payment.deleted.
Endpoints
- get
/suppliersProveedores de la tienda: datos fiscales y condiciones de pago - get
/suppliers/{supplier}Proveedor - get
/supplier-billsComprobantes de proveedores: facturas, notas y deudas por entregas sin factura, con impuestos y líneas - get
/supplier-bills/{supplier_bill}Comprobante de proveedor - get
/supplier-bill-paymentsPagos de comprobantes de proveedores: con dinero, compensación, nota de crédito, anticipo, gasto del libro o fuera del sistema - get
/supplier-bill-payments/{supplier_bill_payment}Pago de comprobante de proveedor - get
/eventsListar los eventos de la tienda de los últimos 30 días: qué cambió en pedidos, pagos, devoluciones, comprobantes fiscales, períodos fiscales, productos, stock y clientes, con el registro tal como está ahora - post
/webhook-endpointsAgregar un endpoint de webhook y suscribirlo a tipos de evento - patch
/webhook-endpoints/{endpoint}Modificar un endpoint de webhook: URL, descripción, tipos de evento, estado
- get
Nuevo
Escritura del libro de dinero y cobros de cuentas corrientes
Nuevo scope finance:write. Ingreso o egreso manual (POST /v1/money-transactions), edición y baja de un movimiento con If-Match: en un movimiento con documento de origen cambian solo la categoría, la contraparte y la descripción, lo demás da 409 money_transaction_locked. Los importes en la moneda de la cuenta van como cadena decimal y los decimales de más dan 422. Transferencias entre cuentas: POST, GET, PATCH y DELETE /v1/money-transfers. Las operaciones masivas money_transactions.create y money_transactions.update asientan y categorizan el libro en lote. Cobro de una cuenta corriente con dinero ya recibido: POST /v1/customer-accounts/{customer_account}/payments, con certificados de retención. Las entradas de cuentas corrientes suman el filtro order_id: las del cobro se vinculan con el pedido de cobro, no con un pago.
Endpoints
- post
/money-transactionsRegistrar un ingreso o egreso manual en una cuenta de dinero - patch
/money-transactions/{transaction}Editar un movimiento de dinero: en uno con documento de origen, solo la categoría, la contraparte y la descripción - delete
/money-transactions/{transaction}Borrar un movimiento manual y devolver el saldo de la cuenta - post
/money-transfersTransferir dinero entre cuentas, con comisión o sin ella - get
/money-transfers/{money_transfer}Obtener una transferencia entre cuentas de dinero - patch
/money-transfers/{money_transfer}Editar la transferencia entera en su lugar: cuentas, importes, comisión, fecha y descripción - delete
/money-transfers/{money_transfer}Borrar una transferencia con todas sus partes - post
/customer-accounts/{customer_account}/paymentsRegistrar un cobro de cuenta corriente con dinero ya recibido: entrada en la cuenta corriente con certificados de retención - get
/customer-account-entriesMovimientos de las cuentas corrientes de clientes: venta a cuenta, cobro, devolución, baja por incobrable, compensación, retención y anulación - post
/bulk-operationsIniciar una operación masiva desde una carga o una dirección de entrada, una exportación del listado o la generación de un archivo - get
/bulk-operationsListar las operaciones masivas de la app cambiadas desde un momento dado: avance y resultados - get
/bulk-operations/{operation}Obtener una operación masiva
- post
Nuevo
Cuentas corrientes de clientes
Con finance:read ya están las cuentas corrientes de clientes (GET /v1/customer-accounts) con su saldo, igual a la suma de sus movimientos, el límite de crédito (null: sin límite) y el plazo de pago; los movimientos de las cuentas (GET /v1/customer-account-entries, filtros customer_account_id y payment_id) con importe con signo, vencimiento de cada cargo y vínculos con el pedido, el pago y la devolución; y el resumen de un período (GET /v1/customer-accounts/{customer_account}/statement) con saldo acumulado y deudas abiertas con vencimiento. El customer_id y la nota del personal sobre el cliente piden customers:read. Eventos nuevos: customer_account.created, customer_account.updated, customer_account_entry.created y customer_account_entry.updated, que llega cuando la unión de clientes pasa un movimiento a la cuenta del cliente que queda.
Endpoints
- get
/customer-accountsCuentas corrientes de clientes: saldo, límite de crédito y plazo de pago - get
/customer-accounts/{customer_account}Cuenta corriente de un cliente - get
/customer-accounts/{customer_account}/statementResumen de la cuenta corriente de un cliente en un período: saldo inicial y final, movimientos con saldo acumulado y deudas abiertas con vencimiento - get
/customer-account-entriesMovimientos de las cuentas corrientes de clientes: venta a cuenta, cobro, devolución, baja por incobrable, compensación, retención y anulación - get
/customer-account-entries/{customer_account_entry}Movimiento de la cuenta corriente de un cliente - get
/eventsListar los eventos de la tienda de los últimos 30 días: qué cambió en pedidos, pagos, devoluciones, comprobantes fiscales, períodos fiscales, productos, stock y clientes, con el registro tal como está ahora - post
/webhook-endpointsAgregar un endpoint de webhook y suscribirlo a tipos de evento - patch
/webhook-endpoints/{endpoint}Modificar un endpoint de webhook: URL, descripción, tipos de evento, estado
- get
Nuevo
Tarjetas de regalo y sus movimientos
Con finance:read ya están las tarjetas de regalo (GET /v1/gift-cards) con valor nominal, saldo y outstanding, la deuda de la tienda por la tarjeta: 0 si no está pagada, igual al saldo si está bloqueada o vencida; y los movimientos de tarjetas (GET /v1/gift-card-transactions, filtros gift_card_id y payment_id) con importe con signo y saldo después de cada uno. El titular customer_id requiere customers:read. Eventos nuevos: gift_card.created, gift_card.updated y gift_card_transaction.created.
Endpoints
- get
/gift-cardsTarjetas de regalo: valor nominal, saldo y deuda de la tienda por cada tarjeta - get
/gift-cards/{card}Tarjeta de regalo - get
/gift-card-transactionsMovimientos de tarjetas de regalo: emisión, canje, devolución a la tarjeta, ajuste, anulación, bloqueo y traspaso de saldo - get
/gift-card-transactions/{entry}Movimiento de la tarjeta de regalo - get
/eventsListar los eventos de la tienda de los últimos 30 días: qué cambió en pedidos, pagos, devoluciones, comprobantes fiscales, períodos fiscales, productos, stock y clientes, con el registro tal como está ahora - post
/webhook-endpointsAgregar un endpoint de webhook y suscribirlo a tipos de evento - patch
/webhook-endpoints/{endpoint}Modificar un endpoint de webhook: URL, descripción, tipos de evento, estado
- get
Nuevo
Turnos de caja y diario del cajón
finance:read ahora abre los turnos de caja (GET /v1/pos-shifts) con el arqueo del cajón en cada moneda — fondo inicial, esperado, contado, diferencia y fondo que queda para el turno siguiente —, el diario del cajón (GET /v1/pos-cash-movements, filtro shift_id) y los motivos de ingreso y retiro (GET /v1/pos-cash-reasons). Pagos y devoluciones suman el campo y el filtro pos_shift_id: el turno que recibió el dinero, para conciliar sus ventas. Eventos nuevos: pos_shift.opened, pos_shift.closed, pos_shift.updated y pos_cash_movement.created.
Endpoints
- get
/pos-shiftsTurnos de caja modificados desde un momento dado: arqueo del cajón en cada moneda - get
/pos-shifts/{shift}Turno de caja - get
/pos-cash-movementsDiario del cajón: ventas y devoluciones en efectivo, ingresos, retiros, depósitos en la caja fuerte, cambio y anulaciones - get
/pos-cash-movements/{movement}Movimiento del cajón - get
/pos-cash-reasonsMotivos de ingreso y retiro de efectivo con su categoría del libro de movimientos de dinero - get
/paymentsListar los pagos de pedidos cambiados desde un momento dado - get
/payments/{payment}Obtener un pago de un pedido - post
/payments/{payment}/confirmConfirmar que se recibió el dinero de un cobro pendiente - get
/refundsListar las devoluciones de pedidos cambiadas desde un momento dado: ítems y movimientos por pago - get
/refunds/{refund}Obtener una devolución de un pedido - post
/orders/{order}/refundsDevolver ítems y envío de un pedido: el dinero vuelve por los medios de pago, la mercadería al stock - post
/refunds/{refund}/confirmConfirmar que el dinero de la devolución se reintegró fuera del sistema - get
/eventsListar los eventos de la tienda de los últimos 30 días: qué cambió en pedidos, pagos, devoluciones, comprobantes fiscales, períodos fiscales, productos, stock y clientes, con el registro tal como está ahora - post
/webhook-endpointsAgregar un endpoint de webhook y suscribirlo a tipos de evento - patch
/webhook-endpoints/{endpoint}Modificar un endpoint de webhook: URL, descripción, tipos de evento, estado
- get
Nuevo
Cotización contable del día
La nueva operación GET /v1/exchange-rates/{currency} con finance:read devuelve la cotización contable del día en una fecha — la que usa el libro de dinero para convertir a la moneda de la tienda los movimientos de una cuenta en esa moneda: como cadena decimal, con el día en que se fijó (rate_date) y la fuente de cotización de mercado de la regla de la tienda.
Endpoints
Nuevo
Libro de dinero: cuentas, categorías y movimientos
El nuevo scope finance:read abre las cuentas de dinero de la tienda con su saldo en la moneda de la cuenta, las categorías de movimientos con los códigos de las categorías del sistema y el libro de movimientos — con el importe del asiento en la moneda de la tienda y en la de la cuenta, la fecha contable, el registro que lo asentó (source) y el comprobante principal (document); las patas de una transferencia comparten transfer_id. Eventos nuevos: money_transaction.created, money_transaction.updated y money_transaction.deleted.
Endpoints
- get
/money-accountsListar las cuentas de dinero de la tienda con su saldo actual: caja, banco, adquirente, billetera - get
/money-accounts/{account}Obtener una cuenta de dinero - get
/money-categoriesListar las categorías de movimientos de dinero: el árbol de ingresos y egresos con los códigos de las categorías del sistema - get
/money-transactionsListar los movimientos de dinero cambiados desde un momento: ingresos y egresos por cuenta con su origen y comprobante principal - get
/money-transactions/{transaction}Obtener un movimiento de dinero - get
/eventsListar los eventos de la tienda de los últimos 30 días: qué cambió en pedidos, pagos, devoluciones, comprobantes fiscales, períodos fiscales, productos, stock y clientes, con el registro tal como está ahora - post
/webhook-endpointsAgregar un endpoint de webhook y suscribirlo a tipos de evento - patch
/webhook-endpoints/{endpoint}Modificar un endpoint de webhook: URL, descripción, tipos de evento, estado
- get
Nuevo
Comisión del proveedor e impuesto retenido del pago
El pago suma provider_fee_amount y provider_withheld_tax_amount — la comisión del proveedor de pagos y el impuesto que retuvo como agente — y las partes que el proveedor devolvió al reembolsar al comprador: refunded_provider_fee_amount y refunded_provider_withheld_tax_amount.
Endpoints
- get
/paymentsListar los pagos de pedidos cambiados desde un momento dado - get
/payments/{payment}Obtener un pago de un pedido - post
/payments/{payment}/confirmConfirmar que se recibió el dinero de un cobro pendiente - get
/eventsListar los eventos de la tienda de los últimos 30 días: qué cambió en pedidos, pagos, devoluciones, comprobantes fiscales, períodos fiscales, productos, stock y clientes, con el registro tal como está ahora - post
/webhook-endpointsAgregar un endpoint de webhook y suscribirlo a tipos de evento - patch
/webhook-endpoints/{endpoint}Modificar un endpoint de webhook: URL, descripción, tipos de evento, estado
- get
Nuevo
Dinero del pago, razón social de la venta y eventos de pagos y reembolsos
El pago suma tender — el pago en moneda extranjera con la cotización, su modo, fuente, base de mercado y recargo de la tienda —, received_asset (la moneda que llegó de verdad) y legal_entity_id; el pedido suma legal_entity_id. Eventos nuevos: payment.created, payment.succeeded, payment.status_changed, payment.updated, refund.completed, refund.status_changed y refund.updated.
Endpoints
- get
/paymentsListar los pagos de pedidos cambiados desde un momento dado - get
/payments/{payment}Obtener un pago de un pedido - post
/payments/{payment}/confirmConfirmar que se recibió el dinero de un cobro pendiente - get
/ordersListar los pedidos cambiados desde un momento dado: ítems, totales, estado del pedido y estado del pago - get
/orders/{order}Obtener un pedido - post
/orders/{order}/cancelCancelar un pedido - post
/orders/{order}/statusPasar un pedido a otro estado de la tienda - post
/draft-orders/{draft}/completeConfirmar el pedido desde un borrador: cobrarle al cliente o registrar el pago como recibido - get
/bulk-operations/{operation}/resultObtener el resultado de una operación masiva: NDJSON, una línea por línea de entrada o por elemento exportado, o el ZIP de una operación de archivo; se reanuda con Range - get
/eventsListar los eventos de la tienda de los últimos 30 días: qué cambió en pedidos, pagos, devoluciones, comprobantes fiscales, períodos fiscales, productos, stock y clientes, con el registro tal como está ahora - post
/webhook-endpointsAgregar un endpoint de webhook y suscribirlo a tipos de evento - patch
/webhook-endpoints/{endpoint}Modificar un endpoint de webhook: URL, descripción, tipos de evento, estado
- get
Nuevo
Razones sociales, comprobantes fiscales y períodos fiscales
El nuevo scope fiscal:read abre las razones sociales de la tienda, los comprobantes fiscales en todos los estados —con los impuestos autorizados por el fisco, la fecha contable, los datos de ARCA y el PDF— y los períodos fiscales de las razones sociales en tiendas de Argentina. El receptor del comprobante requiere customers:read. Eventos nuevos: fiscal_document.created, fiscal_document.updated, fiscal_document.issued, fiscal_document.failed, fiscal_document.annulled y tax_period.status_changed.
Endpoints
- get
/legal-entitiesListar las razones sociales de la tienda: emisoras de comprobantes fiscales y titulares de los períodos fiscales - get
/fiscal-documentsListar los comprobantes fiscales cambiados desde un momento: facturas, notas de crédito y de débito en todos los estados - get
/fiscal-documents/{document}Obtener un comprobante fiscal - get
/fiscal-documents/{document}/pdfDescargar el PDF de un comprobante fiscal, el mismo archivo que recibe el cliente - get
/tax-periodsListar los períodos fiscales de las razones sociales: qué meses están cerrados y son definitivos - get
/eventsListar los eventos de la tienda de los últimos 30 días: qué cambió en pedidos, pagos, devoluciones, comprobantes fiscales, períodos fiscales, productos, stock y clientes, con el registro tal como está ahora - post
/webhook-endpointsAgregar un endpoint de webhook y suscribirlo a tipos de evento - patch
/webhook-endpoints/{endpoint}Modificar un endpoint de webhook: URL, descripción, tipos de evento, estado
- get
Nuevo
Impuesto de la venta y costo de los ítems de pedidos
Los pedidos reciben tax_lines, delivery_tax_lines y tax_lines de cada ítem, y las devoluciones reciben tax_lines: el impuesto de la venta según la clasificación de los productos, en una forma TaxLine común. Con costs:read, los ítems de los pedidos reciben cost_amount y cost_basis.
Endpoints
- get
/ordersListar los pedidos cambiados desde un momento dado: ítems, totales, estado del pedido y estado del pago - get
/orders/{order}Obtener un pedido - post
/orders/{order}/cancelCancelar un pedido - post
/orders/{order}/statusPasar un pedido a otro estado de la tienda - post
/draft-orders/{draft}/completeConfirmar el pedido desde un borrador: cobrarle al cliente o registrar el pago como recibido - get
/refundsListar las devoluciones de pedidos cambiadas desde un momento dado: ítems y movimientos por pago - get
/refunds/{refund}Obtener una devolución de un pedido - post
/orders/{order}/refundsDevolver ítems y envío de un pedido: el dinero vuelve por los medios de pago, la mercadería al stock - post
/refunds/{refund}/confirmConfirmar que el dinero de la devolución se reintegró fuera del sistema - get
/bulk-operations/{operation}/resultObtener el resultado de una operación masiva: NDJSON, una línea por línea de entrada o por elemento exportado, o el ZIP de una operación de archivo; se reanuda con Range
- get
Nuevo
Clases de impuesto de los productos
El nuevo endpoint /v1/tax-classes lista las clases de impuesto de la tienda: el tipo de impuesto (taxed, exempt, untaxed) y la alícuota en puntos básicos. Los productos tienen un nuevo campo tax_class_id, de lectura y escritura al crear, modificar y en el upsert; null es la clase predeterminada de la tienda. Antes, un producto creado por la API siempre recibía la clase predeterminada.
Endpoints
- get
/tax-classesListar las clases de impuesto de la tienda: el tipo y la alícuota de impuesto con que se vende un producto - get
/productsListar los productos: categorías, opciones y fotos, sin variantes - get
/products/{product}Obtener un producto - get
/products/by-external-id/{external_id}Obtener un producto por su ID externo - post
/productsCrear un producto con sus variantes - patch
/products/{product}Modificar la ficha de un producto: campos, categorías, ID externo - patch
/products/by-external-id/{external_id}Crear o modificar un producto con sus variantes por su ID en la app - put
/products/{product}/optionsReemplazar las opciones del producto y distribuir sus variantes
- get
Nuevo
Consentimiento de publicidad por canal
El cliente tiene un campo nuevo marketing_consents — consentimiento de publicidad por canal (email, telegram, whatsapp, instagram): una fila por cada canal donde el cliente aceptó (subscribed) o rechazó (unsubscribed) de forma explícita, con el momento del último consentimiento explícito. Un rechazo en un canal ya no detiene la publicidad en los demás. Por WhatsApp la tienda envía publicidad solo con subscribed, en cualquier modo de consentimiento.
Endpoints
- get
/customersListar los clientes cambiados desde un momento dado: contactos, consentimiento de marketing, direcciones y grupos; búsqueda por teléfono, email y grupo - get
/customers/{customer}Obtener un cliente - get
/customers/by-external-id/{external_id}Obtener un cliente por su ID externo - post
/customersCrear un cliente: un nombre y al menos un contacto - patch
/customers/{customer}Actualizar el nombre, el idioma y el ID externo de un cliente - patch
/customers/by-external-id/{external_id}Crear o actualizar un cliente por su ID externo
- get
Obsoleto
accepts_marketing y marketing_consent_at están obsoletos
Los campos del cliente accepts_marketing y marketing_consent_at están obsoletos y ahora indican el consentimiento de publicidad por email. El consentimiento por canal está en marketing_consents. Los campos siguen funcionando mientras funcione /v1.
Endpoints
- get
/customersListar los clientes cambiados desde un momento dado: contactos, consentimiento de marketing, direcciones y grupos; búsqueda por teléfono, email y grupo - get
/customers/{customer}Obtener un cliente - get
/customers/by-external-id/{external_id}Obtener un cliente por su ID externo - post
/customersCrear un cliente: un nombre y al menos un contacto - patch
/customers/{customer}Actualizar el nombre, el idioma y el ID externo de un cliente - patch
/customers/by-external-id/{external_id}Crear o actualizar un cliente por su ID externo
- get
Nuevo
Factura de renovación de membresía
Los pedidos tienen un nuevo motivo de cancelación del sistema cancel_reason = membership_renewal_void: se anuló la factura de renovación de una membresía porque se canceló o terminó sin pago. Esa factura no tenía dinero cobrado.
Endpoints
Nuevo
Moneda del total al confirmar un borrador
Confirmar un borrador acepta el campo opcional currency: la moneda en la que la app leyó el total. Una tienda sin pedidos puede cambiar de moneda, y el total coincidiría como número en otra moneda; ahora esa confirmación recibe 422 y no se crea el pedido.
Endpoints
Nuevo
Vencimiento de paquetes de visitas
Las visitas de un paquete vencido pasan a ser una venta del día: un pedido pagado con el método service_package. Extender el plazo cancela esa venta por sistema: el pedido recibe el motivo de cancelación service_package_term_extended y las visitas vuelven al paquete.
Endpoints
Nuevo
Tipos de error de cada endpoint
Cada endpoint de la especificación tiene ahora el campo x-problem-types con los tipos de error que devuelve: sus errores propios y los que se desprenden de cómo funciona (clave de idempotencia, versión en If-Match, cursor del feed, rango del resultado, eliminación, consentimiento de las consecuencias). Los errores comunes, como token, acceso, validación de la entrada, límite de solicitudes y fallas del servidor, pueden venir de cualquier endpoint, y el catálogo x-problem-types del documento los sigue listando. Se quitó del catálogo el tipo stocktake_location_occupied porque ningún endpoint lo devolvía. Los endpoints que responden con un conflicto sin clave de idempotencia ahora describen la respuesta 409.
Cambio
Límite de solicitudes rechazadas
Las solicitudes rechazadas en la entrada — 401 y 403 de una dirección no permitida o de un plan sin API — ahora se cuentan por dirección. Por encima del límite rejected_requests_per_minute la dirección recibe 429 too_many_requests con policy igual a rejected y el encabezado Retry-After hasta que termine el minuto. Las solicitudes con un token vigente no se cuentan y este límite nunca las rechaza.
Nuevo
Visitas de paquetes
Medio de pago service_package: una visita descontada del paquete de visitas del cliente; la línea del pedido la pagó una visita comprada antes con el paquete. El negocio cobró ese dinero al vender el paquete, así que este pago no entra en la caja ni en las cuentas, y la visita pasa a ser ingreso del pedido ahora. Devolver esa línea devuelve la visita al paquete: una transacción de devolución con destino service_package que no mueve dinero.
Endpoints
- get
/paymentsListar los pagos de pedidos cambiados desde un momento dado - get
/payments/{payment}Obtener un pago de un pedido - get
/refundsListar las devoluciones de pedidos cambiadas desde un momento dado: ítems y movimientos por pago - get
/refunds/{refund}Obtener una devolución de un pedido - post
/orders/{order}/refundsDevolver ítems y envío de un pedido: el dinero vuelve por los medios de pago, la mercadería al stock - post
/orders/{order}/refunds/calculateCalcular la devolución de un pedido y lo que queda por devolver, sin escribir nada - get
/ordersListar los pedidos cambiados desde un momento dado: ítems, totales, estado del pedido y estado del pago - get
/orders/{order}Obtener un pedido - post
/draft-orders/{draft}/completeConfirmar el pedido desde un borrador: cobrarle al cliente o registrar el pago como recibido
- get
Nuevo
Paquetes de visitas
Tipo de producto service_package: un paquete de visitas, un conjunto de visitas a servicios que la tienda vende por adelantado. Los pedidos tienen el campo service_package_issue_amount: el total de paquetes vendidos en el pedido. Un paquete es una obligación de la tienda en visitas, no un ingreso: el ingreso llega cuando se usa una visita del paquete. Restá el campo del total junto con gift_card_issue_amount, reservation_deposit_amount y account_payment_amount.
Endpoints
- get
/ordersListar los pedidos cambiados desde un momento dado: ítems, totales, estado del pedido y estado del pago - get
/orders/{order}Obtener un pedido - post
/orders/{order}/statusPasar un pedido a otro estado de la tienda - post
/orders/{order}/cancelCancelar un pedido - post
/draft-orders/{draft}/completeConfirmar el pedido desde un borrador: cobrarle al cliente o registrar el pago como recibido - get
/bulk-operations/{operation}/resultObtener el resultado de una operación masiva: NDJSON, una línea por línea de entrada o por elemento exportado, o el ZIP de una operación de archivo; se reanuda con Range - get
/productsListar los productos: categorías, opciones y fotos, sin variantes - post
/productsCrear un producto con sus variantes - get
/products/{product}Obtener un producto - patch
/products/{product}Modificar la ficha de un producto: campos, categorías, ID externo - get
/products/by-external-id/{external_id}Obtener un producto por su ID externo - patch
/products/by-external-id/{external_id}Crear o modificar un producto con sus variantes por su ID en la app - put
/products/{product}/optionsReemplazar las opciones del producto y distribuir sus variantes
- get
Lanzamiento
API de integraciones v1
La primera versión del contrato: la tienda y sus locales, el catálogo, el stock, los pedidos y sus estados, los borradores de pedido, los pagos y reembolsos, los clientes, las cargas y operaciones masivas, los eventos y los webhooks. Cada cambio posterior del contrato aparece en este registro.