# Unify Retail Documentation

> Documentation for Unify Retail

## Guides
- [Introduction](https://developers.unify-retail.com/docs/getting-started.md): UniFy is a Powerful, flexible, and user-friendly OMS and POS solution
- [Main Concepts](https://developers.unify-retail.com/docs/main-concepts.md)
- [Authentication](https://developers.unify-retail.com/docs/authentication.md): Learn how to authenticate requests to Unify API's endpoints.
- [Data Types](https://developers.unify-retail.com/docs/data-types.md): Learn how to use and are used data types
- [Pagination](https://developers.unify-retail.com/docs/pagination.md)
- [Filtering](https://developers.unify-retail.com/docs/filtering.md): Discover how to implement filtering syntax.
- [Overview](https://developers.unify-retail.com/docs/webhooks-overview.md): Webhooks provide a way for notifications to be delivered to an external web server whenever certain events occur
- [Supported events](https://developers.unify-retail.com/docs/webhooks-supported-events.md)
- [Retry Policy](https://developers.unify-retail.com/docs/webhooks-retry-policy.md)
- [Best Practices](https://developers.unify-retail.com/docs/webhooks-best-practices.md): When using webhooks, hold to these best practices to increase security and performance.
- [Security](https://developers.unify-retail.com/docs/webhooks-security.md): When using webhooks, hold to these best practices to increase security and performance.
- [How it works](https://developers.unify-retail.com/docs/merchant-api-how-it-works.md): Merchant API ? But what is it for ?
- [Requirements](https://developers.unify-retail.com/docs/merchant-api-requirements.md): Ensure a successful and secure integration
- [Endpoints](https://developers.unify-retail.com/docs/merchant-api-endpoints.md): Discover what is the expected for Merchant API's
- [Getting Started](https://developers.unify-retail.com/docs/widget-overview.md): Unify Widgets are embeddable web components that integrate directly into your storefront.  They handle all communication with the Unify API and can be fully customized to match your brand.
- [E-Reservation](https://developers.unify-retail.com/docs/widget-ereservation.md): Multi-step reservation widget allowing customers to search for store availability, select a store, and complete their reservation with contact information.
- [Store Availability](https://developers.unify-retail.com/docs/widget-store-availability.md): Search and display store locations with real-time stock availability and opening hours.
- [Stock](https://developers.unify-retail.com/docs/widget-stock.md)
- [Order Details](https://developers.unify-retail.com/docs/widget-order-details.md): Display comprehensive order information including items, pricing, shipping details, and package tracking in a modal dialog.
- [Return](https://developers.unify-retail.com/docs/widget-return.md): Multi-step return management widget allowing customers to initiate product returns, select return reasons, and track return status.
- [Payment](https://developers.unify-retail.com/docs/widget-payment.md): Process payments through multiple methods (cash register, QR code) with a flexible, event-driven widget.
- [Event Tracker](https://developers.unify-retail.com/docs/widget-event-tracker.md): Track customer interactions in real-time for analytics and reporting.
- [Best Practices](https://developers.unify-retail.com/docs/shopify-best-practices.md)

## API Reference
- [Retrieve a list of users and their details](https://developers.unify-retail.com/reference/get_v1-users.md)
- [Create new user](https://developers.unify-retail.com/reference/post_v1-users.md)
- [Create/Update multiple users](https://developers.unify-retail.com/reference/put_v1-users-bulk.md)
- [Retrieve details of a specific user](https://developers.unify-retail.com/reference/get_v1-users-id.md)
- [Update details of a specific user](https://developers.unify-retail.com/reference/put_v1-users-id.md)
- [Delete a specific user](https://developers.unify-retail.com/reference/delete_v1-users-id.md)
- [Retrieve a list of items and their details](https://developers.unify-retail.com/reference/get_v1-items.md)
- [Create new item](https://developers.unify-retail.com/reference/post_v1-items.md)
- [Create/Update multiple items](https://developers.unify-retail.com/reference/put_v1-items-bulk.md): Each item in the array is created if its `item_id` does not already exist, or updated if it does. `item_id` is always required. Required fields for creation are the same as for [POST /v1/items](/reference/post_v1-items); for updates, see [PUT /v1/items/{id}](/reference/put_v1-items-id).
- [Retrieve details of a specific item](https://developers.unify-retail.com/reference/get_v1-items-id.md)
- [Update details of a specific item](https://developers.unify-retail.com/reference/put_v1-items-id.md)
- [Delete a specific item](https://developers.unify-retail.com/reference/delete_v1-items-id.md)
- [Retrieve a list of companies and their details](https://developers.unify-retail.com/reference/get_v1-companies.md)
- [Create a new company](https://developers.unify-retail.com/reference/post_v1-companies.md)
- [Retrieve details of a specific company](https://developers.unify-retail.com/reference/get_v1-companies-id.md)
- [Update details of a specific company](https://developers.unify-retail.com/reference/put_v1-companies-id.md)
- [Delete a specific company](https://developers.unify-retail.com/reference/delete_v1-companies-id.md)
- [Retrieve a list of locations and their details](https://developers.unify-retail.com/reference/get_v1-locations.md)
- [Create a new location](https://developers.unify-retail.com/reference/post_v1-locations.md)
- [Create/Update multiple locations](https://developers.unify-retail.com/reference/put_v1-locations-bulk.md): Each item in the array is created if its `location_id` does not already exist, or updated if it does. `location_id` is always required. Required fields for creation are the same as for [POST /v1/locations](/reference/post_v1-locations); for updates, see [PUT /v1/locations/{id}](/reference/put_v1-locations-id).
- [Retrieve details of a specific location](https://developers.unify-retail.com/reference/get_v1-locations-id.md)
- [Update details of a specific location](https://developers.unify-retail.com/reference/put_v1-locations-id.md)
- [Delete a specific location](https://developers.unify-retail.com/reference/delete_v1-locations-id.md)
- [Retrieve stock levels for items across different locations](https://developers.unify-retail.com/reference/get_v1-stocks.md)
- [Update stock levels for multiple items](https://developers.unify-retail.com/reference/put_v1-stocks-bulk.md)
- [Retrieve the unified stock of the item only from locations flagged as 'unified stock'](https://developers.unify-retail.com/reference/get_v1-unified-stocks.md)
- [Reserve stock for an item](https://developers.unify-retail.com/reference/post_v1-unified-stocks-reserve.md)
- [Unreserve stock for an item](https://developers.unify-retail.com/reference/post_v1-unified-stocks-unreserve.md)
- [Retrieve a list of orders and their details](https://developers.unify-retail.com/reference/get_v1-orders.md)
- [Create a new order](https://developers.unify-retail.com/reference/post_v1-orders.md)
- [Retrieve details of a specific order](https://developers.unify-retail.com/reference/get_v1-orders-id.md)
- [Update details of a specific order](https://developers.unify-retail.com/reference/put_v1-orders-id.md)
- [Apply an operation to an order](https://developers.unify-retail.com/reference/put_v1-orders-id-operations.md)
- [Retrieve a list of orders transactions and their details](https://developers.unify-retail.com/reference/get_v1-orders-id-transactions.md)
- [Retrieve the history of a specific order](https://developers.unify-retail.com/reference/get_v1-orders-id-history.md)
- [Create a new order transaction](https://developers.unify-retail.com/reference/post_v1-orders-id-transactions.md)
- [Retrieve return promises for items in a specific order](https://developers.unify-retail.com/reference/get_v1-orders-id-return-promises.md)
- [Retrieve an order transaction and their details](https://developers.unify-retail.com/reference/get_v1-orders-id-transactions-transaction-uuid.md)
- [Update an order transaction status](https://developers.unify-retail.com/reference/put_v1-orders-id-transactions-transaction-uuid.md)
- [Migrate historical orders in bulk](https://developers.unify-retail.com/reference/post_v1-orders-migrate.md): Bulk import of historical orders. Each order is created with status `shipped` and a corresponding preparation request. Items not found are created as `Migrated Item`. Returns one result per order.
- [Retrieve a list of preparation requests and their details](https://developers.unify-retail.com/reference/get_v1-preparation-requests.md)
- [Apply an operation on a preparation request](https://developers.unify-retail.com/reference/put_v1-preparation-requests-id-operations.md)
- [Retrieve details of a specific preparation request](https://developers.unify-retail.com/reference/get_v1-preparation-requests-id.md)
- [Retrieve documents related to a specific preparation request](https://developers.unify-retail.com/reference/get_v1-preparation-requests-documents.md)
- [Update a preparation request (tags)](https://developers.unify-retail.com/reference/put_v1-preparation-requests-id.md)
- [Retrieve the history of a specific preparation request](https://developers.unify-retail.com/reference/get_v1-preparation-requests-id-history.md)
- [Retrieve a list of delivery promises and their details](https://developers.unify-retail.com/reference/post_v1-delivery-promises.md)
- [Retrieve a list of RMA and their details](https://developers.unify-retail.com/reference/get_v1-rma.md)
- [Create new RMA](https://developers.unify-retail.com/reference/post_v1-rma.md)
- [Retrieve details of a specific RMA](https://developers.unify-retail.com/reference/get_v1-rma-id.md)
- [Update details of a specific RMA](https://developers.unify-retail.com/reference/patch_v1-rma-id.md): If the RMA status is CONFIRMED or CLOSED, the PATCH request must contain the 'tags' field exclusively; otherwise, the request will be rejected.
- [Update operation to authorize status for a specific return](https://developers.unify-retail.com/reference/patch_v1-rma-id-authorize.md)
- [Retrieve the history of a specific return](https://developers.unify-retail.com/reference/get_v1-rma-id-history.md)
- [Update operation to confirm status for a specific return](https://developers.unify-retail.com/reference/patch_v1-rma-id-confirm.md)
- [Update operation to closed status for a specific return](https://developers.unify-retail.com/reference/patch_v1-rma-id-close.md)
- [Retrieve a list of Webhooks and their details](https://developers.unify-retail.com/reference/get_v1-webhooks.md)
- [Create a new webhook](https://developers.unify-retail.com/reference/post_v1-webhooks.md)
- [Create/Update multiple webhooks](https://developers.unify-retail.com/reference/put_v1-webhooks-bulk.md)
- [Retrieves the history of webhook call logs](https://developers.unify-retail.com/reference/get_v1-webhooks-history.md)
- [Retrieve details of a specific webhook](https://developers.unify-retail.com/reference/get_v1-webhooks-id.md)
- [Update details of a specific webhook](https://developers.unify-retail.com/reference/put_v1-webhooks-id.md)
- [Delete a specific webhook](https://developers.unify-retail.com/reference/delete_v1-webhooks-id.md)
- [Retrieve a list of Pickup Points sorted by distance from a given address](https://developers.unify-retail.com/reference/get_v1-pickup-points.md)
- [Create a new device](https://developers.unify-retail.com/reference/post_v1-devices.md)
- [Retrieve details of a specific device](https://developers.unify-retail.com/reference/get_v1-devices-id.md)
- [Update details of a specific device](https://developers.unify-retail.com/reference/put_v1-devices-id.md)
- [Delete a specific device](https://developers.unify-retail.com/reference/delete_v1-devices-id.md)
- [Retrieve a list of devices and their details](https://developers.unify-retail.com/reference/get_v1-devices.md)
- [Create/Update multiple devices](https://developers.unify-retail.com/reference/put_v1-devices-bulk.md)
- [Create new event](https://developers.unify-retail.com/reference/post_v1-pos-events.md)
- [Retrieve details of pos events](https://developers.unify-retail.com/reference/get_v1-pos-events.md)
- [Retrieve details of a specific pos event uuid](https://developers.unify-retail.com/reference/get_v1-pos-events-id.md)