تتيح لك واجهة برمجة التطبيقات الخاصة بنا إنشاء موقع استلام حيث يمكن جمع الشحنات. يمكن أن يكون الموقع إما فرع أو مستودع. يشرح هذا الدليل كيفية استخدام نقطة النهاية createPickupLocation لإضافة موقع استلام جديد.
التعليمات
الخطوة 1: نقطة نهاية واجهة برمجة التطبيقات
- لإنشاء موقع استلام، استخدم نقطة النهاية POST التالية:
https://api.tryoto.com/rest/v2/createPickupLocation
الخطوة 2: التفويض
- يجب تضمين رمز Bearer صالح في رؤوس الطلب لأغراض المصادقة
الخطوة 3: معلمات جسم الطلب
- يجب أن يكون جسم الطلب بتنسيق JSON ويجب أن يتضمن على الأقل مرشح تاريخ واحد.
| الاسم | مطلوب | النوع | الوصف |
|---|---|---|---|
| name | نعم | string | اسم موقع الاستلام |
| type | لا | string | branch,warehouse. الافتراضي هو warehouse |
| code | نعم | string | رمز موقع الاستلام |
| mobile | نعم | string | رقم الجوال لموقع الاستلام |
| lat | لا | number | خط العرض، *إذا لم يكن موجودًا، قد لا يتم تعيين الطلبات تلقائيًا إلى مواقع الاستلام |
| lon | لا | number | خط الطول، * إذا لم يكن موجودًا، قد لا يتم تعيين الطلبات تلقائيًا إلى مواقع الاستلام |
| city | نعم | string | اسم المدينة لموقع الاستلام |
| country | نعم | string | رمز ISO2 للبلد "SA","AE" إلخ. |
| postcode | لا | string | الرمز البريدي لموقع الاستلام |
| address | نعم | string | عنوان الشارع لموقع الاستلام |
| contactName | نعم | string | إذا لم يكن موجودًا، قد لا تتمكن من إنشاء شحنات مع بعض شركات التوصيل |
| contactEmail | نعم | string | بتنسيق test@example.com |
| servingRadius | لا | number | نصف قطر الخدمة للفرع بالكيلومترات |
| brandName | لا | string | اسم العلامة التجارية للمتجر الذي ينتمي إليه هذا الموقع. |
| status | لا | string | حالة موقع الاستلام (نشط، غير نشط) |
الخطوة 4: طلب مثال
فيما يلي مثال على طلب لإنشاء مستودع:
باستخدام cURL:
curl --location 'https://api.tryoto.com/rest/v2/createPickupLocation' \ --data '{ "type": "warehouse", "code": "code-01", "name": "Location Name", "mobile": "555888777", "address": "Test warehouse 3539, Al Khalidiyyah Al Janubiyyah, Dammam 32225", "contactName": "Test Contact", "contactEmail": "Test Email", "lat": "26.001", "lon": "50.001", "city": "Dammam", "district":"Al Khalidiyyah", "street":"Al Janubiyyah", "state":"Eastern Province", "country":"SA", "postcode": "12345", "servingRadius": "10", "brandName": "Example Seller", "status": "active" }'
الخطوة 5: استجابة المثال
- ستعيد استجابة ناجحة تفاصيل موقع الاستلام الذي تم إنشاؤه حديثًا:
{ "warhouseId": "123", "pickupLocationCode": "code-01", "success": true, "message": "warhouse has been created" }
