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

سامانه اطلاع‌رسانی تجارت هوشمند تیپاکس

راهنمای جامع مستندات و سامانه‌های تجارت هوشمند تیپاکس. برای مشاهده مستندات هر نسخه، روی کارت مورد نظر کلیک کنید — تمام جزئیات و جداول آن نسخه در یک صفحه نمایش داده می‌شود.

Latest

مستندات API V4

جدیدترین نسخه API تیپاکس با ۷۶ اندپوینت در ۱۷ گروه. شامل ۶ روش ثبت سفارش، Device Register، Return Order و Pickup مرسوله.

۷۶ اندپوینت
۱۷ گروه
۱۴۵ Schema
Stable

مستندات API V3

نسخه پایدار قبلی با ۱۰۵ اندپوینت در ۲۳ گروه. شامل باکس لاین (Box Line)، لاکر، Webhook، تیکتینگ و تراکنش‌های مالی.

۱۰۵ اندپوینت
۲۳ گروه
۱۹۸ Schema
به‌زودی

سامانه قبول

سامانه ویژه شعب و نمایندگی‌های تیپاکس برای قبول، ثبت و تحویل مرسولات در سطح محلی. مستندات به‌زودی.

— اندپوینت
— گروه
— Schema

راهنماها و آموزش‌ها

ای‌تیپاکس

پلتفرم فروش سازمانی

ربات بله

ثبت سفارش از پیام‌رسان بله

پلاگین وردپرس

اتصال ووکامرس به تیپاکس

مای‌تیپاکس

اپلیکیشن موبایل

جدیدترین نسخه API تیپاکس • بر اساس OpenAPI 3.0.1 رسمی

مستندات API نسخه ۴ (V4)

جدیدترین و پیشرفته‌ترین نسخه API تیپاکس با ۷۶ اندپوینت در ۱۷ گروه. تمام جزئیات و جداول این نسخه در همین صفحه نمایش داده شده است. برای دسترسی سریع به هر گروه، از لینک‌های زیر استفاده کنید یا صفحه را اسکرول کنید.

Base URL (پروداکشن)omapi.tipax.ir
Base URL (تست)omtestapi.tipax.ir
تعداد اندپوینت۷۶
Document UI V4 Swagger V4

۶ روش ثبت سفارش

OmOrder، DeviceRegister، ReturnRegister و...

Pickup مرسوله

جمع‌آوری با PickupParcelWithUpdateBarcode

Device Register

ثبت سفارش از دستگاه با creatorBranchId

Return Order

ثبت مرجوعی با OmV4ReturnOrderRegister

Locker (V4)

جستجوی کیوسک با lat/lon/cityId

Webhook اختصاصی

successCallbackUrl + failureCallbackUrl

احراز هویت در V4

۱
ثبت‌نام در https://etipaxco.com/register و ورود به https://etipaxco.com/login
۲
دریافت apiKey از پروفایل کسب‌وکار در پنل
۳
ارسال POST به https://igtgatewayapi.tipax.ir/Token با username، password، "grant_type": "password" //این بخش را بدون تغییر بگذارید
۴
ارسال هدر Authorization: Bearer YOUR_ACCESS_TOKEN در تمام درخواست‌ها
دسترسی سریع به ۱۷ گروه:
احراز هویت مدیریت مشتری مدیریت آدرس ثبت سفارش مرسولات بسته‌های مشتری وضعیت مرسولات محاسبه هزینه انواع پرداخت بسته‌بندی رهگیری لاکر مالی تیکتینگ شهرها استان‌ها ویرایش مشتری حقیقی

جزئیات و جداول API V4 (۱۷ گروه، ۷۶ اندپوینت)

احراز هویت 1 اندپوینت

ورود و توکن — گروه Account

اندپوینت‌های این گروه

1 اندپوینت
POST
/api/OM/v4/Account/RefreshToken
ورود
RefreshTokenDto | AccessTokenApiResult
پایدار

نمونه درخواست — احراز هویت

POST /api/OM/v4/Account/RefreshToken

RefreshTokenDto.json

مدیریت مشتری 18 اندپوینت

مشتری، کیف پول، شعب — گروه Customers

اندپوینت‌های این گروه

18 اندپوینت
POST
/api/OM/v4/Customers/GetCustomers
OmCustomerBriefListDtoListApiResult
جدید
GET
/api/OM/v4/Customers
دریافت مشتری جاری
OmCustomerListDto
پایدار
GET
/api/OM/v4/Customers/Credit
دریافت اعتبار مشتری
پایدار
GET
/api/OM/v4/Customers/Wallet
دریافت موجودی کیف پول
پایدار
POST
/api/OM/v4/Customers/RechargeWallet
شارژ کیف پول
OmPaymentUrlCuDto | OmPaymentUrlListDto
پایدار
GET
/api/OM/v4/Customers/Remain
دریافت مانده حساب
پایدار
GET
/api/OM/v4/Customers/mycustomers/{id}
دریافت مشتری من
OmClientListDto
پایدار
GET
/api/OM/v4/Customers/mycustomers
دریافت لیست مشتریان من
OmClientsListDtoOmBaseListDto
پایدار
GET
/api/OM/v4/Customers/mySubstations
دریافت لیست شعب من
CustomerSubstationListDtoOmBaseListDto
پایدار
POST
/api/OM/v4/Customers/CreateMySubstation
افزودن به لیست شعب من
CustomerSubstationCuDto
پایدار
POST
/api/OM/v4/Customers/DisableMySubstation
غیرفعال کردن شعبه من
پایدار
POST
/api/OM/v4/Customers/EnableMySubstation
فعال کردن شعبه من
پایدار
POST
/api/OM/v4/Customers/RegisterForPanel
SSORegisterWithEmailAndNoPeopleRequest | SSORegisterResponseForPanelApiResult
پایدار
GET
/api/OM/v4/Customers/GetMyCustomers/{substationCode}
گرفتن لیست مشتری های شعبه ی من
OmMyCustomerListDtoListApiResult
پایدار
POST
/api/OM/v4/Customers/ApprovePhoneNumber
SSOUpdateRequest | SSORegisterResponseForPanelApiResult
پایدار
POST
/api/OM/v4/Customers/ValidateUserForPanel
SSOUserValidationDto | SSOTokenApiResult
پایدار
POST
/api/OM/v4/Customers/ApprovePhoneNumberCode
SSOUserValidationDto | AccessTokenApiResult
پایدار
POST
/api/OM/v4/Customers/ResendSMSForApprovePhoneNumber
UserIdDto | ApiResult
پایدار

نمونه درخواست — مدیریت مشتری

POST /api/OM/v4/Customers/RechargeWallet

OmPaymentUrlCuDto.json

مدیریت آدرس 5 اندپوینت

آدرس کسب‌وکار و دفترچه — گروه Addresses

اندپوینت‌های این گروه

5 اندپوینت
POST
/api/OM/v4/Addresses
افزودن آدرس برای مشتری جاری (آدرس کسب و کار)
OmAddressCuDto | PeopleAddressesListDto
پایدار
GET
/api/OM/v4/Addresses
دریافت لیست آدرس های کاربر(آدرس های کسب و کار)
پایدار
POST
/api/OM/v4/Addresses/Book
افزودن آدرس به دفترچه آدرس
PeopleAddressCuDto | PeopleAddressesListDto
پایدار
GET
/api/OM/v4/Addresses/Book
دریافت دفترچه آدرس کاربر
پایدار
GET
/api/OM/v4/Addresses/{id}
در یافت آدرس با کد آدرس
PeopleAddressesListDto
پایدار

نمونه درخواست — مدیریت آدرس

POST /api/OM/v4/Addresses

OmAddressCuDto.json

POST /api/OM/v4/Addresses/Book

PeopleAddressCuDto.json

ثبت سفارش 6 اندپوینت

۶ روش ثبت سفارش — گروه OmOrder

اندپوینت‌های این گروه

6 اندپوینت
POST
/api/OM/v4/OmOrder
OmV4OrderRegisterCuDto | OmV4OrderListDto
پایدار
POST
/api/OM/v4/OmOrder/RegisterOrderWithAddress
ثبت سفارش با آدرس مبدا و مقصد از پیش ساخته شده
OmV4OrderWithAddressCuDto | OmV4OrderListDto
پایدار
POST
/api/OM/v4/OmOrder/WithPreDefinedOrigin
ثبت سفارش با مبدأ از پیش تعریف شده
OmV4OrderWithOriginAddressCuDto | OmV4OrderListDto
پایدار
POST
/api/OM/v4/OmOrder/WithClientAndAddress
ثبت سفارش با آدرس مبدا و مقصد
OmV4OrderWithClientAndAddressCuDto | OmV4OrderListDto
V4
POST
/api/OM/v4/OmOrder/DeviceRegisterOrder
OmV4DeviceOrderRegister | OmV4OrderListDto
Device
POST
/api/OM/v4/OmOrder/ReturnRegisterOrder
OmV4ReturnOrderRegister | OmV4OrderListDto
Return

نمونه درخواست — ثبت سفارش

POST /api/OM/v4/OmOrder

OmV4OrderRegisterCuDto.json 


{
  "packages": [
    {
      "origin": {
        "cityId": 1677,
        "fullAddress": "آدرس فرستنده پلاک23",
        "latitude": 34.64556632,
        "longitude": 50.87211113,
        "beneficiary": {
          "fullName": "امیر",
          "mobile": "09121234567",
          "floor": "2",
          "unit": "4",
          "postalCode": "1234567891",
                  "description": "test",
        }
      },
      "destination": {
        "cityId": 1262,
        "fullAddress": "آدرس گیرنده پلاک 444",
        "latitude": 37.78039158,
        "longitude": 45.90133144,
                "floor": "12",
        "unit": "32",
        "postalCode": "8529637410",
        "beneficiary": {
          "fullName": "امیرعلی",
          "mobile": "09331234567"
        }
      },
      "customParcelTitle": "TEST",
      "weight": 1,
      "packageValue": 10000000,
      "length": 30,
      "width": 40,
      "height": 45,
      "packageContentId": 9,
      "packingId": 10,
      "packType": 20,
      "serviceId": 4,
      "paymentType": 20,
      "pickupType": 10,
      "distributionType": 10,
      "cod": 0,
      "cashAmount": 0,

    }
  ],
  "traceCode": "MP11101492",
  "secondaryTraceCode": "MP85214798910",
  "discountCode": null,
  "successCallbackUrl": "",
  "failureCallbackUrl": ""
}

POST /api/OM/v4/OmOrder/RegisterOrderWithAddress

OmV4OrderWithAddressCuDto.json 

{
  "packages": [
    {
      "originId": 29570365,
      "destinationId":70031520,
        "receiver": {
            "phone": "02191031648",
            "fullName": "محمدرضا",
            "mobile": "09981112223"
      },
      "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"
    }
  ]
}

POST /api/OM/v4/OmOrder/WithPreDefinedOrigin

OmV4WithPreDefinedOrigin.json 

{
  "packages": [
    {
      "originId": 29570365,
      "destination": {
        "cityId": 1022,
        "fullAddress": "آدرس گیرنده پلاک 444",
        "latitude": 37.78039158,
        "longitude": 45.90133144,
        "postalCode": "8529637410",
        "beneficiary": {
          "fullName": "امیرعلی",
          "mobile": "09331234567"
        }
      },
      "customParcelTitle": "TEST",
      "weight": 1,
      "packageValue": 10000000,
      "length": 1,
      "width": 1,
      "height": 1,
      "packageContentId": 9,
      "packType": 20,
      "serviceId": 4,
      "paymentType": 20,
      "pickupType": 10,
      "distributionType": 10,
      "cod": 0,
      "cashAmount": 0
    }
  ],
  "traceCode": "MP1111492",
  "secondaryTraceCode": "MP852147878780",
  "discountCode": null
}

POST /api/OM/v4/OmOrder/ReturnRegisterOrder

OmV4ReturnOrderRegister.json

مرسولات 10 اندپوینت

Pickup، ابطال، مبلغ — گروه Parcels

اندپوینت‌های این گروه

10 اندپوینت
POST
/api/OM/v4/Parcels/GetReadyForPickupList
ParcelListDtoListApiResult
Pickup
POST
/api/OM/v4/Parcels/PickupParcelWithUpdateBarcode
AcceptParcelForPickup | ApiResult
Pickup
GET
/api/OM/v4/Parcels/GetByOrderId/{orderId}
دریافت لیست مرسوله ها بر اساس شماره سفارش
OmParcelDtoOmBaseListDto
پایدار
GET
/api/OM/v4/Parcels/PaymentType/{trackingCode}
نوع پرداخت
پایدار
PUT
/api/OM/v4/Parcels/Cancel/{trackingCode}
ابطال مرسوله
پایدار
GET
/api/OM/v4/Parcels/GetAmountByTrackingCode/{trackingCode}
دریافت مبلغ مرسوله با کد رهگیری ای تیپاکس
OmOrderCostBriefListDto
پایدار
POST
/api/OM/v4/Parcels/GetSumTotalAmountByTrackingCodes
دریافت جمع هزینه ی مرسوله ها(تومان)
پایدار
GET
/api/OM/v4/Parcels/GetAmountByContractCode/{contractCode}
دریافت مبلغ مرسوله با کد قرارداد جت
OmOrderCostBriefListDto
پایدار
GET
/api/OM/v4/Parcels/GetPriceDetailByTrackingCode/{trackingCode}
دریافت جزییات مبلغ مرسوله با کد کد رهگیری ای تیپاکس
OmOrderCostListDto
پایدار
GET
/api/OM/v4/Parcels/GetPriceDetailByContractCode/{contractCode}
دریافت جزییات مبلغ مرسوله با کد قرارداد جت
OmOrderCostListDto
پایدار

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

POST /api/OM/v4/Parcels/PickupParcelWithUpdateBarcode

AcceptParcelForPickup.json

بسته‌های مشتری 2 اندپوینت

دفترچه بسته — گروه ParcelBooks

اندپوینت‌های این گروه

2 اندپوینت
GET
/api/OM/v4/ParcelBooks
دریافت لیست بسته های تعریف شده مشتری
OmCustomerPackageResponseOmBaseListDto
پایدار
POST
/api/OM/v4/ParcelBooks
افزودن بسته جدید به لیست بسته های مشتری
OmCreateCustomerPackageRequest | OmCreateCustomerPackageResponse
پایدار

وضعیت مرسولات 2 اندپوینت

وضعیت و رویداد — گروه ParcelStatus

اندپوینت‌های این گروه

2 اندپوینت
GET
/api/OM/v4/ParcelStatus
لیست وضعیت ها
OmParcelStatusListDtoListApiResult
پایدار
GET
/api/OM/v4/ParcelStatus/GetEventWithStatus
لیست رویداد ها
ParcelEventTypeListDtoListApiResult
پایدار

محاسبه هزینه 5 اندپوینت

قیمت و سرویس — گروه Pricing

اندپوینت‌های این گروه

5 اندپوینت
POST
/api/OM/v4/Pricing
دریافت قیمت
OmPriceDto
پایدار
POST
/api/OM/v4/Pricing/WithAddressId
دریافت قیمت (با آی دی آدرس های تعریف شده)
OmPriceWithAddressDto
پایدار
POST
/api/OM/v4/Pricing/WithOriginAddressId
دریافت قیمت (با آی دی آدرس مبدا از تعریف شده)
OmPriceWithOriginAddressDto
پایدار
POST
/api/OM/v4/Pricing/GetServicesBetweenCities
دریافت لیست سرویس های بین دو شهر
OmGetServicesBetweenCitiesDto | JetServicesBetweenCitiesListDtoApiResult
پایدار
POST
/api/OM/v4/Pricing/GetServicesList
لیست سرویس ها
OmServiceListDtoListApiResult
جدید

نمونه درخواست — محاسبه هزینه

POST /api/OM/v4/Pricing

OmPriceDto.json

POST /api/OM/v4/Pricing/GetServicesBetweenCities

OmGetServicesBetweenCitiesDto.json

انواع پرداخت 2 اندپوینت

پرداخت‌ها — گروه PaymentType

اندپوینت‌های این گروه

2 اندپوینت
POST
/api/OM/v4/PaymentType/Search
دریافت لیست نوع پرداخت ها
PaymentTypeSearchDto
پایدار
GET
/api/OM/v4/PaymentType/Get
دریافت پرداخت ها با id
PaymentTypeListDto
پایدار

بسته‌بندی 3 اندپوینت

نوع بسته و محتوا — گروه PackingType

اندپوینت‌های این گروه

3 اندپوینت
GET
/api/OM/v4/PackingType/GetPackTypes
دریافت نوع بسته
PublicPackagingGroupListDtoListApiResult
پایدار
GET
/api/OM/v4/PackingType/GetPackingTypes
دریافت بسته بندی ها
OmPackagingTypeResponseOmBaseListDto
پایدار
GET
/api/OM/v4/PackingType/GetPackagingContents
دریافت لیست محتوا
OmPackagingContentResponseOmBaseListDto
پایدار

رهگیری 6 اندپوینت

پیگیری مرسوله — گروه Tracking

اندپوینت‌های این گروه

6 اندپوینت
GET
/api/OM/v4/Tracking/BriefTracking/{trackingInput}
پیگیری مرسوله
JetTrackingBriefListDto
پایدار
GET
/api/OM/v4/Tracking/ByContractCode/{contractCode}
پیگیری مرسوله با کد قرارداد جت
پایدار
GET
/api/OM/v4/Tracking/{orderId}
پیگیری با کد سفارش
پایدار
POST
/api/OM/v4/Tracking/ByTrackingCode
پیگیری چند مرسوله با کد رهگیری
پایدار
POST
/api/OM/v4/Tracking/{traceCode}
پیگیری با کد رهگیری مشتری
پایدار
POST
/api/OM/v4/Tracking/BySecondaryTraceCode/{secondaryTraceCode}
پیگیری با کد رهگیری ثانویه مشتری
پایدار

لاکر 2 اندپوینت

کیوسک و بانچ — گروه Locker

اندپوینت‌های این گروه

2 اندپوینت
POST
/api/v4/Locker/SearchKiosks
جست و جوی کیوسک ها بر اساس مختصات جغرافیایی یا کد شهر -- همراه با فیلتر ابعاد لاکر ها
LockerSearchDto | KiosksListDtoApiResult
Locker
POST
/api/v4/Locker/SearchBunches
جست و جوی بانچ ها بر اساس مختصات جغرافیایی یا کد شهر -- همراه با فیلتر ابعاد لاکر ها
LockerSearchDto | BunchesListDtoApiResult
Locker

نمونه درخواست — لاکر

POST /api/v4/Locker/SearchKiosks

LockerSearchDto.json

مالی 3 اندپوینت

تراکنش — گروه Financial

اندپوینت‌های این گروه

3 اندپوینت
GET
/api/OM/v4/Financial/GetDocuments
دریافت حداکثر 100 تراکنش آخر
پایدار
GET
/api/OM/v4/Financial/GetDocumentsByYear
دریافت تراکنش ها بر اساس سال مالی
پایدار
GET
/api/OM/v4/Financial/GetDocumentById
دریافت جزییات تراکنش مالی
OmVoucherListDto
پایدار

تیکتینگ 6 اندپوینت

تیکت و پاسخ — گروه Ticketing

اندپوینت‌های این گروه

6 اندپوینت
GET
/api/OM/v4/Ticketing
لیست تیکت ها
OmTicketListDtoOmBaseListDto
پایدار
POST
/api/OM/v4/Ticketing
ثبت تیکت
OmTicketCuDto
پایدار
POST
/api/OM/v4/Ticketing/Answer
ثبت پاسخ تیکت
OmTicketResponseCuDto
پایدار
GET
/api/OM/v4/Ticketing/{id}
دریافت جزییات با شماره تیکت
OmGetTicketByIdDto
پایدار
GET
/api/OM/v4/Ticketing/GetByOrderId/{orderId}
دریافت تیکت های مرتبط با یک سفارش
OmGetTicketByIdDto
پایدار
GET
/api/OM/v4/Ticketing/GetDepartments
دریافت لیست دپارتمان ها
OmTicketCategoryListDtoOmBaseListDto
پایدار

نمونه درخواست — تیکتینگ

POST /api/OM/v4/Ticketing

OmTicketCuDto.json

شهرها 3 اندپوینت

لیست شهرها — گروه Cities

اندپوینت‌های این گروه

3 اندپوینت
GET
/api/OM/v4/Cities
دریافت لیست شهرها
پایدار
GET
/api/OM/v4/Cities/plusstate
دریافت لیست شهرها به همراه نام استان
پایدار
GET
/api/OM/v4/Cities/BranchCities
دریافت لیست شهرهای دارای نمایندگی فعال
پایدار

استان‌ها 1 اندپوینت

استان‌های ایران — گروه States

اندپوینت‌های این گروه

1 اندپوینت
GET
/api/OM/v4/States
دریافت لیست استان های ایران
پایدار

ویرایش مشتری حقیقی 1 اندپوینت

مشتری حقیقی — گروه ActualCustomers

اندپوینت‌های این گروه

1 اندپوینت
PUT
/api/OM/v4/customers/actual
ویرایش مشتری حقیقی
OmUpdateActualCustomerDto
پایدار

نمونه درخواست — ویرایش مشتری حقیقی

PUT /api/OM/v4/customers/actual

OmUpdateActualCustomerDto.json
نسخه پایدار قبلی (Stable) • بر اساس OpenAPI 3.0.1 رسمی

مستندات API نسخه ۳ (V3)

نسخه سوم API تیپاکس با ۱۰۵ اندپوینت در ۲۳ گروه، شامل باکس لاین (Box Line)، لاکر، Webhook، تیکتینگ، تراکنش‌های مالی و سرویس‌های اکوپک. تمام جزئیات و جداول این نسخه در همین صفحه نمایش داده شده است.

Base URL (پروداکشن)omapi.tipax.ir
Base URL (تست)omtestapi.tipax.ir
تعداد اندپوینت۱۰۵
Document UI V3 Swagger V3

سه روش ورود

token، tokenwithphonenumber، RefreshToken

باکس لاین (Box Line)

۵ اندپوینت مجزا (Booking)

لاکر

جستجوی کیوسک و بانچ

Webhook رویداد

مدیریت کال‌بک سفارش

مالی و تراکنش

۱۰۰ تراکنش آخر و جزئیات سند

تیکتینگ

ثبت و پاسخ تیکت

احراز هویت در V3

۱
ثبت‌نام در https://etipaxco.com/register و ورود به https://etipaxco.com/login
۲
دریافت apiKey از پروفایل کسب‌وکار در پنل
۳
ارسال POST به https://omapi.tipax.ir/api/OM/v3/Account/token با username، password، apiKey
۴
ارسال هدر Authorization: Bearer YOUR_ACCESS_TOKEN در تمام درخواست‌ها
دسترسی سریع به ۲۳ گروه:
احراز هویت مدیریت مشتری ویرایش مشتری مدیریت آدرس ثبت سفارش باکس لاین مرسولات بسته‌های مشتری وضعیت مرسولات نوع مرسوله محاسبه هزینه انواع پرداخت بسته‌بندی محتوای بسته رهگیری لاکر Webhook تاریخچه Webhook مالی تیکتینگ زمان‌بندی شهرها استان‌ها

جزئیات و جداول API V3 (۲۳ گروه، ۱۰۵ اندپوینت)

احراز هویت 3 اندپوینت

ورود و توکن — گروه Account

اندپوینت‌های این گروه

3 اندپوینت
POST
/api/OM/v3/Account/token
ورود
LoginRequest | LoginResponse
پایدار
POST
/api/OM/v3/Account/tokenwithphonenumber
LoginRequestWithPhoneNumber | LoginResponse
پایدار
POST
/api/OM/v3/Account/RefreshToken
دریافت توکن بروزرسانی
RefreshTokenDto | AccessTokenApiResult
پایدار

نمونه درخواست — احراز هویت

POST /api/OM/v3/Account/token

LoginRequest.json

POST /api/OM/v3/Account/RefreshToken

RefreshTokenDto.json

POST /api/OM/v3/Account/token → Response

LoginResponse.json

مدیریت مشتری 20 اندپوینت

مشتری، اعتبار، شعب — گروه Customers

اندپوینت‌های این گروه

20 اندپوینت
GET
/api/OM/v3/Customers
دریافت مشتری جاری
OmCustomerListDto
پایدار
GET
/api/OM/v3/Customers/Credit
دریافت اعتبار مشتری
پایدار
GET
/api/OM/v3/Customers/Wallet
دریافت موجودی کیف پول
پایدار
POST
/api/OM/v3/Customers/RechargeWallet
شارژ کیف پول
OmPaymentUrlCuDto | OmPaymentUrlListDto
پایدار
GET
/api/OM/v3/Customers/Remain
دریافت مانده حساب
پایدار
GET
/api/OM/v3/Customers/mycustomers/{id}
دریافت مشتری من
OmClientListDto
پایدار
GET
/api/OM/v3/Customers/myproducts
دریافت لیست محصولات من
CustomerProductListDtoOmBaseListDto
پایدار
GET
/api/OM/v3/Customers/mycustomers
دریافت لیست مشتریان من
OmClientsListDtoOmBaseListDto
پایدار
GET
/api/OM/v3/Customers/mySubstations
دریافت لیست شعب من
CustomerSubstationListDtoOmBaseListDto
پایدار
POST
/api/OM/v3/Customers/CreateMySubstation
افزودن به لیست شعب من
CustomerSubstationCuDto
پایدار
POST
/api/OM/v3/Customers/DisableMySubstation
غیرفعال کردن شعبه من
پایدار
POST
/api/OM/v3/Customers/EnableMySubstation
فعال کردن شعبه من
پایدار
GET
/api/OM/v3/Customers/{customerId}/GetCustomerCreatedByCustomer
CustomerListDtoListApiResult
پایدار
GET
/api/OM/v3/Customers/{substationId}/GetCustomersOfSubstation
CustomerListDtoListApiResult
پایدار
POST
/api/OM/v3/Customers/RegisterForPanel
SSORegisterWithEmailAndNoPeopleRequest | SSORegisterResponseForPanelApiResult
پایدار
GET
/api/OM/v3/Customers/GetMyCustomers/{substationCode}
گرفتن لیست مشتری های شعبه ی من
OmMyCustomerListDtoListApiResult
پایدار
POST
/api/OM/v3/Customers/ApprovePhoneNumber
SSOUpdateRequest | SSORegisterResponseForPanelApiResult
پایدار
POST
/api/OM/v3/Customers/ValidateUserForPanel
SSOUserValidationDto | SSOTokenApiResult
پایدار
POST
/api/OM/v3/Customers/ApprovePhoneNumberCode
SSOUserValidationDto | AccessTokenApiResult
پایدار
POST
/api/OM/v3/Customers/ResendSMSForApprovePhoneNumber
UserIdDto | ApiResult
پایدار

ویرایش مشتری 1 اندپوینت

مشتری حقیقی — گروه ActualCustomers

اندپوینت‌های این گروه

1 اندپوینت
PUT
/api/OM/v3/customers/actual
ویرایش مشتری حقیقی
OmUpdateActualCustomerDto
پایدار

مدیریت آدرس 6 اندپوینت

آدرس و پلیگون — گروه Addresses

اندپوینت‌های این گروه

6 اندپوینت
POST
/api/OM/v3/Addresses
افزودن آدرس برای مشتری جاری (آدرس کسب و کار)
OmAddressCuDto | PeopleAddressesListDto
پایدار
GET
/api/OM/v3/Addresses
دریافت لیست آدرس های کاربر(آدرس های کسب و کار)
پایدار
POST
/api/OM/v3/Addresses/Book
افزودن آدرس به دفترچه آدرس
PeopleAddressCuDto | PeopleAddressesListDto
پایدار
GET
/api/OM/v3/Addresses/Book
دریافت دفترچه آدرس کاربر
پایدار
GET
/api/OM/v3/Addresses/{id}
در یافت آدرس با کد آدرس
PeopleAddressesListDto
پایدار
GET
/api/OM/v3/Addresses/GetBranchPolygonByPoint
دریافت نزدیکترین پلیگون نمایندگی براساس مختصات طول و عرض جغرافیایی
GisBranchListDtoApiResult
پایدار

نمونه درخواست — مدیریت آدرس

POST /api/OM/v3/Addresses

OmAddressCuDto.json

ثبت سفارش 16 اندپوینت

۱۶ روش ثبت سفارش — گروه Orders

اندپوینت‌های این گروه

16 اندپوینت
POST
/api/OM/v3/Orders
ثبت سفارش
OmOrderCuDto | OmOrderListDto
پایدار
POST
/api/OM/v3/Orders/OrderForAnotherCustomer
ثبت سفارش توسط مشتری برای یک مشتری دیگر
OmOrderCuByAnotherCustomerDto | OmOrderListDto
پایدار
POST
/api/OM/v3/Orders/GroupOrder
ثبت سفارش گروهی (اکسل)
OmOrderCuDto | OmOrderListDto
گروهی
POST
/api/OM/v3/Orders/WithPreDefinedAddresses
ثبت سفارش با آدرس های از پیش تعریف شده
OmOrderWithAddressCuDto | OmOrderListDto
پایدار
POST
/api/OM/v3/Orders/WithPreDefinedOrigin
ثبت سفارش با مبدأ از پیش تعریف شده
OmOrderWithOriginAddressCuDto | OmOrderListDto
پایدار
POST
/api/OM/v3/Orders/PluginOrder
ثبت سفارش از طریق پلاگین
OmOrderWithOriginAddressCuDto | OmOrderListDto
پایدار
POST
/api/OM/v3/Orders/WithCoordinates
ثبت سفارش با مختصات جغرافیایی
OmOrderWithLocationCuDto | OmOrderListDto
پایدار
POST
/api/OM/v3/Orders/WithDiscount
ثبت سفارش با استفاده از کد تخفیف
OmOrderCuDto | OmOrderListDto
پایدار
GET
/api/OM/v3/Orders/GetOrderAmountByOrderId/{orderId}
دریافت مبلغ سفارش
پایدار
POST
/api/OM/v3/Orders/GetSumTotalAmountByOrderIds
دریافت جمع هزینه ی سفارش ها(تومان)
پایدار
POST
/api/OM/v3/Orders/MyTipaxOrder
ثبت سفارش مای تیپاکس
MyTipaxOrderRegisterCuDto | OmOrderListDtoApiResult
پایدار
POST
/api/OM/v3/Orders/CancelOrder/{orderId}
ابطال سفارش
OmInvalidatedBarcodesListDtoApiResult
پایدار
POST
/api/OM/v3/Orders/PreOrder
ثبت پیش سفارش
OmPreOrderCuDto | OmOrderListDto
جدید
POST
/api/OM/v3/Orders/CancelOrderByCode/{secondaryTraceCode}
ابطال سفارش با کد ثانویه سفارش
OmInvalidatedBarcodesListDtoApiResult
پایدار
POST
/api/OM/v3/Orders/QueueOrder
ثبت سفارش در صف
OmQueueOrderCuDto | OmQueuedOrderListDtoApiResult
جدید
POST
/api/OM/v3/Orders/BulkQueueOrder
ثبت سفارش در صف به صورت گروهی
OmBulkQueueOrderCuDto | OmBulkQueuedOrderListDtoApiResult
گروهی

نمونه درخواست — ثبت سفارش

POST /api/OM/v3/Orders

OmOrderCuDto.json

POST /api/OM/v3/Orders/WithPreDefinedAddresses

OmOrderWithAddressCuDto.json

باکس لاین (LTL) 5 اندپوینت

ثبت باکس لاین — گروه Booking

اندپوینت‌های این گروه

5 اندپوینت
POST
/api/OM/v3/Booking/Register
ثبت سفارش جدید از نوع باکس لاین (Box Line) در سامانه
BookingCuDto | BookingListDtoApiResult
Box Line
POST
/api/OM/v3/Booking/Search
جستجوی سفارش‌های باکس لاین با استفاده از فیلترهای اختیاری
BookingV3SearchDto | BookingListDtoIPagedListApiResult
Box Line
POST
/api/OM/v3/Booking/GetWorkingDates
دریافت لیست تاریخ‌های کاری (ساعات مجاز جمع‌آوری یا تحویل) بر اساس آدرس، تاریخ شروع و مهلت زمانی
GetWorkingDatesDto | BookingWorkingDateListDtoListApiResult
Box Line
POST
/api/OM/v3/Booking/Cancel
ابطال سفارش باکس لاین توسط مشتری
BookingStatusUpdateDto | BookingListDtoApiResult
Box Line
POST
/api/OM/v3/Booking/UpdateByCustomer/{bookingId}
ویرایش سفارش باکس لاین توسط مشتری
BookingUpdateDto | BookingListDtoApiResult
Box Line

نمونه درخواست — باکس لاین

POST /api/OM/v3/Booking/Register

BookingCuDto.json

مرسولات 9 اندپوینت

جستجو و ابطال — گروه Parcels

اندپوینت‌های این گروه

9 اندپوینت
GET
/api/OM/v3/Parcels/GetByOrderId/{orderId}
دریافت لیست مرسوله ها بر اساس شماره سفارش
OmParcelDtoOmBaseListDto
پایدار
GET
/api/OM/v3/Parcels/PaymentType/{trackingCode}
نوع پرداخت
پایدار
PUT
/api/OM/v3/Parcels/Cancel/{trackingCode}
ابطال مرسوله
پایدار
GET
/api/OM/v3/Parcels/GetAmountByTrackingCode/{trackingCode}
دریافت مبلغ مرسوله با کد رهگیری ای تیپاکس
OmOrderCostBriefListDto
پایدار
POST
/api/OM/v3/Parcels/GetSumTotalAmountByTrackingCodes
دریافت جمع هزینه ی مرسوله ها(تومان)
پایدار
GET
/api/OM/v3/Parcels/GetAmountByContractCode/{contractCode}
دریافت مبلغ مرسوله با کد قرارداد جت
OmOrderCostBriefListDto
پایدار
GET
/api/OM/v3/Parcels/GetPriceDetailByTrackingCode/{trackingCode}
دریافت جزییات مبلغ مرسوله با کد کد رهگیری ای تیپاکس
OmOrderCostListDto
پایدار
GET
/api/OM/v3/Parcels/GetPriceDetailByContractCode/{contractCode}
دریافت جزییات مبلغ مرسوله با کد قرارداد جت
OmOrderCostListDto
پایدار
POST
/api/OM/v3/Parcels/Search
دریافت لیست مرسوله هایی که در دست جمع آوری هستند
ParcelSearchByBranchDto | ParcelListDtoListApiResult
پایدار

بسته‌های مشتری 2 اندپوینت

دفترچه — گروه ParcelBooks

اندپوینت‌های این گروه

2 اندپوینت
GET
/api/OM/v3/ParcelBooks
دریافت لیست بسته های تعریف شده مشتری
OmCustomerPackageResponseOmBaseListDto
پایدار
POST
/api/OM/v3/ParcelBooks
افزودن بسته جدید به لیست بسته های مشتری
OmCreateCustomerPackageRequest | OmCreateCustomerPackageResponse
پایدار

وضعیت مرسولات 2 اندپوینت

وضعیت و رویداد — گروه ParcelStatus

اندپوینت‌های این گروه

2 اندپوینت
GET
/api/OM/v3/ParcelStatus
لیست وضعیت ها
OmParcelStatusListDtoListApiResult
پایدار
GET
/api/OM/v3/ParcelStatus/GetEventWithStatus
لیست رویداد ها
ParcelEventTypeListDtoListApiResult
پایدار

نوع مرسوله 2 اندپوینت

انواع مرسوله — گروه ParcelType

اندپوینت‌های این گروه

2 اندپوینت
POST
/api/OM/v3/ParcelType/Search
دریافت لیست نوع مرسوله ها
ParcelTypeSearchDto
پایدار
GET
/api/OM/v3/ParcelType/Get
دریافت مرسوله ها با id
ParcelTypeListDto
پایدار

محاسبه هزینه 7 اندپوینت

قیمت و سرویس — گروه Pricing

اندپوینت‌های این گروه

7 اندپوینت
POST
/api/OM/v3/Pricing
دریافت قیمت
OmPriceDto
پایدار
POST
/api/OM/v3/Pricing/WithAddressId
دریافت قیمت (با آی دی آدرس های تعریف شده)
OmPriceWithAddressDto
پایدار
POST
/api/OM/v3/Pricing/WithOriginAddressId
دریافت قیمت (با آی دی آدرس مبدا از تعریف شده)
OmPriceWithOriginAddressDto
پایدار
POST
/api/OM/v3/Pricing/GetForAllServices
دریافت قیمت برای تمامی سرویس ها
OmPriceDto
پایدار
POST
/api/OM/v3/Pricing/WithAddressIdForAllServices
دریافت قیمت با آدرس های تعریف شده برای تمامی سرویس ها
OmPriceWithAddressDto
پایدار
POST
/api/OM/v3/Pricing/WithOriginAddressIdForAllServices
دریافت قیمت با آدرس مبدا تعریف شده برای تمامی سرویس ها
OmPriceWithOriginAddressDto
پایدار
POST
/api/OM/v3/Pricing/GetServicesBetweenCities
دریافت لیست سرویس های بین دو شهر
OmGetServicesBetweenCitiesDto | JetServicesBetweenCitiesListDtoApiResult
پایدار

نمونه درخواست — محاسبه هزینه

POST /api/OM/v3/Pricing

OmPriceDto.json

POST /api/OM/v3/Pricing/GetServicesBetweenCities

OmGetServicesBetweenCitiesDto.json

انواع پرداخت 2 اندپوینت

پرداخت — گروه PaymentType

اندپوینت‌های این گروه

2 اندپوینت
POST
/api/OM/v3/PaymentType/Search
دریافت لیست نوع پرداخت ها
PaymentTypeSearchDto
پایدار
GET
/api/OM/v3/PaymentType/Get
دریافت پرداخت ها با id
PaymentTypeListDto
پایدار

بسته‌بندی 1 اندپوینت

بسته‌بندی — گروه PackingPrices

اندپوینت‌های این گروه

1 اندپوینت
GET
/api/OM/v3/PackingPrices
دریافت بسته بندی ها
OmPackagingTypeResponseOmBaseListDto
پایدار

محتوای بسته 1 اندپوینت

محتوا — گروه PackContentRates

اندپوینت‌های این گروه

1 اندپوینت
GET
/api/OM/v3/PackContentRates
دریافت لیست محتوا
OmPackagingContentResponseOmBaseListDto
پایدار

رهگیری 6 اندپوینت

پیگیری — گروه Tracking

اندپوینت‌های این گروه

6 اندپوینت
GET
/api/OM/v3/Tracking/BriefTracking/{trackingInput}
پیگیری مرسوله
JetTrackingBriefListDto
پایدار
GET
/api/OM/v3/Tracking/ByContractCode/{contractCode}
پیگیری مرسوله با کد قرارداد جت
پایدار
GET
/api/OM/v3/Tracking/{orderId}
پیگیری با کد سفارش
پایدار
POST
/api/OM/v3/Tracking/ByTrackingCode
پیگیری چند مرسوله با کد رهگیری
پایدار
POST
/api/OM/v3/Tracking/{traceCode}
پیگیری با کد رهگیری مشتری
پایدار
POST
/api/OM/v3/Tracking/BySecondaryTraceCode/{secondaryTraceCode}
پیگیری با کد رهگیری ثانویه مشتری
پایدار

لاکر 2 اندپوینت

کیوسک و بانچ — گروه Locker

اندپوینت‌های این گروه

2 اندپوینت
POST
/api/v3/Locker/SearchKiosks
جست و جوی کیوسک ها بر اساس مختصات جغرافیایی یا کد شهر -- همراه با فیلتر ابعاد لاکر ها
LockerSearchDto | KiosksListDtoApiResult
Locker
POST
/api/v3/Locker/SearchBunches
جست و جوی بانچ ها بر اساس مختصات جغرافیایی یا کد شهر -- همراه با فیلتر ابعاد لاکر ها
LockerSearchDto | BunchesListDtoApiResult
Locker

نمونه درخواست — لاکر

POST /api/v3/Locker/SearchKiosks

LockerSearchDto.json

Webhook 4 اندپوینت

مدیریت کال‌بک — گروه CustomerWebhook

اندپوینت‌های این گروه

4 اندپوینت
GET
/api/OM/v3/CustomerWebhook
Returns all CustomerWebhooks
CustomerWebhookListDtoApiResult
پایدار
POST
/api/OM/v3/CustomerWebhook
Creates a CustomerWebhook
CustomerWebhookCuDto | CustomerWebhookListDtoApiResult
پایدار
PUT
/api/OM/v3/CustomerWebhook
Updates a CustomerWebhook by unique id
CustomerWebhookCuDto | CustomerWebhookListDtoApiResult
پایدار
PUT
/api/OM/v3/CustomerWebhook/SoftDelete/{id}
ApiResult
پایدار

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

POST /api/OM/v3/CustomerWebhook

CustomerWebhookCuDto.json

تاریخچه Webhook 2 اندپوینت

گزارش — گروه CustomerWebhookHistory

اندپوینت‌های این گروه

2 اندپوینت
POST
/api/OM/v3/CustomerWebhookHistory/GetAll
Returns all CustomerWebhookHistories
CustomerWebhookHistorySearchDto | CustomerWebhookHistoryListDtoListApiResult
پایدار
GET
/api/OM/v3/CustomerWebhookHistory/Recent/{customerId}
CustomerWebhookHistoryListDtoListApiResult
پایدار

مالی 3 اندپوینت

تراکنش — گروه Financial

اندپوینت‌های این گروه

3 اندپوینت
GET
/api/OM/v3/Financial/GetDocuments
دریافت حداکثر 100 تراکنش آخر
پایدار
GET
/api/OM/v3/Financial/GetDocumentsByYear
دریافت تراکنش ها بر اساس سال مالی
پایدار
GET
/api/OM/v3/Financial/GetDocumentById
دریافت جزییات تراکنش مالی
OmVoucherListDto
پایدار

تیکتینگ 6 اندپوینت

تیکت — گروه Ticketing

اندپوینت‌های این گروه

6 اندپوینت
GET
/api/OM/v3/Ticketing
لیست تیکت ها
OmTicketListDtoOmBaseListDto
پایدار
POST
/api/OM/v3/Ticketing
ثبت تیکت
OmTicketCuDto
پایدار
POST
/api/OM/v3/Ticketing/Answer
ثبت پاسخ تیکت
OmTicketResponseCuDto
پایدار
GET
/api/OM/v3/Ticketing/{id}
دریافت جزییات با شماره تیکت
OmGetTicketByIdDto
پایدار
GET
/api/OM/v3/Ticketing/GetByOrderId/{orderId}
دریافت تیکت های مرتبط با یک سفارش
OmGetTicketByIdDto
پایدار
GET
/api/OM/v3/Ticketing/GetDepartments
دریافت لیست دپارتمان ها
OmTicketCategoryListDtoOmBaseListDto
پایدار

زمان‌بندی 1 اندپوینت

برنامه روزانه — گروه TimeTable

اندپوینت‌های این گروه

1 اندپوینت
GET
/api/v3/TimeTable/GetNextDayTimeTableSchedule
TimeTableScheduleApiResult
پایدار

شهرها 3 اندپوینت

شهرها و استان‌ها — گروه Cities

اندپوینت‌های این گروه

3 اندپوینت
GET
/api/OM/v3/Cities
دریافت لیست شهرها
پایدار
GET
/api/OM/v3/Cities/plusstate
دریافت لیست شهرها به همراه نام استان
پایدار
GET
/api/OM/v3/Cities/BranchCities
دریافت لیست شهرهای دارای نمایندگی فعال
پایدار

استان‌ها 1 اندپوینت

استان — گروه States

اندپوینت‌های این گروه

1 اندپوینت
GET
/api/OM/v3/States
دریافت لیست استان های ایران
پایدار
سامانه ویژه شعب و نمایندگی‌ها

سامانه قبول مرسولات تیپاکس

این بخش در حال آماده‌سازی است. به‌زودی مستندات کامل سامانه قبول مرسولات تیپاکس برای اپراتورهای شعب و نمایندگی‌ها در این صفحه ارائه خواهد شد.

وضعیتدر حال آماده‌سازی
تاریخ انتشاربه‌زودی

دیتای مستندات هنوز موجود نیست

مستندات و اندپوینت‌های سامانه قبول به‌محض دریافت فایل OpenAPI رسمی، در این صفحه قرار خواهند گرفت. در صورت داشتن فایل OpenAPI برای سامانه قبول، آن را برای ما ارسال کنید تا اضافه شود.

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

جدول کامل انواع بسته‌بندی تیپاکس شامل شناسه، ابعاد، وزن و نوع بسته. این مقادیر در فیلد packingId در زمان ثبت سفارش استفاده می‌شوند.

لیست بسته‌بندی‌ها

packingIdminWeightminHeightminWidthminLength maxWeightmaxHeightmaxWidthmaxLength heightwidthlengthpackTypetitle
Loading data...

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

لیست انواع محتوای قابل ارسال با شناسه‌های مرتبط. این شناسه در فیلد packageContentId استفاده می‌شود.

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

idpackTypetitle
Loading data...

پارامترها و توضیحات

جدول کامل پارامترهای استفاده‌شده در API تیپاکس. هر پارامتر شامل نام انگلیسی و توضیح فارسی است. برای جستجو از کادر بالای جدول استفاده کنید.

جدول پارامترها

parameter description
Username omapi.tipax.irنام کاربری در
Password omapi.tipax.irرمز عبور در
APIkey کلید ای‌تیپاکس API
refreshToken توکن به‌روزرسانی (دریافت شده هنگام ساخت توکن قبلی)
id آیدی کاربر
firstName نام
lastName نام خانوادگی
nationalCode کدملی
email ایمیل
phone تلفن
mobile شماره تلفن همراه
description توضیحات
title عنوان آدرس
cityId آیدی شهر
districtId منطقه
mainStreet1 خیابان اصلی
sideStreet1 خیابان فرعی
mainAlley1 کوچه اصلی
sideAlley1 کوچه فرعی
latitude طول جغرافیایی
longitude عرض جغرافیایی
postalCode کدپستی
unit واحد
floor طبقه
no پلاک
isDefault
personId آیدی کاربر
plaque پلاک
fullAddress آدرس کامل
beneficiary.phone شماره تلفن فرستنده
beneficiary.fullName نام و نام خانوادگی فرستنده
beneficiary.mobile موبایل فرستنده
destination.beneficiary.phone شماره تلفن گیرنده
destination.beneficiary.fullName نام و نام خانوادگی گیرنده
destination.beneficiary.mobile موبایل گیرنده
weight وزن بسته
packageValue ارزش بسته
length طول بسته
width عرض بسته
height ارتفاع بسته
packingId آی‌دی بسته‌بندی
packType نوع بسته‌بندی
parcelTypeId آیدی نوع بسته
parcelBookId آیدی بسته‌های تعریف شده مشتری
serviceId نوع سرویس
enableLabelPrivacy چاپ جزئیات فرستنده و گیرنده بر روی لیبل
paymentType نوع پرداخت
pickupType نوع جمع‌آوری
cod COD مبلغ
cashAmount مبلغ نقدی
barcode بارکد
secondaryTraceCode کد رهگیری اختصاصی ثانویه
discountCode کد تخفیف
originId ثبت کرده‌ایم addressbook آیدی آدرس مبدا که از قبل در
destinationId ثبت کرده‌ایم addressbook آیدی آدرس مقصد که از قبل در
originId ثبت کرده‌ایم addressbook آیدی آدرس مبدا که از قبل در
title عنوان بسته
length طول بسته
width عرض بسته
height ارتفاع بسته
packageValue ارزش بسته پستی
weight وزن بسته
packType پاکت:10 بسته :20 مینی پک:50
packageContentId (packContentRate تمامی مقادیر ممکن در متد) محتویات مثل: عمومی، شکستنی
packingId (PackingPrices تمامی مقادیر ممکن در متد) نوع بسته‌بندی مثال: کارتن سایز 1
isUnusual (true/false) آیا بسته غیراستاندارد است
origin.cityId آیدی شهر مبدا
destination.cityId آیدی شهر مقصد
weight وزن بسته
packageValue ارزش بسته پستی
length طول بسته
width عرض بسته
height ارتفاع بسته
packingId (تمامی مقادیر ممکن در متد PackingPrices) نوع بسته بندی مثال : کارتن سایز 1
parcelBookId آیدی بسته های تعریف شده مشتری
isUnusual آیا بسته غیر استاندارد است (true/false)
packType نوع – 10:پاکت – 20:بسته- 50:مینی پک
paymentType نوع پرداخت- 10:سمت فرستنده-اعتباری – 20:سمت گیرنده -پسکرایه
– 30:سمت گیرنده-پرداخت در محل- 40:سمت فرستنده-پرداخت در محل-
50:سمت فرستنده-پرداخت از کیف پول 80-سمت فرستنده-نقدی (تمامی مقادیر ممکن در متد PaymentType)
pickupType نوع جمع آوری - 10:جمع آوری در محل مشتری – 20:جمع آوری در نمایندگی
distributionType نوع تحویل- 10:تحویل در محل مشتری – 20:تحویل در نمایندگی
Serviced نوع سرویس- 1:ارسال زمینی همان روز – 2:ارسال زمینی یک روزه- 3:ارسال زمینی دو روزه- 5:اکسپرس ویژه بین شهری- 6:"بین الملل- 7:اکسپرس درون شهری
customerId کد مشتری
departmentId (GetDepartments تمامی مقادیر ممکن در متد) آیدی دپارتمان
priorityId الویت
subject موضوع
Text متن پاسخ تیکت
ticketId آیدی تیکتی که می‌خواهیم به آن پاسخ دهیم
contractCode کد قرارداد
orderNo شماره سفارش
contractKindName نوع قرارداد
dispatchCount تعداد بسته‌های ارسالی
contractStatusName وضعیت قرارداد
contractStatusId آیدی وضعیت قرارداد
dispatchValue ارزش بسته‌ها
contractInternalTime تاریخ شمسی ثبت سفارش
terminateUserFullName نام کاربر ابطال‌کننده سفارش
terminateDescribe دلیل ابطال
shippingCost هزینه حمل‌ونقل
specialService سرویس ویژه
packageService هزینه بسته‌بندی
smsCost هزینه پیامک
tax مالیات
discount تخفیف
hasCOD است COD آیا سفارش
cod COD مبلغ
finalAmount مبلغ نهایی
cashAmount مبلغ نقدی
payInPlaceAmount مبلغ پس‌کرایه
prePaidAmount مبلغ پیش پرداخت
paymentKindName نوع پرداخت
senderFullName نام فرستنده
senderMobileNumber موبایل فرستنده
senderPhoneNumber تلفن فرستنده
phoneNumber تلفن همراه
senderAddress آدرس فرستنده
senderCityName نام شهر فرستنده
totalWeight وزن بسته‌ها
barcode بارکدها
traceCode کد رهگیری مشتری
secondaryTraceCode کد رهگیری ثانویه مشتری
status وضعیت فعلی بسته
statusId آیدی وضعیت بسته
origin آدرس فرستنده
originState استان فرستنده
originCity شهر فرستنده
destination آدرس مقصد
destinationState استان مقصد
destinationCity شهر مقصد
paymentType نوع پرداخت
length طول
width عرض
height ارتفاع
value ارزش
weight وزن
packageType (packagingPrices) آیدی نوع بسته‌بندی
title عنوان نوع بسته‌بندی
packageContentTitle محتویات بسته مثل : عمومی , شکستنی
isFragile آیا بسته شکستنی است؟
parcelStatusHistories تاریخچه وضعیت بسته
jetIdContractAmountInfo کد قرارداد جت
shippingCost هزینه حمل‌ونقل
packageService هزینه بسته‌بندی
tax مالیات
finalAmount مبلغ نهایی
paymentKindName نوع پرداخت
cashAmount مبلغ نقدی
payInPlaceAmount مبلغ پس‌کرایه
organizationalServices خدمات سازمانی
distanceDay تخمین زمان تحویل بسته
nationalId
persianRegistrationDate
registrationNo
economicNo
companyId
customerCode
jetIdCustomer
leadId
clientsId
addressId
cityETipaxId
isIndividual
genderTypeId
homeTownCityId
maritalStatusId
approveId
ReceiverKioskId آیدی کیوسک جهت استفاده از سرویس لاکر پر شود
(برای اطلاعات بیشتر از سرویس لاکر بخش Locker را مطالعه نمایید)
preFix
branchId
modifierId
creatorId
peopleAddressTypeId
frontCallBackUrl
militaryStatusId
religionTypesId
dateOfEmployment
senderAddressId
jetId کد قرارداد جت
inFix
pickupStartTime
pickupEndTime
isDescending
toModificationDate
fromCreationDate
customParcelTitle این پارامتر شناسه فاکتور را تعیین می‌کند. در صورتی که گزارش به‌صورت اکسل دریافت شود، مقدار این پارامتر در ستون شناسه فاکتور نمایش داده خواهد شد
sourceCityId
destinationCityId
creationTime
modificationTime
totalItemCount
pageNumber
pageSize
pageCount
fromModificationDate
toCreationDate
sortBy
recordsPerPage
oldBarcode
newBarcode
bubbleWrapAmount
glueAmount
salaryAmount
postFix
barcodeTypeId
pickupDate
successCallbackUrl
failureCallbackUrl
addressTitle
clientTitle
bubbleWrapAmount
districtManagersOpinion
customerSubstationCode
exclusiveCode
birthDate
idNo
managerName
userId
generatedBarcodeId
otherAddress

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

سرویس‌های مختلف ارسال تیپاکس شامل سرویس عادی، سیستمی، ویژه، موتوری، سیستمی مقصد و سرویس مرجوعی. شناسه هر سرویس در فیلد serviceId استفاده می‌شود.

لیست سرویس‌ها

idisActivetitle
Loading data...

انواع پرداخت

مدل‌های مختلف پرداخت هزینه ارسال شامل پرداخت سمت فرستنده، سمت گیرنده، نقدی، اعتباری و کیف پول. شناسه در فیلد paymentType استفاده می‌شود.

لیست انواع پرداخت

id title description
10سمت فرستنده - پیش‌پرداختپرداخت در محل مبدا پیش از تحویل
20سمت گیرنده - نقدیپرداخت نقدی توسط گیرنده هنگام تحویل
30سمت گیرنده - پرداخت در محلپرداخت توسط گیرنده در محل دریافت
40سمت فرستنده - پرداخت در محل از اعتبارپرداخت در محل از اعتبار فرستنده
50سمت فرستنده - پرداخت از کیف پولکسر از کیف پول فرستنده
60سمت فرستنده - پرداخت در محل از کیف پولپرداخت در محل از کیف پول فرستنده
80سمت فرستنده - نقدیپرداخت نقدی در مبدا
90سمت فرستنده - اعتبار نمایندگیکسر از اعتبار نمایندگی

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

لیست کامل شهرها و استان‌های تحت پوشش تیپاکس. برای دریافت لیست سرویس‌های بین دو شهر از ابزار سرویس بین دو شهر استفاده کنید.

جستجوی شهر

id jetId latitude longitude stateTitle stateId title
Loading data...

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

کد وضعیت‌های ممکن برای مرسولات در طول چرخه ارسال. این مقادیر در پاسخ API و رویدادهای مرسوله استفاده می‌شوند.

لیست وضعیت‌ها

id latinTitle title
Loading data...

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

رویدادهای قابل مشاهده در طول چرخه زندگی یک مرسوله. این رویدادها در پاسخ متد رهگیری (Tracking) قابل دسترسی هستند.

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

idmodifiercreatormodificationTime creationTimemodificationDatecreationDatemodifierId creatorIdisActiveparcelStatus.idparcelStatus.latinTitle parcelStatus.titlefParcelStatusIdlatinTitletitle
Loading data...

نمونه پی‌لود ثبت سفارش

۹ نمونه آماده از بدنه JSON برای متدهای مختلف ثبت سفارش. روی دکمه «کپی JSON» کلیک کنید تا در پروژه خود استفاده کنید.

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

{ "packages": [ { "origin": { "cityId": 1677, "fullAddress": "آدرس فرستنده پلاک23", "latitude": 34.64556632, "longitude": 50.87211113, "beneficiary": { "fullName": "امیر", "mobile": "09121234567", "floor": "2", "unit": "4", "postalCode": "1234567891", "description": "test", } }, "destination": { "cityId": 1022, "fullAddress": "آدرس گیرنده پلاک 444", "latitude": 37.78039158, "longitude": 45.90133144, "floor": "12", "unit": "32", "postalCode": "8529637410", "beneficiary": { "fullName": "امیرعلی", "mobile": "09331234567" } }, "customParcelTitle": "TEST", "weight": 1, "packageValue": 10000000, "length": 30, "width": 40, "height": 45, "packageContentId": 9, "packingId": 10, "packType": 20, "serviceId": 4, "paymentType": 20, "pickupType": 10, "distributionType": 10, "cod": 0, "cashAmount": 0, } ], "traceCode": "MP11101492", "secondaryTraceCode": "MP85214798910", "discountCode": null, "successCallbackUrl": "", "failureCallbackUrl": "" }

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

{ "packages": [ { "originId": 29570365, "destinationId":70031520, "receiver": { "phone": "02191031648", "fullName": "محمدرضا", "mobile": "09981112223" }, "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": 1022, "fullAddress": "آدرس گیرنده پلاک 444", "latitude": 37.78039158, "longitude": 45.90133144, "postalCode": "8529637410", "beneficiary": { "fullName": "امیرعلی", "mobile": "09331234567" } }, "customParcelTitle": "TEST", "weight": 1, "packageValue": 10000000, "length": 1, "width": 1, "height": 1, "packageContentId": 9, "packType": 20, "serviceId": 4, "paymentType": 20, "pickupType": 10, "distributionType": 10, "cod": 0, "cashAmount": 0 } ], "traceCode": "MP1111492", "secondaryTraceCode": "MP852147878780", "discountCode": null }

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. نمونه بادی ثبت سفارش با WithCoordinates

{ "latitude": "36.5461926", "longitude": "52.6783361", "no": "string", "packages": [ { "destination": { "cityId": 1262, "fullAddress": "شهرک تست خیابان تست کوچه تست", "floor": "2", "unit": "45", "postalCode": "1234567891", "latitude": "35.71957113", "longitude": "51.37508023", "no": "3", "description": "توضیح تست", "beneficiary": { "phone": "093518880888", "fullName": "تست تستی", "mobile": "093518880888" } }, "isUnsual": false, "weight": 4, "packageValue": 450000000, "length": 35, "width": 45, "height": 55, "packingId": 11, "packageContentId": 9, "packType": 20, "description": "Test", "serviceId": 4, "enableLabelPrivacy": true, "paymentType": 20, "pickupType": 20, "distributionType": 20, "cod": 0, "cashAmount": 0, "customParcelTitle": "TEST-SHENASE" } ], "traceCode": "TEST547698", "secondaryTraceCode": "TS3456678", "discountCode": "" }

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

{ "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 }

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

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

8. نمونه بادی برای محاسبه هزینه (Pricing)

{ "packageInputs": [ { "origin": { "cityId": 1262 }, "destination": { "cityId": 1262 }, "weight": 2, "packageValue": 2222222, "length": 2, "width": 2, "height": 2, "packingId": 7, "packageContentId": 520, "packType": 20, "paymentType": 20, "pickupType": 0, "distributionType": 10, "serviceId": 7 } ] }

9. نمونه بادی ثبت سفارش با اکوپک

{ "packages": [ { "origin": { "cityId": 1262, "fullAddress": "آدرس فرستنده پلاک23", "latitude": 51.8302611199163, "longitude": 35.4438412913701, "beneficiary": { "fullName": "امیر", "mobile": "09121234567", "floor": "2", "unit": "4", "postalCode": "1234567891", "description": "test" } }, "destination": { "cityId": 1293, "fullAddress": "آدرس گیرنده پلاک 444", "latitude": 51.78712623, "longitude": 35.42576206, "floor": "12", "unit": "32", "postalCode": "8529637410", "beneficiary": { "fullName": "امیرعلی", "mobile": "09331234567" } }, "customParcelTitle": "TESTL", "weight": 1, "packageValue": 10000000, "length": 40, "width": 30, "height": 5, "packingId": 522, "packageContentId": 36, "packType": 70, "paymentType": 20, "pickupType": 20, "distributionType": 10, "serviceId": 7, "cod": 0, "cashAmount": 0 } ], "traceCode": "MP11101492", "secondaryTraceCode": "MP85214798910", "discountCode": null, "successCallbackUrl": "", "failureCallbackUrl": "" }

10. نمونه بادی ثبت سفارش باکس لاین (Booking/Register)

{ "pickupDate": "1405/05/10", "deadlineDays": 2, "bookingParcels": [ { "parcelValue": "500000000", "weight": "30", "description": "Refrigerator sample", "packagingTypeId": 509, "senderClientId": 5877661, "receiverClientId": 71012065, "senderAddressesId": 86035238, "receiverAddressesId": 85581549, "paymentTypeId": 10, "pickupTypeId": 10, "deliveryTypeId": 10, "packagingContentId": 11 } ], "WorkingDates": [ { "date": "1405/05/10", "start": "09:00", "end": "15:00", "Type": "Origin" }, { "date": "1405/05/11", "start": "09:00", "end": "15:00", "Type": "Origin" }, { "date": "1405/05/10", "start": "02:40", "end": "12:00", "Type": "Destination" }, { "date": "1405/05/11", "start": "02:40", "end": "12:00", "Type": "Destination" } ] }

سوالات متداول

پاسخ به سوالات رایج توسعه‌دهندگان درباره API تیپاکس. اگر سوال شما در این لیست نیست با تیم پشتیبانی تماس بگیرید.

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 وب‌هوک (Webhook) چیست و چه تفاوتی بین نسخه‌های 3 و 4 API ای‌تی‌پاکس در استفاده از آن وجود دارد؟

وب‌هوک (Webhook) یک مکانیزم ارتباطی کارآمد بین اپلیکیشن‌ها است که امکان تبادل خودکار و آنی اطلاعات را فراهم می‌کند.

برخلاف روش سنتی «پولینگ» (Polling) که در آن یک اپلیکیشن باید به‌طور مداوم سرویس دیگر را برای دریافت اطلاعات جدید بررسی کند، وب‌هوک به سرویس مبدأ اجازه می‌دهد تا در لحظه وقوع یک رویداد (مانند تغییر وضعیت بسته پستی)، اطلاعات مربوطه را به‌صورت «پوش» (Push) به یک URL از پیش تعیین‌شده در اپلیکیشن مقصد ارسال کند. این امر باعث افزایش سرعت، کاهش سربار پردازشی و به‌روزرسانی آنی اطلاعات می‌شود.

تفاوت اصلی بین نسخه ۳ و ۴ API ای‌تی‌پاکس

تفاوت اصلی بین نسخه ۳ و ۴ API ای‌تی‌پاکس در همین نحوه تبادل اطلاعات نهفته است:

  1. نسخه ۳ (API v3): این نسخه به‌صورت «همزمان» (Synchronous) عمل می‌کند. بدین معنی که تمامی عملیات مربوط به هر سفارش (ثبت، پردازش و غیره) به‌صورت لحظه‌ای انجام شده و نتیجه بلافاصله برگردانده می‌شود. اگرچه در صورت داشتن توکن معتبر، ثبت سفارش دچار مشکل نمی‌شود، اما ماهیت همزمان این نسخه باعث تجمع بار پردازشی در صورت افزایش درخواست‌های همزمان می‌گردد.
  2. نسخه ۴ (API v4): این نسخه به‌صورت «مبتنی بر رویداد» (Event-Driven) و با استفاده از «صف‌گذاری» (Queue) پیاده‌سازی شده است. در این نسخه، ارائه URL برای «کال‌بک موفقیت» (Success Callback URL) و «کال‌بک شکست» (Fail Callback URL) الزامی است. این URLها همان اندپوینت‌های وب‌هوک هستند که ای‌تی‌پاکس تغییرات وضعیت بسته‌ها را به آن‌ها ارسال می‌کند. این معماری برای مشتریانی که قابلیت پیاده‌سازی وب‌هوک را دارند و به عملکرد بالا و مکانیزم‌های «تلاش مجدد» (Retry) نیاز دارند، ایده‌آل است.

چرا استفاده از وب‌هوک در نسخه ۴ API ای‌تی‌پاکس ضروری است؟

نسخه ۴ ای‌تی‌پاکس به‌گونه‌ای طراحی شده است که با الگوی ترافیک لحظه‌ای و پرترافیک (مثلاً ۱۰۰۰ درخواست در لحظه) سازگار باشد. وب‌هوک امکان پردازش آنی و کارآمد این حجم از درخواست‌ها را فراهم می‌کند.

شما با آماده‌سازی یک URL در سیستم خودتان که قادر به دریافت درخواست‌های HTTP POST از ای‌تی‌پاکس باشد و ثبت آن در تنظیمات، می‌توانید تغییرات وضعیت بسته‌ها را به محض وقوع دریافت و در سیستم خود به‌روزرسانی کنید. این رویکرد ضمن افزایش سرعت دریافت اطلاعات، بار پردازشی را روی سرورهای شما و ای‌تی‌پاکس کاهش می‌دهد و از به‌روز بودن دائمی اطلاعات اطمینان حاصل می‌کند.

11 هنگام فراخوانی سرویس https://omapi.tipax.ir/api/OM/v3/Tracking/ByTrackingCode گاهی خطای زیر دریافت می‌شود: API calls quota exceeded! maximum admitted 10 per 1s. دلیل این خطا چیست و چگونه می‌توان از بروز آن جلوگیری کرد؟

این خطا مربوط به محدودیت نرخ درخواست (Rate Limit) در سرویس OmOrder تیپاکس است. بر اساس تنظیمات سرور، حداکثر ۱۰ درخواست در هر ثانیه برای هر کلاینت (بر اساس API Key یا IP) مجاز است.

در صورتی که تعداد فراخوانی‌ها از این حد بیشتر شود، سامانه به‌صورت موقت مانع پردازش می‌شود و پیام خطای فوق (معمولاً همراه با وضعیت HTTP 429) برگردانده می‌شود.

روش‌های پیشنهادی برای جلوگیری از خطا

  1. بین هر batch از درخواست‌ها وقفه‌ای حدود ۱۰۰ تا ۱۵۰ میلی‌ثانیه در نظر بگیرید.
  2. در صورت امکان، چند مرسوله را به‌صورت گروهی (Bulk) داخل یک درخواست واحد ارسال کنید تا حجم فراخوانی‌ها کاهش یابد.
12 (LTL) قوانین و مقررات سرویس باکس لاین

سرویس ال.تی.ال (باکس لاین)

سرویس ال.تی.ال فضایی از حامل را طبق شرایط مشخص به مشتریان اختصاص می‌دهد. هر فضای واحد معادل مساحت یک باکس لاین (۱.۲ × ۱ مترمربع) بوده و حداکثر وزن مجاز آن ۳۰۰ کیلوگرم و ارتفاع مجاز ۲ متر است.

در صورت تجاوز ابعاد یا وزن از این محدودیت‌ها، مشتری باید فضای جدیدی خریداری کند. برای هر فضای اختصاص‌یافته تنها یک مبدأ و یک مقصد قابل تعریف است. اگر مرسوله شامل چند بسته است، باید به‌صورت تجمیع‌شده و یکپارچه (در قالب باکس لاین شیرینگ‌شده، بچ یا گونی) ارسال شود.

تخلیه و بارگیری مرسوله بر عهده مشتری است و در صورت تحویل مرسوله در باکس لاین، مسئولیت بازگشت آن با گیرنده خواهد بود. همچنین، محتویات مرسوله باید مجاز و مطابق گروه‌های کالایی مورد تأیید تیپاکس بوده و جزو اقلام ممنوعه ارسالی نباشد.

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

  • حداکثر ارزش مرسوله: ۱۰,۰۰۰,۰۰۰,۰۰۰ ریال
  • کف وزن: ۰.۱ کیلوگرم
  • سقف وزن: ۳۰۰ کیلوگرم
13 تفاوت سرویس‌های اکسپرس، اکسپرس پلاس و همان‌روز (Same Day) تیپاکس چیست؟

تیپاکس سه نوع سرویس برای ارسال مرسولات ارائه می‌دهد تا کاربران بر اساس سرعت مورد نیاز خود انتخاب کنند:

  1. اکسپرس: بسته از نزدیک‌ترین نمایندگی جمع‌آوری شده و در مدت ۳ روز کاری به گیرنده تحویل می‌شود.
  2. اکسپرس پلاس: بسته نیز توسط نزدیک‌ترین نمایندگی جمع‌آوری شده، ولی با سرعت بالاتر، طی ۲۰ ساعت کاری تحویل داده می‌شود. برای استفاده از این سرویس باید بسته را تا ساعت ۱۷:۰۰ همان روز به نمایندگی تحویل دهید؛ در غیر این صورت ارسال آن به اولین نوبت کاری بعدی موکول خواهد شد.
  3. همان روز (Same Day): سریع‌ترین گزینه است که بسته را ظرف ۱۰ ساعت کاری به مقصد می‌رساند. کافی‌ست مرسوله تا ساعت ۱۴:۰۰ به نمایندگی تحویل داده شود تا حداکثر تا ساعت ۲۲:۰۰ همان روز به گیرنده برسد، و در صورت تحویل دیرتر از این زمان، ارسال در نخستین نوبت کاری روز آینده انجام می‌گیرد.

نکته: سرویس‌های اکسپرس پلاس و همان روز فعلاً فقط در شهرهای تهران و البرز فعال هستند و سایر شهرها می‌توانند از سرویس اکسپرس استفاده کنند.

14 چه مقادیری برای serviceId باعث تعیین قرارداد از نوع اکسپرس می‌شوند؟

اگر برای پارامتر serviceId مقادیر زیر ارسال شود، نوع قرارداد نهایی اکسپرس خواهد بود:

  • ۱ – ارسال زمینی همان روز
  • ۲ – ارسال زمینی یک روزه
  • ۳ – ارسال زمینی دو روزه
  • ۴ – ارسال زمینی سه روزه
  • ۵ – اکسپرس ویژه بین‌شهری
  • ۷ – اکسپرس درون‌شهری

در این صورت، نوع قرارداد نهایی اکسپرس در نظر گرفته می‌شود.

15 پارامتر ‌paymentType در ثبت سفارش تیپاکس چه مقادیری را می‌پذیرد و هر مقدار چه نوع پرداختی را مشخص می‌کند؟

برای پارامتر paymentType مقادیر زیر مجاز هستند:

  • ۱۰ – سمت فرستنده / اعتباری
  • ۲۰ – سمت گیرنده / پس‌کرایه
  • ۳۰ – سمت گیرنده / پرداخت در محل
  • ۴۰ – سمت فرستنده / پرداخت در محل
  • ۵۰ – سمت فرستنده / پرداخت از کیف پول
  • ۸۰ – سمت فرستنده / نقدی

مقادیر ۱۰ و ۴۰ – کسر از اعتبار فرستنده

در صورت ارسال مقادیر ۱۰ و ۴۰، هزینه خدمات از اعتبار فرستنده (صاحب حساب کاربری در ای‌تیپاکس) در هر دو حالت کسر خواهد شد. اما در حالت سمت فرستنده – پرداخت در محل (۴۰)، سیستم به‌صورت اتوماتیک ارزش مرسوله را به‌جای COD جای‌گذاری می‌کند، در صورتی که پارامتر COD ارسال نشود یا مقدار آن کمتر از ارزش مرسوله نباشد.

مقادیر ۲۰ و ۳۰ – دریافت از گیرنده

همچنین در صورت ارسال مقادیر ۲۰ (سمت گیرنده – پس‌کرایه) و ۳۰ (سمت گیرنده – پرداخت در محل)، در هر دو حالت هزینه خدمات از گیرنده دریافت خواهد شد. اما در حالت سمت گیرنده – پرداخت در محل (۳۰)، سیستم به‌صورت اتوماتیک ارزش مرسوله را به‌جای COD جای‌گذاری می‌کند، در صورتی که پارامتر COD ارسال نشود یا مقدار آن کمتر از ارزش مرسوله نباشد.

مقدار ۸۰ – پرداخت نقدی به نماینده

در نهایت، در صورت ارسال پارامتر ۸۰ (سمت فرستنده – نقدی)، نماینده تیپاکس در زمان جمع‌آوری، هزینه ارسال را به‌صورت نقدی از فرستنده دریافت می‌کند. بنابراین در صورت ثبت سفارش در این حالت از پرداخت، لازم است پارامتر cashAmount مقداردهی و ارسال شود.

16 اگر سفارش در پلتفرم ای‌تی‌پاکس (eTipax) ثبت شود اما عملیات جمع‌آوری (Pickup) انجام نشود، چه اتفاقی می‌افتد؟

در این حالت، سفارش پس از گذشت ۳۰ روز (مدت زمان Expire) به‌صورت خودکار منقضی شده و ابطال می‌گردد.

17 عوامل اصلی تاثیرگذار بر هزینه خدمات در تیپاکس چیست؟

هزینه خدمات در تیپاکس بر اساس چندین عامل کلیدی تعیین می‌گردد. این عوامل عبارتند از فاصله بین مبدا و مقصد، نوع سرویس انتخابی، نوع بسته ارسالی، ارزش اعلام‌شده برای مرسوله جهت بیمه، وزن و ابعاد فیزیکی بسته (طول، عرض و ارتفاع)، و همچنین نحوه جمع‌آوری مرسوله (حضوری یا در محل).

18 منظور از “کال‌بک موفقیت” (Success Callback URL) و “کال‌بک شکست” (Fail Callback URL) در API v4 تیپاکس چیست؟

در نسخه ۴ API تیپاکس، معماری به‌صورت «مبتنی بر رویداد» (Event‑Driven) و «غیرهمزمان» (Async) طراحی شده است. به همین دلیل، نتیجه پردازش هر سفارش بلافاصله در پاسخ Request برگردانده نمی‌شود. به‌جای آن، شما باید دو آدرس (URL) در اختیار تیپاکس قرار دهید تا نتیجه پردازش را در زمان مناسب برای شما ارسال کند:

  1. کال‌بک موفقیت (Success Callback URL): این URL آدرسی در سیستم شماست که تیپاکس پس از پردازش موفق درخواست (مثلاً ثبت موفق سفارش یا هر مرحله‌ای که در صف پردازش بدون خطا کامل شود) به آن یک درخواست HTTP POST ارسال می‌کند.
  2. کال‌بک شکست (Fail Callback URL): این URL برای زمانی است که پردازش درخواست با خطا مواجه شود. در چنین حالتی تیپاکس به‌جای پاسخ موفق، اطلاعات خطا را به Fail Callback URL ارسال می‌کند.

در نتیجه وجود این دو آدرس باعث می‌شود بتوانید بدون انتظار، درخواست‌ها را با سرعت بالا ارسال کنید، عملیات پشت‌صحنه را صف‌بندی و پردازش کنید، سیستم شما نتیجه را دقیق و آنی دریافت کند و همچنین سازوکار «Retry» و پایداری بالاتر برای شما فراهم شود.

19 اگر پارامتر packingId در جیسون ارسالی وجود نداشته باشد، چه می‌شود؟

اگر در جیسون ارسالی شما به تیپاکس، پارامتر packingid وجود نداشته باشد، سیستم به‌صورت اتومات نوع بسته شما را (نیاز به بسته بندی ندارد) در نظر خواهد گرفت

20 مبلغ قرارداد (finalPrice) چگونه محاسبه می‌شود؟

مبلغ نهایی قرارداد برابر است با مجموع هزینه خدمات، هزینه بسته‌بندی، مالیات بر ارزش افزوده و هزینه جبران خسارت (پوشش ارزش کالا). این مبلغ در پاسخ API با پارامتر finalPrice بازگردانده می‌شود.

21 محدودیت‌های وزن و ارزش مرسوله برای هر نوع بسته‌بندی چقدر است؟

در API تیپاکس، چهار نوع بسته‌بندی تعریف شده است که هر کدام دارای سقف مشخصی برای وزن و ارزش مرسوله هستند. در هنگام ثبت سفارش، رعایت این محدودیت‌ها الزامی است:

نوع بسته‌بندیمحدودیت وزنسقف ارزش مرسوله (ریال)
حجیم و سنگینحداقل ۳۰ کیلوگرم - حداکثر ۱۰۰ کیلوگرم۳,۰۰۰,۰۰۰,۰۰۰
بسته (کارتن)حداکثر ۳۰ کیلوگرم۱,۰۰۰,۰۰۰,۰۰۰
پاکتحداکثر ۲ کیلوگرم۲۰,۰۰۰,۰۰۰
مینی پک (فلایر)حداکثر ۲ کیلوگرم۱۰۰,۰۰۰,۰۰۰

توجه: در صورت ارسال مقادیر فراتر از این محدودیت‌ها، سیستم با خطای اعتبارسنجی (Validation Error) مواجه خواهد شد.

22 حداکثر تعداد ارقام مجاز برای فیلد پلاک در ثبت آدرس چقدر است؟

فیلد «پلاک» در زمان ثبت آدرس حداکثر می‌تواند شامل ۵ رقم عددی باشد. در صورت وارد کردن بیش از ۵ رقم، سیستم اجازه ثبت آدرس را نخواهد داد.

23 چگونه می‌توانم ID محصولات (کالاها) جدید را دریافت کنم؟

برای دریافت (Get) شناسه‌های محصولات جدید (Product IDs)، لطفاً endpoint زیر را فراخوانی (Call) نمایید:

URL: https://integrationapi.tipax.ir/api/OM/v3/Customers/myproducts

با فراخوانی این آدرس، لیستی از Product IDها در پاسخ دریافت خواهد شد.

24 مشخصات بسته بندی اکوپک چیست؟
  • بسته بندی اکو پک تخفیف ندارد.
  • جمع اوری در محل نمایندگی می باشد.
  • نوع بسته بندی فقط فلایر A4 به ابعاد 21.5*30*5 می باشد.
  • وزن مرسوله تا 1 کیلوگرم است.
  • ارزش مرسوله 15000000 ریال می باشد.
25 در زمان Call کردن سرویس Pricing، مدت زمان (Response Time) بالایی وجود دارد، مشکل چیست؟

با توجه به معماری سامانه ای‌تیپاکس، پیش از Call کردن سرویس Pricing لازم است تا ابتدا یک سفارش ثبت و بارکد دریافت کنید و سپس مجدد سرویس Pricing را Call کنید و Response Time را بررسی کنید.

26 لجستیک معکوس چیست و چگونه ثبت می‌شود؟

سرویس لجستیک معکوس برای جمع‌آوری و بازگرداندن مرسولات از گیرنده به فرستنده طراحی شده است. این سرویس در سامانه مشابه ثبت سفارش عادی انجام می‌شود، با این تفاوت که تمامی هزینه‌های حمل تنها توسط فرستنده پرداخت می‌شود و امکان پرداخت هزینه توسط گیرنده وجود ندارد.

فرآیند تحویل مرسوله

پس از ثبت سفارش، یک پیامک حاوی بارکد مرسوله و لینک مربوط به رهگیری سفارش برای گیرنده ارسال می‌شود. گیرنده هنگام تحویل مرسوله به نماینده تیپاکس، کافی است بارکد دریافتی را ارائه دهد.

نمونه پیامک ارسالی

مشتری محترم تیپاکس، سلام

بسته مرجوعی شما توسط [نام ثبت‌کننده] با بارکد [بارکد مرسوله] در سامانه ثبت شد. لطفاً هنگام تحویل، بارکد را ارائه دهید.

لینک: [لینک سفارش]

تیپاکس – ۰۲۱۸۴۵۷

کاربرد سرویس

این سرویس مناسب کسب‌وکارهایی است که نیاز به دریافت کالاهای مرجوعی، جمع‌آوری اسناد، نمونه کالا یا سایر مرسولات از مشتریان خود دارند.

27 چگونه می‌توانم جزئیات کامل رهگیری (دست‌رشته‌ها) را مشاهده کنم؟

برای مشاهده تمامی دست‌رشته‌ها و جزئیات کامل وضعیت مرسوله، از متد POST استفاده کنید و درخواست را به آدرس زیر ارسال نمایید. مقدار trackingInput را با شماره قرارداد مرسوله جایگزین کرده و در Body درخواست یک آبجکت خالی ({}) ارسال کنید.

آدرس درخواست:
POST https://omapi.tipax.ir/api/v2/Tracking/GetJetTrackingDetail?trackingInput=3616202582144234437

بدنه درخواست (Body):
{}

نکته: به‌جای 3616202582144234437، شماره قرارداد موردنظر خود را قرار دهید.

28 آیا می‌توان اطلاعات مشتری (کلاینت) را از طریق API ویرایش کرد؟

بله، امکان ویرایش اطلاعات مشتری از طریق API فراهم شده است. برای این کار کافی است درخواست خود را به آدرس زیر ارسال کنید:

آدرس API:
https://omapi.tipax.ir/api/v2/client

متد: PUT

نمونه JSON (پیلود) مورد نیاز: 

{
  "fullName": "string",
  "mobile": "string",
  "nationalId": "string",
  "telephonNumber": "string",
  "id": "string"
}

نکته: تمامی فیلدها به‌صورت رشته (string) ارسال می‌شوند و فیلد id برای شناسایی مشتری الزامی است.

29 ثبت سفارش به‌صورت همان روز (Same Day) در ای‌تیپاکس چگونه انجام می‌شود و چه شرایطی دارد؟

ثبت سفارش سرویس همان روز (Same Day) در ای‌تیپاکس دارای شرایط و محدودیت‌های زیر است:

1. محدوده ثبت سفارش: ثبت سفارش سرویس Same Day فقط برای مبدا و مقصد تهران به تهران امکان‌پذیر است.

2. وزن مرسوله: وزن بسته باید حداکثر 12 کیلوگرم باشد.

3. ابعاد بسته: حداکثر ابعاد بسته‌بندی باید 37 × 37 × 15 سانتی‌متر باشد تا مرسوله امکان قرارگیری در لاکر را داشته باشد.

4. تأیید آدرس مشتری: مشتری باید پیش از ثبت سفارش، آدرس خود را از طریق لینک مربوطه تأیید کرده باشد. پس از انتخاب شماره مشتری، در بخش آدرس‌ها می‌توانید لیست آدرس‌های پیشنهادی را مشاهده کرده و آدرس تأییدشده مشتری را انتخاب نمایید.

5. نوع بسته‌بندی: ثبت سفارش Same Day فقط برای بسته (کارتن) و پاکت امکان‌پذیر است و استفاده از اکوپک برای این سرویس امکان‌پذیر نیست.

6. نحوه عملکرد سرویس: در این نوع ثبت سفارش، مرسوله در ابتدا برای ارسال به آدرس مشتری در نظر گرفته می‌شود؛ هم‌زمان با ثبت سفارش، یک لاکر نیز برای مشتری رزرو می‌شود. در صورتی که مشتری در زمان مراجعه مأمور توزیع در آدرس حضور نداشته باشد، بسته به لاکر رزروشده منتقل شده و در آنجا قرار می‌گیرد تا مشتری بتواند برای دریافت مرسوله به لاکر مراجعه کند. هزینه رزرو لاکر تا 48 ساعت رایگان می‌باشد.

با مختومه شدن سفارش، رزرو مربوط به لاکر نیز به‌صورت خودکار مختومه خواهد شد.

خلاصه شرایط: تهران به تهران، حداکثر وزن 12 کیلوگرم، حداکثر ابعاد 37 × 37 × 15 سانتی‌متر، آدرس تأییدشده مشتری و فقط بسته یا پاکت.

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

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

{
  "packages": [
    {
      "origin": {
        "cityId": 1677,
        "fullAddress": "آدرس فرستنده پلاک23",
        "latitude": 34.64556632,
        "longitude": 50.87211113,
        "beneficiary": {
          "fullName": "امیر",
          "mobile": "09121234567",
          "floor": "2",
          "unit": "4",
          "postalCode": "1234567891",
          "description": "test"
        }
      },
      "destination": {
        "cityId": 1022,
        "fullAddress": "آدرس گیرنده پلاک 444",
        "latitude": 37.78039158,
        "longitude": 45.90133144,
        "floor": "12",
        "unit": "32",
        "postalCode": "8529637410",
        "beneficiary": {
          "fullName": "امیرعلی",
          "mobile": "09331234567"
        }
      },
      "customParcelTitle": "TEST",
      "weight": 1,
      "packageValue": 10000000,
      "length": 30,
      "width": 40,
      "height": 45,
      "packageContentId": 9,
      "packingId": 10,
      "packType": 20,
      "serviceId": 4,
      "paymentType": 20,
      "pickupType": 10,
      "distributionType": 10,
      "cod": 0,
      "cashAmount": 0
    }
  ],
  "traceCode": "MP11101492",
  "secondaryTraceCode": "MP85214798910",
  "discountCode": null,
  "successCallbackUrl": "",
  "failureCallbackUrl": ""
}

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

{
  "packages": [
    {
      "originId": 29570365,
      "destinationId": 70031520,
      "receiver": {
        "phone": "02191031648",
        "fullName": "محمدرضا",
        "mobile": "09981112223"
      },
      "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,
      "cod": 0,
      "cashAmount": 0
    }
  ],
  "traceCode": "MP11101492",
  "discountCode": null,
  "successCallbackUrl": "",
  "failureCallbackUrl": ""
}

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

نظرات، پیشنهادات و انتقادات شما در بهبود مستندات API تیپاکس بسیار ارزشمند است. لطفاً با تکمیل این فرم، تجربه خود را با ما در میان بگذارید.

📘 راهنمای جامع پلتفرم ای‌تیپاکس

🌐 وبسایت ای‌تیپاکس ⬇️نسخه آفلاین راهنمایی ای تیپاکس
🎬 ویدیوی آموزشی ⏱️ مدت زمان: 29 دقیقه
📹 آموزش تصویری کامل کار با پلتفرم ای‌تیپاکس - از ثبت‌نام تا مدیریت مالی

مقدمه

ای‌تیپاکس، پلتفرم فروش سازمانی تیپاکس است که با هدف بهینه‌سازی و ساده‌سازی فرآیند ارسال کالا برای تمامی کسب‌وکارها طراحی شده است. با استفاده از ای‌تیپاکس دیگر نیازی به مراجعه حضوری به نمایندگی‌های تیپاکس و یا تماس تلفنی برای جمع‌آوری و ارسال بسته‌ها نیست.

⏱️ زمان مطالعه: حدود ۱۰ دقیقه 💻 پلتفرم: وب (ETipax) 🎥 ویدیو: 29 دقیقه

📋 مراحل گام‌به‌گام کار با ای‌تیپاکس

📊 راهنمای ثبت سفارش گروهی با اکسل در ای‌تیپاکس

راهنمای آفلاین ثبت سفارش گروهی در اکسل
🎬 ویدیوی آموزشی ⏱️ مدت زمان: 13 دقیقه
📹 آموزش تصویری کامل ثبت سفارش گروهی با اکسل در ای‌تیپاکس - از دانلود تا دریافت بارکد

مقدمه

ثبت سفارش گروهی با اکسل یکی از قابلیت‌های قدرتمند پلتفرم ای‌تیپاکس است که به شما امکان می‌دهد تعداد زیادی سفارش را به صورت همزمان و با استفاده از یک فایل اکسل ثبت کنید. این روش برای کسب‌وکارهایی که روزانه حجم بالایی از سفارش‌ها را ارسال می‌کنند، بسیار کارآمد و زمان‌بر است.

⏱️ زمان مطالعه: حدود ۸ دقیقه 📊 فرمت فایل: Excel (xlsx) 🎥 ویدیو: 13 دقیقه

📋 مراحل گام‌به‌گام ثبت سفارش گروهی با اکسل در ای تیپاکس

🤖 راهنمای جامع ربات تیپاکس در پیام‌رسان بله

🤖 بازوی رسمی تیپاکس در بله ⬇️ راهنمای آفلاین
🎬 ویدیوی آموزشی ⏱️ مدت زمان: 5 دقیقه
📹 آموزش تصویری کامل ثبت سفارش در ربات تیپاکس - از ورود تا دریافت فاکتور

🔹 ربات تیپاکس در پیام‌رسان بله، امکان ثبت سفارش، دریافت فاکتور، رهگیری مرسوله و برآورد هزینه را به ساده‌ترین شکل ممکن فراهم کرده است.

📋 این راهنما تمام مراحل را به‌صورت گام‌به‌گام از صفر تا صد پوشش می‌دهد.

⏱️ زمان مطالعه: ۳ دقیقه | 📱 پلتفرم: پیام‌رسان بله | 🎥 ویدیو: 5 دقیقه

📌 مراحل گام‌به‌گام

⚠️ نکته مهم: در صورت بروز هرگونه مشکل، با تیم پشتیبانی تیپاکس تماس بگیرید.

📦 راهنمای نصب و پیکربندی افزونه تیپاکس | وردپرس + ووکامرس

⬇️ لینک دانلود پلاگین 🌐راهنمای نصب آفلاین
🎬 ویدیوی آموزشی ⏱️ مدت زمان: 25 دقیقه
آموزش تصویری کامل نصب و راه اندازی پلاگین ورد پرس

🔹 افزونه تیپاکس راه‌حل جامع اتصال فروشگاه ووکامرس شما به سامانه ای‌تیپاکس است. با نصب و پیکربندی این افزونه می‌توانید محاسبه خودکار هزینه حمل، ثبت سفارش، چاپ بارکد و مدیریت ارسال‌ها را مستقیماً از پیشخوان وردپرس انجام دهید.

📋 این راهنما تمام مراحل را به‌صورت گام‌به‌گام از صفر تا صد پوشش می‌دهد.

⏱️ زمان مطالعه:10 دقیقه | 🖥️ پلتفرم: وردپرس + ووکامرس

📌 مراحل گام‌به‌گام

⚠️ نکته مهم: در صورت بروز هرگونه مشکل، بخش «لاگ» (Logs) افزونه را بررسی کنید.

📱 راهنمای ثبت سفارش در سامانه مای‌تیپاکس

دانلود از گوگل پلی (اندروید)⬇️ نسخه وب اپلیکیشن (ios)⬇️ دانلود از بازار ⬇️ راهنمای آفلاین مای‌تیپاکس 🌐 ورود به سامانه مای‌تیپاکس
🎬 ویدیوی آموزشی ⏱️ مدت زمان: 9 دقیقه
📹 آموزش تصویری کامل کار با اپلیکیشن مای تیپاکس - از ثبت‌نام تا رهگیری مرسوله

مقدمه

اپلیکیشن مای تیپاکس (My Tipax) راه‌حلی سریع و آسان برای ثبت، پیگیری و مدیریت سفارش‌های پستی است. با استفاده از این اپلیکیشن می‌توانید بدون نیاز به مراجعه حضوری، مرسوله‌های خود را ثبت کرده و وضعیت آن‌ها را در لحظه پیگیری کنید.

⏱️ زمان مطالعه: حدود ۸ دقیقه 📱 پلتفرم: اندروید و iOS 🎥 ویدیو: 9 دقیقه

📋 مراحل گام‌به‌گام استفاده از اپلیکیشن مای تیپاکس