مخططات البيانات
عنوان التسليم
AddressData · المخطط · مخططات البيانات: طلبات الشراء
address_line_1سلسلة نصية nullمطلوبالسطر الأول من العنوان.
address_line_2سلسلة نصية nullمطلوبمعلومات إضافية عن العنوان.
cityسلسلة نصية nullمطلوبالمدينة أو المنطقة المحلية.
country_codeسلسلة نصية nullمطلوبرمز البلد.
first_nameسلسلة نصية nullمطلوبالاسم الأول.
house_numberسلسلة نصية nullمطلوبرقم المبنى أو المنزل.
last_nameسلسلة نصية nullمطلوباسم العائلة.
phoneسلسلة نصية nullمطلوبرقم الهاتف.
postal_codeسلسلة نصية nullمطلوبالرمز البريدي.
regionسلسلة نصية nullمطلوبالمنطقة الإدارية.
streetسلسلة نصية nullمطلوباسم الشارع.
حقول إضافية: لا
ApiResponse_OrderFileListData_
ApiResponse_OrderFileListData_ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days (1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
dataOrderFileListDataمطلوبمحتوى الاستجابة الناجحة.
metaContextPageMetaContextMetaPageMetaRequestMetaمطلوبالبيانات الوصفية للاستجابة.
حقول إضافية: لا
ApiResponse_OrderReleaseListData_
ApiResponse_OrderReleaseListData_ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days (1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
dataOrderReleaseListDataمطلوبمحتوى الاستجابة الناجحة.
metaContextPageMetaContextMetaPageMetaRequestMetaمطلوبالبيانات الوصفية للاستجابة.
حقول إضافية: لا
عرض القائمة — طلبات الشراء — الاستجابة
ApiResponse_list_OrderSummaryData__ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
dataمصفوفة <OrderSummaryData> مطلوبمثال على الاستجابة · ApiResponse_list_OrderSummaryData__.
metaContextPageMetaContextMetaPageMetaRequestMetaمطلوبالبيانات الوصفية للاستجابة.
حقول إضافية: لا
جلب — طلبات الشراء — الاستجابة
ApiResponse_OrderDetailData_ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
dataOrderDetailDataمطلوبمثال على الاستجابة · OrderDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaمطلوبالبيانات الوصفية للاستجابة.
حقول إضافية: لا
CurrentReleaseData
CurrentReleaseData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days (1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
acquiredقيمة منطقيةمطلوبالوصول بعد الشراء (true / false)
changelogسلسلة نصيةمطلوبوصف التغييرات
covered_by_purchaseقيمة منطقيةمطلوبالوصول بعد الشراء (true / false)
idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد.
published_atسلسلة نصيةمطلوبنشر الإصدار · UTC
format:"date-time"requires_new_purchaseقيمة منطقيةمطلوبلا يمكن الوصول إلى الملفات المضافة بعد الشراء · requires_new_purchase
sequenceعدد صحيحمطلوبالموضع في المجموعة المرتبة.
version_labelسلسلة نصيةمطلوبالنسخة
حقول إضافية: لا
معلومات العميل المسجلة لهذا المورد
CustomerData · المخطط · مخططات البيانات: طلبات الشراء
emailسلسلة نصيةمطلوبعنوان البريد الإلكتروني.
first_nameسلسلة نصية nullمطلوبالاسم الأول.
last_nameسلسلة نصية nullمطلوباسم العائلة.
phoneسلسلة نصية nullمطلوبرقم الهاتف.
حقول إضافية: لا
DeliveryContentDeletion
DeliveryContentDeletion · احذف المحتوى نهائيًا مع إبقاء السجل. لا يعود الرمز إلى المخزون القابل للبيع.
expected_versionعدد صحيحمطلوبالإصدار المقروء قبل الكتابة؛ يؤدي عدم التطابق إلى رفض التحديث.
minimum:1reasonسلسلة نصيةمطلوبالسبب المسجل للتغيير.
minLength:1maxLength:500
حقول إضافية: لا
تواريخ الشحن والتسليم
DeliveryDatesData · تتضمن قائمة الطلبات وتفاصيلها delivery.dates. التواريخ بصيغة YYYY-MM-DD مخططة ولا تؤكد الشحن الفعلي. للتواريخ الحالية الأولوية؛ وتستخدم الطلبات القديمة التقدير المحفوظ. القيم المحذوفة أو غير المعروفة هي null. تتضمن التفاصيل أيضًا جميع بنود الطلب وصور المنتجات.
dispatch_timezoneسلسلة نصية nullمطلوبالمنطقة الزمنية للشحن (IANA; null).
estimated_delivery_fromسلسلة نصية nullمطلوببداية التسليم المتوقع (YYYY-MM-DD; null).
سلسلة نصية:format:"date"estimated_delivery_toسلسلة نصية nullمطلوبنهاية التسليم المتوقع (YYYY-MM-DD; null).
سلسلة نصية:format:"date"planned_dispatch_onسلسلة نصية nullمطلوبتاريخ الشحن المخطط (YYYY-MM-DD; null).
سلسلة نصية:format:"date"
حقول إضافية: لا
DeliveryReplacement
DeliveryReplacement · اختر وحدة حرة موجودة. لا يبدأ الاستبدال مدة الاحتفاظ من جديد.
expected_unit_versionعدد صحيحمطلوبالإصدار الحالي للوحدة الحرة البديلة.
minimum:1expected_versionعدد صحيحمطلوبالإصدار المقروء قبل الكتابة؛ يؤدي عدم التطابق إلى رفض التحديث.
minimum:1reasonسلسلة نصيةمطلوبالسبب المسجل للتغيير.
minLength:1maxLength:500replacement_unit_idسلسلة نصيةمطلوبمعرّف وحدة حرة موجودة للاستخدام كبديل.
format:"uuid"
حقول إضافية: لا
DeliveryPickupPointData
DeliveryPickupPointData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
addressPickupPointAddressDataمطلوبعنوان التسليم.
codeسلسلة نصيةمطلوبرمز ثابت قابل للقراءة آليًا.
القيود
pattern"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesDatanullمطلوبالقيمة التي يحددها المخطط المحيط بها.
country_codeسلسلة نصيةمطلوبرمز البلد.
القيود
pattern"^[A-Z]{2}$"
environmentسلسلة نصيةمطلوبمعلومات البيئة المرفقة بالسجل.
القيود
enum["live", "sandbox"]
kindسلسلة نصيةمطلوبصيغة بنية البيانات التي تحددها القيم المسموح بها.
القيود
enum["locker", "pickup_point"]
location_descriptionسلسلة نصية nullمطلوبالوصف باللغة المحددة.
سلسلة نصية:maxLength:1000nameسلسلة نصيةمطلوباسم المورد في السياق المناسب.
minLength:1maxLength:160opening_hoursسلسلة نصية nullمطلوبOpening hours
سلسلة نصية:maxLength:500operatorسلسلة نصيةمطلوباسم المورد في السياق المناسب.
minLength:1maxLength:63verified_atسلسلة نصيةمطلوبوقت آخر تحديث.
format:"date-time"
حقول إضافية: لا
ApiResponse[list[DeliveryData]]
shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_DeliveryData____1 · اقرأ الوحدات المخصصة دون كشف الرموز. يسحب رد المبلغ الوصول من بنود الطلب المعنية فقط.
dataمصفوفة <shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData> مطلوبمحتوى الاستجابة الناجحة.
metaContextPageMetaContextMetaPageMetaRequestMetaمطلوبالبيانات الوصفية للاستجابة.
حقول إضافية: لا
DeliveryData
shopently_engine__domains__orders__adapters__public_http__digital_deliveries__schemas__DeliveryData · اقرأ الوحدات المخصصة دون كشف الرموز. يسحب رد المبلغ الوصول من بنود الطلب المعنية فقط.
can_downloadقيمة منطقيةمطلوبتنزيل (true / false)
content_stateسلسلة نصيةمطلوبحالة المحتوى: present / deleting / deleted.
delete_due_atسلسلة نصية nullمطلوبموعد حذف الملف؛ تعطل null الحذف التلقائي.
سلسلة نصية:format:"date-time"filenameسلسلة نصية nullمطلوبالملف
first_available_atسلسلة نصية nullمطلوبأول وصول لهذا الشراء؛ لا يعيد الاستبدال بدء المدة.
سلسلة نصية:format:"date-time"generationعدد صحيحمطلوبجيل التخصيص؛ يزداد عند الاستبدال.
idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد.
format:"uuid"kindسلسلة نصية nullمطلوبصيغة بنية البيانات التي تحددها القيم المسموح بها.
line_idسلسلة نصيةمطلوبمعرّف ثابت لبند الطلب.
order_idسلسلة نصيةمطلوبمعرّف طلب الشراء المرتبط.
payload_idسلسلة نصيةمطلوبمعرّف المحتوى؛ ليس رابط تنزيل عامًا.
format:"uuid"product_idسلسلة نصيةمطلوبمعرّف المنتج.
reasonسلسلة نصيةمطلوبالسبب المسجل للتغيير.
size_bytesعدد صحيح nullمطلوبالحجم بالبايت
stateسلسلة نصيةمطلوبالحالة
unit_idسلسلة نصيةمطلوبمعرّف رمز أو ملف فردي.
format:"uuid"unit_ordinalعدد صحيحمطلوبرقم الوحدة المشتراة ضمن بند الطلب.
variant_idسلسلة نصية nullمطلوبمعرّف متغير المنتج.
versionعدد صحيحمطلوبإصدار المورد المستخدم للتحكم في التعديلات المتزامنة.
حقول إضافية: لا
معلومات الفاتورة
InvoiceData · المخطط · مخططات البيانات: طلبات الشراء
address_line_1سلسلة نصية nullمطلوبالسطر الأول من العنوان.
address_line_2سلسلة نصية nullمطلوبمعلومات إضافية عن العنوان.
cityسلسلة نصية nullمطلوبالمدينة أو المنطقة المحلية.
company_nameسلسلة نصية nullمطلوباسم الشركة.
country_codeسلسلة نصية nullمطلوبرمز البلد.
house_numberسلسلة نصية nullمطلوبرقم المبنى أو المنزل.
postal_codeسلسلة نصية nullمطلوبالرمز البريدي.
regionسلسلة نصية nullمطلوبالمنطقة الإدارية.
streetسلسلة نصية nullمطلوباسم الشارع.
tax_identifierسلسلة نصية nullمطلوبرقم التعريف الضريبي.
tax_schemeسلسلة نصية nullمطلوبنظام حساب الضرائب.
حقول إضافية: لا
المبلغ الصافي / مبلغ الضريبة / المبلغ الإجمالي
OrderAmountBreakdownData · تأتي المبالغ ومعدلات الضريبة من الطلب المحفوظ، بما يشمل تصحيحات البنود. تكون البيانات التاريخية المفقودة null ولا تُستبدل بمعدلات الكتالوج الحالية. تبقى المبالغ سلاسل نصية عشرية.
grossMoneyDataمطلوبالمبلغ الإجمالي · بعد الخصومات; غير معروف: null؛ صفر معروف: 0.
netMoneyDatanullمطلوبالمبلغ الصافي · بعد الخصومات; غير معروف: null؛ صفر معروف: 0.
taxMoneyDatanullمطلوبمبلغ الضريبة · بعد الخصومات; غير معروف: null؛ صفر معروف: 0.
حقول إضافية: لا
الشحن · الخصومات
OrderDeliveryDiscountData · تأتي المبالغ ومعدلات الضريبة من الطلب المحفوظ، بما يشمل تصحيحات البنود. تكون البيانات التاريخية المفقودة null ولا تُستبدل بمعدلات الكتالوج الحالية. تبقى المبالغ سلاسل نصية عشرية.
amountMoneyDataمطلوبالمبلغ الإجمالي · الشحن · الخصومات.
campaign_idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد.
codeسلسلة نصية nullمطلوبرمز ثابت قابل للقراءة آليًا.
kindسلسلة نصيةمطلوبصيغة بنية البيانات التي تحددها القيم المسموح بها.
القيود
enum["coupon", "promotion"]
nameسلسلة نصيةمطلوباسم المورد في السياق المناسب.
sequenceعدد صحيح nullمطلوبالموضع في المجموعة المرتبة.
versionعدد صحيحمطلوبإصدار المورد المستخدم للتحكم في التعديلات المتزامنة.
حقول إضافية: لا
جلب — طلبات الشراء — الاستجابة
OrderDetailData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
created_atسلسلة نصيةمطلوبوقت الإنشاء.
format:"date-time"customerCustomerDataمطلوبمعلومات العميل المسجلة لهذا المورد.
deliveryShippingDetailDataمطلوبطريقة التسليم والمعلومات المرتبطة بها.
discount_amountMoneyDataمطلوبمبلغ عشري ممثل كسلسلة JSON؛ يسمح بالقيمة null فقط حيث يكون ذلك مسموحًا.
discountsمصفوفة <OrderDiscountData> مطلوبالخصومات
idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد. (OrderDetailData).
invoiceInvoiceDatanullمطلوبمعلومات الفاتورة.
invoice_requestedقيمة منطقيةمطلوبما إذا تم طلب فاتورة.
lifecycle_stateOrderLifecycleStateمطلوبحالة دورة حياة المورد.
linesمصفوفة <OrderLineData> مطلوببيانات بنود الطلب المحفوظة وقت تسجيله.
localeسلسلة نصيةمطلوباللغة المحددة لهذا الطلب.
market_idسلسلة نصيةمطلوبمعرّف السوق الذي تعيده نقطة نهاية السياق.
numberسلسلة نصيةمطلوبرقم طلب الشراء أو طلب الخدمة المعروض للمستخدم.
paymentPaymentDataمطلوبتفاصيل الدفع المسجلة للطلب.
pickup_pointPickupPointDatanullمطلوبنقطة الاستلام
prices_include_taxقيمة منطقيةمطلوبما إذا كانت أسعار القائمة تشمل الضرائب.
shipping_addressAddressDatanullمطلوبعنوان التسليم.
shipping_discount_amountMoneyDataمطلوبمبلغ عشري ممثل كسلسلة JSON؛ يسمح بالقيمة null فقط حيث يكون ذلك مسموحًا.
statusOrderStatusDataمطلوبالحالة التي تقبلها هذه العملية تحديدًا.
subtotalMoneyDataمطلوبالمبلغ قبل المكونات الإضافية الموضحة في الاستجابة.
taxMoneyDataمطلوبالمعلومات الضريبية.
tax_breakdownOrderTaxBreakdownDataمطلوبمجموعات الضرائب · source + tax_rate; unallocated_tax.
tax_country_codeسلسلة نصية nullمطلوببلد الضريبة · بيانات الطلب المحفوظة · ISO 3166-1 alpha-2; null.
totalMoneyDataمطلوبالمبلغ الإجمالي.
totalsOrderTotalsDataمطلوبالمجاميع · net / tax / gross; قبل الخصومات / بعد الخصومات.
حقول إضافية: لا
OrderFileData
OrderFileData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days (1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
can_downloadقيمة منطقيةمطلوبتنزيل (true / false)
categoryFileCategoryمطلوبفئة الملف: internal / customer_document / digital
filenameسلسلة نصيةمطلوبالملف
idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد.
labelسلسلة نصيةمطلوباسم المورد في السياق المناسب.
line_idسلسلة نصيةمطلوبمعرّف ثابت لبند الطلب.
mime_typeسلسلة نصيةمطلوبنوع محتوى الوسائط.
product_idسلسلة نصيةمطلوبمعرّف المنتج.
purchase_idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد. · purchase_id
reasonسلسلة نصيةمطلوبالسبب المسجل للتغيير.
sha256سلسلة نصيةمطلوبSHA-256 (hex, 64)
size_bytesعدد صحيحمطلوبالحجم بالبايت
minimum:1maximum:262144000source_file_idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد. · source_file_id
source_version_idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد. · source_version_id
source_version_numberعدد صحيحمطلوبالنسخة
minimum:1stateسلسلة نصيةمطلوبالحالة
حقول إضافية: لا
OrderFileListData
OrderFileListData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days (1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
filesمصفوفة <OrderFileData> مطلوبملفات المنتج
updates_pendingقيمة منطقيةمطلوبالوصول إلى الملفات المستقبلية بعد الشراء · updates_pending
حقول إضافية: لا
البيانات الوصفية للصورة وعنوان URL الخاص بها
OrderImageData · المخطط · مخططات البيانات: طلبات الشراء
altسلسلة نصية nullمطلوبالنص البديل للصورة.
sourceسلسلة نصيةاختياريمصدر النشاط المسجل.
const:"current_catalog"urlسلسلة نصيةمطلوبعنوان URL للمورد.
حقول إضافية: لا
حالة دورة حياة المورد
OrderLifecycleState · المخطط · مخططات البيانات: طلبات الشراء
سلسلة نصيةالقيود
enum["placed", "cancelled", "fulfilled", "returned"]
حقول إضافية: نعم
بيانات بنود الطلب المحفوظة وقت تسجيله
OrderLineData · المخطط · مخططات البيانات: طلبات الشراء
discount_amountMoneyDataمطلوبمبلغ عشري ممثل كسلسلة JSON؛ يسمح بالقيمة null فقط حيث يكون ذلك مسموحًا.
discount_grossMoneyDataمطلوبالمبلغ الإجمالي · الخصومات; غير معروف: null؛ صفر معروف: 0.
discount_netMoneyDatanullمطلوبالمبلغ الصافي · الخصومات; غير معروف: null؛ صفر معروف: 0.
discount_taxMoneyDatanullمطلوبمبلغ الضريبة · الخصومات; غير معروف: null؛ صفر معروف: 0.
discountsمصفوفة <OrderDiscountData> مطلوبالخصومات · net / tax / gross.
identifiersكائنحقول إضافية: سلسلة نصيةمطلوبرموز تعريف المنتج.
imageOrderImageDatanullمطلوبالبيانات الوصفية للصورة وعنوان URL الخاص بها.
line_idسلسلة نصيةمطلوبمعرّف ثابت لبند الطلب.
manual_discountOrderManualDiscountDatanullمطلوبخصم يدوي; null.
nameسلسلة نصيةمطلوباسم المورد في السياق المناسب.
original_totalMoneyDataمطلوبالمبلغ الإجمالي.
original_total_grossMoneyDataمطلوبالمبلغ الإجمالي · المنتجات · قبل الخصومات; غير معروف: null؛ صفر معروف: 0.
original_total_netMoneyDatanullمطلوبالمبلغ الصافي · المنتجات · قبل الخصومات; غير معروف: null؛ صفر معروف: 0.
original_total_taxMoneyDatanullمطلوبمبلغ الضريبة · المنتجات · قبل الخصومات; غير معروف: null؛ صفر معروف: 0.
positionعدد صحيحمطلوبالموضع في المجموعة المرتبة.
product_idسلسلة نصيةمطلوبمعرّف المنتج.
quantityعدد صحيحمطلوبعدد الوحدات.
skuسلسلة نصيةمطلوبرمز وحدة حفظ المخزون.
taxMoneyDatanullمطلوبمبلغ الضريبة · وحدة واحدة · بيانات الطلب المحفوظة; tax ≠ unit_tax; غير معروف: null؛ صفر معروف: 0.
tax_category_idسلسلة نصية nullمطلوبمعرّف الفئة الضريبية · بيانات الطلب المحفوظة; null.
tax_category_nameسلسلة نصية nullمطلوباسم الفئة الضريبية المحفوظ; null.
tax_rateسلسلة نصية nullمطلوبtax_rate · بيانات الطلب المحفوظة: "0.23" = 23%; "0" ≠ null.
totalMoneyDataمطلوبالمبلغ الإجمالي.
total_grossMoneyDataمطلوبالمبلغ الإجمالي · المنتجات · بعد الخصومات; غير معروف: null؛ صفر معروف: 0.
total_netMoneyDatanullمطلوبالمبلغ الصافي · المنتجات · بعد الخصومات; غير معروف: null؛ صفر معروف: 0.
total_taxMoneyDatanullمطلوبمبلغ الضريبة · المنتجات · بعد الخصومات · بيانات الطلب المحفوظة; غير معروف: null؛ صفر معروف: 0.
unit_grossMoneyDataمطلوبالمبلغ الإجمالي · وحدة واحدة · قبل الخصومات; غير معروف: null؛ صفر معروف: 0.
unit_netMoneyDatanullمطلوبالمبلغ الصافي · وحدة واحدة · قبل الخصومات; غير معروف: null؛ صفر معروف: 0.
unit_priceMoneyDataمطلوبسعر الوحدة.
unit_taxMoneyDatanullمطلوبمبلغ الضريبة · وحدة واحدة · قبل الخصومات; غير معروف: null؛ صفر معروف: 0.
variant_idسلسلة نصية nullمطلوبمعرّف متغير المنتج.
variant_optionsمصفوفة <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData> مطلوبخيارات المتغيرات المرتبطة بالمنتج أو بالبيانات المحفوظة.
حقول إضافية: لا
خصم يدوي
OrderManualDiscountData · تأتي المبالغ ومعدلات الضريبة من الطلب المحفوظ، بما يشمل تصحيحات البنود. تكون البيانات التاريخية المفقودة null ولا تُستبدل بمعدلات الكتالوج الحالية. تبقى المبالغ سلاسل نصية عشرية.
amountMoneyDataمطلوبالمبلغ الإجمالي · خصم يدوي · بيانات الطلب المحفوظة.
kindسلسلة نصيةمطلوبنوع الخصم: percentage / fixed.
القيود
enum["percentage", "fixed"]
valueسلسلة نصيةمطلوبالقيمة المضبوطة: percentage "10" = 10%; fixed = المبلغ الإجمالي.
حقول إضافية: لا
الحالة التي تقبلها هذه العملية تحديدًا
OrderPaymentStatus · المخطط · مخططات البيانات: طلبات الشراء
سلسلة نصيةالقيود
enum["unpaid", "paid", "failed", "refunded"]
حقول إضافية: نعم
OrderReleaseData
OrderReleaseData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days (1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
access_reasonسلسلة نصيةمطلوبالوصول بعد الشراء · السبب المسجل للتغيير.
access_stateسلسلة نصيةمطلوبالوصول بعد الشراء · الحالة
current_releaseCurrentReleaseDatanullمطلوبالإصدارات الرقمية · current_release
grant_reasonسلسلة نصيةمطلوبالوصول بعد الشراء · السبب المسجل للتغيير.
granted_atسلسلة نصيةمطلوبالوصول بعد الشراء · UTC
format:"date-time"idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد.
line_idسلسلة نصيةمطلوبمعرّف ثابت لبند الطلب.
manifest_sha256سلسلة نصيةمطلوبالإصدارات الرقمية · SHA-256
product_idسلسلة نصيةمطلوبمعرّف المنتج.
published_atسلسلة نصيةمطلوبنشر الإصدار · UTC
format:"date-time"purchase_idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد. · purchase_id
release_idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد. · release_id
release_sequenceعدد صحيحمطلوبالإصدارات الرقمية · الموضع في المجموعة المرتبة.
update_daysعدد صحيح nullمطلوبعدد الأيام (days; null)
update_modeسلسلة نصيةمطلوبالوصول إلى الملفات المستقبلية بعد الشراء: none / period / unlimited
update_monthsعدد صحيح nullمطلوبالأشهر (months; null)
updates_untilسلسلة نصية nullمطلوبالوصول إلى الملفات المستقبلية بعد الشراء · UTC
سلسلة نصية:format:"date-time"version_labelسلسلة نصيةمطلوبالنسخة
حقول إضافية: لا
OrderReleaseListData
OrderReleaseListData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days (1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
releasesمصفوفة <OrderReleaseData> مطلوبالإصدارات الرقمية
updates_pendingقيمة منطقيةمطلوبالوصول إلى الملفات المستقبلية بعد الشراء · updates_pending
حقول إضافية: لا
الحالة التي تقبلها هذه العملية تحديدًا
OrderStatusData · المخطط · مخططات البيانات: طلبات الشراء
idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد. (OrderStatusData).
nameسلسلة نصيةمطلوباسم المورد في السياق المناسب.
updated_atسلسلة نصيةمطلوبوقت آخر تحديث.
format:"date-time"versionعدد صحيحمطلوبإصدار المورد المستخدم للتحكم في التعديلات المتزامنة.
حقول إضافية: لا
عرض القائمة · الحالات — طلبات الشراء — الاستجابة
shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
created_atسلسلة نصيةمطلوبوقت الإنشاء.
format:"date-time"idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).
is_initialقيمة منطقيةمطلوبما إذا كانت هذه هي الحالة الأولية.
nameسلسلة نصيةمطلوباسم المورد في السياق المناسب.
positionعدد صحيحمطلوبالموضع في المجموعة المرتبة.
حقول إضافية: لا
عرض القائمة · الحالات — طلبات الشراء — الاستجابة
shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
dataمصفوفة <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData> مطلوبمثال على الاستجابة · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.
metaContextPageMetaContextMetaPageMetaRequestMetaمطلوبالبيانات الوصفية للاستجابة.
حقول إضافية: لا
تحديث · الحالة — طلبات الشراء — محتوى الطلب
OrderStatusUpdate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
expected_versionعدد صحيحمطلوبالإصدار المقروء قبل الكتابة؛ يؤدي عدم التطابق إلى رفض التحديث.
minimum:1maximum:9223372036854775807status_idسلسلة نصيةمطلوبمعرّف مأخوذ من دليل الحالات المناسب.
القيود
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
حقول إضافية: لا
عرض القائمة — طلبات الشراء — الاستجابة
OrderSummaryData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
created_atسلسلة نصيةمطلوبوقت الإنشاء.
format:"date-time"customerCustomerDataمطلوبمعلومات العميل المسجلة لهذا المورد.
deliveryShippingDataمطلوبطريقة التسليم والمعلومات المرتبطة بها.
discount_amountMoneyDataمطلوبمبلغ عشري ممثل كسلسلة JSON؛ يسمح بالقيمة null فقط حيث يكون ذلك مسموحًا.
idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد. (OrderSummaryData).
lifecycle_stateOrderLifecycleStateمطلوبحالة دورة حياة المورد.
localeسلسلة نصيةمطلوباللغة المحددة لهذا الطلب.
market_idسلسلة نصيةمطلوبمعرّف السوق الذي تعيده نقطة نهاية السياق.
numberسلسلة نصيةمطلوبرقم طلب الشراء أو طلب الخدمة المعروض للمستخدم.
paymentPaymentDataمطلوبتفاصيل الدفع المسجلة للطلب.
prices_include_taxقيمة منطقيةمطلوبما إذا كانت أسعار القائمة تشمل الضرائب.
shipping_discount_amountMoneyDataمطلوبمبلغ عشري ممثل كسلسلة JSON؛ يسمح بالقيمة null فقط حيث يكون ذلك مسموحًا.
statusOrderStatusDataمطلوبالحالة التي تقبلها هذه العملية تحديدًا.
subtotalMoneyDataمطلوبالمبلغ قبل المكونات الإضافية الموضحة في الاستجابة.
taxMoneyDataمطلوبالمعلومات الضريبية.
tax_country_codeسلسلة نصية nullمطلوببلد الضريبة · بيانات الطلب المحفوظة · ISO 3166-1 alpha-2; null.
totalMoneyDataمطلوبالمبلغ الإجمالي.
حقول إضافية: لا
الطلب · مجموعات الضرائب
OrderTaxBreakdownData · تأتي المبالغ ومعدلات الضريبة من الطلب المحفوظ، بما يشمل تصحيحات البنود. تكون البيانات التاريخية المفقودة null ولا تُستبدل بمعدلات الكتالوج الحالية. تبقى المبالغ سلاسل نصية عشرية.
groupsمصفوفة <OrderTaxGroupData> مطلوبمجموعات الضرائب · source + tax_rate; غير معروف: null؛ صفر معروف: 0.
unallocated_taxMoneyDataمطلوبضريبة غير موزعة = order.tax − Σ groups.tax; ±.
حقول إضافية: لا
مجموعات الضرائب
OrderTaxGroupData · تأتي المبالغ ومعدلات الضريبة من الطلب المحفوظ، بما يشمل تصحيحات البنود. تكون البيانات التاريخية المفقودة null ولا تُستبدل بمعدلات الكتالوج الحالية. تبقى المبالغ سلاسل نصية عشرية.
grossMoneyDataمطلوبالمبلغ الإجمالي · بعد الخصومات; غير معروف: null؛ صفر معروف: 0.
netMoneyDatanullمطلوبالمبلغ الصافي · بعد الخصومات; غير معروف: null؛ صفر معروف: 0.
sourceسلسلة نصيةمطلوبالمصدر: products (المنتجات), shipping (الشحن).
القيود
enum["products", "shipping"]
taxMoneyDatanullمطلوبمبلغ الضريبة · بعد الخصومات; غير معروف: null؛ صفر معروف: 0.
tax_rateسلسلة نصية nullمطلوبtax_rate · بيانات الطلب المحفوظة: "0.23" = 23%; "0" ≠ null.
حقول إضافية: لا
الطلب · المجاميع
OrderTotalsData · تأتي المبالغ ومعدلات الضريبة من الطلب المحفوظ، بما يشمل تصحيحات البنود. تكون البيانات التاريخية المفقودة null ولا تُستبدل بمعدلات الكتالوج الحالية. تبقى المبالغ سلاسل نصية عشرية.
before_discountsOrderAmountBreakdownDataمطلوبالطلب · قبل الخصومات · net / tax / gross.
discountsOrderAmountBreakdownDataمطلوبالخصومات · net / tax / gross.
orderOrderAmountBreakdownDataمطلوبالطلب · بعد الخصومات · net / tax / gross.
product_discountsOrderAmountBreakdownDataمطلوبالمنتجات · الخصومات · net / tax / gross.
productsOrderAmountBreakdownDataمطلوبالمنتجات · بعد الخصومات · net / tax / gross.
products_before_discountsOrderAmountBreakdownDataمطلوبالمنتجات · قبل الخصومات · net / tax / gross.
shippingOrderAmountBreakdownDataمطلوبالشحن · بعد الخصومات · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownDataمطلوبالشحن · قبل الخصومات · net / tax / gross.
shipping_discountsOrderAmountBreakdownDataمطلوبالشحن · الخصومات · net / tax / gross.
حقول إضافية: لا
خيارات المتغيرات المرتبطة بالمنتج أو بالبيانات المحفوظة
shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · المخطط · مخططات البيانات: طلبات الشراء
nameسلسلة نصيةمطلوباسم المورد في السياق المناسب.
valueسلسلة نصيةمطلوبالقيمة التي يحددها المخطط المحيط بها.
حقول إضافية: لا
OrderDiscountData
OrderDiscountData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
amountMoneyDataمطلوبالمبلغ الإجمالي · المنتجات · الخصومات.
campaign_idسلسلة نصيةمطلوبمعرّف المورد؛ احتفظ به كما أعيد.
codeسلسلة نصية nullمطلوبرمز ثابت قابل للقراءة آليًا.
kindسلسلة نصيةمطلوبصيغة بنية البيانات التي تحددها القيم المسموح بها.
القيود
enum["coupon", "promotion"]
nameسلسلة نصيةمطلوباسم المورد في السياق المناسب.
sequenceعدد صحيح nullاختياريترتيب التطبيق; null.
shipping_amountMoneyDatanullاختياريالمبلغ الإجمالي · الشحن · الخصومات; null.
versionعدد صحيحمطلوبإصدار المورد المستخدم للتحكم في التعديلات المتزامنة.
حقول إضافية: لا
تفاصيل الدفع المسجلة للطلب
PaymentData · المخطط · مخططات البيانات: طلبات الشراء
amountMoneyDataمطلوبpayment.amount هو إجمالي الطلب. لا تحدد حالة الدفع المبالغ المدفوعة أو المستردة أو المتبقية.
environmentسلسلة نصيةمطلوبمعلومات البيئة المرفقة بالسجل.
القيود
enum["live", "sandbox"]
method_codeسلسلة نصية nullمطلوبرمز طريقة التسليم أو الدفع.
method_nameسلسلة نصية nullمطلوباسم طريقة التسليم أو الدفع.
paid_atسلسلة نصية nullمطلوبتاريخ ووقت وضع علامة مدفوع على الدفعة.
سلسلة نصية:format:"date-time"statusOrderPaymentStatusمطلوبالحالة التي تقبلها هذه العملية تحديدًا.
updated_atسلسلة نصيةمطلوبوقت آخر تحديث.
format:"date-time"versionعدد صحيحمطلوبإصدار المورد المستخدم للتحكم في التعديلات المتزامنة.
حقول إضافية: لا
تحديث · حالة الدفع — طلبات الشراء — محتوى الطلب
PaymentStatusUpdate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
expected_versionعدد صحيحمطلوبالإصدار المقروء قبل الكتابة؛ يؤدي عدم التطابق إلى رفض التحديث.
minimum:0maximum:9223372036854775807reasonسلسلة نصيةمطلوبالسبب المسجل للتغيير.
minLength:1maxLength:500statusPaymentStatusمطلوبالحالة التي تقبلها هذه العملية تحديدًا. unpaid: غير مدفوع; paid: مدفوع; failed: فشل الدفع; refunded: مُسترد.
حقول إضافية: لا
الحالة التي تقبلها هذه العملية تحديدًا
PaymentStatus · المخطط · مخططات البيانات: طلبات الشراء
سلسلة نصيةالقيود
enum["unpaid", "paid", "failed", "refunded"]
حقول إضافية: نعم
PickupPointAddressData
PickupPointAddressData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
address_line_1سلسلة نصيةمطلوبالسطر الأول من العنوان.
minLength:1maxLength:240cityسلسلة نصيةمطلوبالمدينة أو المنطقة المحلية.
minLength:1maxLength:160postal_codeسلسلة نصيةمطلوبالرمز البريدي.
minLength:1maxLength:32
حقول إضافية: لا
PickupPointCoordinatesData
PickupPointCoordinatesData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
latitudeعددمطلوبWGS84 φ (°)
minimum:-90.0maximum:90.0longitudeعددمطلوبWGS84 λ (°)
minimum:-180.0maximum:180.0
حقول إضافية: لا
PickupPointData
PickupPointData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
address_line1سلسلة نصيةمطلوبالسطر الأول من العنوان.
cityسلسلة نصيةمطلوبالمدينة أو المنطقة المحلية.
codeسلسلة نصيةمطلوبرمز ثابت قابل للقراءة آليًا.
country_codeسلسلة نصيةمطلوبرمز البلد.
kindسلسلة نصيةمطلوبصيغة بنية البيانات التي تحددها القيم المسموح بها.
القيود
enum["locker", "pickup_point"]
latitudeعدد nullمطلوبWGS84 φ (°)
location_descriptionسلسلة نصية nullمطلوبالوصف باللغة المحددة.
longitudeعدد nullمطلوبWGS84 λ (°)
nameسلسلة نصيةمطلوباسم المورد في السياق المناسب.
opening_hoursسلسلة نصية nullمطلوبOpening hours
operatorسلسلة نصيةمطلوباسم المورد في السياق المناسب.
postal_codeسلسلة نصيةمطلوبالرمز البريدي.
حقول إضافية: لا
PickupPointSummaryData
PickupPointSummaryData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
codeسلسلة نصيةمطلوبرمز ثابت قابل للقراءة آليًا.
القيود
pattern"^[A-Za-z0-9_-]{1,63}$"
country_codeسلسلة نصيةمطلوبرمز البلد.
القيود
pattern"^[A-Z]{2}$"
environmentسلسلة نصيةمطلوبمعلومات البيئة المرفقة بالسجل.
القيود
enum["live", "sandbox"]
kindسلسلة نصيةمطلوبصيغة بنية البيانات التي تحددها القيم المسموح بها.
القيود
enum["locker", "pickup_point"]
operatorسلسلة نصيةمطلوباسم المورد في السياق المناسب.
minLength:1maxLength:63
حقول إضافية: لا
معلومات العميل المسجلة لهذا المورد
RequestCustomerData · المخطط · مخططات البيانات: طلبات الشراء
emailسلسلة نصيةمطلوبعنوان البريد الإلكتروني.
nameسلسلة نصيةمطلوباسم المورد في السياق المناسب.
حقول إضافية: لا
طريقة التسليم والمعلومات المرتبطة بها
ShippingData · المخطط · مخططات البيانات: طلبات الشراء
amountMoneyDataمطلوبمبلغ الشحن شامل الضريبة والمسجل في الطلب بصيغة MoneyData. لا تغيّر التعديلات الضريبية اللاحقة هذا المبلغ التاريخي.
datesDeliveryDatesDataمطلوبتواريخ الشحن والتسليم. تتضمن قائمة الطلبات وتفاصيلها delivery.dates. التواريخ بصيغة YYYY-MM-DD مخططة ولا تؤكد الشحن الفعلي. للتواريخ الحالية الأولوية؛ وتستخدم الطلبات القديمة التقدير المحفوظ. القيم المحذوفة أو غير المعروفة هي null. تتضمن التفاصيل أيضًا جميع بنود الطلب وصور المنتجات.
method_codeسلسلة نصية nullمطلوبرمز طريقة التسليم أو الدفع.
method_nameسلسلة نصية nullمطلوباسم طريقة التسليم أو الدفع.
pickup_pointPickupPointSummaryDatanullمطلوبنقطة الاستلام
recipient_modeسلسلة نصيةمطلوبصيغة بنية البيانات التي تحددها القيم المسموح بها.
القيود
enum["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
حقول إضافية: لا
ShippingDetailData
ShippingDetailData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
amountMoneyDataمطلوبمبلغ الشحن شامل الضريبة والمسجل في الطلب بصيغة MoneyData. لا تغيّر التعديلات الضريبية اللاحقة هذا المبلغ التاريخي.
datesDeliveryDatesDataمطلوبتواريخ الشحن والتسليم. تتضمن قائمة الطلبات وتفاصيلها delivery.dates. التواريخ بصيغة YYYY-MM-DD مخططة ولا تؤكد الشحن الفعلي. للتواريخ الحالية الأولوية؛ وتستخدم الطلبات القديمة التقدير المحفوظ. القيم المحذوفة أو غير المعروفة هي null. تتضمن التفاصيل أيضًا جميع بنود الطلب وصور المنتجات.
discount_grossMoneyDataمطلوبالمبلغ الإجمالي · الخصومات; غير معروف: null؛ صفر معروف: 0.
discount_netMoneyDatanullمطلوبالمبلغ الصافي · الخصومات; غير معروف: null؛ صفر معروف: 0.
discount_taxMoneyDatanullمطلوبمبلغ الضريبة · الخصومات; غير معروف: null؛ صفر معروف: 0.
discountsمصفوفة <OrderDeliveryDiscountData> nullمطلوبالشحن · الخصومات; []: 0; null: غير معروف: null؛ صفر معروف: 0.
grossMoneyDataمطلوبالمبلغ الإجمالي · بعد الخصومات; غير معروف: null؛ صفر معروف: 0.
method_codeسلسلة نصية nullمطلوبرمز طريقة التسليم أو الدفع.
method_nameسلسلة نصية nullمطلوباسم طريقة التسليم أو الدفع.
netMoneyDatanullمطلوبالمبلغ الصافي · بعد الخصومات; غير معروف: null؛ صفر معروف: 0.
original_grossMoneyDataمطلوبالمبلغ الإجمالي · الشحن · قبل الخصومات; غير معروف: null؛ صفر معروف: 0.
original_netMoneyDatanullمطلوبالمبلغ الصافي · الشحن · قبل الخصومات; غير معروف: null؛ صفر معروف: 0.
original_taxMoneyDatanullمطلوبمبلغ الضريبة · الشحن · قبل الخصومات; غير معروف: null؛ صفر معروف: 0.
pickup_pointDeliveryPickupPointDatanullمطلوبنقطة الاستلام
recipient_modeسلسلة نصيةمطلوبصيغة بنية البيانات التي تحددها القيم المسموح بها.
القيود
enum["full_address", "pickup_contact", "address_only", "name_contact", "contact_only"]
taxMoneyDatanullمطلوبمبلغ الضريبة · بعد الخصومات; غير معروف: null؛ صفر معروف: 0.
tax_category_idسلسلة نصية nullمطلوبمعرّف الفئة الضريبية · بيانات الطلب المحفوظة; null.
tax_category_nameسلسلة نصية nullمطلوباسم الفئة الضريبية المحفوظ; null.
tax_rateسلسلة نصية nullمطلوبtax_rate · بيانات الطلب المحفوظة: "0.23" = 23%; "0" ≠ null.
حقول إضافية: لا