مخططات البيانات: الإرجاع والشكاوى والاستبدال

مخططات البيانات: الإرجاع والشكاوى والاستبدال. حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

مخططات البيانات

عرض القائمة — الإرجاع والشكاوى والاستبدال — الاستجابة

ApiResponse_list_RequestSummaryData__ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

dataمصفوفة <RequestSummaryData > مطلوب: مثال على الاستجابة · ApiResponse_list_RequestSummaryData__.

مثال: [{"created_at":"2026-01-01T12:00:00Z","customer":{"email":"customer@example.invalid","name":"Example"},"id":"example","number":"example","order_id":"example","order_number":"example","products_value":{"amount":"0.00","currency":"PLN","minor_units":2},"refund":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1},"resolution_state":"unknown","status":{"id":"example","locale":"en","name":"Example"},"type":"return","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب: البيانات الوصفية للاستجابة.

مثال: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

حقول إضافية: لا

جلب — الإرجاع والشكاوى والاستبدال — الاستجابة

ApiResponse_RequestDetailData_ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

dataRequestDetailData مطلوب: مثال على الاستجابة · RequestDetailData.

مثال: {"created_at":"2026-01-01T12:00:00Z","customer":{"email":"customer@example.invalid","name":"Example"},"id":"example","items":[{"id":"example","name":"Example","order_line_id":"example","product_id":"example","quantity":1,"returned_quantity":1,"sku":"example","total":{"amount":"0.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"0.00","currency":"PLN","minor_units":2},"variant_id":"example","variant_options":[{"name":"Example","value":"example"}]}],"number":"example","order_id":"example","order_number":"example","products_value":{"amount":"0.00","currency":"PLN","minor_units":2},"refund":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1},"resolution_state":"unknown","status":{"id":"example","locale":"en","name":"Example"},"type":"return","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب: البيانات الوصفية للاستجابة.

مثال: {"request_id":"example"}

حقول إضافية: لا

تحديث · مبلغ الاسترداد — الإرجاع والشكاوى والاستبدال — محتوى الطلب

RefundAmountUpdate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

amountسلسلة نصيةمطلوب

مبلغ عشري ممثل كسلسلة JSON؛ يسمح بالقيمة null فقط حيث يكون ذلك مسموحًا.

minLength: 1maxLength: 64

القيود

pattern: "^[+-]?(?:[0-9]+(?:\\.[0-9]+)?|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?$"

مثال: "0.00"

expected_versionعدد صحيحمطلوب

الإصدار المقروء قبل الكتابة؛ يؤدي عدم التطابق إلى رفض التحديث.

minimum: 0maximum: 9223372036854775807

مثال: 1

reasonسلسلة نصيةاختياري

السبب المسجل للتغيير.

maxLength: 500

القيمة الافتراضية: ""

حقول إضافية: لا

معلومات المبلغ المسترد المسجلة

RefundData · المخطط · مخططات البيانات: الإرجاع والشكاوى والاستبدال

amountMoneyData nullمطلوب

مبلغ عشري ممثل كسلسلة JSON؛ يسمح بالقيمة null فقط حيث يكون ذلك مسموحًا.

مثال: {"amount":"0.00","currency":"PLN","minor_units":2}

completed_atسلسلة نصية nullمطلوب

وقت الاكتمال.

سلسلة نصية:format: "date-time"

مثال: null

statusسلسلة نصيةمطلوب

الحالة التي تقبلها هذه العملية تحديدًا.

القيود

enum: ["pending", "completed"]

مثال: "pending"

updated_atسلسلة نصية nullمطلوب

وقت آخر تحديث.

سلسلة نصية:format: "date-time"

مثال: "2026-01-01T12:00:00Z"

versionعدد صحيحمطلوب

إصدار المورد المستخدم للتحكم في التعديلات المتزامنة.

مثال: 1

حقول إضافية: لا

جلب — الإرجاع والشكاوى والاستبدال — الاستجابة

RequestDetailData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

created_atسلسلة نصيةمطلوب

وقت الإنشاء.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"

customerRequestCustomerData مطلوب

معلومات العميل المسجلة لهذا المورد.

مثال: {"email":"customer@example.invalid","name":"Example"}

idسلسلة نصيةمطلوب

معرّف المورد؛ احتفظ به كما أعيد. (RequestDetailData).

مثال: "example"

itemsمصفوفة <RequestItemData > مطلوب

العناصر المضمنة في المورد.

مثال:

[{"id":"example","name":"Example","order_line_id":"example","product_id":"example","quantity":1,"returned_quantity":1,"sku":"example","total":{"amount":"0.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"0.00","currency":"PLN","minor_units":2},"variant_id":"example","variant_options":[{"name":"Example","value":"example"}]}]

numberسلسلة نصيةمطلوب

رقم طلب الشراء أو طلب الخدمة المعروض للمستخدم.

مثال: "example"

order_idسلسلة نصيةمطلوب

معرّف طلب الشراء المرتبط.

مثال: "example"

order_numberسلسلة نصيةمطلوب

رقم طلب الشراء المرتبط.

مثال: "example"

products_valueMoneyData مطلوب

قيمة المنتجات في طلب الشراء.

مثال: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData مطلوب

معلومات المبلغ المسترد المسجلة.

مثال:

{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1}

resolution_stateسلسلة نصيةمطلوب

حالة معالجة طلب خدمة العميل.

القيود

enum: ["unknown", "open", "completed", "rejected", "cancelled"]

مثال: "unknown"

statusRequestStatusData مطلوب

الحالة التي تقبلها هذه العملية تحديدًا.

مثال: {"id":"example","locale":"en","name":"Example"}

typeRequestType مطلوب

نوع المورد.

مثال: "return"

updated_atسلسلة نصيةمطلوب

وقت آخر تحديث.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"

versionعدد صحيحمطلوب

إصدار المورد المستخدم للتحكم في التعديلات المتزامنة.

مثال: 1

حقول إضافية: لا

جلب — الإرجاع والشكاوى والاستبدال — الاستجابة

RequestItemData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

idسلسلة نصيةمطلوب: معرّف المورد؛ احتفظ به كما أعيد. (RequestItemData).

مثال: "example"
nameسلسلة نصيةمطلوب: اسم المورد في السياق المناسب.

مثال: "Example"
order_line_idسلسلة نصية nullمطلوب: معرّف بند طلب الشراء المرتبط.

مثال: "example"
product_idسلسلة نصيةمطلوب: معرّف المنتج.

مثال: "example"
quantityعدد صحيحمطلوب: عدد الوحدات.

مثال: 1
returned_quantityعدد صحيحمطلوب: الكمية المرتجعة لهذا البند.

مثال: 1
skuسلسلة نصيةمطلوب: رمز وحدة حفظ المخزون.

مثال: "example"
totalMoneyData مطلوب: المبلغ الإجمالي.

مثال: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData مطلوب: سعر الوحدة.

مثال: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idسلسلة نصية nullمطلوب: معرّف متغير المنتج.

مثال: "example"
variant_optionsمصفوفة <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > مطلوب: خيارات المتغيرات المرتبطة بالمنتج أو بالبيانات المحفوظة.

مثال: [{"name":"Example","value":"example"}]

حقول إضافية: لا

الحالة التي تقبلها هذه العملية تحديدًا

RequestStatusData · المخطط · مخططات البيانات: الإرجاع والشكاوى والاستبدال

idسلسلة نصيةمطلوب: معرّف المورد؛ احتفظ به كما أعيد. (RequestStatusData).

مثال: "example"
localeسلسلة نصيةمطلوب: اللغة المحددة لهذا الطلب.

مثال: "en"
nameسلسلة نصية nullمطلوب: اسم المورد في السياق المناسب.

مثال: "Example"

حقول إضافية: لا

عرض القائمة · الحالات — الإرجاع والشكاوى والاستبدال — الاستجابة

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

codeسلسلة نصيةمطلوب: رمز ثابت قابل للقراءة آليًا.

مثال: "example"
created_atسلسلة نصيةمطلوب: وقت الإنشاء.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"
idسلسلة نصيةمطلوب: معرّف المورد؛ احتفظ به كما أعيد. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

مثال: "example"
is_initialقيمة منطقيةمطلوب: ما إذا كانت هذه هي الحالة الأولية.

مثال: false
localeسلسلة نصيةمطلوب: اللغة المحددة لهذا الطلب.

مثال: "en"
nameسلسلة نصية nullمطلوب: اسم المورد في السياق المناسب.

مثال: "Example"
positionعدد صحيحمطلوب: الموضع في المجموعة المرتبة.

مثال: 1
typeRequestType مطلوب: نوع المورد.

مثال: "return"

حقول إضافية: لا

عرض القائمة · الحالات — الإرجاع والشكاوى والاستبدال — الاستجابة

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

dataمصفوفة <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > مطلوب: مثال على الاستجابة · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

مثال: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"locale":"en","name":"Example","position":1,"type":"return"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب: البيانات الوصفية للاستجابة.

مثال: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

حقول إضافية: لا

تحديث · الحالة — الإرجاع والشكاوى والاستبدال — محتوى الطلب

RequestStatusUpdate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

expected_versionعدد صحيحمطلوب

الإصدار المقروء قبل الكتابة؛ يؤدي عدم التطابق إلى رفض التحديث.

minimum: 1maximum: 9223372036854775807

مثال: 1

status_idسلسلة نصيةمطلوب

معرّف مأخوذ من دليل الحالات المناسب.

القيود

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

مثال: "example"

حقول إضافية: لا

عرض القائمة — الإرجاع والشكاوى والاستبدال — الاستجابة

RequestSummaryData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

created_atسلسلة نصيةمطلوب

وقت الإنشاء.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"

customerRequestCustomerData مطلوب

معلومات العميل المسجلة لهذا المورد.

مثال: {"email":"customer@example.invalid","name":"Example"}

idسلسلة نصيةمطلوب

معرّف المورد؛ احتفظ به كما أعيد. (RequestSummaryData).

مثال: "example"

numberسلسلة نصيةمطلوب

رقم طلب الشراء أو طلب الخدمة المعروض للمستخدم.

مثال: "example"

order_idسلسلة نصيةمطلوب

معرّف طلب الشراء المرتبط.

مثال: "example"

order_numberسلسلة نصيةمطلوب

رقم طلب الشراء المرتبط.

مثال: "example"

products_valueMoneyData مطلوب

قيمة المنتجات في طلب الشراء.

مثال: {"amount":"0.00","currency":"PLN","minor_units":2}

refundRefundData مطلوب

معلومات المبلغ المسترد المسجلة.

مثال:

{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1}

resolution_stateسلسلة نصيةمطلوب

حالة معالجة طلب خدمة العميل.

القيود

enum: ["unknown", "open", "completed", "rejected", "cancelled"]

مثال: "unknown"

statusRequestStatusData مطلوب

الحالة التي تقبلها هذه العملية تحديدًا.

مثال: {"id":"example","locale":"en","name":"Example"}

typeRequestType مطلوب

نوع المورد.

مثال: "return"

updated_atسلسلة نصيةمطلوب

وقت آخر تحديث.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"

versionعدد صحيحمطلوب

إصدار المورد المستخدم للتحكم في التعديلات المتزامنة.

مثال: 1

حقول إضافية: لا

نوع المورد

RequestType · المخطط · مخططات البيانات: الإرجاع والشكاوى والاستبدال

سلسلة نصية

القيود

enum: ["return", "exchange", "complaint"]

حقول إضافية: نعم

خيارات المتغيرات المرتبطة بالمنتج أو بالبيانات المحفوظة

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · المخطط · مخططات البيانات: الإرجاع والشكاوى والاستبدال

nameسلسلة نصيةمطلوب: اسم المورد في السياق المناسب.

مثال: "Example"
valueسلسلة نصيةمطلوب: القيمة التي يحددها المخطط المحيط بها.

مثال: "example"

حقول إضافية: لا