# POS System

## Guides

- [PARTNER PROGRAMME](https://api-docs.urbanpiper.com/downstream/readme.md): A quick context about POS integration with UrbanPiper
- [API Documentation](https://api-docs.urbanpiper.com/downstream/api-documentation.md): Quick access to the API documentation section
- [Overview](https://api-docs.urbanpiper.com/downstream/getting-started/overview.md)
- [Onboarding Process](https://api-docs.urbanpiper.com/downstream/getting-started/onboarding-process.md)
- [Environments](https://api-docs.urbanpiper.com/downstream/getting-started/environments.md)
- [Sandbox](https://api-docs.urbanpiper.com/downstream/getting-started/environments/sandbox.md)
- [Webhooks - Callbacks](https://api-docs.urbanpiper.com/downstream/getting-started/webhooks-callbacks.md)
- [Developer Tools](https://api-docs.urbanpiper.com/downstream/getting-started/developer-tools.md)
- [Authentication](https://api-docs.urbanpiper.com/downstream/authentication/authentication.md)
- [Create/Update Store](https://api-docs.urbanpiper.com/downstream/manage-stores/create-update-store.md)
- [Architecture](https://api-docs.urbanpiper.com/downstream/menu/architecture.md)
- [Categories](https://api-docs.urbanpiper.com/downstream/menu/categories.md)
- [Items](https://api-docs.urbanpiper.com/downstream/menu/items.md)
- [Option Groups](https://api-docs.urbanpiper.com/downstream/menu/option-groups.md)
- [Options](https://api-docs.urbanpiper.com/downstream/menu/options.md)
- [Nested Option Group and Option](https://api-docs.urbanpiper.com/downstream/menu/nested-option-group-and-option.md)
- [Taxes](https://api-docs.urbanpiper.com/downstream/menu/taxes.md)
- [Charges](https://api-docs.urbanpiper.com/downstream/menu/charges.md)
- [Menu Push](https://api-docs.urbanpiper.com/downstream/menu/menu-push.md)
- [Validation and Publish](https://api-docs.urbanpiper.com/downstream/menu/validation-and-publish.md)
- [Order Components](https://api-docs.urbanpiper.com/downstream/order/order-components.md)
- [Order Status Update](https://api-docs.urbanpiper.com/downstream/order/order-status-update.md)
- [Order Rider Information](https://api-docs.urbanpiper.com/downstream/order/order-rider-information.md)
- [Store](https://api-docs.urbanpiper.com/downstream/availability/store.md)
- [Item/Option](https://api-docs.urbanpiper.com/downstream/availability/item-option.md)
- [Testing and Validation](https://api-docs.urbanpiper.com/downstream/integration-certification/testing-and-validation.md)
- [Certification](https://api-docs.urbanpiper.com/downstream/integration-certification/certification.md)
- [REST API](https://api-docs.urbanpiper.com/downstream/resources/rest-api.md)
- [JSON](https://api-docs.urbanpiper.com/downstream/resources/json.md)
- [Atlas](https://api-docs.urbanpiper.com/downstream/resources/atlas.md)
- [Gamma](https://api-docs.urbanpiper.com/downstream/resources/gamma.md)
- [Multi-Brand Workflow](https://api-docs.urbanpiper.com/downstream/resources/multi-brand-workflow.md)
- [Webhook Circuit Breaker](https://api-docs.urbanpiper.com/downstream/resources/webhook-circuit-breaker.md)
- [Flush Operations](https://api-docs.urbanpiper.com/downstream/resources/flush-operations.md)
- [Overview](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/aggregator-constraints.md)
- [Generic](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/generic.md)
- [Amazon](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/amazon.md)
- [Careem](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/careem.md)
- [Chatfood](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/chatfood.md)
- [Deliveroo](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/deliveroo.md)
- [DoorDash](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/doordash.md)
- [Dotpe](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/dotpe.md)
- [Dunzo](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/dunzo.md)
- [Eateasy](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/eateasy.md)
- [Eazydiner](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/eazydiner.md)
- [Gupshup](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/gupshup.md)
- [HungerStation](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/hungerstation.md)
- [Inresto](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/inresto.md)
- [Jahez](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/jahez.md)
- [JustEat](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/justeat.md)
- [Magicpin](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/magicpin.md)
- [Mrsool](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/mrsool.md)
- [Noonfood](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/noonfood.md)
- [Radyes](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/radyes.md)
- [Swiggy](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/swiggy.md)
- [Talabat](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/talabat.md)
- [UberEats](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/ubereats.md)
- [Zomato](https://api-docs.urbanpiper.com/downstream/aggregator-constraints/zomato.md)

## API Documentation

- [Introduction](https://api-docs.urbanpiper.com/downstream/api/readme.md)
- [Aggregators](https://api-docs.urbanpiper.com/downstream/api/references/aggregators.md): List of aggregator platforms the integration is supported by us
- [Days of a Week](https://api-docs.urbanpiper.com/downstream/api/references/days-of-a-week.md): List of day values passed in the Store and Category timing configuration
- [Supported Languages](https://api-docs.urbanpiper.com/downstream/api/references/supported-languages.md): List of languages supported to pass in the Menu entities
- [Food Types](https://api-docs.urbanpiper.com/downstream/api/references/food-types.md): List of food type values to be configured for Items
- [Item Tags](https://api-docs.urbanpiper.com/downstream/api/references/item-tags.md): List of valid item tags per aggregator platform
- [Webhook Event Headers](https://api-docs.urbanpiper.com/downstream/api/references/webhook-event-headers.md): List of header values passed in the webhook requests
- [Setting-up Webhooks](https://api-docs.urbanpiper.com/downstream/api/endpoints/setting-up-webhooks.md): API to create/update external system webhook endpoints
- [Stores](https://api-docs.urbanpiper.com/downstream/api/endpoints/stores.md)
- [Add/Update Stores](https://api-docs.urbanpiper.com/downstream/api/endpoints/stores/add-update-stores.md): API to create/update the stores for a brand and its callback
- [Store Toggle](https://api-docs.urbanpiper.com/downstream/api/endpoints/stores/store-toggle.md): API to enable/disable the store for a brand and its callback
- [Menu](https://api-docs.urbanpiper.com/downstream/api/endpoints/menu.md)
- [Add/Update Menu](https://api-docs.urbanpiper.com/downstream/api/endpoints/menu/add-update-menu.md): API to create/update the menu for a brand and its callback
- [Menu Toggle](https://api-docs.urbanpiper.com/downstream/api/endpoints/menu/menu-toggle.md): API to enable/disable the menu for a brand and its callback
- [Category Timing Groups](https://api-docs.urbanpiper.com/downstream/api/endpoints/menu/category-timing-groups.md): API to create/update a timing group for Categories and its callback
- [Order Management](https://api-docs.urbanpiper.com/downstream/api/endpoints/order-management.md)
- [Order Relay](https://api-docs.urbanpiper.com/downstream/api/endpoints/order-management/order-relay.md): A webhook to consume the Order information
- [Order Status Update](https://api-docs.urbanpiper.com/downstream/api/endpoints/order-management/order-status-update.md): APIs to exchange the Order States between the systems.
- [Rider Status Update](https://api-docs.urbanpiper.com/downstream/api/endpoints/order-management/rider-status-update.md): A webhook to consume the delivery rider information
- [Webhook Order Retry API](https://api-docs.urbanpiper.com/downstream/api/endpoints/order-management/webhook-order-retry-api.md): This API is used by the POS partner to retry the Order Relay webhook
- [Self-Delivery Rider Management](https://api-docs.urbanpiper.com/downstream/api/endpoints/order-management/self-delivery-rider-management.md): This section contains the list of APIs related to managing the riders for self-delivery order and their statuses.
- [Rider Status Updates](https://api-docs.urbanpiper.com/downstream/api/endpoints/order-management/self-delivery-rider-management/rider-status-updates.md): This API is used to share the rider updates with aggregators for self-delivery orders.
- [Rider Live Tracking](https://api-docs.urbanpiper.com/downstream/api/endpoints/order-management/self-delivery-rider-management/rider-live-tracking.md): This endpoint is used to send the rider updates to the aggregators for self-delivery orders.
- [Miscellaneous](https://api-docs.urbanpiper.com/downstream/api/endpoints/miscellaneous.md)
- [Zomato Feature Actions](https://api-docs.urbanpiper.com/downstream/api/endpoints/miscellaneous/zomato-feature-actions.md): API to send the delivery rider's body temperature, mask check information, additional rider, and masked contact request. (Zomato specific)
- [Swiggy Feature Actions](https://api-docs.urbanpiper.com/downstream/api/endpoints/miscellaneous/swiggy-feature-actions.md): API to request for the delivery rider's ETA and customer masked phone number (Swiggy specific)
- [Mark Order Item Stock-out](https://api-docs.urbanpiper.com/downstream/api/endpoints/miscellaneous/mark-order-item-stock-out.md): API to mark order out of stock to modify the order (Swiggy Specific)
- [Customer Complaints](https://api-docs.urbanpiper.com/downstream/api/endpoints/miscellaneous/customer-complaints.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://api-docs.urbanpiper.com/downstream/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
