مستندات API بررسی تخصیص بارنامه

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

بررسی تخصیص بارنامه

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

GET/api/v1/rmto/waybill-assign

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

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

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

traceCodeintegerالزامی

کد رهگیری حواله

نمونه: 123456

پارامترها در query ارسال می‌شوند. هر مقدار الزامی، حداکثر ۱۲۸ کاراکتر و بدون کاراکتر کنترلی است؛ نام فیلدها و حروف آن‌ها را مطابق قرارداد نگه دارید.
پارامتر integer باید عدد صحیح مثبت با ارقام لاتین باشد. کدهای مرجع را به‌جای نام نمایشی گزینه بفرستید.
هر فیلد حداکثر ۱۲۸ نویسه و بدون نویسه کنترلی است؛ ورودی نامعتبر پیش از ارسال به راهداری رد می‌شود.
عدد صحیح مثبت وارد کنید؛ کد شهر، شرکت بیمه، نوع سند، کالا و شماره بار در محدوده int32 و سایر اعداد صحیح در محدوده int64 هستند. شناسه بزرگ را به Number جاوااسکریپت تبدیل نکنید.

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

# 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/waybill-assign?traceCode=123456' \
  --header "X-API-Key: $BARBAN_API_KEY" \
  --header "Idempotency-Key: example-waybill-assign-001" \
  --header "Accept: application/json"

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

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

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

ساختار پاسخ

JSON

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

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

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

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

فیلد	نوع و مقدار تهی	توضیح
`CarrierCode`	`string`می‌تواند null باشد	کد شرکت حمل
`CreatedOn`	`datetime`غیرتهی	تاریخ ثبت
`DestinationCityCode`	`string`می‌تواند null باشد	کد مقصد
`DriverNationalId`	`string`می‌تواند null باشد	کد ملی راننده
`EndDate`	`string`می‌تواند null باشد	تاریخ پایان
`FleetCardNo`	`string`می‌تواند null باشد	کارت هوشمند ناوگان
`FleetPlaque`	`string`می‌تواند null باشد	پلاک ناوگان
`GoodTypeCode`	`integer (int64)`غیرتهی	کد کالا
`LoaderTypeCode`	`string`می‌تواند null باشد	کد بارگیر
`LoadingDate`	`string`می‌تواند null باشد	تاریخ بارگیری
`OriginCityCode`	`string`می‌تواند null باشد	کد مبدأ
`SecondDriverNationalId`	`string`می‌تواند null باشد	کد ملی راننده دوم
`StartDate`	`string`می‌تواند null باشد	تاریخ شروع
`TrCode`	`integer (int64)`غیرتهی	کد رهگیری تخصیص
`UpdatedOn`	`datetime`غیرتهی	آخرین تغییر
`Weight`	`integer (int64)`غیرتهی	وزن

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