API reference

Every published endpoint, with parameters, responses and a console to try them out.

Transactions API

Deprecated

Endpoints para consultar el detalle de transacciones de los comercios asociados al usuario autenticado. Se identifica con usuario y contraseña. Para integraciones nuevas usá la Transactions API v2, que usa API key y secret.

POST/api/v1.0/TokenObtiene un token válido de usuario GET/api/v1.0/TransactionDetailReportObtiene la información del detalle de transacciones de los comercios asociados a la cuenta token del usuario.

Authorization API v1

Emisión de access tokens a partir de la API key y el secret. Es la puerta de entrada a la Catalog API y a la Transactions API v2.

POST/oauth/tokenEmite un access token a partir de la API key y el secret.

Transactions API v2

Consulta de ventas, cobros, movimientos de caja y detalle de transacciones. Se identifica con API key y secret, la misma credencial que la Catalog API.

GET/api/v2.0/salesVentas por rango (cursor-based).GET/api/v2.0/paymentsCobros por rango (cursor-based).GET/api/v2.0/cash-movementsMovimientos de caja por rango (cursor-based).GET/api/v2.0/TransactionDetailReportObtiene la información del detalle de transacciones de los comercios asociados a la cuenta token del usuario.GET/api/v2.0/Transaction/GetTransactionsTransacciones con sus ítems consumidos.

Catalog API

Catálogo de un comercio: productos, categorías, combos, cartas y opciones.

POST/api/v2.0/Products/{shopCode}Crea un producto.GET/api/v1.0/Products/{shopCode}Lista los productos de un comercio.PUT/api/v1.0/Products/{sku}Modifica un producto.DEL/api/v1.0/Products/{sku}Elimina un producto.POST/api/v2.0/Categories/{shopCode}Crea una categoría.GET/api/v1.0/Categories/{shopCode}Lista las categorías de un comercio.PUT/api/v1.0/Categories/{categoryUuid}Modifica una categoría.DEL/api/v1.0/Categories/{categoryUuid}Elimina una categoría.POST/api/v2.0/Combos/{shopCode}Crea un combo.GET/api/v1.0/Combos/{shopCode}Lista los combos de un comercio.PUT/api/v1.0/Combos/{sku}Modifica un combo.DEL/api/v1.0/Combos/{sku}Elimina un combo.POST/api/v2.0/Menus/{shopCode}Crea una carta.GET/api/v1.0/Menus/{shopCode}Lista las cartas de un comercio.PUT/api/v1.0/Menus/{menuUuid}Modifica una carta.DEL/api/v1.0/Menus/{menuUuid}Elimina una carta.PUT/api/v1.0/Menus/{menuUuid}/originsCambia los canales de una carta.PUT/api/v1.0/Menus/{menuUuid}/availabilityCambia la disponibilidad de un ítem de la carta.PUT/api/v1.0/Menus/{menuUuid}/priceCambia el precio de un ítem de la carta.PUT/api/v1.0/Menus/{menuUuid}/remove-itemQuita un ítem de la carta.POST/api/v2.0/OptionGroups/{shopCode}Crea un grupo de opciones.GET/api/v1.0/OptionGroups/{shopCode}Lista los grupos de opciones con sus opciones.PUT/api/v1.0/OptionGroups/{id}Modifica un grupo de opciones.DEL/api/v1.0/OptionGroups/{id}Elimina un grupo de opciones.POST/api/v2.0/Options/{shopCode}Crea una opción.PUT/api/v1.0/Options/{id}Modifica una opción.DEL/api/v1.0/Options/{id}Elimina una opción.