API endpoint index

Explore the public API operations. Each link opens the corresponding endpoint in the interactive reference.

Users

Record a location update for the selected driver.

Delete a driver location associated with the selected user.

List the metafields associated with the selected user.

Create a metafield for the selected user.

Delete a metafield associated with the selected user.

Retrieve one metafield associated with the selected user.

Update a metafield associated with the selected user.

List reviews associated with the selected user.

Create a review associated with the selected user.

Retrieve one review associated with the selected user.

List wallets belonging to the selected user.

Retrieve the selected wallet belonging to a user.

List events from the selected user wallet.

Retrieve the selected event from a user wallet.

Returns one user by ID. See the Get user guide for access-level restrictions and SDK usage.

List notification tokens for the selected user.

Create a notification token for the selected user.

Delete the selected notification token.

List completed orders for the selected user that are eligible for a review.

Reset a password using the code and random value issued by the forgot-password flow.

Businesses

Business

List metafields attached to a category in the selected business.

Delete one metafield from a category in the selected business.

Update one metafield on a category in the selected business.

List the ingredients associated with the selected product in its business and category hierarchy.

Retrieve one ingredient associated with the selected product in its business and category hierarchy.

List metafields attached to a product in the selected business and category.

Create a metafield on a product in the selected business and category.

Delete one metafield from a product in the selected business and category.

Retrieve one metafield from a product in the selected business and category.

Update one metafield on a product in the selected business and category.

List delivery zones for the selected business.

Create a delivery zone for the selected business.

Delete the selected delivery zone from a business.

Retrieve the selected delivery zone for a business.

Update the selected delivery zone for a business.

List extras, or product option groups, for the selected business.

Create an extra, or product option group, for the selected business.

Delete one extra from the selected business.

Retrieve one extra, or product option group, from the selected business.

Update one extra, or product option group, in the selected business.

List the metafields associated with the selected extra within a business.

Create a metafield for the selected extra within a business.

Delete a metafield associated with the selected extra within a business.

Retrieve one metafield associated with the selected extra within a business.

Update the selected metafield for a product extra.

List the options for the selected extra within a business.

Create an option for the selected extra within a business.

Delete an option from the selected extra within a business.

Retrieve one option from the selected extra within a business.

Update an option associated with the selected extra within a business.

List the suboptions for the selected option within an extra and business.

Create a suboption for the selected option within an extra and business.

Delete a suboption from the selected option within an extra and business.

Retrieve one suboption from the selected option within an extra and business.

Update a suboption associated with the selected option within an extra and business.

Create a maximum rule for the selected business.

Delete a shared menu association from the selected business.

Update the enabled or snooze settings for a shared menu association.

Delete the selected menu associated with a business.

List metafields attached to the selected business.

Create a metafield attached to the selected business.

Retrieve one metafield belonging to the selected business.

Update one metafield attached to the selected business.

List offers associated with the selected business.

Create a business offer. Offers can apply automatically or use a coupon; coupon is required when type is 2.

Delete the selected offer associated with a business.

List products associated with the selected business.

List gallery items for the selected business.

Create a gallery item for the selected business.

Delete a gallery item from the selected business.

Retrieve one gallery item from the selected business.

List reviews associated with the selected business.

Retrieve one review associated with the selected business.

List webhook configurations for the selected business.

Create a webhook configuration for the selected business.

Delete a webhook configuration from the selected business.

Update a webhook configuration for the selected business.

Find Business Offer

Retrieve the selected offer associated with a business.

Update Business Offer

Update an offer or coupon associated with the selected business.

Business TYpes

List business types available to the project, subject to current filters.

Retrieve one business type by its identifier.

Orders

Create a message associated with the selected order.

List attachments associated with the selected order.

Create an attachment for the selected order.

Delete the selected attachment from an order.

Event Rules

List event rules configured for the project.

Delete the selected event rule.

Retrieve one event rule by identifier.

Update the selected event rule.

List channels belonging to the selected event rule.

Delete the selected channel from an event rule.

Retrieve one channel belonging to the selected event rule.

Delivery Options

List delivery options for the current project.

Create a delivery option for the current project.

Delete the selected delivery option.

Retrieve the selected delivery option.

Update the selected delivery option.

Driver Companies

Languages

List languages configured for the project.

Create a language configuration for the project.

Delete the selected language.

Retrieve the selected language.

Update the selected language.

Translations

Countries

Config Categories

Create a configuration category for the project.

Delete the selected configuration category.

Retrieve the selected configuration category.

Update the selected configuration category.

Paymethods

List payment methods available to the project and caller context.

Retrieve the selected project payment-method definition.

Update the selected project payment-method definition.

Webhooks

List webhooks for the current project.

Create a webhook for the current project.

Delete the selected webhook.

Update the selected webhook.

SEO

Retrieve SEO metadata for the selected business.

Retrieve SEO metadata for the selected category within a business.

Retrieve product metadata for the selected business and category.

Zapier

Reports

Report average customer satisfaction ratings for orders matching the selected filters.

Report elapsed time for driver order acceptance using the selected filters.

Report driver availability time using the selected filters.

Report average driver busy time for the selected filters.