API

توثيق واجهات الربط - طرود

فتح التوثيق على Postman

Get Countries

GET

جلب جميع الدول المتاحة.

GET https://logisti.torod.co/api/Lookup/countries
Headers
X-API-KEY
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Get Cities

GET

جلب المدن لدولة معيّنة.

GET https://logisti.torod.co/api/Lookup/cites/{countryId}
Headers
X-API-KEY
Query Parameters
  • countryId: معرف الدولة
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Get Consignee Types

GET

أنواع المستلم.

GET https://logisti.torod.co/api/Lookup/ConsigneeTypes
Headers
X-API-KEY
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Get Delivery Types

GET

أنواع التسليم.

GET https://logisti.torod.co/api/Lookup/DeliveryTypes
Headers
X-API-KEY
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Get Parcel Statuses

GET

حالات الشحنة.

GET https://logisti.torod.co/api/Lookup/ParcelStatuses
Headers
X-API-KEY
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Get Tracking Entities

GET

الجهات المسؤولة عن تحديث التتبع.

GET https://logisti.torod.co/api/Lookup/ParcelTrackingEntities
Headers
X-API-KEY
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Get Parcel Types

GET

أنواع الشحنات.

GET https://logisti.torod.co/api/Lookup/ParcelTypes
Headers
X-API-KEY
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Get Payment Methods

GET

طرق الدفع.

GET https://logisti.torod.co/api/Lookup/PaymentMethods
Headers
X-API-KEY
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Get Payment Types

GET

أنواع الدفع.

GET https://logisti.torod.co/api/Lookup/PaymentTypes
Headers
X-API-KEY
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Get Shipper Types

GET

أنواع المرسل.

GET https://logisti.torod.co/api/Lookup/ShipperTypes
Headers
X-API-KEY
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Get Pickup Types

GET

أنواع الاستلام.

GET https://logisti.torod.co/api/Lookup/PickupTypes
Headers
X-API-KEY
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Get Data Entries

GET

قائمة بيانات الإحصائيات.

GET https://logisti.torod.co/api/Lookup/dataEntries
Headers
X-API-KEY
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Get Complaint Statuses

GET

حالات الشكوى.

GET https://logisti.torod.co/api/Lookup/ComplaintStatuses
Headers
X-API-KEY
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Add Parcel

POST

إنشاء شحنة جديدة.

POST https://logisti.torod.co/api/Parcel/Add
Headers
X-API-KEY Content-Type: application/json
Body Example
{
    "ParcelDetails": "…"
    ,    "ShipperDetails": "…"
    ,    "ConsigneeDetails": "…"
    ,    "FinancialDetails": "…"
    }
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Assign Parcel

POST

ربط الشحنة بمندوب.

POST https://logisti.torod.co/api/parcelAssigning/assign
Headers
X-API-KEY Content-Type: application/json
Body Example
{
    "wayBillNumberList": "…"
    ,    "agentIdentityNumber": "…"
    ,    "vehicleSequenceNumber": "…"
    ,    "assignDate": "…"
    }
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Update Parcel Details

POST

تحديث بيانات الشحنة.

POST https://logisti.torod.co/api/Parcel/UpdateParcelDetails
Headers
X-API-KEY Content-Type: application/json
Body Example
{
    "WayBillNumber": "…"
    ,    "ParcelType": "…"
    ,    "ParcelWeight": "…"
    ,    "numberOfPieces": "…"
    ,    "expectedDeliveryDate": "…"
    }
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Add Tracking Event

POST

إضافة تحديث تتبع جديد.

POST https://logisti.torod.co/api/Parcel/Tracking
Headers
X-API-KEY Content-Type: application/json
Body Example
{
    "WayBillNumber": "…"
    ,    "ParcelStatus": "…"
    }
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Get Tracking by Parcel Id

GET

قراءة تتبع حسب المعرف.

GET https://logisti.torod.co/api/Parcel/Tracking/GetByParcelId
Headers
X-API-KEY
Query Parameters
  • Id: معرف الشحنة
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Add Complaint

POST

إنشاء شكوى.

POST https://logisti.torod.co/api/complaint/add
Headers
X-API-KEY Content-Type: application/json
Body Example
{
    "WayBillNumber": "…"
    ,    "ComplaintNumber": "…"
    }
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Add Complaint Tracking

POST

إضافة تحديث شكوى.

POST https://logisti.torod.co/api/complaint/tracking
Headers
X-API-KEY Content-Type: application/json
Body Example
{
    "WayBillNumber": "…"
    }
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

List Data Entries

GET

قراءة بيانات KPI.

GET https://logisti.torod.co/api/entryData/listDataEntries/{year}/{month}
Headers
X-API-KEY
Query Parameters
  • year: السنة
  • month: الشهر
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Set Data Entries

POST

تعديل بيانات KPI.

POST https://logisti.torod.co/api/entryData/setDataEntries/{year}/{month}
Headers
X-API-KEY Content-Type: application/json
Query Parameters
  • year: السنة
  • month: الشهر
Body Example
{
    "[]number": "…"
    ,    "[]value": "…"
    }
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Create Support Request

POST

إنشاء طلب دعم.

POST https://logisti.torod.co/api/requests
Headers
X-API-KEY Content-Type: application/json
Body Example
{
    "email": "…"
    ,    "service_type_code": "…"
    ,    "company_name": "…"
    }
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}

Get Request Status

GET

التحقق من الطلب.

GET https://logisti.torod.co/api/requests/{request_id}
Headers
X-API-KEY
Query Parameters
  • request_id: رقم الطلب
Response Example
{
  "isSuccess": true,
  "data": {},
  "errors": null,
  "buildNumber": "1.0.2"
}