توفر واجهة برمجة التطبيقات هذه حالة الطلب الحالية وجدول شحن الطلب وأيضا قائمة بالعناصر بالترتيب بناء على المعلمات التي تم تمريرها في الطلب.
ويستند المعلومات التي تم إرجاعها على حساب مسجل.
التوفُّر حسب الدولة - قائمة بالدول التي قمنا باختبار أداء وتوفر وزمن الاستجابة للواجهة البرمجية:
- الأرجنتين، أستراليا، النمسا، بلجيكا، البرازيل، بلغاريا، كندا، تشيلي، كولومبيا، كرواتيا، الدنمارك، الإكوادور، إستونيا، فنلندا، فرنسا، ألمانيا، اليونان، المجر، الهند، إندونيسيا، أيرلندا، كازاخستان، لاتفيا، ليتوانيا، المكسيك، هولندا، نيوزيلندا، النرويج، بيرو، بولندا، البرتغال، رومانيا، روسيا، صربيا، سنغافورة، سلوفينيا، إسبانيا، السويد، سويسرا، تركيا، أوكرانيا، الولايات المتحدة الأمريكية وفيتنام.
إذا لم يتم ذكر بلدك في القائمة، يمكنك التواصل معنا مباشرةً أو مع نقطة الاتصال لدى شنايدر (POC) للتحقق مما إذا كان بلدك لديه الوصول إلى هذه الواجهة البرمجية
سيتطلب الوصول إلى واجهة برمجة التطبيقات مصادقة أووث ، يرجى الرجوع إلى التفاصيل الموجودة على البوابة.
- تدعم واجهة برمجة التطبيقات هذه ترقيم الصفحات ، يرجى الرجوع إلى التفاصيل أدناه لفهم كيفية عمل ترقيم الصفحات:
- عندما يطلب أبي مع المعلمات لإرجاع قائمة طويلة جدا من العناصر ، يتم ترحيل الاستجابة من أجل تجنب الحمولة الثقيلة وازدحام ن/ث.
- يمكن تعيين معلمة طلب للإشارة إلى عدد العناصر التي يجب إرجاعها في استجابة واجهة برمجة تطبيقات واحدة. (حجم الصفحة<=100)
ملاحظة: حجم الصفحة الافتراضي هو 10 - تقوم كل استجابة لواجهة برمجة التطبيقات أيضا بإرجاع معلمات مثل إجمالي عدد السجلات وإجمالي عدد الصفحات ورقم الصفحة.
- إجمالي عدد السجلات: كم عدد السجلات المؤهلة للإرجاع استجابة وفقا للمعلمات التي تم تمريرها في الطلب
- إجمالي عدد الصفحات: عدد الصفحات المتوقعة بناء على حجم الصفحة الحالي وإجمالي عدد السجلات. على سبيل المثال ، سيتطلب 100 سجل بحجم الصفحة 10 10 صفحات.
- رقم الصفحة: مطلوب استجابة رقم الصفحة.
سيتطلب الوصول إلى واجهة برمجة التطبيقات مصادقة أووث ، يرجى الرجوع إلى التفاصيل الموجودة على البوابة.
المعلمات المدعومة في واجهة برمجة التطبيقات:
| المعلمة | نوع البيانات | الوصف | مثال |
| country | string | رمز البلد المطلوب تفاصيل الطلب. | US |
| order-number | string | رقم الطلب في نظام تخطيط موارد المؤسسات ، يمكن أن يكون هذا قيمة الطلب بالكامل أو قيمة "بداية" | AB12345 |
| order-status | string | حالة الطلب الحالية في تخطيط موارد المؤسسات | Delivered |
| page | string | رقم الصفحة الحالي حسب عدد السجلات وحجم الصفحة | 1 |
| page-size | string | عدد السجلات المتوقعة استجابة | 10 |
| item-number | string | رقم البند من عنصر معين في الترتيب | 79895 |
تدعم واجهة برمجة التطبيقات هذه 3 عمليات على النحو التالي:
| مسار الموارد | المعلمات الإلزامية | معلمات اختيارية | الاستجابة المتوقعة |
| /orders/{country} | country | Order-number, order-status, page, page-size | جميع الطلبات المرتبطة بالحساب في البلد المطلوب |
| /orders/{country}/{order-number}/{item-number}/shipment-schedules | Country, order-number, item-number | N/A | سيتم إرجاع جدول الشحن للبند المطلوب بالترتيب |
| /orders/{country}/{order-number} | Country, order-number | Item-number | يتم إرجاع معلومات عامة جنبا إلى جنب مع جدول شحنة من البنود/البند في النظام. |
