קבלת פרטי כרטיס לקוח (Get Account info by cardcom Account Id)
מתי להשתמש בפונקציה זו?
לקוחות אשר עובדים עם CRM משלהם, או שרוצים לעדכן את פרטי הלקוח באתר שלהם \ בDB הפנימי שלהם יכולים להשתמש בפונקציה Get Account info by cardcom Account Id.
מה מקבלים מהפונקציה הזאת?
הפונקציה מספקת את הנתונים הידועים על הלקוח באתר קארדקום, כולל פרמטרים כמו:
- שם הלקוח
- עיר הלקוח
- טלפון
- אימייל
- הערות מיוחדות
- נתונים נוספים משניים.
להלן קישור לפונקציה בJSON.
שיטת בקשה - POST.
Get Account info by cardcom Account Id
https://secure.cardcom.solutions/api/v11/Account/GetByAccountId
להלן הפרמטרים שצרים להעביר בפונקציה Get recurring payment history.
מקרא:
פרמטר אדום - חובה
פרמטר מודגש - מומלץ
פרמטר לא אדום ולא מודגש - אופציונלי
|
מספר |
פרמטר | ערכים אפשריים לדוגמא | תיאור |
| 1 | ApiName | "test2025" | שם משתמש API |
| 2 | ApiPassword | "test5000$" | סיסמת משתמש API |
| 3 | AccountId | 13463 | מספר כרטיס לקוח פנימי |
RESPONSE של Get Account info by cardcom Account Id.
|
מספר |
פרמטר | ערכים אפשריים לדוגמא | תיאור |
| 1 | ResponseCode | 0 | קוד תשובה, אם שווה לאפס הפונקציה בוצעה בצורה תקינה. בכל תשובה אחרת, הפעולה לא הייתה תקינה. |
| 2 | Description | "OK" | תיאור התשובה. ''OK'' זה טוב. |
ערכים של אובייקט Account (3).
|
מספר |
פרמטר | ערכים אפשריים לדוגמא | תיאור |
| 1 | AccountId | 13463 | מספר כרטיס לקוח. |
| 2 | Name | "לקוח טסט" | שם לקוח. |
| 3 | FirstName | "שם ראשוני" | שם נוסף ללקוח של המסמך. |
| 4 | TaxId | "516731969" | מספר ח''פ \ ת''ז. |
| 5 | City | "ראשון לציון" | עיר. |
| 6 | AddressLine1 | "רוטשילד 1" | שורת כתובת ראשונה. |
| 7 | AddressLine2 | "קומה 2 דירה 20" | שורת כתובת שנייה. |
| 8 | Mobile | "0522222222" | מספר טלפון נייד. |
| 9 | Phone | "03161635" | מספר טלפון קווי. |
| 10 | "t.@t.com" | אימייל לקוח. | |
| 11 | IsVatFree | boolean - true \ false | האם הלקוח הוא ללא מע''מ? לקוח מחו''ל לדוגמא. |
| 12 | ZipCode | "41565748" | מיקוד לקוח. |
| 13 | PoBox | "תא דואר מספר 5" | תא דואר. |
| 14 | Fax | "03548135" | פקס. |
| 15 | OpenDate | "4.12.2019" | תאריך פתיחה |
| 16 | Comments | "לקוח VIP" | הערות |
| 17 | AccountForeignKey | "513" | מספר הנח"ש. |
| 18 | SiteUniqueId | "849" | המזהה היחודי של בית העסק עבור הכרטיס לקוח הזה. |
| 19 | ContactName | "משה" | שם איש קשר. |
| 20 | ISOCoinId | 1 - שקל
2 - דולר לקודי מטבע נוספים - רשימת קודי מטבעות |
המטבע שיש בו שימוש במסמכי לקוח. |
| 21 | Balance | 500 | היתרה בכרטיס לקוח. |
| 22 | OpeningBalance | 0 | יתרת פתיחה בכרטיס לקוח. |
להלן קודים לדוגמא על קבלת מידע על הכרטיס לקוח.
שליחת הקריאה לקבלת פרטי החשבון:
{
"ApiName": "test2025",
"ApiPassword": "test5000$",
"AccountId": "4850"
}
התשובה המתקבלת:
{
"ResponseCode": 0,
"Description": "OK",
"Account": {
"AccountId": 4850,
"Name": "test user",
"FirstName": null,
"TaxId": "test company",
"City": "city",
"AddressLine1": "address",
"AddressLine2": "",
"Mobile": "+9721234124112",
"Phone": "",
"Email": null,
"IsVatFree": false,
"ZipCode": null,
"PoBox": null,
"Fax": null,
"OpenDate": "2019-12-04T00:00:00",
"Comments": null,
"AccountForeignKey": null,
"SiteUniqueId": "",
"ContactName": null,
"ISOCoinId": 1,
"Balance": 0.00,
"OpeningBalance": 0.00
}
}