مخططات البيانات: طلبات الشراء

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مطلوب

اسم الشارع.

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

dataمصفوفة <OrderSummaryData > مطلوب

مثال على الاستجابة · ApiResponse_list_OrderSummaryData__.

مثال: [{"created_at":"2026-10-19T10:00:00Z","customer":{"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null},"delivery":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"dates":{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"},"method_code":"shipping-old","method_name":"Historic carrier","pickup_point":null,"recipient_mode":"full_address"},"discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"id":"order-0000","lifecycle_state":"placed","locale":"pl","market_id":"market-pl","number":"0001","payment":{"amount":{"amount":"329.40","currency":"PLN","minor_units":2},"environment":"live","method_code":"payment-old","method_name":"Historic method","paid_at":null,"status":"unpaid","updated_at":"2026-10-19T10:00:00Z","version":0},"prices_include_tax":true,"shipping_discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"status":{"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1},"subtotal":{"amount":"329.40","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2},"tax_country_code":"PL","total":{"amount":"329.40","currency":"PLN","minor_units":2}}]

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta مطلوب

البيانات الوصفية للاستجابة.

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

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

dataOrderDetailData مطلوب

مثال على الاستجابة · OrderDetailData.

مثال: {"created_at":"2026-10-19T10:00:00Z","customer":{"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null},"delivery":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"dates":{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"},"discount_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_net":{"amount":"20.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"24.60","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"version":3}],"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"method_code":"shipping-old","method_name":"Historic carrier","net":{"amount":"0.00","currency":"PLN","minor_units":2},"original_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"original_net":{"amount":"20.00","currency":"PLN","minor_units":2},"original_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"pickup_point":null,"recipient_mode":"full_address","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_category_id":"standard","tax_category_name":"VAT 23%","tax_rate":"0.23"},"discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"version":3}],"id":"order-0000","invoice":null,"invoice_requested":false,"lifecycle_state":"placed","lines":[{"discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_net":{"amount":"20.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":null,"version":3}],"identifiers":{},"image":null,"line_id":"saved-line-a","manual_discount":{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"},"name":"Saved A","original_total":{"amount":"246.00","currency":"PLN","minor_units":2},"original_total_gross":{"amount":"246.00","currency":"PLN","minor_units":2},"original_total_net":{"amount":"200.00","currency":"PLN","minor_units":2},"original_total_tax":{"amount":"46.00","currency":"PLN","minor_units":2},"position":1,"product_id":"product-api","quantity":2,"sku":"A","tax":{"amount":"20.70","currency":"PLN","minor_units":2},"tax_category_id":"standard","tax_category_name":"VAT 23%","tax_rate":"0.23","total":{"amount":"221.40","currency":"PLN","minor_units":2},"total_gross":{"amount":"221.40","currency":"PLN","minor_units":2},"total_net":{"amount":"180.00","currency":"PLN","minor_units":2},"total_tax":{"amount":"41.40","currency":"PLN","minor_units":2},"unit_gross":{"amount":"123.00","currency":"PLN","minor_units":2},"unit_net":{"amount":"100.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"123.00","currency":"PLN","minor_units":2},"unit_tax":{"amount":"23.00","currency":"PLN","minor_units":2},"variant_id":null,"variant_options":[]},{"discount_amount":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_gross":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_net":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"0.00","currency":"PLN","minor_units":2},"discounts":[],"identifiers":{},"image":null,"line_id":"b548a171-c331-505f-98f8-db3a06070998","manual_discount":null,"name":"Saved B","original_total":{"amount":"108.00","currency":"PLN","minor_units":2},"original_total_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"original_total_net":{"amount":"100.00","currency":"PLN","minor_units":2},"original_total_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"position":2,"product_id":"deleted-product","quantity":1,"sku":"B","tax":null,"tax_category_id":"reduced","tax_category_name":"VAT 8%","tax_rate":"0.08","total":{"amount":"108.00","currency":"PLN","minor_units":2},"total_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"total_net":{"amount":"100.00","currency":"PLN","minor_units":2},"total_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"unit_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"unit_net":{"amount":"100.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"108.00","currency":"PLN","minor_units":2},"unit_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"variant_id":null,"variant_options":[]}],"locale":"pl","market_id":"market-pl","number":"0001","payment":{"amount":{"amount":"329.40","currency":"PLN","minor_units":2},"environment":"live","method_code":"payment-old","method_name":"Historic method","paid_at":null,"status":"unpaid","updated_at":"2026-10-19T10:00:00Z","version":0},"pickup_point":null,"prices_include_tax":true,"shipping_address":null,"shipping_discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"status":{"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1},"subtotal":{"amount":"329.40","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2},"tax_breakdown":{"groups":[{"gross":{"amount":"221.40","currency":"PLN","minor_units":2},"net":{"amount":"180.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"41.40","currency":"PLN","minor_units":2},"tax_rate":"0.23"},{"gross":{"amount":"108.00","currency":"PLN","minor_units":2},"net":{"amount":"100.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"8.00","currency":"PLN","minor_units":2},"tax_rate":"0.08"},{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"source":"shipping","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_rate":"0.23"}],"unallocated_tax":{"amount":"0.00","currency":"PLN","minor_units":2}},"tax_country_code":"PL","total":{"amount":"329.40","currency":"PLN","minor_units":2},"totals":{"before_discounts":{"gross":{"amount":"378.60","currency":"PLN","minor_units":2},"net":{"amount":"320.00","currency":"PLN","minor_units":2},"tax":{"amount":"58.60","currency":"PLN","minor_units":2}},"discounts":{"gross":{"amount":"49.20","currency":"PLN","minor_units":2},"net":{"amount":"40.00","currency":"PLN","minor_units":2},"tax":{"amount":"9.20","currency":"PLN","minor_units":2}},"order":{"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}},"product_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}},"products":{"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}},"products_before_discounts":{"gross":{"amount":"354.00","currency":"PLN","minor_units":2},"net":{"amount":"300.00","currency":"PLN","minor_units":2},"tax":{"amount":"54.00","currency":"PLN","minor_units":2}},"shipping":{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"tax":{"amount":"0.00","currency":"PLN","minor_units":2}},"shipping_before_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}},"shipping_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}}}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta مطلوب

البيانات الوصفية للاستجابة.

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

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

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

عنوان البريد الإلكتروني.

مثال: "customer@example.invalid"

first_nameسلسلة نصية | nullمطلوب

الاسم الأول.

مثال: "Example"

last_nameسلسلة نصية | nullمطلوب

اسم العائلة.

مثال: "Example"

phoneسلسلة نصية | nullمطلوب

رقم الهاتف.

مثال: null

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

dispatch_timezoneسلسلة نصية | nullمطلوب

المنطقة الزمنية للشحن (IANA; null).

مثال: "Europe/Warsaw"

estimated_delivery_fromسلسلة نصية | nullمطلوب

بداية التسليم المتوقع (YYYY-MM-DD; null).

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

مثال: "2026-10-20"

estimated_delivery_toسلسلة نصية | nullمطلوب

نهاية التسليم المتوقع (YYYY-MM-DD; null).

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

مثال: "2026-10-21"

planned_dispatch_onسلسلة نصية | nullمطلوب

تاريخ الشحن المخطط (YYYY-MM-DD; null).

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

مثال: "2026-10-19"

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

addressPickupPointAddressData مطلوب

عنوان التسليم.

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

رمز ثابت قابل للقراءة آليًا.

القيود

pattern

"^[A-Za-z0-9_-]{1,63}$"

coordinatesPickupPointCoordinatesData | nullمطلوب

القيمة التي يحددها المخطط المحيط بها.

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

رمز البلد.

القيود

pattern

"^[A-Z]{2}$"

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

معلومات البيئة المرفقة بالسجل.

القيود

enum

["live", "sandbox"]

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

صيغة بنية البيانات التي تحددها القيم المسموح بها.

القيود

enum

["locker", "pickup_point"]

location_descriptionسلسلة نصية | nullمطلوب

الوصف باللغة المحددة.

سلسلة نصية:maxLength: 1000

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

اسم المورد في السياق المناسب.

minLength: 1maxLength: 160

opening_hoursسلسلة نصية | nullمطلوب

Opening hours

سلسلة نصية:maxLength: 500

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

اسم المورد في السياق المناسب.

minLength: 1maxLength: 63

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

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

format: "date-time"

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

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مطلوب

نظام حساب الضرائب.

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

grossMoneyData مطلوب

المبلغ الإجمالي · بعد الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

netMoneyData | nullمطلوب

المبلغ الصافي · بعد الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

taxMoneyData | nullمطلوب

مبلغ الضريبة · بعد الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

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

amountMoneyData مطلوب

المبلغ الإجمالي · الشحن · الخصومات⁦.⁩

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

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

معرّف المورد؛ احتفظ به كما أعيد⁦.⁩

مثال: "saved-coupon"

codeسلسلة نصية | nullمطلوب

رمز ثابت قابل للقراءة آليًا⁦.⁩

مثال: "SAVE"

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

صيغة بنية البيانات التي تحددها القيم المسموح بها⁦.⁩

القيود

enum

["coupon", "promotion"]

مثال: "coupon"

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

اسم المورد في السياق المناسب⁦.⁩

مثال: "Saved coupon"

sequenceعدد صحيح | nullمطلوب

الموضع في المجموعة المرتبة⁦.⁩

مثال: 1

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

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

مثال: 3

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

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

وقت الإنشاء⁦.⁩

format: "date-time"

مثال: "2026-10-19T10:00:00Z"

customerCustomerData مطلوب

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

مثال: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}

deliveryShippingDetailData مطلوب

طريقة التسليم والمعلومات المرتبطة بها⁦.⁩

مثال: {"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"dates":{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"},"discount_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_net":{"amount":"20.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"24.60","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"version":3}],"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"method_code":"shipping-old","method_name":"Historic carrier","net":{"amount":"0.00","currency":"PLN","minor_units":2},"original_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"original_net":{"amount":"20.00","currency":"PLN","minor_units":2},"original_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"pickup_point":null,"recipient_mode":"full_address","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_category_id":"standard","tax_category_name":"VAT 23%","tax_rate":"0.23"}

discount_amountMoneyData مطلوب

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

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

discountsمصفوفة <OrderDiscountData > مطلوب

الخصومات

مثال: [{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"version":3}]

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

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

مثال: "order-0000"

invoiceInvoiceData | nullمطلوب

معلومات الفاتورة⁦.⁩

مثال: null

invoice_requestedقيمة منطقيةمطلوب

ما إذا تم طلب فاتورة⁦.⁩

مثال: false

lifecycle_stateOrderLifecycleState مطلوب

حالة دورة حياة المورد⁦.⁩

مثال: "placed"

linesمصفوفة <OrderLineData > مطلوب

بيانات بنود الطلب المحفوظة وقت تسجيله⁦.⁩

مثال: [{"discount_amount":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_gross":{"amount":"24.60","currency":"PLN","minor_units":2},"discount_net":{"amount":"20.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"4.60","currency":"PLN","minor_units":2},"discounts":[{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":null,"version":3}],"identifiers":{},"image":null,"line_id":"saved-line-a","manual_discount":{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"},"name":"Saved A","original_total":{"amount":"246.00","currency":"PLN","minor_units":2},"original_total_gross":{"amount":"246.00","currency":"PLN","minor_units":2},"original_total_net":{"amount":"200.00","currency":"PLN","minor_units":2},"original_total_tax":{"amount":"46.00","currency":"PLN","minor_units":2},"position":1,"product_id":"product-api","quantity":2,"sku":"A","tax":{"amount":"20.70","currency":"PLN","minor_units":2},"tax_category_id":"standard","tax_category_name":"VAT 23%","tax_rate":"0.23","total":{"amount":"221.40","currency":"PLN","minor_units":2},"total_gross":{"amount":"221.40","currency":"PLN","minor_units":2},"total_net":{"amount":"180.00","currency":"PLN","minor_units":2},"total_tax":{"amount":"41.40","currency":"PLN","minor_units":2},"unit_gross":{"amount":"123.00","currency":"PLN","minor_units":2},"unit_net":{"amount":"100.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"123.00","currency":"PLN","minor_units":2},"unit_tax":{"amount":"23.00","currency":"PLN","minor_units":2},"variant_id":null,"variant_options":[]},{"discount_amount":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_gross":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_net":{"amount":"0.00","currency":"PLN","minor_units":2},"discount_tax":{"amount":"0.00","currency":"PLN","minor_units":2},"discounts":[],"identifiers":{},"image":null,"line_id":"b548a171-c331-505f-98f8-db3a06070998","manual_discount":null,"name":"Saved B","original_total":{"amount":"108.00","currency":"PLN","minor_units":2},"original_total_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"original_total_net":{"amount":"100.00","currency":"PLN","minor_units":2},"original_total_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"position":2,"product_id":"deleted-product","quantity":1,"sku":"B","tax":null,"tax_category_id":"reduced","tax_category_name":"VAT 8%","tax_rate":"0.08","total":{"amount":"108.00","currency":"PLN","minor_units":2},"total_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"total_net":{"amount":"100.00","currency":"PLN","minor_units":2},"total_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"unit_gross":{"amount":"108.00","currency":"PLN","minor_units":2},"unit_net":{"amount":"100.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"108.00","currency":"PLN","minor_units":2},"unit_tax":{"amount":"8.00","currency":"PLN","minor_units":2},"variant_id":null,"variant_options":[]}]

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

اللغة المحددة لهذا الطلب⁦.⁩

مثال: "pl"

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

معرّف السوق الذي تعيده نقطة نهاية السياق⁦.⁩

مثال: "market-pl"

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

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

مثال: "0001"

paymentPaymentData مطلوب

تفاصيل الدفع المسجلة للطلب⁦.⁩

مثال: {"amount":{"amount":"329.40","currency":"PLN","minor_units":2},"environment":"live","method_code":"payment-old","method_name":"Historic method","paid_at":null,"status":"unpaid","updated_at":"2026-10-19T10:00:00Z","version":0}

pickup_pointPickupPointData | nullمطلوب

نقطة الاستلام

مثال: null

prices_include_taxقيمة منطقيةمطلوب

ما إذا كانت أسعار القائمة تشمل الضرائب⁦.⁩

مثال: true

shipping_addressAddressData | nullمطلوب

عنوان التسليم⁦.⁩

مثال: null

shipping_discount_amountMoneyData مطلوب

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

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

statusOrderStatusData مطلوب

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

مثال: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}

subtotalMoneyData مطلوب

المبلغ قبل المكونات الإضافية الموضحة في الاستجابة⁦.⁩

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

taxMoneyData مطلوب

المعلومات الضريبية⁦.⁩

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

tax_breakdownOrderTaxBreakdownData مطلوب

مجموعات الضرائب · ⁦source + tax_rate; unallocated_tax.⁩

مثال: {"groups":[{"gross":{"amount":"221.40","currency":"PLN","minor_units":2},"net":{"amount":"180.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"41.40","currency":"PLN","minor_units":2},"tax_rate":"0.23"},{"gross":{"amount":"108.00","currency":"PLN","minor_units":2},"net":{"amount":"100.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"8.00","currency":"PLN","minor_units":2},"tax_rate":"0.08"},{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"source":"shipping","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_rate":"0.23"}],"unallocated_tax":{"amount":"0.00","currency":"PLN","minor_units":2}}

tax_country_codeسلسلة نصية | nullمطلوب

بلد الضريبة · بيانات الطلب المحفوظة · ⁦ISO 3166-1 alpha-2; null.⁩

مثال: "PL"

totalMoneyData مطلوب

المبلغ الإجمالي⁦.⁩

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

totalsOrderTotalsData مطلوب

المجاميع · ⁦net / tax / gross;⁩ قبل الخصومات ⁦/⁩ بعد الخصومات⁦.⁩

مثال: {"before_discounts":{"gross":{"amount":"378.60","currency":"PLN","minor_units":2},"net":{"amount":"320.00","currency":"PLN","minor_units":2},"tax":{"amount":"58.60","currency":"PLN","minor_units":2}},"discounts":{"gross":{"amount":"49.20","currency":"PLN","minor_units":2},"net":{"amount":"40.00","currency":"PLN","minor_units":2},"tax":{"amount":"9.20","currency":"PLN","minor_units":2}},"order":{"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}},"product_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}},"products":{"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}},"products_before_discounts":{"gross":{"amount":"354.00","currency":"PLN","minor_units":2},"net":{"amount":"300.00","currency":"PLN","minor_units":2},"tax":{"amount":"54.00","currency":"PLN","minor_units":2}},"shipping":{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"tax":{"amount":"0.00","currency":"PLN","minor_units":2}},"shipping_before_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}},"shipping_discounts":{"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}}

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

altسلسلة نصية | nullمطلوب

النص البديل للصورة.

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

مصدر النشاط المسجل.

const: "current_catalog"

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

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

عنوان URL للمورد.

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

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

discount_amountMoneyData مطلوب

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

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

discount_grossMoneyData مطلوب

المبلغ الإجمالي · الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

discount_netMoneyData | nullمطلوب

المبلغ الصافي · الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

discount_taxMoneyData | nullمطلوب

مبلغ الضريبة · الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

discountsمصفوفة <OrderDiscountData > مطلوب

الخصومات · ⁦net / tax / gross.⁩

مثال: [{"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"shipping_amount":null,"version":3}]

identifiersكائنحقول إضافية: سلسلة نصيةمطلوب

رموز تعريف المنتج⁦.⁩

مثال: {}

imageOrderImageData | nullمطلوب

البيانات الوصفية للصورة وعنوان ⁦URL⁩ الخاص بها⁦.⁩

مثال: null

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

معرّف ثابت لبند الطلب⁦.⁩

مثال: "saved-line-a"

manual_discountOrderManualDiscountData | nullمطلوب

خصم يدوي⁦; null.⁩

مثال: {"amount":{"amount":"12.30","currency":"PLN","minor_units":2},"kind":"fixed","value":"12.30"}

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

اسم المورد في السياق المناسب⁦.⁩

مثال: "Saved A"

original_totalMoneyData مطلوب

المبلغ الإجمالي⁦.⁩

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

original_total_grossMoneyData مطلوب

المبلغ الإجمالي · المنتجات · قبل الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

original_total_netMoneyData | nullمطلوب

المبلغ الصافي · المنتجات · قبل الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

original_total_taxMoneyData | nullمطلوب

مبلغ الضريبة · المنتجات · قبل الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

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

الموضع في المجموعة المرتبة⁦.⁩

مثال: 1

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

معرّف المنتج⁦.⁩

مثال: "product-api"

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

عدد الوحدات⁦.⁩

مثال: 2

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

رمز وحدة حفظ المخزون⁦.⁩

مثال: "A"

taxMoneyData | nullمطلوب

مبلغ الضريبة · وحدة واحدة · بيانات الطلب المحفوظة⁦; tax⁩ ≠ ⁦unit_tax;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

tax_category_idسلسلة نصية | nullمطلوب

معرّف الفئة الضريبية · بيانات الطلب المحفوظة⁦; null.⁩

مثال: "standard"

tax_category_nameسلسلة نصية | nullمطلوب

اسم الفئة الضريبية المحفوظ⁦; null.⁩

مثال: "VAT 23%"

tax_rateسلسلة نصية | nullمطلوب

⁦tax_rate⁩ · بيانات الطلب المحفوظة⁦: "0.23" = 23%; "0"⁩ ≠ ⁦null.⁩

مثال: "0.23"

totalMoneyData مطلوب

المبلغ الإجمالي⁦.⁩

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

total_grossMoneyData مطلوب

المبلغ الإجمالي · المنتجات · بعد الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

total_netMoneyData | nullمطلوب

المبلغ الصافي · المنتجات · بعد الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

total_taxMoneyData | nullمطلوب

مبلغ الضريبة · المنتجات · بعد الخصومات · بيانات الطلب المحفوظة⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

unit_grossMoneyData مطلوب

المبلغ الإجمالي · وحدة واحدة · قبل الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

unit_netMoneyData | nullمطلوب

المبلغ الصافي · وحدة واحدة · قبل الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

unit_priceMoneyData مطلوب

سعر الوحدة⁦.⁩

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

unit_taxMoneyData | nullمطلوب

مبلغ الضريبة · وحدة واحدة · قبل الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

variant_idسلسلة نصية | nullمطلوب

معرّف متغير المنتج⁦.⁩

مثال: null

variant_optionsمصفوفة <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData > مطلوب

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

مثال: []

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

amountMoneyData مطلوب

المبلغ الإجمالي · خصم يدوي · بيانات الطلب المحفوظة⁦.⁩

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

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

نوع الخصم⁦: percentage / fixed.⁩

القيود

enum

["percentage", "fixed"]

مثال: "fixed"

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

القيمة المضبوطة⁦: percentage "10" = 10%; fixed =⁩ المبلغ الإجمالي⁦.⁩

مثال: "12.30"

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

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

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

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

مثال: "status-0"

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

اسم المورد في السياق المناسب.

مثال: "Status 0"

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

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

format: "date-time"

مثال: "2026-10-19T10:00:00Z"

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

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

مثال: 1

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

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

وقت الإنشاء.

format: "date-time"

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

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

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

مثال: "example"

is_initialقيمة منطقيةمطلوب

ما إذا كانت هذه هي الحالة الأولية.

مثال: false

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

اسم المورد في السياق المناسب.

مثال: "Example"

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

الموضع في المجموعة المرتبة.

مثال: 1

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

dataمصفوفة <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData > مطلوب

مثال على الاستجابة · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.

مثال: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"name":"Example","position":1}]

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta مطلوب

البيانات الوصفية للاستجابة.

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

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

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

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

minimum: 1maximum: 9223372036854775807

مثال: 1

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

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

القيود

pattern

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

مثال: "example"

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

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

وقت الإنشاء⁦.⁩

format: "date-time"

مثال: "2026-10-19T10:00:00Z"

customerCustomerData مطلوب

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

مثال: {"email":"customer@example.invalid","first_name":"Example","last_name":"Example","phone":null}

deliveryShippingData مطلوب

طريقة التسليم والمعلومات المرتبطة بها⁦.⁩

مثال: {"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"dates":{"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"},"method_code":"shipping-old","method_name":"Historic carrier","pickup_point":null,"recipient_mode":"full_address"}

discount_amountMoneyData مطلوب

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

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

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

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

مثال: "order-0000"

lifecycle_stateOrderLifecycleState مطلوب

حالة دورة حياة المورد⁦.⁩

مثال: "placed"

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

اللغة المحددة لهذا الطلب⁦.⁩

مثال: "pl"

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

معرّف السوق الذي تعيده نقطة نهاية السياق⁦.⁩

مثال: "market-pl"

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

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

مثال: "0001"

paymentPaymentData مطلوب

تفاصيل الدفع المسجلة للطلب⁦.⁩

مثال: {"amount":{"amount":"329.40","currency":"PLN","minor_units":2},"environment":"live","method_code":"payment-old","method_name":"Historic method","paid_at":null,"status":"unpaid","updated_at":"2026-10-19T10:00:00Z","version":0}

prices_include_taxقيمة منطقيةمطلوب

ما إذا كانت أسعار القائمة تشمل الضرائب⁦.⁩

مثال: true

shipping_discount_amountMoneyData مطلوب

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

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

statusOrderStatusData مطلوب

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

مثال: {"id":"status-0","name":"Status 0","updated_at":"2026-10-19T10:00:00Z","version":1}

subtotalMoneyData مطلوب

المبلغ قبل المكونات الإضافية الموضحة في الاستجابة⁦.⁩

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

taxMoneyData مطلوب

المعلومات الضريبية⁦.⁩

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

tax_country_codeسلسلة نصية | nullمطلوب

بلد الضريبة · بيانات الطلب المحفوظة · ⁦ISO 3166-1 alpha-2; null.⁩

مثال: "PL"

totalMoneyData مطلوب

المبلغ الإجمالي⁦.⁩

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

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

groupsمصفوفة <OrderTaxGroupData > مطلوب

مجموعات الضرائب · ⁦source + tax_rate;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

مثال: [{"gross":{"amount":"221.40","currency":"PLN","minor_units":2},"net":{"amount":"180.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"41.40","currency":"PLN","minor_units":2},"tax_rate":"0.23"},{"gross":{"amount":"108.00","currency":"PLN","minor_units":2},"net":{"amount":"100.00","currency":"PLN","minor_units":2},"source":"products","tax":{"amount":"8.00","currency":"PLN","minor_units":2},"tax_rate":"0.08"},{"gross":{"amount":"0.00","currency":"PLN","minor_units":2},"net":{"amount":"0.00","currency":"PLN","minor_units":2},"source":"shipping","tax":{"amount":"0.00","currency":"PLN","minor_units":2},"tax_rate":"0.23"}]

unallocated_taxMoneyData مطلوب

ضريبة غير موزعة ⁦= order.tax⁩ − Σ ⁦groups.tax;⁩ ±⁦.⁩

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

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

grossMoneyData مطلوب

المبلغ الإجمالي · بعد الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

netMoneyData | nullمطلوب

المبلغ الصافي · بعد الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

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

المصدر⁦: products (⁩المنتجات⁦), shipping (⁩الشحن⁦).⁩

القيود

enum

["products", "shipping"]

مثال: "products"

taxMoneyData | nullمطلوب

مبلغ الضريبة · بعد الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

tax_rateسلسلة نصية | nullمطلوب

⁦tax_rate⁩ · بيانات الطلب المحفوظة⁦: "0.23" = 23%; "0"⁩ ≠ ⁦null.⁩

مثال: "0.23"

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

before_discountsOrderAmountBreakdownData مطلوب

الطلب · قبل الخصومات · ⁦net / tax / gross.⁩

مثال: {"gross":{"amount":"378.60","currency":"PLN","minor_units":2},"net":{"amount":"320.00","currency":"PLN","minor_units":2},"tax":{"amount":"58.60","currency":"PLN","minor_units":2}}

discountsOrderAmountBreakdownData مطلوب

الخصومات · ⁦net / tax / gross.⁩

مثال: {"gross":{"amount":"49.20","currency":"PLN","minor_units":2},"net":{"amount":"40.00","currency":"PLN","minor_units":2},"tax":{"amount":"9.20","currency":"PLN","minor_units":2}}

orderOrderAmountBreakdownData مطلوب

الطلب · بعد الخصومات · ⁦net / tax / gross.⁩

مثال: {"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}}

product_discountsOrderAmountBreakdownData مطلوب

المنتجات · الخصومات · ⁦net / tax / gross.⁩

مثال: {"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}

productsOrderAmountBreakdownData مطلوب

المنتجات · بعد الخصومات · ⁦net / tax / gross.⁩

مثال: {"gross":{"amount":"329.40","currency":"PLN","minor_units":2},"net":{"amount":"280.00","currency":"PLN","minor_units":2},"tax":{"amount":"49.40","currency":"PLN","minor_units":2}}

products_before_discountsOrderAmountBreakdownData مطلوب

المنتجات · قبل الخصومات · ⁦net / tax / gross.⁩

مثال: {"gross":{"amount":"354.00","currency":"PLN","minor_units":2},"net":{"amount":"300.00","currency":"PLN","minor_units":2},"tax":{"amount":"54.00","currency":"PLN","minor_units":2}}

shippingOrderAmountBreakdownData مطلوب

الشحن · بعد الخصومات · ⁦net / tax / gross.⁩

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

shipping_before_discountsOrderAmountBreakdownData مطلوب

الشحن · قبل الخصومات · ⁦net / tax / gross.⁩

مثال: {"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}

shipping_discountsOrderAmountBreakdownData مطلوب

الشحن · الخصومات · ⁦net / tax / gross.⁩

مثال: {"gross":{"amount":"24.60","currency":"PLN","minor_units":2},"net":{"amount":"20.00","currency":"PLN","minor_units":2},"tax":{"amount":"4.60","currency":"PLN","minor_units":2}}

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

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

اسم المورد في السياق المناسب.

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

القيمة التي يحددها المخطط المحيط بها.

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

amountMoneyData مطلوب

المبلغ الإجمالي · المنتجات · الخصومات⁦.⁩

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

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

معرّف المورد؛ احتفظ به كما أعيد⁦.⁩

مثال: "saved-coupon"

codeسلسلة نصية | nullمطلوب

رمز ثابت قابل للقراءة آليًا⁦.⁩

مثال: "SAVE"

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

صيغة بنية البيانات التي تحددها القيم المسموح بها⁦.⁩

القيود

enum

["coupon", "promotion"]

مثال: "coupon"

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

اسم المورد في السياق المناسب⁦.⁩

مثال: "Saved coupon"

sequenceعدد صحيح | nullاختياري

ترتيب التطبيق⁦; null.⁩

مثال: 1

shipping_amountMoneyData | nullاختياري

المبلغ الإجمالي · الشحن · الخصومات⁦; null.⁩

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

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

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

مثال: 3

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

amountMoneyData مطلوب

⁦payment.amount⁩ هو إجمالي الطلب⁦.⁩ لا تحدد حالة الدفع المبالغ المدفوعة أو المستردة أو المتبقية⁦.⁩

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

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

معلومات البيئة المرفقة بالسجل⁦.⁩

القيود

enum

["live", "sandbox"]

مثال: "live"

method_codeسلسلة نصية | nullمطلوب

رمز طريقة التسليم أو الدفع⁦.⁩

مثال: "payment-old"

method_nameسلسلة نصية | nullمطلوب

اسم طريقة التسليم أو الدفع⁦.⁩

مثال: "Historic method"

paid_atسلسلة نصية | nullمطلوب

تاريخ ووقت وضع علامة مدفوع على الدفعة⁦.⁩

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

مثال: null

statusOrderPaymentStatus مطلوب

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

مثال: "unpaid"

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

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

format: "date-time"

مثال: "2026-10-19T10:00:00Z"

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

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

مثال: 0

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

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

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

minimum: 0maximum: 9223372036854775807

مثال: 1

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

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

minLength: 1maxLength: 500

مثال: "Example"

statusPaymentStatus مطلوب

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

مثال: "paid"

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

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

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

السطر الأول من العنوان.

minLength: 1maxLength: 240

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

المدينة أو المنطقة المحلية.

minLength: 1maxLength: 160

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

الرمز البريدي.

minLength: 1maxLength: 32

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

latitudeعددمطلوب

WGS84 φ (°)

minimum: -90.0maximum: 90.0

longitudeعددمطلوب

WGS84 λ (°)

minimum: -180.0maximum: 180.0

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

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سلسلة نصيةمطلوب

الرمز البريدي.

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

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

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

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

عنوان البريد الإلكتروني.

مثال: "customer@example.invalid"

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

اسم المورد في السياق المناسب.

مثال: "Example"

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

amountMoneyData مطلوب

مبلغ الشحن شامل الضريبة والمسجل في الطلب بصيغة MoneyData. لا تغيّر التعديلات الضريبية اللاحقة هذا المبلغ التاريخي.

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

datesDeliveryDatesData مطلوب

تواريخ الشحن والتسليم. تتضمن قائمة الطلبات وتفاصيلها delivery.dates. التواريخ بصيغة YYYY-MM-DD مخططة ولا تؤكد الشحن الفعلي. للتواريخ الحالية الأولوية؛ وتستخدم الطلبات القديمة التقدير المحفوظ. القيم المحذوفة أو غير المعروفة هي null. تتضمن التفاصيل أيضًا جميع بنود الطلب وصور المنتجات.

مثال: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}

method_codeسلسلة نصية | nullمطلوب

رمز طريقة التسليم أو الدفع.

مثال: "shipping-old"

method_nameسلسلة نصية | nullمطلوب

اسم طريقة التسليم أو الدفع.

مثال: "Historic carrier"

pickup_pointPickupPointSummaryData | nullمطلوب

نقطة الاستلام

مثال: null

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

صيغة بنية البيانات التي تحددها القيم المسموح بها.

القيود

enum

["full_address", "pickup_contact"]

مثال: "full_address"

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

amountMoneyData مطلوب

مبلغ الشحن شامل الضريبة والمسجل في الطلب بصيغة ⁦MoneyData.⁩ لا تغيّر التعديلات الضريبية اللاحقة هذا المبلغ التاريخي⁦.⁩

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

datesDeliveryDatesData مطلوب

تواريخ الشحن والتسليم⁦.⁩ تتضمن قائمة الطلبات وتفاصيلها ⁦delivery.dates.⁩ التواريخ بصيغة ⁦YYYY-MM-DD⁩ مخططة ولا تؤكد الشحن الفعلي⁦.⁩ للتواريخ الحالية الأولوية؛ وتستخدم الطلبات القديمة التقدير المحفوظ⁦.⁩ القيم المحذوفة أو غير المعروفة هي ⁦null.⁩ تتضمن التفاصيل أيضًا جميع بنود الطلب وصور المنتجات⁦.⁩

مثال: {"dispatch_timezone":"Europe/Warsaw","estimated_delivery_from":"2026-10-20","estimated_delivery_to":"2026-10-21","planned_dispatch_on":"2026-10-19"}

discount_grossMoneyData مطلوب

المبلغ الإجمالي · الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

discount_netMoneyData | nullمطلوب

المبلغ الصافي · الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

discount_taxMoneyData | nullمطلوب

مبلغ الضريبة · الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

discountsمصفوفة <OrderDeliveryDiscountData > | nullمطلوب

الشحن · الخصومات⁦; []: 0; null:⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

مثال: [{"amount":{"amount":"24.60","currency":"PLN","minor_units":2},"campaign_id":"saved-coupon","code":"SAVE","kind":"coupon","name":"Saved coupon","sequence":1,"version":3}]

grossMoneyData مطلوب

المبلغ الإجمالي · بعد الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

method_codeسلسلة نصية | nullمطلوب

رمز طريقة التسليم أو الدفع⁦.⁩

مثال: "shipping-old"

method_nameسلسلة نصية | nullمطلوب

اسم طريقة التسليم أو الدفع⁦.⁩

مثال: "Historic carrier"

netMoneyData | nullمطلوب

المبلغ الصافي · بعد الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

original_grossMoneyData مطلوب

المبلغ الإجمالي · الشحن · قبل الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

original_netMoneyData | nullمطلوب

المبلغ الصافي · الشحن · قبل الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

original_taxMoneyData | nullمطلوب

مبلغ الضريبة · الشحن · قبل الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

pickup_pointDeliveryPickupPointData | nullمطلوب

نقطة الاستلام

مثال: null

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

صيغة بنية البيانات التي تحددها القيم المسموح بها⁦.⁩

القيود

enum

["full_address", "pickup_contact"]

مثال: "full_address"

taxMoneyData | nullمطلوب

مبلغ الضريبة · بعد الخصومات⁦;⁩ غير معروف⁦: null⁩؛ صفر معروف⁦: 0.⁩

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

tax_category_idسلسلة نصية | nullمطلوب

معرّف الفئة الضريبية · بيانات الطلب المحفوظة⁦; null.⁩

مثال: "standard"

tax_category_nameسلسلة نصية | nullمطلوب

اسم الفئة الضريبية المحفوظ⁦; null.⁩

مثال: "VAT 23%"

tax_rateسلسلة نصية | nullمطلوب

⁦tax_rate⁩ · بيانات الطلب المحفوظة⁦: "0.23" = 23%; "0"⁩ ≠ ⁦null.⁩

مثال: "0.23"

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