انواع بسته‌بندی

packingId minWeight minHeight minWidth minLength maxWeight maxHeight maxWidth maxLength height width length packType عنوان
در حال بارگذاری داده‌ها...

دسته‌بندی‌های محتوای بسته

packageContentId packType عنوان
در حال بارگذاری داده‌ها...

انواع سرویس ارسال

serviceId isActive عنوان
در حال بارگذاری داده‌ها...

انواع روش پرداخت

paymentType توضیحات عنوان
10پرداخت توسط فرستنده به صورت اعتباریسمت فرستنده-اعتباری
20پرداخت توسط گیرنده به صورت پس کرایهسمت گیرنده-پسکرایه
30پرداخت توسط گیرنده در محل دریافتسمت گیرنده-پرداخت در محل
40پرداخت توسط فرستنده در محل ارسالسمت فرستنده-پرداخت در محل
50پرداخت توسط فرستنده از طریق کیف پولسمت فرستنده-پرداخت از کیف پول
80پرداخت توسط فرستنده به صورت نقدیسمت فرستنده-نقدی

شهرها و استان‌ها

id jetId latitude longitude stateTitle stateId عنوان
در حال بارگذاری داده‌ها...

وضعیت مرسولات

id latinTitle عنوان
در حال بارگذاری داده‌ها...

رویدادهای مرسولات

id modifier creator modificationTime creationTime modificationDate creationDate modifierId creatorId isActive parcelStatus.id parcelStatus.latinTitle parcelStatus.title fParcelStatusId latinTitle عنوان
در حال بارگذاری داده‌ها...

ثبت نظر و پیشنهاد

سوالات متداول (FAQ)

1. در نسخه 4 چگونه توکن احراز هویت دریافت کنم؟

دریافت توکن باید از طریق متد POST و آدرس https://igtgatewayapi.tipax.ir/Token و ارسال JSON زیر انجام شود:

{
  "username": "نام کاربری پنل ای تیپاکس شما",
  "password": "رمز عبور پنل ای تیپاکس شما",
  "grant_type": "password" //این بخش را بدون تغییر بگذارید
}

2. وضعیت پارامترهای ثبت زمان جمع‌آوری مرسوله چگونه است؟

در حال حاضر پارامترهای ثبت زمان جمع‌آوری مرسوله در API وجود دارد اما امکان ثبت آن میسر نیست.

3. محدودیت ارزش سفارش چیست؟

ثبت سفارش به ارزش بیشتر از ۱۰۰,۰۰۰,۰۰۰ تومان نیاز به هماهنگی با اکانت منیجر دارد.

4. در جیسون مرتبط با آدرس ها پارامتر peopleAddressTypeId چیست؟

آدرس‌های فرستنده peopleAddressTypeId=1 و آدرس‌های گیرنده peopleAddressTypeId=2 دارند

5. پارامتر EnableLabelPrivacy چیست؟

این پارامتر مشخص می‌کند که آیا جزئیات اطلاعات فرستنده و گیرنده بر روی لیبل چاپ شود (true) یا خیر (false)

6. پارامتر parcelbookId چیست؟

هر مشتری می‌تواند از طریق متد POST و اندپوینت https://omapi.tipax.ir/api/OM/v4/ParcelBooks بسته تعریف کند. بسته‌هایی که توسط خود مشتری تعریف شده‌اند را می‌توان با استفاده از متد Get و اندپوینت https://omapi.tipax.ir/api/OM/v3/ParcelBooks دریافت کرد. در ریسپانس این سرویس، برای هر بسته تعریف شده یک id وجود دارد که این مقادیر همان Vlaueهای مجاز برای پارامتر parcelbookId هستند. نکته مهم در مورد این پارامتر این است که زمانی که در جیسون ارسالی، از این پارامتر استفاده می‌کنید، دیگر لازم نیست پارامترهای مرتبط با ابعاد (طول، عرض و ارتفاع) را ارسال کنید. اما اگر این پارامتر را ارسال نکنید، حتما باید پارامترهای ابعاد را با مقادیر مجاز ارسال کنید.

7. پارامتر parcelTypeId چیست؟

این پارامتر مربوط به نسخه‌های 1 و 2 API تیپاکس است که در نسخه 3 و 4 نیازی به ارسال ان نیست

8. کاربرد آیتم‌های senderAddressAndClient و receiverAddressAndClient چیست؟

در نسخه های 3 و 4 ای پی آی تیپاکس، زمانی که جیسون ارسالی با اطلاعات مربوط به origin و destination پر شده باشد، مقادیر مرتبط با آیتم‌های senderAddressAndClient و receiverAddressAndClient بطور خودکار پر خواهند شد، در نتیجه نیازی به ارسال این آیتم‌ها حین ثبت سفارش نیست.

9. بارکد در محیط تست دریافت شده اما در سیستم ثبت نشده؟ مشکل چیست؟

نسخه v4 به‌صورت event پیاده‌سازی شده و سفارشات بر روی صف (queue) قرار می‌گیره، بنابراین حتما باید success call back url و fail call back url در Request ارسالی وجود داشته باشد.

10. تفاوت نسخه‌های 3 و 4 ای پی آی تیپاکس در چیست؟

نسخهٔ v3 به‌صورت همزمان (Sync) عمل می‌کند؛ یعنی سرور تمامی عملیات مربوط به هر سفارش — ثبت سفارش، پردازش، ثبت قرارداد و غیره — را به‌صورت هم‌زمان انجام می‌دهد و بر اساس داده‌های ارسالی هر سفارش تک‌فقره حدود ۱ تا ۱/۵ ثانیه زمان می‌برد. در ثبت سفارش در v3، در صورتی که توکن معتبر داشته باشید از مرحلهٔ ثبت دچار بلاک نخواهید شد، اما ماهیت synchronous این نسخه باعث می‌شود که در صورت افزایش هم‌زمانی درخواست‌ها، بار پردازشی تجمع یافته افزایش یابد. در مقابل، v4 به‌صورت مبتنی بر رویداد (event-driven) و با صف‌گذاری (queue) پیاده‌سازی شده است؛ در Request ارسالی وجود success callback url و fail callback url الزامی است و این نسخه مناسب مشتریانی است که قابلیت ثبت Web Hook دارند و نیاز به پرفورمنس بالا و مکانیزم Retry دارند. با توجه به این ویژگی‌ها، اگر الگوی ترافیک شما لحظه‌ای و پرترافیک باشد (مثال مطرح‌شده: لحظه‌ای ۱۰۰۰ درخواست)، پیشنهاد صریح استفاده از v4 است؛ چون v3 تمام مراحل را هم‌زمان انجام می‌دهد و برای بارهای Burst بزرگ مناسب‌ترین انتخاب نیست. در صورتی که بخواهید از v3 استفاده کنید و انتظار هم‌زمانی بالا دارید، حتماً استرس‌تست انجام دهید تا رفتار سرویس و زیرساخت شما در شرایط اوج مشخص شود. لازم به ذکر است که در داده‌های ارسالی تعداد دقیق درخواست‌هایی که روی v3 تجربه یا تست شده‌اند ذکر نشده و همچنین جزئیات سیاست‌های Retry و پارامترهای صف در v4 در داده‌ها موجود نیست؛ درخواست برگزاری یک جلسهٔ end-to-end در هفتهٔ آینده برای ثبت سفارش و مستندسازی مطرح شده است ولی زمان و کانال جلسه در داده‌های ارسالی تعیین نشده است.

نمونه جیسون‌های ثبت سفارش

1. نمونه بادی ثبت سفارش با OmOrder

{"packages": [ { "origin": { "cityId": 1677, "fullAddress": "آدرس فرستنده پلاک23", "latitude": 34.64556632, "longitude": 50.87211113, "beneficiary": { "fullName": "امیر", "mobile": "09123437287" } }, "destination": { "cityId": 1022, "fullAddress": "آدرس گیرنده پلاک 444", "latitude": 37.78039158, "longitude": 45.90133144, "beneficiary": { "fullName": "امیرعلی", "mobile": "09335669233" } }, "weight": 1, "packageValue": 10000000, "length": 1, "width": 1, "height": 1, "packageContentId": 9, "packType": 20, "serviceId": 4, "paymentType": 20, "pickupType": 10, "distributionType": 10 } ] }

2. نمونه بادی ثبت سفارش با RegisterOrderWithAddress

{ "packages": [ { "originId": 29570365, "destinationId":70031520, "receiver": { "phone": "02191031648", "fullName": "محمدرضا", "mobile": "09981082048" }, "isUnsual": false, "weight": 11, "packageValue": 20000, "length": 35, "width": 25, "height": 10, "packingId": 49, "packageContentId": 17, "packType": 20, "serviceId": 2, "paymentType": 20, "pickupType": 20, "distributionType": 10, "cashAmount": 12345, "barcode": "1234", "traceCode": "12433543543543" } ] }

3. نمونه بادی ثبت سفارش با WithPreDefinedOrigin

{ "packages": [ { "originId": 29570365, "destination": { "cityId": 1229, "fullAddress": "تهران", "postalCode": "7445175616", "beneficiary": { "phone": "02191031648", "fullName": "محمدرضا", "mobile": "09981082048" } }, "receiver": { "phone": "02191031648", "fullName": "محمدرضا", "mobile": "09981082048" }, "isUnsual": false, "weight": 11, "packageValue": 20000, "length": 35, "width": 25, "height": 10, "packingId": 49, "packageContentId": 17, "packType": 20, "serviceId": 2, "paymentType": 20, "pickupType": 20, "distributionType": 10, "cashAmount": 12345, "barcode": "1234", "traceCode": "12433543543543" } ] }

4. نمونه بادی ثبت سفارش با WithClientAndAddress

{ "packages": [ { "senderClientId": 23570, "receiverClientId": 23570, "senderAddressId": 71483937, "receiverAddressId": 71483937, "weight": 2, "packageValue": 25000000, "length": 20, "width": 20, "height": 20, "packingId": 5, "packageContentId": 9, "packType": 20, "description": "تست", "serviceId": 4, "enableLabelPrivacy": true, "paymentType": 10, "pickupType": 10, "distributionType": 10, "cod": 0, "cashAmount": 0 } ] }

5. نمونه بادی افزودن آدرس برای مشتری جاری (آدرس کسب و کار)

{ "title": "آدرس تست با API", "cityId": 1262, "districtId": 0, "mainStreet1": "بزرگراه امام رضا", "sideStreet1": "خیابان پدافند هوایی", "mainAlley1": "شهید حاج بابایی", "sideAlley1": "", "otherAddress": "شهرک خاورشهر، پلاک 100، واحد 1", "latitude": "35.705586", "longitude": "51.459393", "postalCode": "1234567890", "unit": "1", "floor": "1", "no": "100", "isDefault": false }

6. نمونه بادی افزودن بسته جدید به لیست بسته‌های مشتری

{ "title": "بسته تست با API", "length": 20, "width": 20, "height": 15, "packageValue": 800000000, "weight": 4, "packType": 20, "packageContentId": 9, "packingId": 4, "isUnusual": false }