AppApi

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

appGooglePayConfig

GooglePayResponse appGooglePayConfig()

Get Google Pay configuration for mobile app integration.

Returns the necessary configuration to initialize Google Pay in the mobile application, including merchant details, gateway name, and supported payment methods.

Parameters

This endpoint does not need any parameter.

Return type

GooglePayResponse

Authorization

PaymentIntentStatusResponse

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

appPaymentIntentStatus

PaymentIntentStatusResponse appPaymentIntentStatus(id)

Get the status of a payment intent.

Polls the status of a payment intent from the payment provider (Stripe). Useful for checking if a payment has been completed successfully.

Parameters

Name	Type	Description	Notes
id	String	The ID of the payment intent to check.	[default to null]

Return type

Authorization

PaymentMethodEnabledResponse

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

appPaymentMethodEnabled

PaymentMethodEnabledResponse appPaymentMethodEnabled(method)

Check if a specific payment method is enabled for the platform.

Verifies whether a payment gateway or method is currently active and available for use. This endpoint helps mobile apps determine which payment options to display to users.

Parameters

Name	Type	Description	Notes
method	String	The payment method identifier to check (e.g., “stripe”, “paypal”, “apple_pay”).	[default to null]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

externalRedirect

oas_any_type_not_mapped externalRedirect(endpoint)

Fetch JSON response from external endpoint

Proxies a request to the specified external endpoint and returns its JSON response. The endpoint is sanitized before making the request, and authentication is required to prevent unauthorized access to external services through the proxy.

Parameters

Name	Type	Description	Notes
endpoint	String	URL of the external endpoint to fetch JSON data from	[default to null]

Return type

any

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

externalWebRedirect

externalWebRedirect(code, state_val, error, error_description)

Process OAuth callback and generate redirect URL

Handles OAuth authorization callbacks by collecting query parameters (code, state, error) and constructing a redirect URL to the web application. Used primarily for social login flows where the OAuth provider redirects back to the API with authorization results.

Parameters

Name	Type	Description	Notes
code	String	OAuth authorization code from the provider	[optional] [default to null]
state_val	String	OAuth state parameter for CSRF protection	[optional] [default to null]
error	String	Error code if OAuth authorization failed	[optional] [default to null]
error_description	String	Human-readable error description if OAuth failed	[optional] [default to null]

Return type

null (empty response body)

Authorization

PaginatedResponse_BannerResponse

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

forwardGeocoding

GeocodeResponse forwardGeocoding(latitude, longitude, keyword)

Convert addresses to coordinates or coordinates to addresses

Performs forward geocoding when a keyword is provided, or reverse geocoding when latitude and longitude are provided. Returns detailed address information including formatted address, geographic coordinates, and administrative area components.

Parameters

Name	Type	Description	Notes
latitude	Double	Latitude coordinate for reverse geocoding (-90 to 90)	[optional] [default to null]
longitude	Double	Longitude coordinate for reverse geocoding (-180 to 180)	[optional] [default to null]
keyword	String	Address search keyword for forward geocoding	[optional] [default to null]

Return type

GeocodeResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getAppSettings

AppSettingsResponse getAppSettings(authorization)

Retrieve application settings

Returns comprehensive application configuration including system settings, feature flags, and user-specific preferences. Response varies based on authentication status - authenticated users receive personalized settings.

Parameters

Name	Type	Description	Notes
authorization	String	Optional JWT bearer token for authenticated requests	[optional] [default to null]

Return type

AppSettingsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getBanners

PaginatedResponse_BannerResponse getBanners(vendor_type_id, featured, latitude, longitude, radius_km, include_geometry_stats, spatial_precision, page, per_page)

List all banners with optional filtering.

Retrieves promotional banners with extensive filtering options including vendor type, featured status, and geographic constraints. Returns sorted banners with optional geometry stats.

Parameters

Name	Type	Description	Notes
vendor_type_id	Long	Vendor type ID to filter banners by business category	[optional] [default to null]
featured	Boolean	Whether to filter for featured banners only	[optional] [default to null]
latitude	Double	User’s current latitude for location-based banner filtering	[optional] [default to null]
longitude	Double	User’s current longitude for location-based banner filtering	[optional] [default to null]
radius_km	Double	Search radius in kilometers for geo-filtering (default uses delivery zones)	[optional] [default to null]
include_geometry_stats	Boolean	Include detailed geometry statistics for delivery zones in response	[optional] [default to null]
spatial_precision	String	Spatial precision level: “exact”, “buffer”, or “approximate” (default)	[optional] [default to null]
page	Integer	Page number for pagination (starts at 1)	[optional] [default to null]
per_page	Integer	Number of items per page (default: 20)	[optional] [default to null]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getCitiesByCountry

PaginatedResponse_CityResponse getCitiesByCountry(country_code, search, state_id, page, page_size)

Get cities by country ISO2 code with optional search filter

Returns cities for a given country identified by its ISO2 code (e.g., “US”, “GB”, “EE”). Supports searching by city name and filtering by state. Results are sorted alphabetically.

Parameters

Name	Type	Description	Notes
country_code	String	ISO 3166-1 alpha-2 country code (e.g., “US”, “GB”, “EE”)	[default to null]
search	String	Optional search term to filter cities by name	[optional] [default to null]
state_id	Long	Optional state ID to filter cities within a specific state	[optional] [default to null]
page	Integer	Page number to retrieve (defaults to 1)	[optional] [default to null]
page_size	Integer	Number of cities per page (defaults to 50)	[optional] [default to null]

Return type

PaginatedResponse_CityResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getCitiesByState

PaginatedResponse_CityResponse getCitiesByState(id, state_id, page, page_size)

Retrieve paginated list of cities for a specific state

Returns all cities within a specified state, including their boundaries, timezone information, and UTC offset data. Supports pagination for states with large numbers of cities. Useful for building location hierarchies and providing accurate timezone-aware services.

Parameters

Name	Type	Description	Notes
id	Long	Unique identifier of the country (required for path structure)	[default to null]
state_id	Long	Unique identifier of the state to retrieve cities for	[default to null]
page	Integer	Page number to retrieve (defaults to 1)	[optional] [default to null]
page_size	Integer	Number of cities per page (defaults to 10)	[optional] [default to null]

Return type

PaginatedResponse_CityResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getCountries

PaginatedResponse_CountryResponse getCountries(search, page, page_size)

Get countries with optional search filter

Returns a paginated list of countries with essential information including name, ISO codes, phone code, timezone, and currency data. Supports searching by country name or ISO2 code.

Parameters

Name	Type	Description	Notes
search	String	Optional search term to filter countries by name or ISO2 code	[optional] [default to null]
page	Integer	Page number to retrieve (defaults to 1)	[optional] [default to null]
page_size	Integer	Number of countries per page (defaults to 50)	[optional] [default to null]

Return type

PaginatedResponse_CountryResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getEntityTypeNotificationPreferences

NotificationPreferences getEntityTypeNotificationPreferences(entity_type, entity_id)

Get notification preferences by entity type

Retrieves the user’s notification preferences for an entire entity type, optionally scoped to a specific entity ID. This endpoint supports querying type-level defaults (e.g., all vendor notifications) or individual entity settings when entity_id is provided.

Parameters

Name	Type	Description	Notes
entity_type	String	Type of entity (e.g., “vendor”, “order”, “driver”)	[default to null]
entity_id	Long	Optional specific entity ID to scope the preferences query	[optional] [default to null]

Return type

Authorization

PaginatedResponse_FaqResponse

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getFaqs

PaginatedResponse_FaqResponse getFaqs(faq_type, page, per_page)

List FAQs, optionally filtered by type

Retrieves a list of frequently asked questions from the knowledge base. Results can be filtered by FAQ type/category to show only relevant questions. This endpoint is public and does not require authentication for broader accessibility.

Parameters

Name	Type	Description	Notes
faq_type	String	Optional FAQ category filter (e.g., “billing”, “technical”, “account”)	[optional] [default to null]
page	Integer	Page number for pagination (starts at 1)	[optional] [default to null]
per_page	Integer	Number of items per page (default: 20)	[optional] [default to null]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getGlobalNotificationPreferences

NotificationPreferences getGlobalNotificationPreferences()

Get global notification preferences

Retrieves the user’s global notification preferences that apply across all entities. Global preferences serve as the default settings when entity-specific preferences are not configured, controlling overall notification behavior for push, email, and SMS.

Parameters

This endpoint does not need any parameter.

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getIpInfo

IpInfoResponse getIpInfo()

Retrieve geographic location information for the client’s IP address

Performs GeoIP2 database lookup to determine the geographic location of the requesting client. Returns coordinates, country, subdivision, city, and accuracy information. Automatically detects the client’s real IP address from request headers.

Parameters

This endpoint does not need any parameter.

Return type

IpInfoResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getNotificationPreferences

NotificationPreferences getNotificationPreferences(entity_type, entity_id)

Get notification preferences for specific entity

Retrieves the user’s notification preferences configured for a specific entity instance. This allows checking whether push, email, or SMS notifications are enabled for a particular vendor, order, or other entity type identified by entity_type and entity_id.

Parameters

Name	Type	Description	Notes
entity_type	String	Type of entity (e.g., “vendor”, “order”, “driver”)	[default to null]
entity_id	Long	Unique identifier of the specific entity instance	[default to null]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getPlaceDetails

GeocodeResponse getPlaceDetails(place_id)

Retrieve comprehensive details for a specific place using its unique identifier

Fetches detailed place information from Google Maps Places API using a place ID. Returns complete address information, coordinates, and administrative components for the specified location. Requires user authentication.

Parameters

Name	Type	Description	Notes
place_id	String	Google Maps place ID to retrieve details for	[default to null]

Return type

GeocodeResponse

Authorization

PaginatedResponse_LocationStateResponse

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getStates

PaginatedResponse_LocationStateResponse getStates(country_id, page, page_size)

Retrieve paginated list of states for a specific country

Returns all states or provinces within a specified country, including their boundaries, status, and geographic metadata. Supports pagination for countries with large numbers of administrative divisions.

Parameters

Name	Type	Description	Notes
country_id	Long	Unique identifier of the country to retrieve states for	[default to null]
page	Integer	Page number to retrieve (defaults to 1)	[optional] [default to null]
page_size	Integer	Number of states per page (defaults to 10)	[optional] [default to null]

Return type

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getTaxiPaymentGatewayMethods

PaginatedResponse_PaymentMethodResponse getTaxiPaymentGatewayMethods(page, per_page)

List payment gateway methods for taxi/ride-sharing

Returns payment gateway methods available for taxi and ride-sharing services. These payment methods are specifically configured for taxi operations.

Parameters

Name	Type	Description	Notes
page	Integer		[optional] [default to null]
per_page	Integer		[optional] [default to null]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getVendorPaymentGatewayMethods

PaginatedResponse_PaymentMethodResponse getVendorPaymentGatewayMethods(vendor_id, page, per_page)

List payment gateway methods for a specific vendor

Returns payment gateway methods (Wallet, Cash, Stripe, etc.) available for orders from a specific vendor. Use this endpoint when checking out with a vendor.

Parameters

Name	Type	Description	Notes
vendor_id	Long	Vendor ID to get payment methods for	[default to null]
page	Integer		[optional] [default to null]
per_page	Integer		[optional] [default to null]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getVendorPickupPaymentGatewayMethods

PaginatedResponse_PaymentMethodResponse getVendorPickupPaymentGatewayMethods(vendor_id, page, per_page)

List payment gateway methods for pickup orders

Returns payment gateway methods available for pickup orders from a specific vendor. Pickup orders may have different payment options than delivery orders.

Parameters

Name	Type	Description	Notes
vendor_id	Long	Vendor ID to get pickup payment methods for	[default to null]
page	Integer		[optional] [default to null]
per_page	Integer		[optional] [default to null]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getWalletPaymentGatewayMethods

PaginatedResponse_PaymentMethodResponse getWalletPaymentGatewayMethods(page, per_page)

List payment gateway methods for wallet operations

Returns payment gateway methods available for wallet top-ups and transfers. These payment methods are specifically configured for wallet operations.

Parameters

Name	Type	Description	Notes
page	Integer		[optional] [default to null]
per_page	Integer		[optional] [default to null]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

reverseGeocoding

GeocodeResponse reverseGeocoding(latitude, longitude)

Convert geographic coordinates to a human-readable address

Performs reverse geocoding to convert latitude and longitude coordinates into a detailed address with components including country, city, postal code, street information, and administrative areas. Uses Google Maps Geocoding API for accurate address resolution.

Parameters

Name	Type	Description	Notes
latitude	Double	Latitude coordinate of the location (-90 to 90)	[default to null]
longitude	Double	Longitude coordinate of the location (-180 to 180)	[default to null]

Return type

GeocodeResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

updateEntityTypeNotificationPreferences

NotificationPreferences updateEntityTypeNotificationPreferences(entity_type, UpdateNotificationPreferencesRequest, entity_id)

Update notification preferences by entity type

Updates the user’s notification preferences for an entire entity type, optionally scoped to a specific entity ID. This allows configuring type-level defaults that apply to all entities of a type, or updating settings for a specific entity when entity_id is provided.

Parameters

Name	Type	Description	Notes
entity_type	String	Type of entity (e.g., “vendor”, “order”, “driver”)	[default to null]
UpdateNotificationPreferencesRequest	UpdateNotificationPreferencesRequest	Updated notification preference settings (push, email, SMS flags)
entity_id	Long	Optional specific entity ID to scope the preferences update	[optional] [default to null]

Return type

Authorization

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

updateGlobalNotificationPreferences

NotificationPreferences updateGlobalNotificationPreferences(UpdateNotificationPreferencesRequest)

Update global notification preferences

Updates the user’s global notification preferences that apply across all entities. These settings serve as defaults for all entity types unless overridden by entity-specific preferences, allowing users to control their overall notification experience.

Parameters

Name	Type	Description	Notes
UpdateNotificationPreferencesRequest	UpdateNotificationPreferencesRequest	Updated global notification preference settings (push, email, SMS flags)

Return type

Authorization

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

updateNotificationPreferences

NotificationPreferences updateNotificationPreferences(entity_type, entity_id, UpdateNotificationPreferencesRequest)

Update notification preferences for specific entity

Updates the user’s notification preferences for a specific entity instance. This allows users to customize their notification settings for individual vendors, orders, or other entities, overriding global preferences with entity-specific controls.

Parameters

Name	Type	Description	Notes
entity_type	String	Type of entity (e.g., “vendor”, “order”, “driver”)	[default to null]
entity_id	Long	Unique identifier of the specific entity instance	[default to null]
UpdateNotificationPreferencesRequest	UpdateNotificationPreferencesRequest	Updated notification preference settings (push, email, SMS flags)

Return type

Authorization