مستندات API حواله بارگیری نفت

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

حواله بارگیری نفت

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

GET/api/v1/rmto/oil-loading-order

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

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

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

orderNumberintegerالزامی

شماره حواله بارگیری نفت؛ قرارداد WSDL نسخه V03

نمونه: 123456

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

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

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

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

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

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

ساختار پاسخ

JSON

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

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

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

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

فیلد	نوع و مقدار تهی	توضیح
`destPostalCode`	`string`می‌تواند null باشد	کدپستی مقصد
`driverNationalID`	`string`می‌تواند null باشد	کد ملی راننده
`loadLitre`	`integer (int32)`غیرتهی	مقدار بار به لیتر
`loadWeight`	`integer (int32)`غیرتهی	وزن بار
`oilGoodsCode`	`string`می‌تواند null باشد	کد فرآورده نفتی
`originPostalCode`	`string`می‌تواند null باشد	کدپستی مبدأ
`pLAQUE_ID`	`string`می‌تواند null باشد	شماره پلاک
`pLAQUE_SN`	`string`می‌تواند null باشد	سریال پلاک
`receiverNationalID`	`string`می‌تواند null باشد	شناسه گیرنده
`senderNationalID`	`string`می‌تواند null باشد	شناسه فرستنده
`shomarehHavaleh`	`integer (int64)`غیرتهی	شماره حواله

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