كيف تقرأ عمود الباقة؟يشير الوسم إلى أدنى باقة تتضمن نقطة النهاية، فـ Starter+ تعني باقة الانطلاق وباقة النمو وPro وباقة الأعمال. والملاحظات الموجودة بجانبه شروط إضافية: إضافة (Add-on)، أو حد استخدام، أو قيد على ما تقبله نقطة النهاية.عنوان URL الأساسي لها جميعًا:
https://api.tryoto.com. ويحتاج كل استدعاء إلى Authorization: Bearer <access_token> — راجع التوثيق.التفويض
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Refresh Token استبدال رمز التحديث الدائم برمز وصول صالح لمدة ساعة. | POST /rest/v2/refreshToken | Free+ |
| Health Check هل المنصة تعمل؟ لا تحتاج فعليًا إلى توثيق، ومفيدة لاختبار الاتصال. | GET /rest/v2/healthCheck | Free+ |
الحساب
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Account Info ملف حسابك ورصيدك الحالي. | GET /rest/v2/accountInfo | Free+ |
| Buy Credit شحن رصيد محفظة الشحن. | POST /rest/v2/buyCredit | Free+ |
| Request Mobile Verification إرسال رمز تحقق إلى رقم جوال. | POST /rest/v2/requestMobileVerification | Free+ |
| Verify Mobile Number تأكيد الرمز. أُضيفت للحسابات الفرعية في السوق الإلكترونية، مارس 2026. | POST /rest/v2/verifyMobileNumber | Free+ |
المعاملات
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Get Shipping Price Transactions List المبلغ الذي حُسب على كل شحنة، مع سطر السعر الذي نتج عنه. | POST /rest/v2/getShippingPriceTransactionsList | Starter+ |
| Credit Transactions حركات المحفظة. | GET /rest/v2/creditTransactions | Free+ |
| Shipment Transactions الرسوم على مستوى الشحنة، مع إمكانية الفلترة حسب التاريخ والطلب. | GET /rest/v2/shipmentTransactions | Free+ |
| COD Transactions رصيد محفظة الدفع عند الاستلام، والتحويلات القادمة، والسحوبات، والسجل. أُضيفت في سبتمبر 2026. | GET /rest/v2/codTransactions | Free+ |
السوق الإلكترونية (Marketplace)
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Register إنشاء حساب فرعي لبائع تحت الحساب الرئيسي للسوق الإلكترونية. | POST /rest/v2/marketplace/register | Free+ يتطلب رمز marketplace |
| Client Info تحديث بيانات حساب فرعي. | POST /rest/v2/marketplace/clientInfo | Free+ يتطلب رمز marketplace |
| Client Info قراءة بيانات حساب فرعي. | GET /rest/v2/marketplace/clientInfo | Free+ يتطلب رمز marketplace |
الطلبات
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Create Order نقطة البداية: العميل، والعنوان، والمنتجات، وطريقة الدفع. | POST /rest/v2/createOrder | Free+ |
| Update Order تعديل طلب لم تُنشأ له شحنة بعد. | POST /rest/v2/updateOrder | Free+ |
| Update Order Status فرض حالة معينة (delivered أو returned أو pickedUp) من نظامك الخاص. | POST /rest/v2/updateOrderStatus | Scale+ |
| Cancel Order الإلغاء قبل الشحن. | POST /rest/v2/cancelOrder | Free+ |
| Get Orders قائمة مقسمة إلى صفحات وقابلة للفلترة. | GET /rest/v2/orders | Free+ |
| Hold Order تعليق الطلب دون إلغائه. | POST /rest/v2/holdOrder | Free+ |
| Unhold Order إعادته إلى قائمة الانتظار. | POST /rest/v2/unHoldOrder | Free+ |
| Get Order Details كل البيانات المسجلة على طلب واحد. | GET /rest/v2/orderDetails | Free+ |
| Check Order Availability هل يمكن تنفيذ هذا الطلب، ومن أين، قبل أن تلتزم به. | POST /rest/v2/checkOrderAvailability | Pro+ |
أسعار الشحن
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Check OTO Delivery Fee الأسعار ومواعيد التوصيل المتوقعة ومواعيد الإغلاق لطرد محتمل. وهي نقطة النهاية المخصصة لصفحة الدفع. | POST /rest/v2/checkOTODeliveryFee | Free+ |
| Check Delivery Fee الأسعار وفق عقودك الخاصة المتفاوَض عليها مع شركات الشحن. | POST /rest/v2/checkDeliveryFee | Starter+ |
| Get Delivery Fee رسوم طلب موجود بالفعل. | POST /rest/v2/getDeliveryFee | Free+ |
| Get Delivery Options خيارات التوصيل المضبوطة في حسابك. | GET /rest/v2/getDeliveryOptions | Starter+ |
الشحنات
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Create Shipment حجز الطرد مع شركة شحن. تقبل deliveryOptionId، أو تختار نيابةً عنك. | POST /rest/v2/createShipment | Free+ |
| Cancel Shipment الإلغاء لدى شركة الشحن. | POST /rest/v2/cancelShipment | Free+ |
شحنات الإرجاع
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Create Return Shipment حجز رحلة الإرجاع. | POST /rest/v2/createReturnShipment | Free+ |
| Get Return Link رابط بوابة الإرجاع الموجّه للعميل لطلب واحد. | POST /rest/v2/getReturnLink | Starter+ |
| Get Return Details حالة عملية الإرجاع. | POST /rest/v2/getReturnDetails | Free+ |
| Trigger Return SMS إرسال رابط الإرجاع إلى العميل برسالة نصية. | POST /rest/v2/triggerReturnSms | Starter+ |
الطباعة
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Print AWB بوليصة الشحن (AWB) الخاصة بطلب. | GET /rest/v2/print/orderId | Free+ |
| Print Label مستندات الطلب: بوليصة الشحن، أو الفاتورة الأولية، أو معلومات الطلب، أو مستند الإرجاع. | POST /rest/v2/printLabel | Free+ غير مدرجة في جدول الباقات |
التتبع
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Order Tracking الحالة الحالية للطلب. | POST /rest/v2/orderStatus | Free+ |
| Order History سجل الأحداث كاملًا، بصيغة موحدة بين شركات الشحن. | POST /rest/v2/orderHistory | Free+ |
| Track Shipment تتبع الشحنة على مستوى شركة الشحن. | POST /rest/v2/trackShipment | Enterprise+ |
إشعارات العملاء
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Customer Notifications الرسائل التي أُرسلت إلى العميل بشأن طلب ما، وما آلت إليه. | GET /rest/v2/orders/{orderId}/customer-notifications | Scale+ |
ربط شركات الشحن
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Get Delivery Estimation نافذة التوصيل المتوقعة لمسار شحن معين. | POST /rest/v2/getDeliveryEstimation | Scale+ |
| AI Estimated Delivery Dates مواعيد توصيل يتوقعها النموذج، بدلًا من مستوى الخدمة المعلن من شركة الشحن. | POST /rest/v2/aiEstimatedDeliveryDates | Scale+ |
| Check Coverage هل توجد شركة توصّل إلى هذه الوجهة؟ | POST /rest/v2/checkCoverage | Starter+ |
| Available Cities المدن التي تغطيها شركات الشحن المفعّلة لديك. | POST /rest/v2/availableCities | Free+ |
| Available Time Slots فترات التوصيل المتاحة للحجز. | POST /rest/v2/availableTimeslots | Starter+ |
| DC List قائمة شركات الشحن. | POST /rest/v2/dcList | Free+ |
| DC Config نموذج بيانات الاعتماد التي تحتاجها شركة شحن معينة. | POST /rest/v2/dcConfig | Starter+ |
| DC Activation تفعيل عقد مع شركة شحن. | POST /rest/v2/dcActivation | Starter+ 3 / 7 / 20 / عدد غير محدود من العقود حسب الباقة |
| Get Cities البيانات المرجعية للمدن. | POST /rest/v2/getCities | Free+ |
| Check DC Branch List فروع التسليم وخزائن الشحن التابعة لشركات الشحن. | POST /rest/v2/checkDCBranchList | Free+ |
نقاط استلام الطلب
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Create Pickup Location إنشاء مركز. تتضمن حقول العنوان الوطني، وservingRadius، وpreparationSla. | POST /rest/v2/createPickupLocation | Free+ نوع الفرع متاح في باقة الأعمال فقط |
| Update Pickup Location تعديل نقطة استلام. | POST /rest/v2/updatePickupLocation | Free+ نوع الفرع متاح في باقة الأعمال فقط |
| Get Pickup Location List عرض قائمة نقاط الاستلام. | GET /rest/v2/getPickupLocationList | Free+ نوع الفرع متاح في باقة الأعمال فقط |
العلامات التجارية
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Get List of Brands العلامات التجارية في الحساب. | GET /rest/v2/getBrandList | Starter+ |
| Create Brand إضافة علامة تجارية. | POST /rest/v2/createBrand | Starter+ |
قنوات البيع
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Sales Channels List قائمة القنوات، مع رمز الربط الخاص بكل قناة. | GET /rest/v2/salesChannel/getSalesChannelsList | Free+ |
| Sales Channel Config نموذج بيانات الاعتماد لقناة واحدة. | POST /rest/v2/salesChannel/getSalesChannelConfig | Free+ |
| Sales Channel Activation ربط القناة. | POST /rest/v2/salesChannel/salesChannelActivation | Free+ 1 / 3 / 5 / عدد غير محدود من القنوات حسب الباقة |
المنتجات
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Create Product إضافة SKU. | POST /rest/v2/createProduct | Free+ |
| Product List عرض قائمة SKU. | POST /rest/v2/productList | Free+ |
| Add Box تعريف صندوق تعبئة. | POST /rest/v2/addBox | Free+ |
| Update Box تعديل صندوق. | POST /rest/v2/updateBox | Free+ |
| Get Box قراءة بيانات صندوق. | GET /rest/v2/getBox | Free+ |
إدارة المخزون (Stock Management)
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Update Stock Quantity ضبط مخزون SKU في موقع معين. | POST /rest/v2/updateStockQuantity | Starter+ يتطلب إضافة WMS |
| Check Inventory Stock المخزون في موقع واحد. | GET /rest/v2/checkInventoryStock | Starter+ يتطلب إضافة WMS |
| Check Global Stock المخزون في جميع المواقع. | GET /rest/v2/checkGlobalStock | Starter+ يتطلب إضافة WMS |
| Create Inventory Order طلب وارد أو طلب تحويل. | POST /rest/v2/createInventoryOrder | Starter+ يتطلب إضافة WMS |
| Update Packing Status الإبلاغ عن تقدم التعبئة من نظام WMS الخاص بك. | POST /rest/v2/updatePackingStatus | Starter+ يتطلب إضافة WMS |
| Get Orders Ready For Packing قائمة انتظار الانتقاء والتعبئة لرمز مستودع واحد. | POST /rest/v2/getPackingOrders | Starter+ يتطلب إضافة WMS |
| Check Available Stores For Pickup الفروع التي تتوفر فيها المنتجات ويمكنها تسليمها. | POST /rest/v2/availableStoresForPickup | Starter+ يتطلب إضافة WMS |
| Available Cities For Pickup المدن التي يتاح فيها الاستلام من الفرع (Click & Collect). | POST /rest/v2/availableCitiesForPickup | Starter+ يتطلب إضافة WMS · غير مدرجة في جدول الباقات |
العنوان الوطني
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Get National Address From Short Code تحويل رمز العنوان المختصر السعودي إلى عنوان كامل. | POST /rest/v2/getNationalAddressFromShortCode | Free+ |
Webhook
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Register a webhook اشتراك عنوان URL في نوع حدث معين. | POST /rest/v2/webhook | Starter+ |
| List webhooks اشتراكاتك المسجلة. | GET /rest/v2/webhook | Starter+ |
| Update a webhook تعديل اشتراك قائم باستخدام المعرّف id. | PUT /rest/v2/webhook | Starter+ |
| Delete a webhook حذف اشتراك. | DELETE /rest/v2/webhook | Starter+ |
OTO FLEX
| نقطة النهاية | المسار | الباقة |
|---|---|---|
| Assign Driver إسناد طلب إلى أحد سائقيك الخاصين. | POST /rest/v2/assignDriver | Starter+ |
| Track Driver موقع هذا السائق. | POST /rest/v2/trackDriver | Starter+ |
صفحات ذات صلة
- التوثيق — كيف تستدعي أيًا من نقاط النهاية هذه.
- Webhooks — الأحداث التي تصلك في المقابل.
- apis.tryoto.com — المخططات الكاملة وأمثلة قابلة للتشغيل.