لیست مشتریان

دریافت لیست مشتریان با قابلیت فیلتر و صفحه‌بندی.

درخواست

Method: GET
URL: /api/clients
Headers: Authorization: Bearer {token}

پارامترهای Query:

مثال درخواست

curl -X GET "https://example.com/api/clients?page=1&limit=10" \
  -H "Authorization: Bearer {token}"

پاسخ موفق (200)

{
  "records": [
    {
      "id": 1,
      "company_name": "شرکت نمونه",
      "type": "organization",
      "phone": "021-12345678",
      "city": "تهران",
      "country": "ایران",
      "created_date": "1403-01-15",
      "status": "active"
    }
  ],
  "meta": {
    "total": 50,
    "current_page": 1,
    "per_page": 10
  }
}

خطاها

جزئیات مشتری

دریافت اطلاعات کامل یک مشتری با شناسه مشخص.

درخواست

Method: GET
URL: /api/clients/{id}
Headers: Authorization: Bearer {token}

مثال درخواست

curl -X GET "https://example.com/api/clients/1" \
  -H "Authorization: Bearer {token}"

پاسخ موفق (200)

{
  "record": {
    "id": 1,
    "company_name": "شرکت نمونه",
    "type": "organization",
    "address": "تهران، خیابان ولیعصر",
    "city": "تهران",
    "state": "تهران",
    "zip": "1234567890",
    "country": "ایران",
    "phone": "021-12345678",
    "website": "https://example.com",
    "created_date": "1403-01-15",
    "currency_symbol": "IRR",
    "group_ids": "1,2",
    "labels": ["مهم", "ویژه"],
    "owner_id": 1,
    "created_by": 1
  },
  "custom_fields": {
    "field_1": "مقدار فیلد سفارشی"
  }
}

خطاها

ایجاد مشتری جدید

ایجاد یک مشتری جدید در سیستم.

درخواست

Method: POST
URL: /api/clients
Headers: Authorization: Bearer {token}
Content-Type: application/json

بدنه درخواست:

مثال درخواست

curl -X POST "https://example.com/api/clients" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "شرکت جدید",
    "type": "organization",
    "phone": "021-87654321",
    "city": "اصفهان"
  }'

پاسخ موفق (201)

{
  "record": {
    "id": 2,
    "company_name": "شرکت جدید",
    "type": "organization",
    "phone": "021-87654321",
    "city": "اصفهان",
    "created_date": "1403-06-15"
  }
}

خطاها

بروزرسانی مشتری

بروزرسانی اطلاعات یک مشتری موجود. از هر دو متد PUT و PATCH پشتیبانی می‌کند.

درخواست

Method: PUT / PATCH
URL: /api/clients/{id}
Headers: Authorization: Bearer {token}
Content-Type: application/json

بدنه درخواست: (فیلدهای مورد نیاز برای بروزرسانی)

مثال درخواست

curl -X PUT "https://example.com/api/clients/1" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"company_name": "شرکت نمونه (ویرایش شده)", "phone": "021-11111111"}'

پاسخ موفق (200)

{
  "success": true,
  "message": "مشتری با موفقیت بروزرسانی شد"
}

خطاها

حذف مشتری

حذف یک مشتری از سیستم.

درخواست

Method: DELETE
URL: /api/clients/{id}
Headers: Authorization: Bearer {token}

مثال درخواست

curl -X DELETE "https://example.com/api/clients/1" \
  -H "Authorization: Bearer {token}"

پاسخ موفق (200)

{
  "success": true,
  "message": "مشتری با موفقیت حذف شد"
}

خطاها