createRefundRequest
إنشاء طلب استرداد لطلب. 🔐 تتطلب هذه الطريقة التفويض.
الوصف
ينشئ طلب استرداد للطلب ذي المعرّف المحدد. يُعيد true عند النجاح.
في body.products، اذكر المنتجات المراد استردادها كخريطة من معرّف المنتج إلى { quantity }؛ وnote اختياري.
يجب أن ينتمي الطلب إلى المستخدم وأن يكون مدفوعًا بالكامل، ولا يمكن أن يكون له سوى طلب استرداد معلّق واحد في كل مرة. لتغيير طلب معلّق، ألغِه باستخدام cancelRefundRequest() وأنشئ طلبًا جديدًا.
.createRefundRequest(
,
);
مخطط المعلمات
المخطط
id(required): number
معرّف الطلب.
مثال: 1
body(required): ICreateRefundRequest
بيانات طلب الاسترداد.
body.products(required): Record<string, IRefundProduct>
تفاصيل الاسترداد مفهرسة حسب معرّف المنتج.
مثال:
{ "146": { "quantity": 1 } }
body.note: string
ملاحظة مرفقة بطلب الاسترداد. مطلوبة من API (يعرّفها SDK اختيارية للحفاظ على التوافق الخلفي — مرّرها لتجنب خطأ 400).
مثال: "test"
أمثلة
مثال بسيط
const response = await Orders.createRefundRequest(476, {
products: { '2957': { quantity: 1 } },
note: 'Damaged on delivery',
});
مثال على الاستجابة
true