API endpoint index
Explore the public API operations. Each link opens the corresponding endpoint in the interactive reference.
Part 2 / 2 · View the other part
Reports
GET/reports/drivers_order_location
GET/reports/drivers_orders_status
Report order counts grouped by status for the selected drivers and filters.
GET/reports/drivers_sales
GET/reports/drivers_spend_times
Report average order status-transition times for the selected filters.
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
Return driver-related order report data for the selected filters.
GET/reports/orders_status
Report order counts grouped by status for the selected filters.
GET/reports/products_report
GET/reports/sales
GET/reports/top_categories
GET/reports/top_selling
GET/reports/users
Report registered-user counts grouped by the requested time interval.
GET/reports/drivers_arrived_pickup_spend
Average arrival-to-pickup time
Returns the average elapsed seconds from the driver arriving at the business ( status:3 ) to driver pickup completion ( status:9 ) for orders created in the selected interval, with an optional driver filter. Returns null when no rows qualify.
GET/reports/orders_accept_spend
Average business acceptance time
Returns the average elapsed seconds from delivery_datetime to business acceptance ( status:7 ) for orders created in the selected interval, with optional business, business-manager ownership, and app filters. Returns null when no rows qualify.
GET/reports/drivers_complete_spend
Average driver completion time
Returns the average elapsed seconds from driver assignment ( driver_assigned ) to driver delivery completion ( status:11 ) for orders created in the selected interval, with an optional driver filter. Returns null when no rows qualify.
GET/reports/drivers_delivery_spend
Average driver delivery time
Returns the average elapsed seconds from driver pickup completion ( status:9 ) to driver delivery completion ( status:11 ) for orders created in the selected interval, with an optional driver filter. Returns null when no rows qualify.
GET/reports/drivers_pickup_spend
Average driver pickup time
Returns the average elapsed seconds from driver acceptance ( status:8 ) to driver pickup completion ( status:9 ) for orders created in the selected interval, with an optional driver filter. Returns null when no rows qualify.
GET/reports/orders
Order counts over time
Returns order counts grouped into time buckets for orders created in the selected interval. The bucket size is chosen from the interval length, and optional business, business-manager ownership, and app filters are applied.
Codes
POST/codes/generate
Generate a verification code for the supplied channel and recipient.
GET/codes/verify
Verify a code using the supplied verification data.
POST/codes/verify
Verify a code using the supplied verification data.
Offers
GET/offers
POST/offers
DELETE/offers/{offer_id}
GET/offers/{offer_id}
POST/offers/{offer_id}
GET/offers/public
Importers
POST/importers
DELETE/importers/{importer_id}
POST/importers/{importer_id}
PUT/importers/{importer_id}
GET/importers/{importer_id}/jobs
Franchises
GET/franchises
POST/franchises
DELETE/franchises/{franchise_id}
Delete the selected franchise.
GET/franchises/{franchise_id}
POST/franchises/{franchise_id}
Controls
GET/controls/orders
GET/controls/orders/{order_id}
Products
GET/products
List products using the supported project-wide availability and grouping filters.
Loyalty plans
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}
Loyalty levels
GET/loyalty_levels
POST/loyalty_levels
DELETE/loyalty_levels/{loyalty_level_id}
GET/loyalty_levels/{loyalty_level_id}
POST/loyalty_levels/{loyalty_level_id}
AI
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/conversations/{conversation_id}
Get a specific conversation
Retrieves a single AI conversation by ID with optional relationship loading
GET/ai/metrics/agents
Get AI agents metrics
Returns orders grouped by agent (provider + provider_type): Agent Metrics: - Provider and provider_type - Number of orders - Revenue generated - Participation percentage (% of total orders) Sorting: Agents are sorted by number of orders in descending order. Time Period: - Without month parameter: Returns agents from cu
GET/ai/metrics/chats
Get AI chats metrics
Returns detailed conversation (chat) metrics for AI agents: Chat Metrics: - Active chats (status: active) - Completed chats (status: closed, status_reason: completed) - Abandoned chats (status: closed, status_reason: abandoned) - Failed chats (status: closed, status_reason: failed) - Success rate (% of completed chats
GET/ai/metrics/orders
Get AI orders metrics
Returns detailed order metrics for AI-assisted orders: Order Metrics: - Total orders made with AI (where conversation_id is not null) - Total revenue (sum of order.summary.total) - Average revenue per order - Completed orders (status in 1, 11, 15) - Cancelled orders (status in 2, 5, 16) - Active orders (status not in c
GET/ai/metrics/performance
Get AI performance metrics
Returns performance and efficiency metrics for AI agents: Performance Metrics: - Average cost per conversation (total cost / total conversations) - Average response time in milliseconds from conversations - Human minutes saved by AI (5 minutes per conversation handled) - Return on investment (orders per dollar spent on
GET/ai/metrics/products
Get AI products metrics
Returns top 10 most sold products from AI orders: Product Metrics: - Product ID and name - Times sold (total quantity sold) - Number of orders containing the product - Revenue generated by the product Sorting: Products are sorted by times_sold (quantity) in descending order. Time Period: - Without month parameter: Retu
GET/ai/conversations
Get all conversations
Retrieves a paginated list of AI conversations with optional filtering, ordering, and relationship loading
GET/ai/conversations/{conversation_id}/messages
Get all messages from a conversation
Retrieves a paginated list of messages from a specific conversation with optional filtering and ordering
GET/ai/agents/{provider_external_id}/conversations/current/messages
Get all messages from current conversation
Retrieves all public messages from the current active conversation for an agent
GET/ai/agents/{provider_external_id}/conversations/current
Get current active conversation for an agent
Retrieves or creates the current active conversation for an agent identified by provider external ID
GET/ai/metrics/overview
Get general AI metrics overview
Returns comprehensive order and conversation metrics for AI agents across the platform: Orders Metrics: - Orders made with AI (where conversation_id is not null) - Total revenue from AI orders (sum of order.summary.total) - Average revenue per AI order Conversations Metrics: - Total conversations - Conversations groupe
Auth
POST/auth
Authenticate using the supported email, cellphone, one-time-password, or guest-token branch.
POST/auth/{social}
POST/auth/logout
Log out the authenticated user; token_notification can remove the mobile notification token.
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}
Authenticate by SMS using the selected supported platform.
POST/auth/sms/{platform}/verify
Backoffice
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}
Banner
GET/banner
Banners
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}
Bulks
POST/bulks/products
PUT/bulks/products
POST/bulks/translations
PUT/bulks/translations
Legacy documentation describes both bulk edit and bulk delete payloads for this operation. The two editorial pages remain distinct: bulk edit translations and bulk delete translations.
Cart Groups
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}
Carts
GET/carts
List carts visible to the authenticated caller.
GET/carts/{cart_id}
Retrieve one cart by its UUID, subject to caller scope.
PUT/carts/{cart_id}
Update mutable fields on the identified cart.
GET/carts/{cart_id}/businesses
List businesses currently represented in the selected cart.
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
Apply wallet value to the selected cart.
DELETE/carts/{cart_id}/wallets/{wallet_id}
Remove the selected wallet allocation from a cart.
POST/carts/add_offer
Apply an offer to a cart.
POST/carts/add_product
POST/carts/add_reservation
POST/carts/apply_coupon
Apply or clear a coupon for the selected cart business.
POST/carts/change_driver_tip
Change the driver tip amount or rate for the selected cart business.
POST/carts/change_paymethod
POST/carts/change_place
POST/carts/clear
Remove all product selections from the identified cart.
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
Categories
GET/categories
Checkoutfields
GET/checkoutfields
POST/checkoutfields
Create a project checkout field used by checkout validation.
DELETE/checkoutfields/{checkoutfield}
Delete the selected checkout field.
GET/checkoutfields/{checkoutfield}
Retrieve the selected checkout field.
PUT/checkoutfields/{checkoutfield}
Update the selected checkout field.
Configs
GET/configs
POST/configs
DELETE/configs/{config}
GET/configs/{config}
PUT/configs/{config}
Current
GET/current
Delivery Zones
GET/delivery_zones
Devices
GET/devices
POST/devices
DELETE/devices/{device_id}
GET/devices/{device_id}
PUT/devices/{device_id}
Drivergroups
GET/drivergroups
List driver groups for the current project.
POST/drivergroups
Create a driver group for the current project.
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}
Delete the selected driver group.
GET/drivergroups/{drivergroup_id}
Retrieve the selected driver group.
PUT/drivergroups/{drivergroup_id}
Update the selected driver group.
GET/drivergroups/{drivergroup_id}/metafields
List the metafields associated with the selected driver group.
POST/drivergroups/{drivergroup_id}/metafields
Create a metafield for the selected driver group.
DELETE/drivergroups/{drivergroup_id}/metafields/{metafield_id}
Delete a metafield associated with the selected driver group.
GET/drivergroups/{drivergroup_id}/metafields/{metafield_id}
Retrieve one metafield associated with the selected driver group.
PUT/drivergroups/{drivergroup_id}/metafields/{metafield_id}
Update a metafield associated with the selected driver group.
Drivers
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
Dropdownoptions
GET/dropdownoptions
List dropdown options available to the project.
POST/dropdownoptions
Create a dropdown option available to project configuration and supported resources.
DELETE/dropdownoptions/{dropdownoption}
Delete the selected dropdown option.
GET/dropdownoptions/{dropdownoption}
Retrieve the selected dropdown option.
PUT/dropdownoptions/{dropdownoption}
Update the selected dropdown option.
Emails
POST/emails/send
Fees
GET/fees
POST/fees
DELETE/fees/{fee_id}
GET/fees/{fee_id}
PUT/fees/{fee_id}
Files
GET/files
POST/files
DELETE/files/{file_id}
Frontends
GET/frontends/first_load
Gift Cards
GET/gift_cards
DELETE/gift_cards/{id}
GET/gift_cards/{id}
POST/gift_cards/{id}/send
POST/gift_cards/redeem
Helpers
POST/helpers/addresses/validate
Internal Name
GET/{internal_name}/businesses
GET/{internal_name}/businesses/{business_id}
GET/{internal_name}/businesses/{business_id}/catalog
GET/{internal_name}/businesses/{business_id}/menus
GET/{internal_name}/products/{product_id}
GET/{internal_name}/products/external/{product_external_id}
Logistic
GET/logistic/orders/{order_id}/information
Logs
GET/logs
POST/logs
GET/logs/{log_id}
Marketing Campaigns
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
Markups
GET/markups
POST/markups
DELETE/markups/{markup_id}
GET/markups/{markup_id}
POST/markups/{markup_id}
PUT/markups/{markup_id}
GET/markups/info
Mcp
GET/mcp/status
Occupations
GET/occupations
POST/occupations
POST/occupations/{occupation_id}
Order Groups
GET/order_groups
GET/order_groups/{order_group_id}
Order Options
GET/order_options
Retrieve the authenticated user's current order options and active carts.
POST/order_options
PUT/order_options
Orders Deprecate.Csv
GET/orders_deprecate.csv
Payments
POST/payments/{gateway}/capture
DELETE/payments/{gateway}/cards
Delete a stored payment card through the selected payment gateway.
GET/payments/{gateway}/cards
List stored payment cards for the selected gateway and authorized user/business context.
POST/payments/{gateway}/cards
POST/payments/{gateway}/cards/default
POST/payments/{gateway}/confirm
GET/payments/{gateway}/requirements
Platform Products
GET/platform_products
POST/platform_products
DELETE/platform_products/{platform_product_id}
GET/platform_products/{platform_product_id}
POST/platform_products/{platform_product_id}
Printers
GET/printers
List configured GPRS printer models.
POST/printers
Create a GPRS printer model configuration.
DELETE/printers/{printer}
Delete the selected printer model.
GET/printers/{printer}
Retrieve the selected printer model.
PUT/printers/{printer}
Update the selected printer model.
Professionals
GET/professionals
GET/professionals/{user_id}
POST/professionals/{user_id}
POST/professionals/{user_id}/google/calendar/sync
Schools
GET/schools
GET/schools/{school_id}
GET/schools/students
POST/schools/students
PUT/schools/students/{student_id}
Search
GET/search
GET/search/suggestions
Syncs
POST/syncs/businesses
POST/syncs/businesses/{business_id}/menus
POST/syncs/businesses/{business_id}/menus/availability
Tags
GET/tags
POST/tags
DELETE/tags/{tag_id}
GET/tags/{tag_id}
POST/tags/{tag_id}
Target
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}
Taxes
GET/taxes
POST/taxes
DELETE/taxes/{tax_id}
GET/taxes/{tax_id}
PUT/taxes/{tax_id}
Text Messages
POST/text_messages/send
Theme
GET/theme
Themes
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}
Third Party Integrations
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
Tracking Events
GET/tracking_events
POST/tracking_events
Usage Limits
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