مستندات API کالاهای بیجک معرفی‌نامه

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

کالاهای بیجک معرفی‌نامه

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

GET/api/v1/rmto/introduce/bijak

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

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

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

traceCodestringالزامی

کد رهگیری معرفی‌نامه

نمونه: 123456

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

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

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

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

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

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

ساختار پاسخ

JSON

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

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

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

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

فیلد	نوع و مقدار تهی	توضیح
`[].AndazeKantiner`	`string`می‌تواند null باشد	اندازه کانتینر
`[].ArzesheGhalameKala`	`integer (int64)`غیرتهی	ارزش قلم کالا
`[].CodeBijak`	`string`می‌تواند null باشد	کد بیجک
`[].CodeKala`	`string`می‌تواند null باشد	کد کالا
`[].CodeSanad`	`string`می‌تواند null باشد	کد سند
`[].CodeVahedeShomaresh`	`integer (int32)`غیرتهی	کد واحد شمارش
`[].NoeBastebandi`	`string`می‌تواند null باشد	نوع بسته‌بندی
`[].SharheKala`	`string`می‌تواند null باشد	شرح کالا
`[].ShomareGhalam`	`integer (int32)`غیرتهی	شماره قلم
`[].ShomareKantinar`	`string`می‌تواند null باشد	شماره کانتینر
`[].TarikhSanad`	`string`می‌تواند null باشد	تاریخ سند
`[].Tedad`	`number`غیرتهی	تعداد
`[].VahedeShomaresh`	`string`می‌تواند null باشد	واحد شمارش
`[].VazneKhales`	`number`غیرتهی	وزن خالص
`[].VazneNaKhales`	`number`غیرتهی	وزن ناخالص
`[].ZamaneSabt`	`string`می‌تواند null باشد	زمان ثبت

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