آشنایی با پارامترهای API ای تیپاکس

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

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

مستندات API ای ‌تیپاکس

پارامترهای API ای تیپاکس > حساب کاربری (Account)

/api/OM/v3/Account/token

پارامترهای دریافت توکن احراز هویت و توکن به‌روز رسانی (refresh token)

Parameter Table

Usename	omtest.tipax.ir نام کاربری در
Password	omtest.tipax.ir رمزعبور در
APIkey	ای تیپاکس API کلید

/api/OM/v3/Account/RefreshToken

پارامترهای دریافت توکن احراز هویت جدید از طریق توکن به‌روز رسانی

Parameter Table

Token	توکن احراز هویت قبلی
refreshToken	توکن به روز رسانی (دریافت شده هنگام ساخت توکن قبلی)

پارامترهای API ای تیپاکس > مشتری حقیقی (ActualCustomers)

/api/OM/v3/customers/actual

پارامترهای ویرایش اطلاعات مشتری حقیقی

Parameter Table

id	آیدی کاربر
firstName	نام
lastName	نام خانوادگی
nationalCode	کدملی
email	ایمیل
phone	تلفن
mobile	شماره تلفن همراه
description	توضیحات

پارامترهای API ای تیپاکس > آدرس‌ها (Addresees)

/api/OM/v3/Addresses/

پارامترهای افزودن آدرس برای مشتری جاری

Parameter Table

title	عنوان آدرس
cityId	آیدی شهر
districtId	منطقه
mainStreet1	خیابان اصلی
sideStreet1	خیابان فرعی
mainAlley1	کوچه اصلی
sideAlley1	کوچه غرعی
latitude	طول جغرافیایی
longitude	عرض جغرافیایی
postalCode	کدپستی
unit	واحد
floor	طبقه
no	پلاک
isDefault	(true/false)به‌عنوان آدرس پیشفرض در نظر گرفته شود

/api/OM/v3/Addresses/Book

پارامترهای افزودن آدرس به دفترچه آدرس کاربر

Parameter Table

title	عنوان آدرس
personId	آیدی کاربر
isDefault	آیا به‌عنوان آدرس پیشفرض در نظر گرفته شود
isDefault	1: فرستنده
	2: گیرنده
	3: عمومی
cityId	آیدی شهر
fullAddress	آدرس
postalCode	کدپستی
latitude	طول جغرافیایی
longitude	عرض جغرافیایی
plaque	پلاک
unit	واحد
floor	طبقه
description	توضیحات

پارامترهای API ای تیپاکس > سفارش‌ها (Orders)

ثبت سفارش

/api/OM/v3/Orders

پارامترهای ثبت سفارش

Parameter Table

cityId	آیدی شهر فرستنده
fullAddress	آدرس کامل
floor	طبقه
unit	واحد
postalCode	کد پستی
latitude	طول جغرافیایی
longitude	عرض جغرافیایی
no	پلاک
description	توضیحات
beneficiary.phone	شماره تلفن فرستنده
beneficiary.fullName	نام و نام خانوادگی فرستنده
beneficiary.mobile	موبایل فرستنده
destination.beneficiary.phone	شماره تلفن گیرنده
destination.beneficiary.fullName	نام و نام خانوادگی گیرنده
destination.beneficiary.mobile	موبایل گیرنده
weight	وزن بسته
packageValue	ارزش بسته
length	طول بسته
width	عرض بسته
height	ارتفاع بسته
packingId	نوع بسته‌بندی
packageContentId	محتویات بسته
packType	نوع بسته‌بندی
parcelTypeId	آیدی نوع بسته
parcelBookId	آیدی بسته‌های تعریف شده مشتری
serviceId	نوع سرویس
enableLabelPrivacy	چاپ جزئیات فرستنده و گیرنده بر روی لیبل
paymentType	نوع پرداخت
pickupType	نوع جمع‌آوری
distributionType	نوع تحویل
cod	COD مبلغ
cashAmount	مبلغ نقدی
barcode	بارکد
traceCode	کد رهگیری اختصاصی
secondaryTraceCode	کد رهگیری اختصاصی ثانویه
discountCode	کد تخفیف

/api/OM/v3/Orders/WithPreDefinedAddresses

پارامترهای ثبت سفارش با آدرس‌های از پیش تعریف شده

Parameter Table

originId	ثبت کرده‌ایم addressbook آیدی آدرس مبدا که از قبل در
destinationId	ثبت کرده‌ایم addressbook آیدی آدرس مقصد که از قبل در

/api/OM/v3/Orders/WithPreDefinedOrigin

پارامترهای ثبت سفارش با مبدا از پیش تعریف شده

Parameter Table

originId

ثبت کرده‌ایم addressbook آیدی آدرس مبدا که از قبل در

/api/OM/v3/Orders/WithDiscount

پارامترهای ثبت سفارش با استفاده از کد تخفیف

Parameter Table

discountCode

کد تخفیف

/api/OM/v3/ParcelBooks

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

Parameter Table

title	عنوان بسته
length	طول بسته
width	عرض بسته
height	ارتفاع بسته
packageValue	ارزش بسته پستی
weight	وزن بسته
packType	10: پاکت
	20: بسته

packageContentId	(packContentRate تمامی مقادیر ممکن در متد) محتویات مثل: عمومی، شکستنی
packingId	(PackingPrices تمامی مقادیر ممکن در متد) نوع بسته‌بندی مثال: کارتن سایز 1
isUnusual	(true/false) آیا بسته غیراستاندارد است

پارامترهای API ای تیپاکس > بسته‌ها (Parcels)

پارامترهای این بخش، مشابه پارامترهای بخش رهگیری (tracking) است.

پارامترهای API ای تیپاکس > برآورد هزینه (Pricing)

/api/OM/v3/Pricing

پارامترهای برآورد هزینه

Parameter Table

origin.cityId	آیدی شهر مبدا
destination.cityId	آیدی شهر مقصد
weight	وزن بسته
packageValue	ارزش بسته پستی
length	طول بسته
width	عرض بسته
height	ارتفاع بسته
packingId	(تمامی مقادیر ممکن در متد PackingPrices) نوع بسته بندی مثال : کارتن سایز 1
packageContentId	(تمامی مقادیر ممکن در متد packContentRate) محتویات مثل : عمومی , شکستنی
parcelBookId	آیدی بسته های تعریف شده مشتری
isUnusual	آیا بسته غیر استاندارد است (true/false)
packType	نوع – 10:پاکت – 20:بسته
paymentType	نوع پرداخت- 10:سمت فرستنده-اعتباری – 20:سمت گیرنده -پسکرایه – 30:سمت گیرنده-پرداخت در محل- 40:سمت فرستنده-پرداخت در محل- 50:سمت فرستنده-پرداخت از کیف پول 80-سمت فرستنده-نقدی (تمامی مقادیر ممکن در متد PaymentType)
pickupType	نوع جمع آوری - 10:جمع آوری در محل مشتری – 20:جمع آوری در نمایندگی
distributionType	نوع تحویل- 10:تحویل در محل مشتری – 20:تحویل در نمایندگی
Serviced	نوع سرویس- 1:ارسال زمینی همان روز – 2:ارسال زمینی یک روزه- 3:ارسال زمینی دو روزه- 5:اکسپرس ویژه بین شهری- 6:"بین الملل- 7:اکسپرس درون شهری
discountCode	کد تخفیف
customerId	کد مشتری

/api/OM/v3/Pricing/Min

پارامترهای برآورد حداقل قیمت (با آیدی شهر مبدا و مقصد)

Parameter Table

originCityId	آیدی شهر مبدا
destinationCityIds	آیدی شهر مقصد

پارامترهای API ای تیپاکس > تیکت پشتیبانی (Ticketing)

/api/OM/v3/Ticketing

پارامترهای ثبت تیکت پشتیبانی

Parameter Table

departmentId	(GetDepartments تمامی مقادیر ممکن در متد) آیدی دپارتمان
priorityId	الویت
subject	موضوع
description	توضیحات

/api/OM/v3/Ticketing/Answer

پارامترهای ثبت پاسخ تیکت

Parameter Table

Text	متن پاسخ تیکت
ticketId	آیدی تیکتی که می‌خواهیم به آن پاسخ دهیم

پارامترهای API ای تیپاکس > رهگیری بسته‌ها (Tracking)

/api/OM/v3/Tracking/BriefTracking/{trackingInput}

پارامترهای رهگیری بسته از طریق بارکد

Parameter Table

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	تلفن فرستنده
senderAddress	آدرس فرستنده
senderCityName	نام شهر فرستنده
totalWeight	وزن بسته‌ها
barcode	بارکدها

/api/OM/v3/Tracking/ByTrackingCode

پارامترهای رهگیری چند بسته با کد رهگیری

Package Tracking Table

traceCode	کد رهگیری مشتری
secondaryTraceCode	کد رهگیری ثانویه مشتری
status	وضعیت فعلی بسته
statusId	آیدی وضعیت بسته
origin	آدرس فرستنده
originState	استان فرستنده
originCity	شهر فرستنده
destination	آدرس مقصد
destinationState	استان مقصد
destinationCity	شهر مقصد
description	توضیحات
paymentType	نوع پرداخت
مشخصات بسته
length	طول
width	عرض
height	ارتفاع
value	ارزش
weight	وزن
packageType	(packagingPrices) آیدی نوع بسته‌بندی
title	عنوان نوع بسته‌بندی
packageContentTitle	محتویات بسته مثل : عمومی , شکستنی
isFragile	آیا بسته شکستنی است؟
parcelStatusHistories	تاریخچه وضعیت بسته
جزئیات قیمت
jetIdContractAmountInfo	کد قرارداد جت
shippingCost	هزینه حمل‌ونقل
packageService	هزینه بسته‌بندی
tax	مالیات
discountCode	کد تخفیف
finalAmount	مبلغ نهایی
paymentKindName	نوع پرداخت
cashAmount	مبلغ نقدی
payInPlaceAmount	مبلغ پس‌کرایه
organizationalServices	خدمات سازمانی
distanceDay	تخمین زمان تحویل بسته

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