معرفی
این مستند شامل مشخصات و راهنماي استفاده از وب سرویس های نرم افزار چابک می باشد
. وب سرویس ها در جهت آسودگی مشتري براي ارسال اطلاعات مرسوله هاي خود به سمت
پرتال می باشند. کاربر پس از استفاده از این وب سرویس توانسته است اطلاعات خود را
که ممکن است شامل یک محصول یا تعدادي زیادي محصول باشد را با وب سرویس به سمت
پرتال ارسال نماید و پس از آن اطلاعات را مشاهده می نماید و بر اساس
اطلاعات هر یک از مرسوله ها اقدام به جمع آوري و توزیع محصولات می نماید و پس از آن
مشتري می تواند با استفاده از وب سرویس ها وضعیت تک تک مرسوله هاي خود را پیگیري
نماید.
در جهت راه اندازي وب سرویس ها حتما باید دانش ارسال اطلاعات با استفاده از JSON
فراگرفته شده باشد.
جهت دریافت نام کاربری و کلمه عبور از شرکت پستی طرف قرارداد خود اقدام فرمایید
برای دریافت نمونه مثال ها در نرم افزار پست من اینجا را کلیک کنید
برای دریافت پلاگین وردپرس-ووکامرس اینجا را کلیک کنید
برای مشاهده ویدیو آموزشی نصب افزونه وردپرس-ووکامرس اینجا را کلیک کنید
بیس آدرس سرور API:https://api-ppt.chabok.app
لطفا در پست من پس از Import آدرس را به آدرس فوق تغییر دهید
وب سرویس ها در یک نگاه
در یک نگاه وب سرویس ها به صورت زیر می باشد که در ادامه این مستند توضیح داده خواهد
شد.
سرویس ها
نام سرویس
عدد سرویس
زمینی
1
هوایی
6
پستی
11
پاکت
97
نوع ارسال
نام
عدد
پیش کرایه
0
پس کرایه
1
در خروجی تمام متدها پراپرتی result , message و
object وجود دارد که توضیح آنها به شرح زیر است.
پارامترهای خروجی ثابت
نام پارامتر
نوع پارامتر
توضیحات
result
boolean
موفق بودن یا نبودن ریکوئست
message
string
توضیح علت خطا یا ناموفق بودن ریکوئست
object
object
نتیجه ی API
این متد جهت ارسال اطلاعات یک مرسوله یا تعداد زیادي از مرسولات از این وب
سرویس
استفاده می گردد.
پارامترهای ورودی
نام پارامتر
نوع پارامتر
توضیحات
1
username
string
نام کاربري
2
password
string
پسورد
3
reference
string
شماره مرجع مشتري
4
date
date
تاریخ ارسال اطلاعات
5
pieces_assinged
integer
تعداد بسته
6
service
integer
عدد سرویس
7
value
float
ارزش کالا به ریال
7
inv_value
float
ارزش پرداخت در محل (COD)
8
term_payment
integer
نوع ارسال
9
weight
float
وزن به کیلو گرم
10
person
string
نام شخص گیرنده
11
company
string
نام شرکت گیرنده
12
no_city
integer
کد شهر گیرنده
13
telephone
string
تلفن گیرنده
14
mobile
string
موبایل گیرنده
15
email
string
ایمیل گیرنده
16
address
string
آدرس گیرنده
17
post_code
integer
کد پستی گیرنده
18
content
string
توضیحات اضافی
مثال
{user : {username: "test" , password: "1234" },bulk : [ {cn : {reference: 675675 , date: "2018-05-13" , assinged_pieces: "3" , service: 1 , inv_value: "3350000.00" , value: "3350000.00" , payment_term: 0 , weight: "1" },receiver : {person: "آزمایشی" , company: "" , city_no: "10770" , telephone: "" , mobile: "989034538660" , email: "test@test.com" , address: "آزمایشی" , post_code: "10770" , content: "برسد به دست آقاي انصاری" } } ]}
پارامترهای خروجی
نام پارامتر
نوع پارامتر
توضیحات
1
tracking
string
شماره بارنامه
2
package
string array
شماره بسته ی متصل به بارنامه
3
reference
string
شماره مرجع مشتری
4
status
string
وضعیت بسته
5
error
array
اخطار ها
مثال
{result : [ {tracking: "54100004430128101" , package : [null ],reference: 123 , status: true , error: " (request:1,exist_package:1,exist_cons:1) " } ]}
جهت حذف سفارش از این متد استفاده میشود .
پارامترهای ورودی
نام پارامتر
نوع پارامتر
توضیحات
1
username
string
نام کاربری
2
password
string
کلمه عبور
3
consignment_no
string
شماره بارنامه
4
reason
string
دلیل انصراف
مثال
{consignment_no: "913000039" , reason: "انصراف مشتری" }
پارامترهای خروجی
نام پارامتر
نوع پارامتر
توضیحات
مثال
جهت دریافت اطلاعات هر یک از محصولات ثبت شده از این متد استفاده می گردد.
پارامترهای ورودی
نام پارامتر
نوع پارامتر
توضیحات
1
username
string
نام کاربري
2
password
string
پسورد
3
from
date
تاریخ شروع گزارش
4
to
date
تاریخ پایان گزارش
5
maximum_records
integer
تعداد خروجی گزارش
مثال
{user : {username: "test" , password: "1234" },date : {from: "25-09 -2017" , to: "10-10 -2017" },maximum_records: 10 }
پارامترهای خروجی
نام پارامتر
نوع پارامتر
توضیحات
1
tracking
string
شماره بارنامه
2
date
date
تاریخ ارسال اطلاعات
3
assinged_pieces
integer
تعداد بسته های بارنامه
4
weight
float
وزن به کیلو گرم
5
service
integer
عدد سرویس
6
value
float
ارزش کالا به ریال
7
payment_term
integer
عدد نوع ارسال
8
last_status
string
آخرین وضعیت بسته
9
delivery_date
date
تاریخ تحویل بسته
10
delivery_person
string
نام توزیع کننده
11
person
string
نام شخص گیرنده
12
company
string
نام شرکت گیرنده
13
city
string
نام شهر گیرنده
14
telephone
string
تلفن گیرنده
15
mobile
string
موبایل گیرنده
16
address
string
آدرس گیرنده
17
post_code
integer
کد پستی گیرنده
18
delivery_charge
float
هزینه توزیع
19
insurance_charge
float
مبلغ بیمه
20
vat_charge
float
مالیات
21
pack_charge
float
هزینه بسته بندی
22
extra_charge
float
هزینه اضافی
23
cod_value
float
هزینه پرداخت موقع تحویل
24
total_charge
float
جمع هزینه ها
25
timestamp_date
26
date
date
تاریخ ارسال اطلاعات
27
status
string
وضعیت بسته
28
status_note
string
توضیحات وضعیت بسته
مثال
{cn : {tracking: "54100004430041101" , date: "2020-06-17 14:20:00" , assinged_pieces: "4" , weight: "0.001" , service: "1" , value: "0" , payment_term: "0" , last_status: "OK" , delivery_date: "2020-06-20 13:58:08" , delivery_person: "تست سعید" },receiver : {person: "تست سعید" , company: null , city: "تهران" , telephone: "02144444444" , mobile: "09360950049" , address: "تهران تستی برای تست" , post_code: null },financial : {delivery_charge: "108945" , insurance_charge: "15000" , vat_charge: "12505" , pack_charge: "0" , extra_charge: "0" , cod_value: 0 , total_charge: 136450 },history : [ {timestamp_date: 1592645288 , date: "2020-06-20 13:58:08" , status: "OK" , status_note: "بار به صورت صحیح و سالم تحویل شد" }, {timestamp_date: 1592645097 , date: "2020-06-20 13:54:57" , status: "PU" , status_note: "بار از مبدا جمع آوری شد" }, {timestamp_date: 1592387458 , date: "2020-06-17 14:20:58" , status: "D01" , status_note: "بار در سیستم ورود اطلاعات شد" } ]}
دریافت اطلاعات رهگیري N مرسوله در قالب یک گزارش ، با استفاده از این متد
می توان اطلاعات رهگیري یک یا چندین بارنامه را دریافت نمود.
پارامترهای ورودی
نام پارامتر
نوع پارامتر
توضیحات
1
username
string
نام کاربري
2
password
string
پسورد
3
bulk
integer
شماره رهگیری مرسوله
مثال
{user : {username: "test" , password: "1234" },bulk : ["54100003992527101" ,"54100003942527101" ]}
پارامترهای خروجی
نام پارامتر
نوع پارامتر
توضیحات
1
time
time
زمان رخ دادن آخرین وضعیت
2
date
date
تاریخ رخ دادن آخرین وضعیت
3
status
string
وضعیت بسته
4
status_note
string
توضیحات وضعیت بسته
5
tracking
string
شماره بارنامه
6
reference
string
شماره مرجع مشتری
مثال
{history : [ {time: "01:26" , date: "2020-07-19" , status: "D01" , status_note: "بار در سیستم ورود اطلاعات شد" , tracking: "54100004430128101" , reference: "123" }, {time: "13:58" , date: "2020-06-20" , status: "OK" , status_note: "بار به صورت صحیح و سالم تحویل شد" , tracking: "54100004430041101" , reference: "9990" } ]}
جهت دریافت لیست استان ها می باشند از این متد
استفاده می گردد.
پارامترهای ورودی
نام پارامتر
نوع پارامتر
توضیحات
-
-
-
ساختار تعریف شده اي براي این متد وجود ندارد و با فراخوانی آدرس سرویس همین متد می توان لیست استانها
را دریافت نمود.
پارامترهای خروجی
نام پارامتر
نوع پارامتر
توضیحات
1
no
integer
آیدی استان
2
name
string
نام استان
مثال
{state : [ {no: "1" , name: "آذربایجان شرقی" }, {no: "2" , name: "آذربایجان غربی" }, {}, {}, {}, {}, {}, {}, {no: "9" , name: "خراسان جنوبی" }, {no: "10" , name: "خراسان رضوی" }, {no: "11" , name: "خراسان شمالی" }, {}, {}, {}, {no: "15" , name: "سیستان و بلوچستان" }, {}, {}, {}, {}, {}, {no: "21" , name: "کرمانشاه" }, {no: "22" , name: "کهکیلویه وبویراحمد" }, {}, {no: "24" , name: "مازندران" }, {}, {}, {}, {no: "28" , name: "چهارمحال بختیاری" }, {}, {}, {} ]}
جهت دریافت لیست شهرها با استفاده
از این متد دریافت نمایید.
پارامترهای ورودی
نام پارامتر
نوع پارامتر
توضیحات
1
no
integer
آیدی استان مورد نظر که از متد دریافت استان گرفته شده است.
مثال
پارامترهای خروجی
نام پارامتر
نوع پارامتر
توضیحات
1
state_no
integer
آیدی استان
2
no
integer
آیدی شهرهای استان
3
name
string
نام شهرهای استان
مثال
{objects : {city : [ {state_no: "9" , no: "11907" , name: "آرين شهر" }, {state_no: "9" , no: "11925" , name: "آيسک" }, {state_no: "9" , no: "11698" , name: "ارسک" }, {state_no: "9" , no: "11735" , name: "اسديه" }, {state_no: "9" , no: "11737" , name: "اسفدن-خراسان جنوبي" }, {state_no: "9" , no: "11757" , name: "اسلاميه" }, {state_no: "9" , no: "12020" , name: "بشرويه" }, {state_no: "9" , no: "11320" , name: "بشرویه" }, {state_no: "9" , no: "11538" , name: "بهارستان" }, {state_no: "9" , no: "12120" , name: "بيهود" }, {state_no: "9" , no: "10936" , name: "بیرجند" }, {state_no: "9" , no: "12401" , name: "حاجي آباد-خراسان جنوبي" }, {state_no: "9" , no: "12504" , name: "خضري دشت بياض" }, {state_no: "9" , no: "12546" , name: "خوسف" }, {state_no: "9" , no: "17318" , name: "درمیان" }, {state_no: "9" , no: "12698" , name: "ديهوک" }, {state_no: "9" , no: "12819" , name: "زهان" }, {state_no: "9" , no: "17327" , name: "زیرکوه" }, {state_no: "9" , no: "11544" , name: "سدایان" }, {state_no: "9" , no: "12864" , name: "سرايان" }, {state_no: "9" , no: "11428" , name: "سرایان" }, {state_no: "9" , no: "12868" , name: "سربيشه-خراسان جنوبي" }, {state_no: "9" , no: "12951" , name: "سه قلعه" }, {state_no: "9" , no: "13091" , name: "شوسف" }, {state_no: "9" , no: "11328" , name: "طبس" }, {state_no: "9" , no: "13152" , name: "طبس مسينا" }, {state_no: "9" , no: "13179" , name: "عشق آباد-خراسان جنوبي" }, {state_no: "9" , no: "11348" , name: "فردوس" }, {state_no: "9" , no: "14164" , name: "قائنات" }, {state_no: "9" , no: "13283" , name: "قاين" }, {state_no: "9" , no: "11321" , name: "قاین" }, {state_no: "9" , no: "13361" , name: "قهستان" }, {state_no: "9" , no: "13751" , name: "محمدشهر-خراسان جنوبي" }, {state_no: "9" , no: "13872" , name: "مود" }, {state_no: "9" , no: "11559" , name: "نهبندان" }, {state_no: "9" , no: "14022" , name: "نيمبلوک" }, {state_no: "9" , no: "13594" , name: "گزو" }, {state_no: "9" , no: "13596" , name: "گزيک" } ],selected: null }}
جهت استعلام قیمت از این متد استفاده میشود .
پارامترهای ورودی
نام پارامتر
نوع پارامتر
توضیحات
1
origin
integer
آیدی شهر مبدا
2
destination
integer
آیدی شهر مقصد
3
method
integer
نوع سرویس
4
value
float
ارزش کالا به ریال
5
weight
float
وزن به کیلو گرم
مثال
{order : {origin: "10866" , destination: "10866" , method: "1" , value: "3200000" , weight: "4" }}
پارامترهای خروجی
نام پارامتر
نوع پارامتر
توضیحات
1
quote
integer
جمع هزینه پرداختی
2
zone
integer
نوع محدوده
3
fld_Manual_Cost
float
کرایه حمل
4
fld_Pack_Cost
float
کرایه بسته بندی
5
fld_Charge_Cost
float
کرایه خدمات
6
fld_Manual_Insurance
float
بیمه
7
fld_Lab_Cost
float
سوخت
8
fld_Manual_VAT
float
ارزش افزوده
9
fld_Total_Cost
float
جمع کل
10
price_list
integer
11
min_ins
integer
حداقل بیمه
12
currency
integer
واحد پولی
مثال
{order : {quote: 330270 , price : {zone: "C" , fld_Manual_Cost: 229000 , fld_Pack_Cost: 0 , fld_Charge_Cost: 10000 , fld_Manual_Insurance: 15000 , fld_Lab_Cost: 49000 , fld_Manual_VAT: 27270 , fld_Total_Cost: 330270 , price_list: "1737" , min_ins: "7500000" },currency: "IRR" }}
جهت پیگیري مرسوله ارسالی از این متد استفاده میشود .
پارامترهای ورودی
نام پارامتر
نوع پارامتر
توضیحات
1
reference
string
شماره مرجع مشتری
2
lang
string
زبان خروجی
مثال
{order : {reference: "54100003225544101" , lang: "fa" }}
پارامترهای خروجی
نام پارامتر
نوع پارامتر
توضیحات
1
delivered_to
string
مشتری گیرنده
2
delivery_time
time
زمان مصرف شده
3
signature
img
امضا مشتری
4
lat
float
عرض جغرافیایی
5
lng
float
طول جغرافیایی
6
timestamp_date
timestamp
تاریخ رخداد وضعیت
7
date
date
تاریخ ارسال اطلاعات
8
status
string
وضعیت بسته
9
loc
lat.lng
مکان رخداد وضعیت
10
origin
string
مبدا
11
dest
string
مقصد
12
pickup_agent_code
string
کد نماینده جمع آوری
13
pickup_agent
string
نماینده جمع آوری
14
delivery_agent_code
string
کد نماینده توزیع
15
delivery_agent
string
نماینده توزیع
16
sender_code
string
کد مشتری ارسال کننده
17
sender_company
string
شرکت ارسال کننده
18
sender_contact
string
مشتری ارسال کننده
19
sender_phone
text
تلفن ارسال کننده
20
receiver_company
string
شرکت تحویل گیرنده
21
receiver_contact
string
مشتری تحویل گیرنده
22
receiver_phone
string
شماره مشتری تحویل گیرنده
مثال
{order : {delivered_to: "خسروانی" , delivery_time: "1397/04/20 10:27:25" , signature: http://portal.chaparnet.com/Attachment/signatures/2018-07-11.10:27:25_753_1531304846441.png , geo : {lat: "35.72247834" , lng: "51.45734967" },history : [ {timestamp_date: 1531293828 , date: "1397/04/20" , status: "OD (توزیع توسط پیک)" , geo : {},loc: "تهران" }, {timestamp_date: 1531288645 , date: "1397/04/20" , status: "OK (سالم تحویل شد)" , geo : {lat: "35.72247834" , lng: "51.45734967" },loc: null }, {timestamp_date: 1531283244 , date: "1397/04/20" , status: "IR (اسکن ورود)" , geo : {},loc: "تهران" }, {timestamp_date: 1531280298 , date: "1397/04/20" , status: "OF (اسکن خروج)" , geo : {},loc: "تهران" }, {timestamp_date: 1531274867 , date: "1397/04/20" , status: "IR (اسکن ورود)" , geo : {},loc: "تهران" }, {timestamp_date: 1531258780 , date: "1397/04/20" , status: "OF (اسکن خروج)" , geo : {},loc: "زنجان" }, {timestamp_date: 1531258539 , date: "1397/04/20" , status: "D01 (ورود اطلاعات)" , geo : {},loc: "IRAN/زنجان/" }, {timestamp_date: 1531258539 , date: "1397/04/20" , status: "D01 (ورود اطلاعات)" , geo : {},loc: "IRAN/زنجان/" } ],origin: "زنجان" , dest: "تهران" , pickup_agent_code: "3313" , pickup_agent: "نماینده زنجان" , delivery_agent_code: "1080" , delivery_agent: "نماینده تهران" , sender_code: "1000" , sender_company: null , sender_contact: null , sender_phone: null , receiver_company: null , receiver_contact: null , receiver_phone: "09126980570" }}