مشتریان



متد ها :

POST /customers ایجاد مشتری جدید

ایجاد مشتری

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

POST /customers

محتوی درخواست (Body parameters)

name نوع:String عنوان:نام مشتری نام مشتری در فاکتور نمایش داده خواهد شد .
email نوع:String عنوان:ایمیل مشتری آدرس پست الکترونیکی مشتری . *توجه : وجود ایمیل و یا شماره موبایل مشتری الزامی است و حداقل یکی از این دو مقدار باید پر شده باشد .
mobile نوع:String عنوان:موبایل مشتری شماره ۱۱ رقمی موبایل مشتری یک رشته از اعداد است . *توجه : وجود ایمیل و یا شماره موبایل مشتری الزامی است و حداقل یکی از این دو مقدار باید پر شده باشد .
address نوع:String عنوان:آدرس مشتری آدرس مشتری .
postal_code نوع:Integer عنوان:کد پستی کد پستی مشتری یک رشته عددی است .
company نوع:String عنوان:نام شرکت نام سازمان یا شرکت مشتری .
tel نوع:Integer عنوان:تلفن مشتری شماره تلفن مشتری یک رشته عددی است .
fax نوع:Integer عنوان:شماره دورنگار مشتری شماره دورنگار مشتری یک رشته عددی است .
registration_number نوع:Integer عنوان:شماره ثبت شماره ثبت یک رشته عددی است .
economical_number نوع:Integer عنوان:کد اقتصادی کد اقتصادی مشتری یک رشته عددی است .

نمونه کد درخواست

                        curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"name":"آرین نجفی", "email":"[email protected]", "mobile":"09122345577"}' "https://api.hesabit.com/v1/customers/?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48"

نمونه پاسخ

                        
HTTP/1.1 201 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
    "data": {
        "Customer": {
            "id": "511f70f9-f270-4370-9d44-32622e65ec33",
            "name": "آرین نجفی",
            "company": "آسمان",
            "address": "تهران ، پاسداران ، گلستان سوم",
            "postal_code": "1234567890",
            "tel": "02188624168",
            "fax": "02188624168",
            "email": "[email protected]",
            "mobile": "09122345577",
            "registration_number": "12345678",
            "economical_number": "123456789",
            "created": 1460952000
        }
    },
    "success": true,
    "status": 201
}
GET /customers خواندن لیست مشتریات
GET /customers/{customer id} خواندن یک مشتری از طریق شناسه مشتری

خواندن مشتریات

GET /customers

گرفتن لیست مشتریات .


پارامترهای درخواست (Query parameters)

email نوع:String عنوان:ایمیل مشتری آدرس پست الکترونیکی مشتری .
mobile نوع:String عنوان:موبایل مشتری شماره ۱۱ رقمی موبایل مشتری یک رشته از اعداد است .
company نوع:String عنوان:نام شرکت نام سازمان یا شرکت مشتری .
limit نوع:Integer عنوان:تعداد به صورت پیش فرض ۱۰ مشتری آخر بازگردانده می شود . این مقدار تا ۱۰۰ رکورد قابل تنظیم است .
offset نوع:Integer عنوان:نقطه شروع نقطه شروع یک مقدار عددی است که نقطه شروع رکورد ها را در کوئری مشخص می کند .
page نوع:Integer عنوان:صفحه صفحه یک مقدار عددی است که برای صفحه بندی در کوئری استفاده می شود .

نمونه کد درخواست

                        curl -X GET -H "Cache-Control: no-cache" "https://api.hesabit.com/v1/customers/?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48&limit=10"

نمونه پاسخ

                        
HTTP/1.1 200 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
    "data": [
        {
            "Customer": {
                "id": "511f70f9-f270-4370-9d44-32622e65ec33",
                "name": "آرین نجفی",
                "company": "آسمان",
                "address": "تهران ، پاسداران ، گلستان سوم",
                "tel": "02188624168",
                "email": "[email protected]",
                "mobile": "09122345577",
                "created": 1460952000
            }
        },
        {
            "Customer": {
                "id": "51193ce4-f4c8-43aa-a063-21c02e65ec11",
                "name": "",
                "company": "",
                "address": "",
                "tel": "",
                "email": "[email protected]",
                "mobile": "",
                "created": 1460911000
            }
        }
    ],
    "success": true,
    "status": 200
}

خواندن یک مشتری

GET /customers/{customer_id}

خواندن یک مشتری از طریق شناسه مشتری .


مقادیر درخواست در آدرس (Path parameters)

customer_id شناسه مشتری یک رشته ۳۶ کاراکتری منحصر به فرد است .

نمونه کد درخواست

                        curl -X GET -H "Cache-Control: no-cache" "https://api.hesabit.com/v1/customers/511f70f9-f270-4370-9d44-32622e65ec33?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48"

نمونه پاسخ

                        
HTTP/1.1 200 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
    "data": [
        {
            "Customer": {
                "id": "511f70f9-f270-4370-9d44-32622e65ec33",
                "name": "آرین نجفی",
                "company": "آسمان",
                "address": "تهران ، پاسداران ، گلستان سوم",
                "tel": "02188624168",
                "email": "[email protected]",
                "mobile": "09122345577",
                "created": 1460952000
            }
        }
    ],
    "success": true,
    "status": 200
}
PUT /customers/{customer_id} ویرایش یک مشتری

ویرایش مشتری

ویرایش یک مشتری .

PUT /customers/{customer_id}

محتوی درخواست (Body parameters)

name نوع:String عنوان:نام مشتری نام مشتری در فاکتور نمایش داده خواهد شد .
email نوع:String عنوان:ایمیل مشتری آدرس پست الکترونیکی مشتری . *توجه : وجود ایمیل و یا شماره موبایل مشتری الزامی است و حداقل یکی از این دو مقدار باید پر شده باشد .
mobile نوع:String عنوان:موبایل مشتری شماره ۱۱ رقمی موبایل مشتری یک رشته از اعداد است . *توجه : وجود ایمیل و یا شماره موبایل مشتری الزامی است و حداقل یکی از این دو مقدار باید پر شده باشد .
address نوع:String عنوان:آدرس مشتری آدرس مشتری .
company نوع:String عنوان:نام شرکت نام سازمان یا شرکت مشتری .
tel نوع:Integer عنوان:تلفن مشتری شماره تلفن مشتری یک رشته عددی است .

نمونه کد درخواست

                        curl -X PUT -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"email":"[email protected]", "name": "آرین نجفیان"}' "https://api.hesabit.com/v1/customers/511f70f9-f270-4370-9d44-32622e65ec33?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48"

نمونه پاسخ

                        
HTTP/1.1 200 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
    "data": {
        "Customer": {
            "id": "511f70f9-f270-4370-9d44-32622e65ec33",
            "name": "آرین نجفیان",
            "company": "آسمان",
            "address": "تهران ، پاسداران ، گلستان سوم",
            "tel": "02188624168",
            "email": "[email protected]",
            "mobile": "09122345577",
            "created": 1460952000
        }
    },
    "success": true,
    "status": 201
}
DELETE /customers/{customer_id} حذف یک مشتری

حذف مشتری

پاک کردن یک مشتری .

DELETE /customers/{customer_id}

مقادیر درخواست در آدرس (Path parameters)

customer_id شناسه مشتری یک رشته ۳۶ کاراکتری منحصر به فرد است .

نمونه کد درخواست

                        curl -X DELETE -H "Cache-Control: no-cache" "https://api.hesabit.com/v1/customers/511f70f9-f270-4370-9d44-32622e65ec33?access_token=56fea353-98cc-4aac-9acf-3eb82e65ec48"

نمونه پاسخ

                        
HTTP/1.1 200 OK
Server:  nginx
Date:  Mon, 18 Apr 2016 17:58:44 GMT
Content-Type:  application/json; charset=UTF-8
Connection:  keep-alive
Vary:  Accept-Encoding

{
  "data": {
    "Customer": {
      "id": "511f70f9-f270-4370-9d44-32622e65ec33"
    }
  },
  "success": true,
  "status": 200,
  "message": "Customer deleted successfully"
}