مستندات API اطلاعات سند تجاری

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

اطلاعات سند تجاری

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

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

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

GET/api/v1/rmto/trade-document

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

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

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

referenceDocumentNumberstringالزامی

شماره سند مرجع

نمونه: 123456

documentTypeintegerالزامی

نوع سند مطابق مجوز راهداری

نمونه: 1

پارامترها در 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/trade-document?referenceDocumentNumber=123456&documentType=1' \
  --header "X-API-Key: $BARBAN_API_KEY" \
  --header "Idempotency-Key: example-trade-document-001" \
  --header "Accept: application/json"

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

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

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

ساختار پاسخ

JSON

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

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

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

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

فیلد	نوع و مقدار تهی	توضیح
`ContainersCount`	`string`می‌تواند null باشد	تعداد کانتینر
`ContainersList`	`array`می‌تواند null باشد	کانتینرها
`ContainersList[].AdditionalInformation`	`string`می‌تواند null باشد	اطلاعات تکمیلی
`ContainersList[].EmptyWeight`	`string`می‌تواند null باشد	وزن خالی
`ContainersList[].GoodsList`	`array`می‌تواند null باشد	فهرست کالاها
`ContainersList[].GoodsList[].AdditionalInformation`	`string`می‌تواند null باشد	اطلاعات تکمیلی
`ContainersList[].GoodsList[].Count`	`string`می‌تواند null باشد	تعداد
`ContainersList[].GoodsList[].DangerousGoodsCode`	`string`می‌تواند null باشد	کد کالای خطرناک
`ContainersList[].GoodsList[].GoodsCode`	`string`می‌تواند null باشد	کد کالا
`ContainersList[].GoodsList[].GoodsDescription`	`string`می‌تواند null باشد	شرح کالا
`ContainersList[].GoodsList[].GrossWeight`	`string`می‌تواند null باشد	وزن ناخالص
`ContainersList[].GoodsList[].HSCode`	`string`می‌تواند null باشد	کد تعرفه کالا
`ContainersList[].GoodsList[].LogisticCode`	`string`می‌تواند null باشد	کد لجستیک
`ContainersList[].GoodsList[].TraceCode`	`string`می‌تواند null باشد	کد رهگیری
`ContainersList[].GoodsList[].Volume`	`string`می‌تواند null باشد	حجم
`ContainersList[].GrossWeight`	`string`می‌تواند null باشد	وزن ناخالص
`ContainersList[].Humidity`	`string`می‌تواند null باشد	رطوبت
`ContainersList[].ID`	`string`می‌تواند null باشد	شناسه
`ContainersList[].LoadVolume`	`string`می‌تواند null باشد	حجم بارگیری
`ContainersList[].MaxTemp`	`string`می‌تواند null باشد	بیشینه دما
`ContainersList[].MinTemp`	`string`می‌تواند null باشد	کمینه دما
`ContainersList[].PackagCount`	`integer (int32)`غیرتهی	تعداد بسته
`ContainersList[].Seals`	`array`می‌تواند null باشد	پلمب‌ها
`ContainersList[].Seals[].Marks`	`string`می‌تواند null باشد	علائم
`ContainersList[].Seals[].SealingParty`	`string`می‌تواند null باشد	عامل پلمب
`ContainersList[].Type`	`string`می‌تواند null باشد	نوع
`ContainersList[].UnitTemp`	`string`می‌تواند null باشد	واحد دما
`DischargePostalCode`	`string`می‌تواند null باشد	کدپستی تخلیه
`DriverName`	`string`می‌تواند null باشد	نام راننده
`DriverNationalCode`	`string`می‌تواند null باشد	کد ملی راننده
`Error_Code`	`integer (int32)`غیرتهی	کد خطا
`Error_Message`	`string`می‌تواند null باشد	شرح خطا
`GoodsValue`	`string`می‌تواند null باشد	ارزش کالا
`GrossWeight`	`string`می‌تواند null باشد	وزن ناخالص
`LoadingDateTime`	`integer (int64)`غیرتهی	زمان بارگیری
`LoadingPostalCode`	`string`می‌تواند null باشد	کدپستی بارگیری
`NetWeight`	`string`می‌تواند null باشد	وزن خالص
`PackageCount`	`string`می‌تواند null باشد	تعداد بسته
`ReceiverName`	`string`می‌تواند null باشد	نام گیرنده
`ReceiverNationalCode`	`string`می‌تواند null باشد	کد ملی گیرنده
`RegistrationDate`	`integer (int64)`غیرتهی	تاریخ ثبت سند
`SenderName`	`string`می‌تواند null باشد	نام فرستنده
`SenderNationalCode`	`string`می‌تواند null باشد	کد ملی فرستنده
`VesselRegistrationNumber`	`string`می‌تواند null باشد	شماره ثبت وسیله حمل
`listGoods`	`array`می‌تواند null باشد	کالاها
`listGoods[].AdditionalInformation`	`string`می‌تواند null باشد	اطلاعات تکمیلی
`listGoods[].Count`	`string`می‌تواند null باشد	تعداد
`listGoods[].DangerousGoodsCode`	`string`می‌تواند null باشد	کد کالای خطرناک
`listGoods[].GoodsCode`	`string`می‌تواند null باشد	کد کالا
`listGoods[].GoodsDescription`	`string`می‌تواند null باشد	شرح کالا
`listGoods[].GrossWeight`	`string`می‌تواند null باشد	وزن ناخالص
`listGoods[].HSCode`	`string`می‌تواند null باشد	کد تعرفه کالا
`listGoods[].LogisticCode`	`string`می‌تواند null باشد	کد لجستیک
`listGoods[].TraceCode`	`string`می‌تواند null باشد	کد رهگیری
`listGoods[].Volume`	`string`می‌تواند null باشد	حجم

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