محصولات



متد ها :

POST /items ایجاد محصول جدید

ایجاد محصول

ایجاد محصول جدید .

POST /items

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

description نوع:String عنوان:شرح محصول شرح محصول در فاکتور نمایش داده خواهد شد .
name نوع:String عنوان:عنوان کوتاه عنوان کوتاه محصول معمولا برای استفاده در لیست ها داخل پنل کاربری استفاده می شود .
cost نوع:Integer عنوان:قیمت محصول قیمت محصول به ریال .
code نوع:String عنوان:کد محصول کد محصول یک رشته از اعداد و حروف انگلیسی به صورت دلخواه و غیر تکراری است . این کد در سرویس های سفارش پیامکی و تلگرام و ... استفاده می شود . در صورتی که این مقدار تنظیم نشود ، سیستم یک کد تصادفی برای محصول در نظر خواهد گرفت .

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

                        curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"title":"لپ تاپ", "description":"لپ تاپ macpro", "cost":"27800000"}' "https://api.hesabit.com/v1/items/?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": {
        "Item": {
            "id": "57151ea8-1540-429b-8a68-49ef2e65ec43",
            "cost": 27800000,
            "name": "لپ تاپ",
            "description": "لپ تاپ macpro",
            "discount": 0,
            "tax": 0,
            "invoiced_count": 0,
            "sold_count": 0,
            "code": "1ab",
            "created": 1460952000,
            "short_link": "http://hesab.it/1U2PR2",
            "status": "active"
        }
    },
    "success": true,
    "status": 201
}
                        
                    
GET /items خواندن لیست محصولات
GET /items/{item id} خواندن یک محصول از طریق شناسه محصول

خواندن محصولات

GET /items

گرفتن لیست محصولات .


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

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

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

                        curl -X GET -H "Cache-Control: no-cache" "https://api.hesabit.com/v1/items/?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": [
        {
            "Item": {
                "id": "57151ea8-1540-429b-8a68-49ef2e65ec43",
                "cost": 27800000,
                "name": "لپ تاپ",
                "description": "لپ تاپ macpro",
                "discount": 0,
                "tax": 0,
                "invoiced_count": 2,
                "sold_count": 1,
                "code": "1ab",
                "created": 1460952000,
                "short_link": "http://hesab.it/1U2PR2",
                "status": "active"
            },
            "Item": {
                "id": "52151ea8-1540-429b-8a68-49ef2e65ec42",
                "cost": 1700000,
                "name": "کیف لپ تاپ",
                "description": "کیف لپ تاپ macpro",
                "discount": 0,
                "tax": 0,
                "invoiced_count": 0,
                "sold_count": 0,
                "code": "bag14",
                "created": 1460952301,
                "short_link": "http://hesab.it/1U2P34",
                "status": "active"
            }
        }
    ],
    "success": true,
    "status": 200
}
                        
                    

خواندن یک محصول

GET /items/{item_id}

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


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

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

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

                        curl -X GET -H "Cache-Control: no-cache" "https://api.hesabit.com/v1/items/57151ea8-1540-429b-8a68-49ef2e65ec43?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": [
        {
            "Item": {
                "id": "57151ea8-1540-429b-8a68-49ef2e65ec43",
                "cost": 27800000,
                "name": "لپ تاپ",
                "description": "لپ تاپ macpro",
                "discount": 0,
                "tax": 0,
                "invoiced_count": 2,
                "sold_count": 1,
                "code": "1ab",
                "created": 1460952000,
                "short_link": "http://hesab.it/1U2PR2",
                "status": "active"
            }
        }
    ],
    "success": true,
    "status": 200
}
                        
                    
PUT /items/{item_id} ویرایش یک محصول

ویرایش محصول

ویرایش یک محصول .

PUT /items/{item_id}

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

description نوع:String عنوان:شرح محصول شرح محصول در فاکتور نمایش داده خواهد شد .
name نوع:String عنوان:عنوان کوتاه عنوان کوتاه محصول معمولا برای استفاده در لیست ها داخل پنل کاربری استفاده می شود .
cost نوع:Integer عنوان:قیمت محصول قیمت محصول به ریال .
code نوع:String عنوان:کد محصول کد محصول یک رشته از اعداد و حروف انگلیسی به صورت دلخواه و غیر تکراری است . این کد در سرویس های سفارش پیامکی و تلگرام و ... استفاده می شود . در صورتی که این مقدار تنظیم نشود ، سیستم یک کد تصادفی برای محصول در نظر خواهد گرفت .

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

                        curl -X PUT -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"description":"لپ تاپ macpro 2016", "cost": 37800000}' "https://api.hesabit.com/v1/items/57151ea8-1540-429b-8a68-49ef2e65ec43?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": {
        "Item": {
            "id": "57151ea8-1540-429b-8a68-49ef2e65ec43",
            "cost": 37800000,
            "name": "لپ تاپ",
            "description": "لپ تاپ macpro 2016",
            "discount": 0,
            "tax": 0,
            "invoiced_count": 2,
            "sold_count": 1,
            "code": "1ab",
            "created": 1460952000,
            "short_link": "http://hesab.it/1U2PR2",
            "status": "active"
        }
    },
    "success": true,
    "status": 201
}
                        
                    
DELETE /items/{item_id} حذف یک محصول

حذف محصول

پاک کردن یک محصول .

DELETE /items/{item_id}

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

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

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

                        curl -X DELETE -H "Cache-Control: no-cache" "https://api.hesabit.com/v1/items/57151ea8-1540-429b-8a68-49ef2e65ec43/?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": {
    "Item": {
      "id": "57151ea8-1540-429b-8a68-49ef2e65ec43"
    }
  },
  "success": true,
  "status": 200,
  "message": "Item deleted successfully"
}