Grubtech Grocery APIs

Menu

Menu Notification

The POST/menus/notification webhook allows Grubtech to notify an external service or application whenever there are changes to the menu. This can include events such as the creation of a new menu or updates to an existing menu. The notification is sent to a specified webhook URL provided by the external service.

For more details refer POST/menus/notification API Reference.

Update Menu

The GET/{storeId}/menus/{menuId} is an endpoint provided by Grubtech that enables integration partners to retrieve the latest menu information for a specific store. By using this endpoint, partners can ensure they always have access to the most up-to-date menu data, including items, categories, prices, and availability.

For more details refer GET/{storeId}/menus/{menuId} API Reference.

Menu Items Availability

The POST/{storeId}/menus/items/availability endpoint is designed to enable Grubtech to notify external systems about changes in the availability and quantities of menu items. This is achieved by pushing updates to a specified webhook URL whenever there are changes in item availability or stock levels. This ensures that the external systems have the most up-to-date information, enhancing the accuracy and reliability of their menu offerings.

For more details refer POST/{storeId}/menus/items/availability API Reference.

Menu Sync Status

The POST/{storeId}/menus/sync-status endpoint is designed to enable external systems to notify Grubtech about the status of their menu synchronization processes. This helps Grubtech to track the synchronization status and ensure that menu data is accurately and efficiently communicated between systems. The status updates can include information about successful synchronizations, errors encountered, and other relevant details.

For more details refer POST/{storeId}/menus/sync-status API Reference.

Order

Submit Order

The POST/{applicationId}/orders endpoint is designed to enable external systems, such as third-party ordering platforms, to send order information to the Grubtech platform. This integration ensures that orders placed on external systems are seamlessly pushed to Grubtech, allowing for centralized order management, processing, and fulfillment.

For more details refer POST/{applicationId}/orders API Reference.

Start Order

The POST/orders/{id}/started endpoint is designed to enable Grubtech to notify external systems when an order has been started. This is achieved by sending an HTTP POST request to a specified webhook URL with details about the order. This notification helps external systems keep track of the order status in real-time, ensuring they are updated when the preparation of the order begins.

For more details refer POST/orders/{id}/started API Reference.

Prepare Order

The POST/orders/{id}/prepared endpoint is designed to enable Grubtech to mark an order as prepared and communicate any final amendments made to the order. This endpoint is useful for notifying external systems that an order is ready for pickup or delivery, ensuring that the latest order details are accurately recorded.

For more details refer POST/orders/{id}/prepared API Reference.

Submit Final Order

The PUT/{applicationId}/orders/{id} endpoint is designed to enable aggregator platforms to send the final order details to Grubtech. This includes the final pricing calculations and any amendments made to the order. This ensures that Grubtech receives the most accurate and up-to-date information about the order, facilitating smooth processing and fulfillment.

For more details refer PUT/{applicationId}/orders/{id} API Reference.

Collect Order

The POST/orders/{id}/ready-to-collect endpoint is designed to mark an order as ready for collection. This notification is critical for both the customers and the external systems to ensure they are aware that the order is prepared and can be collected. This helps streamline the order fulfillment process and enhances the customer experience by providing timely updates.

For more details refer POST/orders/{id}/ready-to-collect API Reference.

Cancel Order on Aggregator Platform

The POST/orders/{id}/cancel endpoint is designed to allow the cancellation of an order on the aggregator platform. This is essential for managing scenarios where an order can no longer be fulfilled, whether due to customer request, inventory issues, or other reasons. By providing a structured way to cancel orders, this endpoint helps maintain accurate order status and improves overall order management.

For more details refer POST/orders/{id}/ready-to-collect API Reference.

Cancel Order on Grubtech

The POST/{applicationId}/orders/{id}/cancel endpoint is designed to allow external applications, identified by the applicationId, to cancel an order on the Grubtech platform. This endpoint provides a structured way for aggregator platforms or external systems to initiate the cancellation of orders, ensuring that cancellations are accurately recorded and processed in the Grubtech system.

For more details refer POST/{applicationId}/orders/{id}/cancel API Reference.

Order Amendments

Substitute Order Items

The GET/orders/{orderId}/substitute/{OrderItemLineId} endpoint is designed to allow Grubtech to retrieve eligible substitutions for a specific item in an order. This feature is particularly useful when the aggregator platform supports substitutions, allowing customers to choose alternative items if their initial selection is unavailable or if they prefer a different option. By providing a list of eligible substitutions, Grubtech enhances customer satisfaction and maintains flexibility in order fulfillment.

For more details refer GET/orders/{orderId}/substitute/{OrderItemLineId} API Reference.

Amend Order

The POST/orders/{orderId}/amendments endpoint is designed to allow Grubtech to notify the aggregator platform about eligible amendments for a specific order. This endpoint is particularly useful when Grubtech suggests changes to an order, such as item substitutions, modifications, or additions, and requires confirmation from the customer through the aggregator platform. By providing a structured way to communicate amendments, Grubtech enhances order accuracy and customer satisfaction, ensuring that modifications align with customer preferences.

For more details refer POST/orders/{orderId}/amendments API Reference.

Confirm Amended Order

The PUT/orders/{orderId}/amendments/{amendmentId} endpoint is designed to allow the aggregator platform to confirm suggested amendments for a specific order from Grubtech. This endpoint plays a crucial role when customer confirmation is required for modifications suggested by Grubtech, ensuring that changes to the order align with customer preferences and requirements. By providing a structured way to confirm amendments, the endpoint enhances order accuracy and customer satisfaction.

For more details refer PUT/orders/{orderId}/amendments/{amendmentId} API Reference.