get
https://wateer.com.sa/api/v2/vendor/customers
Retrieve complete customer records (names, phone numbers, etc.) through this endpoint
Returns paginated customer data with associated receipt and location information for authenticated vendors.
API Query Parameters Guide
🌐 URL Structure
All parameters are appended after ? in your request URL.
🔍 Filter Parameters
| Parameter | Description | Type | Example |
|---|---|---|---|
branch | Filter by branch location | integer | branch=3 |
pos | Filter by point of sale | integer | pos=15 |
receipt | Find specific receipts | string | receipt=42 |
📖 Pagination Controls
Parameter | Default | Max | Description | Example |
|---|---|---|---|---|
| 1 | Page number to retrieve |
| |
| 10 | 100 | Items per page |
|
💡 Usage Tips
- Combine parameters with
&:
?branch_id=3&page_size=20&page=2 - Error Handling:
400for invalid parameters- Empty results for valid but unmatched queries
- Encoding: Always URL-encode special characters
Authentication
Authorization: Bearer <your_jwt_token>📋 Example Request
GET /api/v2/vendor/customers/?branch=3&pos=15&page=2&page_size=20