# Erply

Erply is a cloud-based retail POS, inventory, CRM, and retail management platform for businesses that need point-of-sale, stock control, customer management, reporting, integrations, and ecommerce workflows.

## Main URLs
- Website: https://erply.com/
- API overview: https://erply.com/erply-api
- API documentation: https://learn-api.erply.com/
- POS API requests: https://learn-api.erply.com/requests/pos
- Inventory API article: https://wiki.erply.com/article/1331-inventory-api
- Release notes: https://erply.com/release-notes

## Product Overview
Erply provides retail POS software with inventory control, sales reporting, CRM/customer data, ecommerce integrations, offline selling, and workflow automation. The platform supports businesses that need centralized retail operations across stores, warehouses, and sales channels.

## Developer Overview
Erply offers APIs for building integrations, custom POS workflows, ecommerce connections, inventory synchronization, CRM integrations, and third-party applications.

The main Erply API is a general-purpose API covering standard Erply features. Developers should start with the Erply API documentation and request list.

## Important API Areas
- Authentication and session management
- Products and inventory
- Sales documents and POS workflows
- Customers and CRM
- Warehouses and stock levels
- Purchase orders
- Inventory transfers
- Reports and revenue data
- Configuration APIs
- Service endpoint discovery

## Authentication
Erply API requests generally use an Erply client code and API session key.

For Inventory API requests, send:
- clientCode
- sessionKey

as request headers.

Do not expose API keys, session keys, client codes, or account-specific credentials in public examples.

## API Conventions
- Use Erply’s official API documentation as the source of truth.
- Some services require discovering the account-specific endpoint first.
- For Inventory API endpoints, use `getServiceEndpoints` to find the correct account-specific endpoint.
- API capabilities may differ between Erply services, accounts, and regions.
- Check release notes for recent platform changes.

## Recommended Developer Workflow
1. Review the main API documentation.
2. Authenticate and obtain a session key.
3. Discover required service endpoints if using service-specific APIs.
4. Use the relevant API request documentation.
5. Test against a sandbox or non-production account where possible.
6. Avoid destructive operations unless explicitly requested by the user.

## Key Concepts
- Product: an item sold or tracked in inventory.
- Inventory: stock quantities, reservations, movements, transfers, and write-offs.
- Sales document: a shared term for invoices, sales orders, receipts, and related sales records.
- POS: point-of-sale workflows including checkout, sales documents, payments, and customer interactions.
- Customer: CRM/contact record used for sales, loyalty, and reporting.
- Warehouse/location: stock-holding location used for inventory tracking.

## Constraints and Warnings
- Do not assume all endpoints are global; some are account- or region-specific.
- Do not poll APIs aggressively.
- Confirm destructive actions such as deleting documents, modifying inventory, or cancelling orders.
- Treat sales, inventory, and accounting data as business-critical.
- Prefer official Erply documentation over third-party examples.
- Do not invent request parameters; verify them in the relevant API reference.

## Best Practices for AI Assistants
When helping users with Erply:
- Prefer TypeScript, JavaScript, PHP, Python, or cURL examples when generating integration code.
- Always mention where credentials should be stored securely.
- Use environment variables for secrets.
- Ask for the specific Erply workflow when unclear: POS, inventory, customers, products, reports, or ecommerce.
- Link users to the exact API request documentation when possible.
- Be careful with inventory-changing and sales-document-changing operations.

## Example Use Cases
- Sync products from Erply to an ecommerce store.
- Pull stock quantities into a website.
- Create or update sales documents.
- Retrieve customers for CRM workflows.
- Build custom checkout or POS functionality.
- Integrate Erply with third-party apps.
- Query inventory movements, write-offs, transfers, and purchase orders.

## Support
- Website contact/support: https://erply.com/
- Public support email listed by Erply: support@erply.com