وظائف واجهة برمجة تطبيقات المتجر
من خلال وظائف واجهة برمجة التطبيقات هذه، يمكنك إدارة مخزون متجر الحيوانات الأليفة والطلبات الخاصة بك.
الحصول على مخزون الحيوانات الأليفة
إرجاع مخزون الحيوانات الأليفة حسب الحالة.
نقطة النهاية: https://petstore3.swagger.io/api/v3/store/inventory
العملية: GET
أمثلة
- API Key
- OAuth 2.0
GET "https://petstore3.swagger.io/api/v3/store/inventory" \
-H "accept: application/json" \
-H "api_key: <YOUR_API_KEY>"
GET "https://petstore3.swagger.io/api/v3/store/inventory" \
-H "accept: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>"
الردود
| الرمز | الوصف |
|---|---|
| 200 | عملية ناجحة |
| default | خطأ غير متوقع |
مثال على الاستجابة
200: عملية ناجحة
{
"sold": 0,
"available": 0,
"pending": 0
}
المعلمات
لا يوجد
تقديم طلب
يضع طلبًا لحيوان أليف.
نقطة النهاية: https://petstore3.swagger.io/api/v3/store/order
العملية: POST
أمثلة
- API Key
- OAuth 2.0
POST "https://petstore3.swagger.io/api/v3/store/order" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "api_key: <YOUR_API_KEY>" \
-d '{
"id": 0,
"petId": 0,
"quantity": 0,
"shipDate": "2025-08-11T15:13:06.939Z",
"status": "placed",
"complete": false
}'
POST "https://petstore3.swagger.io/api/v3/store/order" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>" \
-d '{
"id": 0,
"petId": 0,
"quantity": 0,
"shipDate": "2025-08-11T15:13:06.939Z",
"status": "placed",
"complete": false
}'
الردود
| الرمز | الوصف |
|---|---|
| 200 | عملية ناجحة |
| 400 | طلب غير صالح |
| default | خطأ غير متوقع |
مثال على الاستجابة
200: عملية ناجحة
{
"id": 0,
"petId": 0,
"quantity": 0,
"shipDate": "2025-08-11T15:13:06.939Z",
"status": "placed",
"complete": false
}
المعلمات
هيئة الطلب
| الاسم | النوع | الوصف |
|---|---|---|
| الجسم | كائن الطلب | (مطلوب) كائن Order للحيوان الأليف. |
العثور على طلب
يبحث عن طلب عن طريق معرفه.
نقطة النهاية: https://petstore3.swagger.io/api/v3/store/order/{orderId}
العملية: GET
أمثلة
- API Key
- OAuth 2.0
GET "https://petstore3.swagger.io/api/v3/store/order/1" \
-H "accept: application/json" \
-H "api_key: <YOUR_API_KEY>"
GET "https://petstore3.swagger.io/api/v3/store/order/1" \
-H "accept: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>"
الردود
| الرمز | الوصف |
|---|---|
| 200 | عملية ناجحة |
| 400 | تم توفير معرف غير صالح |
| 404 | الطلب غير موجود |
| default | خطأ غير متوقع |
مثال على الاستجابة
200: عملية ناجحة
{
"id": 1,
"petId": 0,
"quantity": 0,
"shipDate": "2025-08-11T15:13:06.939Z",
"status": "placed",
"complete": false
}
المعلمات
معلمات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| orderId | integer | معرف طلب الشراء المطلوب جلبه |
حذف أمر شراء
يقوم بحذف أمر شراء بواسطة معرّفه.
نقطة النهاية: https://petstore3.swagger.io/api/v3/store/order/{orderId}
العملية: DELETE
أمثلة
- API Key
- OAuth 2.0
DELETE "https://petstore3.swagger.io/api/v3/store/order/1" \
-H "accept: application/json" \
-H "api_key: <YOUR_API_KEY>"
DELETE "https://petstore3.swagger.io/api/v3/store/order/1" \
-H "accept: application/json" \
-H "Authorization: Bearer <YOUR_OAUTH_TOKEN>"
الردود
| الرمز | الوصف |
|---|---|
| 200 | تم حذف الطلب |
| 400 | تم توفير معرف غير صالح |
| 404 | الطلب غير موجود |
| default | خطأ غير متوقع |
(يؤدي الحذف الناجح إلى إرجاع الرمز 200 بدون نص استجابة).
المعلمات
معلمات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| orderId | integer | معرف الطلب المراد حذفه |