مرجع API · الكتالوج

قراءة فئة فرعية

GET/v1/wallets/{walletId}/catalog/subcategories/{subcategoryId}

فئة فرعية واحدة.

الصلاحيةcatalogue:read
المصادقةقراءة موقَّعة
حدود الموظفين التي يُحتسب ضمنهاكل الاستدعاءات
حزمة SDK لـ ‎.NETanis.Catalogue.GetSubcategoryAsync(walletId, subcategoryId)

المعاملات

الاسمالموضعالنوعملاحظات
walletIdإلزاميpathUUIDمعرّف UUID بأحرف صغيرة مع الشرطات.
subcategoryIdإلزاميpathUUIDمعرّف UUID بأحرف صغيرة مع الشرطات.

الاستدعاء

موقَّعة بمفتاحك. بلا محتوى وبلا رقم استخدام لمرة واحدة (nonce).

الترويسات: Signature-Input، Signature، X-Anis-Date، Accept-Language (اختياري). تضبطها حزم SDK كلها نيابةً عنك.

المحتوى: لا يوجد.

الردود

الحالةالمعنىالمحتوى
200نجاح.CatalogueObject
401مرفوض: لم تتم المصادقة.مشكلة
403مرفوض: غير مسموح.مشكلة
404مرفوض: غير موجود، أو ليس لك.مشكلة
429مرفوض: بلغتَ حدًا.مشكلة
503لا قرار: خدمة مطلوبة غير متاحة.مشكلة

كل ردّ موقَّع من أنيس؛ وتتحقق منه حزم SDK قبل أن يصلك.

حالات الرفض

كل رفض مشكلةٌ موقَّعة. ابنِ منطقك على رمزها code؛ وكلٌّ منها يرتبط بصفحة تشرح معناه وما عليك فعله.

الخطأالرمزالحالة
بيانات اعتماد غير صالحةinvalid_credentials401
صلاحية غير كافيةinsufficient_scope403
عنوان المصدر غير مسموحsource_ip_not_allowed403
تجاوزت حدّ الاستدعاءاتrate_limited429
الحساب غير مخوَّلbinding_not_authorized403
الحساب غير فعّالaccount_inactive403
المحفظة غير ممنوحةwallet_not_granted404
غير موجودresource_not_found404
الخدمة غير متاحةdependency_unavailable503
انتهت مهلة الاستدعاءrequest_timeout504
خطأ داخليinternal_error500

الأنواع

CatalogueObject

واحد من: CatalogueCategory, CatalogueSubcategory, CatalogueCard — كل مسار يُرجع نوعًا واحدًا منها بالضبط.

CatalogueCategory

الحقلالنوعملاحظات
idموجود دائمًاUUIDمعرّف الفئة.
nameLocalizedTextاسم الفئة، بالعربية والإنجليزية.
descriptionLocalizedTextوصف، بالعربية والإنجليزية.
logostringعنوان صورة شعار الفئة.
typestringهل الفئة محلية أم دولية. القيم: local, international
inStockموجود دائمًاbooleanهل يمكن شراء أي شيء فيها الآن.
displayOrderموجود دائمًاintegerترتيب عرض الفئات — الأصغر أولًا.

LocalizedText

الحقلالنوعملاحظات
arstringالنص العربي.
enstringالنص الإنجليزي.

CatalogueSubcategory

الحقلالنوعملاحظات
idموجود دائمًاUUIDمعرّف الفئة الفرعية.
categoryIdموجود دائمًاUUIDالفئة التي تتبع لها.
nameLocalizedTextاسم الفئة الفرعية، بالعربية والإنجليزية.
descriptionLocalizedTextوصف، بالعربية والإنجليزية.
logostringعنوان صورة شعار الفئة الفرعية.
isBestSellingموجود دائمًاbooleanعلّمتها أنيس بأنها من الأكثر مبيعًا.
displayOrderموجود دائمًاintegerترتيب عرض الفئات الفرعية — الأصغر أولًا.
availableموجود دائمًاbooleanهل يمكن الشراء منها الآن.

CatalogueCard

الحقلالنوعملاحظات
idموجود دائمًاUUIDمعرّف البطاقة — وهو cardId الذي يحمله طلب الشراء.
subcategoryIdموجود دائمًاUUIDالفئة الفرعية التي تتبع لها.
nameLocalizedTextاسم البطاقة، بالعربية والإنجليزية.
faceValuestringالقيمة المطبوعة على البطاقة، إن وُجدت.
unitPriceMoneyالسعر الذي تدفعه هذه المحفظة. أرسله دون تغيير في expectedUnitPrice لطلب الشراء. البطاقة التي لا تملكه لا يمكن بيعها لهذه المحفظة.
businessPriceMoneyللعرض فقط. طلب الشراء بهذا السعر قد يُرفض بـ price_changed.
personalPriceMoneyسعر التجزئة، ويُعرض فقط ما دام أعلى من سعر الأعمال. للعرض فقط.
hasSpecialOfferموجود دائمًاbooleanهل يوجد عرض خاص.
specialOfferPriceMoneyسعر العرض، ويُعرض فقط مع العرض الخاص. للعرض فقط.
availableموجود دائمًاbooleanهل يمكن شراء البطاقة الآن.

Money

الحقلالنوعملاحظات
amountموجود دائمًاstringنصّ عشري بثلاث خانات عشرية بالضبط، مثل "10.500" — وليس رقم JSON أبدًا.
currencyموجود دائمًاstringرمز العملة، مثل LYD: وهو دائمًا عملة المحفظة.
asOfstring (date-time)وقت قراءة هذا السعر أو الرصيد.