Application Endpoints

Applications within POS Hub can have a variety of endpoints that are used to interact with the POS Hub platform. These endpoints are allow for a bi-directional communication between the POS Hub platform and the application.

Overview

All applications within POS Hub have a webhook endpoint that is used to receive real-time notifications when certain events occur within the POS Hub platform. This mechanism ensures that your application stays synchronized with the changes happening across the platform. The webhook dispatch system is designed with robust retry logic, strict timeout settings, and clear payload structures to ensure reliable and predictable delivery.

POS Application Endpoints

If you are developing a POS application that integrates with the POS Hub platform, your application type will be marked as POS and you will be able toconfigure the following POS specific endpoints:

Sync Endpoint

The sync endpoint will be called if a user within the POS Hub platform invokes the sync action for a specific location your application is installed at, or our automation system triggers a sync action for your application to ensure that we have the catalog, location details, tax rates and other information up to date.

The response of this endpoint should conform to the CatalogImport schema defined within the POS Hub API documentation.

Marketplace Application Endpoints

If you are developing a Marketplace application that integrates with the POS Hub platform, your application type will be marked as MARKETPLACE and you will be able to configure the following marketplace specific endpoints:

Menu Publish Endpoint

The publish endpoint will be called when a user within the POS Hub platform invokes the menu publish action for a specific location your application is installed at, or our automation system triggers a menu publish action automatically.

This request will be a POST request with a payload that conforms to the MenuPublish schema defined within the POS Hub API documentation, and the response of this endpoint should be a 200 OK response.

Store Status Endpoint

The store status endpoint will be called when a user within the POS Hub platform invokes request that the store that is connected via the application is open or closed, this will include pausing the store temporarily.

The response of this endpoint should be a 200 OK response.

Delivery Application Endpoints

If you are developing a Delivery application that integrates with the POS Hub platform, your application type will be marked as DELIVERY and you will be able to configure the following delivery specific endpoints:

Get Quotes Endpoint

The quotes endpoint will be called when a user or the POS Hub platform requests a quote for a delivery job, the request will contain the the full delivery details and the response of this endpoint should be a 200 OK response with a response that confirms to a Array<DeliveryQuote> schema defined within the POS Hub API documentation.

This endpoint is designed to return multiple quotes when available, and the POS Hub platform will select the best quote based on the criteria defined within the location settings.

Dispatch Quote Endpoint

The dispatch quote endpoint will be called when a user or the POS Hub platform selects a quote to dispatch, the request will contain the delivery and quote details, the endpoint should take care of converting the quote into a dispatched delivery.

The response of this endpoint should be a 200 OK response with a response that confirms to a DispatchedDelivery schema defined within the POS Hub API documentation.

Get Dispatched Delivery Endpoint

The dispatched delivery endpoint will be called when POS Hub needs to get the latest status of a dispatched delivery, the request will contain the delivery details and the response of this endpoint should be a 200 OK response with a response that confirms to a DispatchedDelivery schema defined within the POS Hub API documentation.

Cancel Delivery Endpoint

The cancel delivery endpoint will be called when a user or the POS Hub platform requests to cancel a dispatched delivery, the request will contain the delivery details and the response of this endpoint should be a 200 OK response.

If the endpoint cannot confirm the cancellation of the delivery, the response should be a 400 Bad Request response with object that confrosm to the ErrorResponse schema defined within the POS Hub API documentation.