למאמר הדרכה על הגדרות שימוש ב HTTP REST API לחצו כאן
יצירת הזמנה חדשה מתבצעת דרך:
Action: Create
Method: POST
URL: https://api.powerlink.co.il/api/record/crmorder
בעת פתיחת הזמנה מבנה הפקודה נחלק לשני חלקים:
1) הזמנה
2) פריטי הזמנה
שדות הזמנה
הפרמטרים שחייבים לשלוח בחלק זה הם
accountid – מזהה רשומת הלקוח, משמש אותנו לקישור הלקוח להזמנה, ניתן להשיג את הפרמטר באמצעות שאילתא בAPI במאמר: שאילתא דרך API
שם החברה - companyname
סוג המטבע - currencycode (מקבל ערך מספרי):
ILS = 4
USD = 1
GBP = 2
JPY = 31
EUR = 27
AUD = 18
CAD = 6
DKK = 12
NOK = 28
SEK = 3
CHF = 5
BRL = 32
שדות נוספים אפשריים לשליחה:
טלפון - telephone
פקס - fax
כתובת - address
דואר אלקטרוני - emailaddress
שדות פריטי ההזמנה
אובייקט פרטי ההזמנה הוא מערך של מוצרים, בתוך כל פריט בפרטי ההזמנה נכלול את שם המוצר, כמות, מחיר ליחיד, ומחיר סופי.
productid - מזהה רשומת המוצר, משמש אותנו לקישור המוצר ששמור במערכת להזמנה, ניתן להשיג את הפרמטר באמצעות שאילתא ב-API
שם מוצר - productname
הערה: שם המוצר מקבל טקסט (String) באופן חופשי
על מנת ליצור את הקישור למוצר קיים במערכת - חובה לשלוח יחד את שני הפרמטרים: productid וגם productname
מחיר המוצר - itemprice
כמות - itemquantity
הנחת עיגול - rounddiscountcode (יכלל עם ערך=1 רק עם רוצים להוסיף הנחה בעסקה)
מע"מ - taxincludecode (יכלל עם ערך=1 רק אם רוצים לחשב מע"מ בעסקה)
סכום הנחה - amountdiscount
ניכוי במקור - taxdeduction
סכום סופי של הפריט (מכפלת מחיר מוצר בכמות) – itemtotalprice
תיאור- description
שם מוצר - productname
הערה: שם המוצר מקבל טקסט (String) באופן חופשי אך גם יכול לקבל מוצר מתוך רשימת המוצרים במערכת- חובה לשלוח את productname ואת productid עם ה id של המוצר, במידה והמוצר קיים במערכת.
מחיר המוצר - itemprice
כמות - itemquantity
הנחת עיגול - rounddiscountcode (יכלל עם ערך=1 רק עם רוצים להוסיף הנחה בעסקה)
מע"מ - taxincludecode (יכלל עם ערך=1 רק אם רוצים לחשב מע"מ בעסקה)
סכום הנחה - amountdiscount
ניכוי במקור - taxdeduction
סכום סופי של הפריט (מכפלת מחיר מוצר בכמות) - itemtotalprice
{
"companyname":"ישראל כהן",
"accountid" : "c3117df4-25b1-46a5-b19a-459e788424c1"
"idnumber":"123456789",
"telephone":"43606540",
"fax" :"056045604",
"address" :"דיזנגוף 121",
"emailaddress" :"israel@israel.com",
"currencycode" :4,
Items:{
Item:[
{
productname:"טלויזיה 55 אינצ",
itemprice:100,
itemquantity:1,
itemtotalprice:100
},
{
productname:"מצלמת וידיאו דיגיטלית",
description:"מצלמה עם 64 גיגה זיכרון פנימי",
itemprice:200,
itemquantity:2,
itemtotalprice:400 }
]
},
"description":"זמן אספקה עד 14 יום עבודה",
"productstotal":1400,
"amountdiscount":0,
"rounddiscountcode":1,
"taxincludecode":1,
"totalamount":1638,
"taxdeduction":0,
"totalpayment":1638
}
"companyname":"ישראל כהן",
"accountid" : "c3117df4-25b1-46a5-b19a-459e788424c1"
"idnumber":"123456789",
"telephone":"43606540",
"fax" :"056045604",
"address" :"דיזנגוף 121",
"emailaddress" :"israel@israel.com",
"currencycode" :4,
Items:{
Item:[
{
productid:" 59682ba6-a925-43fc-9cb4-30489b97b720",
itemprice:100,
itemquantity:1,
itemtotalprice:100
}
]
},
"description":"זמן אספקה עד 14 יום עבודה",
"productstotal":1400,
"amountdiscount":0,
"rounddiscountcode":1,
"taxincludecode":1,
"totalamount":1638,
"taxdeduction":0,
"totalpayment":1638
}