Índice de endpoints

GET/reports/drivers_orders_status

Informa la cantidad de pedidos agrupados por estado para los repartidores y filtros seleccionados.

GET/reports/drivers_sales

GET/reports/drivers_spend_times

Informa los tiempos promedio de transición entre estados de los pedidos mediante los filtros seleccionados.

GET/reports/drivers_top_categories

GET/reports/drivers_top_orders

GET/reports/drivers_top_selling

GET/reports/grouping_report

GET/reports/hours_report

GET/reports/order_location

GET/reports/orders_drivers

Devuelve datos del informe de pedidos relacionados con repartidores para los filtros seleccionados.

GET/reports/orders_status

Informa la cantidad de pedidos agrupados por estado mediante los filtros seleccionados.

GET/reports/products_report

GET/reports/sales

GET/reports/top_categories

GET/reports/top_selling

GET/reports/users

Informa la cantidad de usuarios registrados agrupada por el intervalo de tiempo solicitado.

GET/reports/orders

Número de pedidos a lo largo del tiempo

Devuelve conteos de pedidos agrupados en franjas de tiempo para pedidos creados en el intervalo seleccionado. El tamaño de cada franja se elige según la longitud del período y se aplican filtros opcionales por negocio, propiedad asociada al administrador de negocio y aplicación.

GET/reports/drivers_delivery_spend

Tiempo promedio de entrega del repartidor

Devuelve el promedio de segundos transcurridos desde la finalización de la recogida por el repartidor ( status:9 ) hasta la finalización de la entrega por el repartidor ( status:11 ) para pedidos creados en el intervalo seleccionado, con un filtro opcional por repartidor. Devuelve null cuando no hay filas aptas.

GET/reports/drivers_pickup_spend

Tiempo promedio de recogida del repartidor

Devuelve el promedio de segundos transcurridos desde la aceptación del repartidor ( status:8 ) hasta que completa la recogida ( status:9 ) para pedidos creados en el intervalo seleccionado, con un filtro opcional por repartidor. Devuelve null cuando ninguna fila cumple los requisitos.

GET/reports/drivers_arrived_pickup_spend

Tiempo promedio desde la llegada hasta la recogida

Devuelve el promedio de segundos transcurridos desde que el repartidor llega al negocio ( status:3 ) hasta que completa la recogida ( status:9 ) para pedidos creados en el intervalo seleccionado, con un filtro opcional por repartidor. Devuelve null cuando ninguna fila cumple los requisitos.

GET/reports/orders_accept_spend

Tiempo promedio que tarda el negocio en aceptar

Devuelve el promedio de segundos transcurridos desde delivery_datetime hasta la aceptación del negocio ( status:7 ) para pedidos creados en el intervalo seleccionado, con filtros opcionales por negocio, propiedad asociada al administrador de negocio y aplicación. Devuelve null cuando no hay filas aptas.

GET/reports/drivers_complete_spend

Tiempo promedio que tarda el repartidor en completar la entrega

Devuelve el promedio de segundos transcurridos desde la asignación del repartidor ( driver_assigned ) hasta que completa la entrega ( status:11 ) para pedidos creados en el intervalo seleccionado, con un filtro opcional por repartidor. Devuelve null cuando ninguna fila cumple los requisitos.

POST/codes/generate

Genera un code de verificación para el canal y el destinatario proporcionados.

GET/codes/verify

Verifica un code con los datos de verificación proporcionados.

POST/codes/verify

Verifica un code con los datos de verificación proporcionados.

GET/offers

POST/offers

DELETE/offers/{offer_id}

GET/offers/{offer_id}

POST/offers/{offer_id}

GET/offers/public

POST/importers

DELETE/importers/{importer_id}

POST/importers/{importer_id}

PUT/importers/{importer_id}

GET/importers/{importer_id}/jobs

GET/franchises

POST/franchises

DELETE/franchises/{franchise_id}

Elimina la franquicia seleccionada.

GET/franchises/{franchise_id}

POST/franchises/{franchise_id}

GET/controls/orders

GET/controls/orders/{order_id}

GET/products

Lista los productos mediante los filtros admitidos de disponibilidad y agrupación en todo el proyecto.

GET/loyalty_plans

POST/loyalty_plans

DELETE/loyalty_plans/{loyalty_plan_id}

GET/loyalty_plans/{loyalty_plan_id}

POST/loyalty_plans/{loyalty_plan_id}

PUT/loyalty_plans/{loyalty_plan_id}

GET/loyalty_plans/{loyalty_plan_id}/businesses

POST/loyalty_plans/{loyalty_plan_id}/businesses

DELETE/loyalty_plans/{loyalty_plan_id}/businesses/{business_id}

GET/loyalty_plans/{loyalty_plan_id}/businesses/{business_id}

POST/loyalty_plans/{loyalty_plan_id}/businesses/{business_id}

PUT/loyalty_plans/{loyalty_plan_id}/businesses/{business_id}

GET/loyalty_levels

POST/loyalty_levels

DELETE/loyalty_levels/{loyalty_level_id}

GET/loyalty_levels/{loyalty_level_id}

POST/loyalty_levels/{loyalty_level_id}

GET/ai/agents/{agent_id}/templates

POST/ai/agents/{agent_id}/templates/{template_id}/send

POST/ai/agents/{agent_id}/templates/refresh

POST/ai/agents/{agent_id}/templates/sync

GET/ai/agents/{agent_id}/translations

PATCH/ai/agents/{agent_id}/translations

PUT/ai/agents/{agent_id}/translations

POST/ai/agents/{agent_id}/translations/copy

GET/ai/agents/{provider_external_id}/conversations/current

Obtener la conversación activa asociada actualmente a un agente

Obtiene o crea la conversación activa de un agente identificado por un ID externo del proveedor

GET/ai/metrics/agents

Obtener métricas de agentes de IA

Devuelve pedidos agrupados por agente (provider + provider_type): Métricas de agente: - Campos provider y provider_type - Número de pedidos - Ingresos generados - Porcentaje de participación (% del total de pedidos) Ordenamiento: Los agentes se ordenan por número de pedidos de forma descendente. Período: - Sin parámetr

GET/ai/metrics/chats

Obtener métricas de chats de IA

Devuelve métricas detalladas de conversaciones (chat) para agentes de IA: Métricas de chat: - Chats activos (status: active) - Chats completados (status: closed, status_reason: completed) - Chats abandonados (status: closed, status_reason: abandoned) - Chats fallidos (status: closed, status_reason: failed) - Tasa de éx

GET/ai/metrics/orders

Obtener métricas de pedidos de IA

Devuelve métricas detalladas de pedidos asistidos por IA: Métricas de pedidos: - Total de pedidos realizados con IA (cuando conversation_id no es null) - Ingresos totales (suma de order.summary.total) - Ingresos promedio por pedido - Pedidos completados (status en 1, 11, 15) - Pedidos cancelados (status en 2, 5, 16) -

GET/ai/metrics/products

Obtener métricas de productos de IA

Devuelve los 10 productos más vendidos de pedidos de IA: Métricas de producto: - ID y nombre del producto - Cantidad vendida (total de unidades) - Número de pedidos que contienen el producto - Ingresos generados por el producto Ordenamiento: Los productos se ordenan por times_sold (cantidad) de forma descendente. Perío

GET/ai/metrics/performance

Obtener métricas de rendimiento de la IA

Devuelve métricas de rendimiento y eficiencia de los agentes de IA: Métricas de rendimiento: - Costo promedio por conversación (costo total / total de conversaciones) - Tiempo promedio de respuesta en milisegundos de las conversaciones - Minutos humanos ahorrados por IA (5 minutos por conversación atendida) - Retorno d

GET/ai/metrics/overview

Obtener resumen general de métricas de IA

Devuelve métricas completas de pedidos y conversaciones para agentes de IA en toda la plataforma: Métricas de pedidos: - Pedidos realizados con IA (cuando conversation_id no es null) - Ingresos totales de pedidos de IA (suma de order.summary.total) - Ingresos promedio por pedido de IA Métricas de conversaciones: - Tota

GET/ai/conversations

Obtener todas las conversaciones

Obtiene una lista paginada de conversaciones de IA, con filtrado y ordenamiento opcionales y carga opcional de relaciones

GET/ai/agents/{provider_external_id}/conversations/current/messages

Obtener todos los mensajes de la conversación actual

Obtiene todos los mensajes públicos de la conversación activa actual de un agente

GET/ai/conversations/{conversation_id}/messages

Obtener todos los mensajes de una conversación

Obtiene una lista paginada de mensajes de una conversación específica, con filtrado y ordenamiento opcionales

GET/ai/conversations/{conversation_id}

Obtener una conversación específica

Obtiene una conversación de IA por ID, con carga opcional de relaciones

POST/auth

Autentica mediante la opción admitida de email, cellphone, one-time-password o guest-token.

POST/auth/{social}

POST/auth/logout

Cierra la sesión del usuario autenticado; token_notification puede eliminar el token de notificación móvil.

POST/auth/platform/apple

POST/auth/platform/facebook

POST/auth/platform/google

POST/auth/platform/login

POST/auth/platform/otp/email/generate

POST/auth/platform/otp/email/verify

POST/auth/platform/otp/phone/generate

POST/auth/platform/otp/phone/verify

POST/auth/platform/password/change

POST/auth/platform/signup

POST/auth/sms/{platform}

Autentica por SMS mediante la plataforma admitida seleccionada.

POST/auth/sms/{platform}/verify

GET/backoffice/schools

GET/backoffice/schools/{school_id}/labels

GET/backoffice/schools/{school_id}/labels.pdf

GET/backoffice/schools/{school_id}/meals

GET/backoffice/schools/{school_id}/reports/kitchen.csv

GET/backoffice/schools/{school_id}/reports/kitchen.xlsx

GET/backoffice/schools/{school_id}/reports/products_ordered.csv

GET/backoffice/schools/{school_id}/reports/products_ordered.pdf

GET/backoffice/schools/{school_id}/reports/products_ordered.xlsx

GET/backoffice/schools/classrooms

POST/backoffice/schools/classrooms

DELETE/backoffice/schools/classrooms/{classroom_id}

PUT/backoffice/schools/classrooms/{classroom_id}

GET/backoffice/schools/grades

POST/backoffice/schools/grades

DELETE/backoffice/schools/grades/{grade_id}

PUT/backoffice/schools/grades/{grade_id}

POST/backoffice/schools/grades/bulk

GET/backoffice/schools/parents/{customer_id}/students

POST/backoffice/schools/parents/{customer_id}/students

DELETE/backoffice/schools/parents/{customer_id}/students/{student_id}

GET/backoffice/schools/reports/kitchen

GET/backoffice/schools/reports/products_ordered

GET/backoffice/schools/students

POST/backoffice/schools/students

DELETE/backoffice/schools/students/{student_id}

GET/backoffice/schools/students/{student_id}

PUT/backoffice/schools/students/{student_id}

POST/backoffice/schools/students/{student_id}/parents

DELETE/backoffice/schools/students/{student_id}/parents/{user_id}

GET/banner

GET/banners

POST/banners

DELETE/banners/{banner_id}

GET/banners/{banner_id}

PUT/banners/{banner_id}

GET/banners/{banner_id}/items

POST/banners/{banner_id}/items

DELETE/banners/{banner_id}/items/{banner_item_id}

GET/banners/{banner_id}/items/{banner_item_id}

POST/banners/{banner_id}/items/{banner_item_id}

POST/bulks/products

PUT/bulks/products

POST/bulks/translations

PUT/bulks/translations

La documentación heredada describe las cargas útiles de edición masiva y eliminación masiva para esta operación. Las dos páginas editoriales siguen siendo distintas: edición masiva de traducciones y eliminación masiva de traducciones.

POST/cart_groups

GET/cart_groups/{cart_group_id}

POST/cart_groups/{cart_group_id}/confirm

POST/cart_groups/{cart_group_id}/place

GET/cart_groups/{cart_group_id}/prepare

POST/cart_groups/{cart_group_id}/wallets

DELETE/cart_groups/{cart_group_id}/wallets/{wallet_id}

GET/carts

Lista los carritos visibles para el solicitante autenticado.

GET/carts/{cart_id}

Obtén un carrito por su UUID, según el alcance de quien realiza la solicitud.

PUT/carts/{cart_id}

Actualiza los campos modificables del carrito identificado.

GET/carts/{cart_id}/businesses

Lista los negocios representados actualmente en el carrito seleccionado.

POST/carts/{cart_id}/confirm

GET/carts/{cart_id}/metafields

POST/carts/{cart_id}/metafields

DELETE/carts/{cart_id}/metafields/{metafield}

GET/carts/{cart_id}/metafields/{metafield}

POST/carts/{cart_id}/metafields/{metafield}

PUT/carts/{cart_id}/metafields/{metafield}

POST/carts/{cart_id}/metafields/bulk_sync

GET/carts/{cart_id}/offers

POST/carts/{cart_id}/place

PUT/carts/{cart_id}/products/{product_id}

GET/carts/{cart_id}/upselling

POST/carts/{cart_id}/wallets

Aplica saldo de la billetera al carrito seleccionado.

DELETE/carts/{cart_id}/wallets/{wallet_id}

Elimina del carrito la asignación de billetera seleccionada.

POST/carts/add_offer

Aplica una oferta a un carrito.

POST/carts/add_product

POST/carts/add_reservation

POST/carts/apply_coupon

Aplica o elimina un coupon para el negocio del carrito seleccionado.

POST/carts/change_driver_tip

Cambia el importe o la tasa de la propina del repartidor para el negocio del carrito seleccionado.

POST/carts/change_paymethod

POST/carts/change_place

POST/carts/clear

Elimina todas las selecciones de productos del carrito identificado.

POST/carts/confirm_group

GET/carts/dashboard

POST/carts/multi_product

POST/carts/place_group

POST/carts/prepare_checkout

POST/carts/remove_offer

POST/carts/remove_product

POST/carts/update_product

GET/categories

GET/checkoutfields

POST/checkoutfields

Crea un campo de checkout del proyecto que se usa en la validación del checkout.

DELETE/checkoutfields/{checkoutfield}

Elimina el campo de checkout seleccionado.

GET/checkoutfields/{checkoutfield}

Obtén el campo de checkout seleccionado.

PUT/checkoutfields/{checkoutfield}

Actualiza el campo de checkout seleccionado.

GET/configs

POST/configs

DELETE/configs/{config}

GET/configs/{config}

PUT/configs/{config}

GET/current

GET/delivery_zones

GET/devices

POST/devices

DELETE/devices/{device_id}

GET/devices/{device_id}

PUT/devices/{device_id}

GET/drivergroups

Lista los grupos de repartidores del proyecto actual.

POST/drivergroups

Crea un grupo de repartidores para el proyecto actual.

GET/drivergroups/{driver_group_id}/deliveryzones

POST/drivergroups/{driver_group_id}/deliveryzones

DELETE/drivergroups/{driver_group_id}/deliveryzones/{delivery_zone_id}

GET/drivergroups/{driver_group_id}/deliveryzones/{delivery_zone_id}

PUT/drivergroups/{driver_group_id}/deliveryzones/{delivery_zone_id}

GET/drivergroups/{driver_group_id}/drivers

GET/drivergroups/{driver_group_id}/logs

DELETE/drivergroups/{drivergroup_id}

Elimina el grupo de repartidores seleccionado.

GET/drivergroups/{drivergroup_id}

Obtén el grupo de repartidores seleccionado.

PUT/drivergroups/{drivergroup_id}

Actualiza el grupo de repartidores seleccionado.

GET/drivergroups/{drivergroup_id}/metafields

Lista los metafields asociados con el grupo de repartidores seleccionado.

POST/drivergroups/{drivergroup_id}/metafields

Crea un metafield para el grupo de repartidores seleccionado.

DELETE/drivergroups/{drivergroup_id}/metafields/{metafield_id}

Elimina un metafield asociado con el grupo de repartidores seleccionado.

GET/drivergroups/{drivergroup_id}/metafields/{metafield_id}

Obtén un metafield asociado con el grupo de repartidores seleccionado.

PUT/drivergroups/{drivergroup_id}/metafields/{metafield_id}

Actualiza un metafield asociado con el grupo de repartidores seleccionado.

POST/drivers/{driver_id}/delivery_blocks

POST/drivers/{driver_id}/delivery_blocks/{delivery_block_id}

PUT/drivers/{driver_id}/delivery_blocks/{delivery_block_id}

GET/drivers/{user_id}/assign_requests

GET/drivers/{user_id}/assign_requests/{request_id}

PUT/drivers/{user_id}/assign_requests/{request_id}

POST/drivers/sync_schedule_events

GET/dropdownoptions

Lista las opciones desplegables disponibles para el proyecto.

POST/dropdownoptions

Crea una opción desplegable disponible para la configuración del proyecto y los recursos compatibles.

DELETE/dropdownoptions/{dropdownoption}

Elimina la opción desplegable seleccionada.

GET/dropdownoptions/{dropdownoption}

Obtén la opción desplegable seleccionada.

PUT/dropdownoptions/{dropdownoption}

Actualiza la opción desplegable seleccionada.

POST/emails/send

GET/fees

POST/fees

DELETE/fees/{fee_id}

GET/fees/{fee_id}

PUT/fees/{fee_id}

GET/files

POST/files

DELETE/files/{file_id}

GET/frontends/first_load

GET/gift_cards

DELETE/gift_cards/{id}

GET/gift_cards/{id}

POST/gift_cards/{id}/send

POST/gift_cards/redeem

POST/helpers/addresses/validate

GET/{internal_name}/businesses

GET/{internal_name}/businesses/{business_id}

GET/{internal_name}/businesses/{business_id}/catalog

GET/{internal_name}/businesses/{business_id}/categories

GET/{internal_name}/businesses/{business_id}/menus

GET/{internal_name}/products/{product_id}

GET/{internal_name}/products/external/{product_external_id}

GET/logistic/orders/{order_id}/information

GET/logs

POST/logs

GET/logs/{log_id}

GET/marketing_campaigns

POST/marketing_campaigns

DELETE/marketing_campaigns/{marketing_campaign_id}

GET/marketing_campaigns/{marketing_campaign_id}

POST/marketing_campaigns/{marketing_campaign_id}

PUT/marketing_campaigns/{marketing_campaign_id}

GET/marketing_campaigns/{marketing_campaign_id}/conditions

POST/marketing_campaigns/{marketing_campaign_id}/conditions

DELETE/marketing_campaigns/{marketing_campaign_id}/conditions/{marketing_campaign_condition_id}

GET/marketing_campaigns/{marketing_campaign_id}/conditions/{marketing_campaign_condition_id}

POST/marketing_campaigns/{marketing_campaign_id}/conditions/{marketing_campaign_condition_id}

PUT/marketing_campaigns/{marketing_campaign_id}/conditions/{marketing_campaign_condition_id}

GET/marketing_campaigns/{marketing_campaign_id}/users

POST/marketing_campaigns/audience

GET/markups

POST/markups

DELETE/markups/{markup_id}

GET/markups/{markup_id}

POST/markups/{markup_id}

PUT/markups/{markup_id}

GET/markups/info

GET/mcp/status

GET/occupations

POST/occupations

POST/occupations/{occupation_id}

GET/order_groups

GET/order_groups/{order_group_id}

GET/order_options

Obtén las opciones de pedido actuales y los carritos activos del usuario autenticado.

POST/order_options

PUT/order_options

GET/orders_deprecate.csv

POST/payments/{gateway}/capture

DELETE/payments/{gateway}/cards

Elimina una tarjeta de pago almacenada mediante el gateway de pago seleccionado.

GET/payments/{gateway}/cards

Lista las tarjetas de pago almacenadas para el gateway seleccionado y el contexto autorizado de usuario o negocio.

POST/payments/{gateway}/cards

POST/payments/{gateway}/cards/default

POST/payments/{gateway}/confirm

GET/payments/{gateway}/requirements

GET/platform_products

POST/platform_products

DELETE/platform_products/{platform_product_id}

GET/platform_products/{platform_product_id}

POST/platform_products/{platform_product_id}

GET/printers

Lista los modelos configurados de impresoras GPRS.

POST/printers

Crea una configuración de modelo de impresora GPRS.

DELETE/printers/{printer}

Elimina el modelo de impresora seleccionado.

GET/printers/{printer}

Obtén el modelo de impresora seleccionado.

PUT/printers/{printer}

Actualiza el modelo de impresora seleccionado.

GET/professionals

GET/professionals/{user_id}

POST/professionals/{user_id}

POST/professionals/{user_id}/google/calendar/sync

GET/schools

GET/schools/{school_id}

GET/schools/students

POST/schools/students

PUT/schools/students/{student_id}

GET/search

GET/search/suggestions

POST/syncs/businesses

POST/syncs/businesses/{business_id}/menus

POST/syncs/businesses/{business_id}/menus/availability

GET/tags

POST/tags

DELETE/tags/{tag_id}

GET/tags/{tag_id}

POST/tags/{tag_id}

GET/{target}/{target_id}/calendar_events

DELETE/{target}/{target_id}/calendar_events/{calendar_event_id}

GET/{target}/{target_id}/calendar_events/{calendar_event_id}

POST/{target}/{target_id}/calendar_events/{calendar_event_id}

PUT/{target}/{target_id}/calendar_events/{calendar_event_id}

GET/taxes

POST/taxes

DELETE/taxes/{tax_id}

GET/taxes/{tax_id}

PUT/taxes/{tax_id}

POST/text_messages/send

GET/theme

GET/themes

POST/themes

DELETE/themes/{theme_id}

GET/themes/{theme_id}

POST/themes/{theme_id}

GET/themes/{theme_id}/gallery

POST/themes/{theme_id}/gallery

DELETE/themes/{theme_id}/gallery/{gallery}

GET/themes/{theme_id}/gallery/{gallery}

POST/themes/{theme_id}/gallery/{gallery}

POST/third_party_integrations

DELETE/third_party_integrations/{third_party_integration_id}

POST/third_party_integrations/{third_party_integration_id}

GET/third_party_integrations/{third_party_integration_key}/business/{external_id}

POST/third_party_integrations/run

GET/tracking_events

POST/tracking_events

GET/usage_limits

Get the project usage limits

Consumption limits in force for the project, with how much of each one is left. Reading never consumes: the counters are read, not incremented. Limits split by the caller (IP, user or API key) are never returned. Limits that only monitor are hidden unless include=monitor is sent, since they change nothing the client ca

GET/users_new.csv

GET/users.csv

GET/validation_field_order_types

GET/validation_field_sites

GET/validationfields

POST/validationfields

DELETE/validationfields/{validationfield_id}

GET/validationfields/{validationfield_id}

PUT/validationfields/{validationfield_id}

DELETE/validationfields/{validationfield_id}/order_types/{order_type_id}

GET/validationfields/{validationfield_id}/order_types/{order_type_id}

POST/validationfields/{validationfield_id}/order_types/{order_type_id}

PUT/validationfields/{validationfield_id}/order_types/{order_type_id}

DELETE/validationfields/{validationfield_id}/sites/{site_id}

GET/validationfields/{validationfield_id}/sites/{site_id}

POST/validationfields/{validationfield_id}/sites/{site_id}

PUT/validationfields/{validationfield_id}/sites/{site_id}

GET/xml/sitemap