مستندات API رد و تأیید بارنامه در بازه تاریخ

راهنمای اتصال سرویس

رد و تأیید بارنامه در بازه تاریخ

استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.

این سرویس موقتاً غیرفعال است

قرارداد برای آماده‌سازی اتصال در دسترس است. پیش از درخواست عملیاتی، وضعیت خدمت را با پشتیبانی بررسی کنید.

GET/api/v1/rmto/bol/approvals

X-API-Keyدسترسی مورد نیاز: waybills:readپارامترها در Queryمصرف سهمیه طبق شرایط اشتراک

ورودی‌های درخواست

پارامترها را با نام دقیق در query string ارسال کنید. نوع داده و الزامی بودن هر فیلد را پیش از ارسال بررسی کنید.

fromDatestringالزامی

تاریخ شمسی شروع yyyy/MM/dd؛ حداکثر بازه ۳۱ روز

نمونه: 1405/07/01

toDatestringالزامی

تاریخ شمسی پایان yyyy/MM/dd

نمونه: 1405/07/15

پارامترها در query ارسال می‌شوند. هر مقدار الزامی، حداکثر ۱۲۸ کاراکتر و بدون کاراکتر کنترلی است؛ نام فیلدها و حروف آن‌ها را مطابق قرارداد نگه دارید.
fromDate و toDate تاریخ شمسی معتبر با قالب yyyy/MM/dd هستند. تاریخ پایان نباید قبل از شروع باشد و اختلاف دو تاریخ حداکثر ۳۱ روز است.
هر فیلد حداکثر ۱۲۸ نویسه و بدون نویسه کنترلی است؛ ورودی نامعتبر پیش از ارسال به راهداری رد می‌شود.
تاریخ شمسی باید واقعاً معتبر و با قالب yyyy/MM/dd باشد؛ ترتیب تاریخ‌ها و حداکثر اختلاف ۳۱ روز، حتی بین دو سال، بررسی می‌شود.

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

# Use your test key. Example inputs are synthetic; no automatic retry.
# Set BARBAN_API_KEY privately before running this example.
curl --request GET 'https://api.bar-ban.ir/api/v1/rmto/bol/approvals?fromDate=1405%2F07%2F01&toDate=1405%2F07%2F15' \
  --header "X-API-Key: $BARBAN_API_KEY" \
  --header "Idempotency-Key: example-bol-approvals-001" \
  --header "Accept: application/json"

مقادیر نمونه‌اند. کپی کد هیچ درخواستی ارسال نمی‌کند.

کلید آزمایشی بدون فراخوانی راهداری پاسخ می‌دهد؛ کسر سهمیه به تنظیمات خریداری‌شده پلن بستگی دارد.

قرارداد با WSDL نسخه V03 در 2026-10-20 تطبیق داده شده است؛ موفقیت استعلام عملیاتی نیازمند مجوز و حساب معتبر راهداری است.

ساختار پاسخ

JSON

ابتدا وضعیت HTTP و پوش پاسخ را بررسی کنید. مقادیر این مثال آموزشی‌اند؛ وجود قرارداد، سلامت لحظه‌ای سرویس بالادستی را تضمین نمی‌کند.

نمونه آموزشی پاسخ

{
  "requestId": "example-bol-approvals-001",
  "sandbox": true,
  "found": true,
  "data": {
    "sandbox": true,
    "service": "bol-approvals",
    "message": "احراز هویت و ساختار درخواست معتبر است؛ راهداری فراخوانی نشد."
  },
  "error": null
}

فیلدهای داده پاسخ ۲۶ فیلد

فیلد	نوع و مقدار تهی	توضیح
`Count`	`integer (int32)`غیرتهی	تعداد
`Error_Code`	`integer (int32)`غیرتهی	کد خطا
`Error_Message`	`string`می‌تواند null باشد	شرح خطا
`data`	`array`می‌تواند null باشد	جزئیات
`data[].Alter_Status_Time`	`array`می‌تواند null باشد	تاریخچه وضعیت
`data[].BarNumber`	`integer (int32)`غیرتهی	شماره بارنامه
`data[].BarnameID`	`integer (int32)`غیرتهی	شناسه بارنامه
`data[].Carrier`	`string`می‌تواند null باشد	شرکت حمل
`data[].Carrier_ID`	`string`می‌تواند null باشد	شناسه شرکت حمل
`data[].Confirm_Time`	`string`می‌تواند null باشد	زمان تأیید
`data[].Confirmed`	`boolean`غیرتهی	تأیید بارنامه
`data[].Driver_First_Name`	`string`می‌تواند null باشد	نام راننده
`data[].Driver_Last_Name`	`string`می‌تواند null باشد	نام خانوادگی راننده
`data[].From_PostCode`	`string`می‌تواند null باشد	کدپستی مبدأ
`data[].Goods`	`array`می‌تواند null باشد	کالاها
`data[].Goods[].Good_ID`	`integer (int32)`غیرتهی	شناسه کالا
`data[].Goods[].Good_Name`	`string`می‌تواند null باشد	نام کالا
`data[].Goods[].Weight`	`integer (int32)`غیرتهی	وزن
`data[].IssueDate`	`string`می‌تواند null باشد	تاریخ صدور
`data[].National_ID`	`string`می‌تواند null باشد	کد ملی راننده
`data[].Receiver_National_ID`	`string`می‌تواند null باشد	کد ملی گیرنده
`data[].Sender_National_ID`	`string`می‌تواند null باشد	کد ملی فرستنده
`data[].Serial`	`string`می‌تواند null باشد	سریال
`data[].To_PostCode`	`string`می‌تواند null باشد	کدپستی مقصد
`data[].TraceCode`	`string`می‌تواند null باشد	کد رهگیری
`data[].Warehouse_ID`	`string`می‌تواند null باشد	شناسه انبار

پاسخ نامنتظره گرفتید؟راهنمای پاسخ‌ها و خطاها آماده اتصال هستید؟مرور نکات محیط عملیاتی