انتقل إلى المحتوى
ShopentlyLearn

مخططات البيانات: المخزون

مخططات البيانات: المخزون. حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

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

الكميات المخصصة لمواقع المستودع

AllocationData · المخطط · مخططات البيانات: المخزون
location_codeسلسلة نصيةمطلوب

رمز الموقع داخل المستودع.

مثال: "example"
location_idسلسلة نصيةمطلوب

معرّف الموقع داخل المستودع.

مثال: "example"
location_nameسلسلة نصيةمطلوب

اسم الموقع داخل المستودع.

مثال: "example"
on_handعدد صحيحمطلوب

الكمية الفعلية في المخزون.

مثال: 10

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

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · يُعاد الرمز بصيغة JSON والملف كمحتوى ثنائي. يتطلب كل طلب Bearer وصلاحية reveal.
dataCodeContentData مطلوب

محتوى الاستجابة الناجحة.

مثال: {"code":"DEMO-ONE","delivery_id":null,"kind":"code","payload_id":"00000000-0000-4000-8000-000000000004","unit_id":"00000000-0000-4000-8000-000000000003"}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

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

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

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

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · تحقق من الحجم والمجموع الاختباري والصيغة. لا يعني اكتمال الرفع استلام التوريد.
dataDigitalUploadData مطلوب

محتوى الاستجابة الناجحة.

مثال: {"consumer_id":"00000000-0000-4000-8000-000000000001","consumer_kind":"digital_import","expires_at":"2026-11-03T13:00:00Z","filename":"codes.txt","id":"00000000-0000-4000-8000-000000000002","product_id":"example","purpose":"digital_import","received_bytes":18,"sha256":"636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a","size_bytes":18,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

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

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

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

ApiResponse[ImportData]

ApiResponse_ImportData_ · تحقق من الحالة والإصدار ونتيجة التحقق. تنتمي المسودة إلى مفتاح API الذي أنشأها.
dataImportData مطلوب

محتوى الاستجابة الناجحة.

مثال: {"delivery_id":null,"delivery_status":null,"delivery_version":null,"expected_count":2,"expires_at":"2026-11-03T13:00:00Z","id":"00000000-0000-4000-8000-000000000001","kind":"code","product_id":"example","status":"validated","validated_count":2,"validation_digest":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

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

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

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

عرض القائمة · المخزون — المخزون — الاستجابة

ApiResponse_list_StockData__ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
dataمصفوفة <StockData > مطلوب

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

مثال: [{"active":true,"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

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

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

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

ApiResponse[PoolData]

ApiResponse_PoolData_ · اقرأ الإعدادات والكميات قبل تعديلها. لا تتضمن الاستجابة رموزًا أو محتوى ملفات.
dataPoolData مطلوب

محتوى الاستجابة الناجحة.

مثال: {"configured":true,"counts":{"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0},"email_mode":"order_link","enabled":true,"order_version":2,"product_id":"example","retention_days":null,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

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

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

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

جلب · المخزون — المخزون — الاستجابة

ApiResponse_StockDetailData_ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
dataStockDetailData مطلوب

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

مثال: {"active":true,"allocations":[{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}],"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

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

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

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

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · اقرأ حتى 100 وحدة في الصفحة. تعرض القائمة البيانات الوصفية دون كشف الرموز.
dataUnitsData مطلوب

محتوى الاستجابة الناجحة.

مثال: {"order_version":2,"total":1,"units":[{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

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

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

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

CodeContentData

CodeContentData · يُعاد الرمز بصيغة JSON والملف كمحتوى ثنائي. يتطلب كل طلب Bearer وصلاحية reveal.
codeسلسلة نصيةمطلوب

النص الدقيق للرمز الرقمي. حافظ على حالة الأحرف والمسافات الداخلية.

minLength: 1maxLength: 512
مثال: "DEMO-ONE"
delivery_idسلسلة نصية nullاختياري

معرّف التوريد أو تخصيص الطلب.

سلسلة نصية:format: "uuid"
مثال: null
kindسلسلة نصيةاختياري

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

const: "code"
القيمة الافتراضية: "code"مثال: "code"
payload_idسلسلة نصيةمطلوب

معرّف المحتوى؛ ليس رابط تنزيل عامًا.

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000004"
unit_idسلسلة نصيةمطلوب

معرّف رمز أو ملف فردي.

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000003"

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

DigitalUploadCreate

DigitalUploadCreate · احجز مساحة لملف واربطه باستيراد أو بالوحدة المراد استبدالها.
consumer_idسلسلة نصيةمطلوب

معرّف الاستيراد أو الوحدة المرتبطة.

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000001"
consumer_kindسلسلة نصيةمطلوب

ارتباط الرفع: digital_import / digital_unit.

القيود
enum
["digital_import", "digital_unit"]
مثال: "digital_import"
filenameسلسلة نصيةمطلوب

الملف

minLength: 1maxLength: 255
مثال: "codes.txt"
purposeسلسلة نصيةمطلوب

digital_import: قائمة TXT/CSV؛ digital_unit: ملف يُباع فرديًا.

القيود
enum
["digital_unit", "digital_import"]
مثال: "digital_import"
sha256سلسلة نصيةمطلوب

SHA-256 (hex, 64)

القيود
pattern
"^[0-9a-f]{64}$"
مثال: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesعدد صحيحمطلوب

الحجم بالبايت

minimum: 1maximum: 262144000
مثال: 18

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

DigitalUploadData

DigitalUploadData · تحقق من الحجم والمجموع الاختباري والصيغة. لا يعني اكتمال الرفع استلام التوريد.
consumer_idسلسلة نصيةمطلوب

معرّف الاستيراد أو الوحدة المرتبطة.

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000001"
consumer_kindسلسلة نصيةمطلوب

ارتباط الرفع: digital_import / digital_unit.

القيود
enum
["digital_import", "digital_unit"]
مثال: "digital_import"
expires_atسلسلة نصيةمطلوب

وقت انتهاء صلاحية هذا الرفع أو الاستيراد.

format: "date-time"
مثال: "2026-11-03T13:00:00Z"
filenameسلسلة نصيةمطلوب

الملف

مثال: "codes.txt"
idسلسلة نصيةمطلوب

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

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000002"
product_idسلسلة نصيةمطلوب

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

مثال: "example"
purposeسلسلة نصيةمطلوب

digital_import: قائمة TXT/CSV؛ digital_unit: ملف يُباع فرديًا.

القيود
enum
["digital_unit", "digital_import"]
مثال: "digital_import"
received_bytesعدد صحيحمطلوب

جارٍ الرفع… · الحجم بالبايت

مثال: 18
sha256سلسلة نصيةمطلوب

SHA-256 (hex, 64)

مثال: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesعدد صحيحمطلوب

الحجم بالبايت

مثال: 18
statusسلسلة نصيةمطلوب

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

مثال: "ready"

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

ImportCommit

ImportCommit · أنشئ توريدًا مخططًا أو مستلمًا من الدفعة المتحقق منها. الوحدات المخططة ليست متاحة للبيع بعد.
delivered_atسلسلة نصيةمطلوب

تاريخ التسليم ووقته.

format: "date-time"
مثال: "2026-11-03T12:00:00Z"
expected_delivery_versionعدد صحيحمطلوب

إصدار التوريد؛ 0 للتوريد الجديد.

minimum: 0maximum: 0
مثال: 0
expected_sales_limit_versionعدد صحيح nullاختياري

إصدار حد البيع؛ مطلوب مع publish_for_sale=true.

عدد صحيح:minimum: 0maximum: 9223372036854775807
مثال: 0
expected_versionعدد صحيحمطلوب

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

minimum: 1maximum: 9223372036854775807
مثال: 2
location_idسلسلة نصيةمطلوب

معرّف الموقع داخل المستودع.

القيود
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
مثال: "location-digital"
publish_for_saleقيمة منطقيةاختياري

تزيد true أيضًا حد البيع المحدود؛ وتتركه false دون تغيير.

القيمة الافتراضية: falseمثال: true
statusسلسلة نصيةمطلوب

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

القيود
enum
["planned", "received"]
مثال: "received"
validation_digestسلسلة نصيةمطلوب

مجموع التحقق الاختباري؛ أرسله دون تغيير عند التأكيد.

القيود
pattern
"^[0-9a-f]{64}$"
مثال: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
warehouse_idسلسلة نصيةمطلوب

معرّف المستودع.

القيود
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
مثال: "warehouse-main"

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

ImportCreate

ImportCreate · أنشئ مسودة تضم حتى 1000 رمز أو 100 ملف. لا يزيد المخزون المتاح للبيع في هذه المرحلة.
countعدد صحيحمطلوب

العدد الدقيق للوحدات في الدفعة.

minimum: 1maximum: 1000
مثال: 2
kindسلسلة نصيةمطلوب

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

القيود
enum
["code", "file"]
مثال: "code"

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

ImportData

ImportData · تحقق من الحالة والإصدار ونتيجة التحقق. تنتمي المسودة إلى مفتاح API الذي أنشأها.
delivery_idسلسلة نصية nullمطلوب

معرّف التوريد أو تخصيص الطلب.

مثال: null
delivery_statusسلسلة نصية nullمطلوب

حالة التوريد: planned / received؛ وقبل التأكيد null.

مثال: null
delivery_versionعدد صحيح nullمطلوب

الإصدار الحالي لتوريد المستودع.

مثال: null
expected_countعدد صحيحمطلوب

العدد المتوقع؛ يجب قبول الدفعة كاملة.

مثال: 2
expires_atسلسلة نصيةمطلوب

وقت انتهاء صلاحية هذا الرفع أو الاستيراد.

format: "date-time"
مثال: "2026-11-03T13:00:00Z"
idسلسلة نصيةمطلوب

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

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000001"
kindسلسلة نصيةمطلوب

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

القيود
enum
["code", "file"]
مثال: "code"
product_idسلسلة نصيةمطلوب

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

مثال: "example"
statusسلسلة نصيةمطلوب

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

مثال: "validated"
validated_countعدد صحيحمطلوب

عدد الوحدات المقبولة في آخر تحقق ناجح.

مثال: 2
validation_digestسلسلة نصية nullمطلوب

مجموع التحقق الاختباري؛ أرسله دون تغيير عند التأكيد.

مثال: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
versionعدد صحيحمطلوب

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

مثال: 2

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

ImportReceive

ImportReceive · استلم الوحدات الموجودة دون استيراد الرموز أو الملفات مرة أخرى.
expected_delivery_versionعدد صحيحمطلوب

إصدار التوريد؛ 0 للتوريد الجديد.

minimum: 1maximum: 9223372036854775807
مثال: 1
expected_sales_limit_versionعدد صحيح nullاختياري

إصدار حد البيع؛ مطلوب مع publish_for_sale=true.

عدد صحيح:minimum: 0maximum: 9223372036854775807
expected_versionعدد صحيحمطلوب

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

minimum: 1maximum: 9223372036854775807
مثال: 3
publish_for_saleقيمة منطقيةاختياري

تزيد true أيضًا حد البيع المحدود؛ وتتركه false دون تغيير.

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

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

ImportValidate

ImportValidate · تحقق من الدفعة كاملة. يرفض التكرار أو الإدخال غير الصحيح الدفعة، ولا تُقتطع الرموز.
code_columnسلسلة نصية nullاختياري

عمود CSV الذي يحتوي الرموز؛ استخدم code.

سلسلة نصية:const: "code"
expected_versionعدد صحيحمطلوب

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

minimum: 1maximum: 9223372036854775807
مثال: 1
formatسلسلة نصية nullاختياري

صيغة قائمة الرموز: txt / csv؛ استخدم upload_ids للملفات.

القيود · سلسلة نصية 1
enum
["txt", "csv"]
مثال: "txt"
source_upload_idسلسلة نصية nullاختياري

رفع TXT/CSV خاص وجاهز لهذا الاستيراد.

سلسلة نصية:format: "uuid"
مثال: "00000000-0000-4000-8000-000000000002"
upload_idsمصفوفة <سلسلة نصية> nullاختياري

1–100 رفع ملفات خاصة وجاهزة لهذا الاستيراد.

مصفوفة:minItems: 1maxItems: 100
مصفوفة / مصفوفة:format: "uuid"

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

ImportWithdrawal

ImportWithdrawal · اسحب الوحدات الحرة فقط. تبقى الوحدات المحجوزة والمخصصة مرتبطة بطلباتها.
expected_delivery_versionعدد صحيحمطلوب

إصدار التوريد؛ 0 للتوريد الجديد.

minimum: 1maximum: 9223372036854775807
مثال: 1
expected_order_versionعدد صحيحمطلوب

إصدار ترتيب التخصيص، وليس إصدار طلب العميل.

minimum: 0maximum: 9223372036854775807
مثال: 1
expected_versionعدد صحيحمطلوب

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

minimum: 1maximum: 9223372036854775807
مثال: 3
reasonسلسلة نصيةمطلوب

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

minLength: 1maxLength: 500
مثال: "Withdraw a revoked license"

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

تحديث · الحجز اليدوي — المخزون — محتوى الطلب

ManualReservationUpdate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
expected_versionعدد صحيحمطلوب

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

minimum: 1maximum: 9223372036854775807
مثال: 1
manual_reservedعدد صحيحمطلوب

الكمية المحجوزة يدويًا.

minimum: 0maximum: 2147483647
مثال: 1
reasonسلسلة نصيةاختياري

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

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

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

PoolChange

PoolChange · فعّل الرموز أو الملفات الفردية بدءًا من Professional. يحافظ التعطيل على الوصول إلى المشتريات السابقة.
email_modeسلسلة نصيةاختياري

disabled: بلا رسالة؛ order_link: رابط الطلب؛ code_text: يمكن إضافة الرموز.

القيود
enum
["disabled", "order_link", "code_text"]
القيمة الافتراضية: "disabled"مثال: "order_link"
enabledقيمة منطقيةمطلوب

ما إذا كان هذا الإعداد مفعّلًا.

مثال: true
expected_versionعدد صحيحمطلوب

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

minimum: 0maximum: 9223372036854775807
مثال: 0
retention_daysعدد صحيح nullاختياري

null: بلا نهاية؛ 1–3650 يومًا من أول وصول. لا تُحذف الرموز تلقائيًا.

عدد صحيح:minimum: 1maximum: 3650
مثال: null

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

PoolCounts

PoolCounts · اقرأ الإعدادات والكميات قبل تعديلها. لا تتضمن الاستجابة رموزًا أو محتوى ملفات.
availableعدد صحيحمطلوب

عدد الوحدات الحرة التي لم تُحجز أو تُسلّم بعد.

مثال: 1
heldعدد صحيحمطلوب

وحدات محجوزة للطلبات ولم تُسلّم بعد.

مثال: 0
issuedعدد صحيحمطلوب

وحدات سُلّمت بالفعل لمشتريات مدفوعة.

مثال: 1
plannedعدد صحيحمطلوب

وحدات توريدات مؤكدة لم تُستلم بعد.

مثال: 0
retiredعدد صحيحمطلوب

وحدات مسحوبة تبقى في السجل.

مثال: 0
stagedعدد صحيحمطلوب

وحدات استيرادات غير مكتملة، ليست مخزونًا بعد.

مثال: 0

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

PoolData

PoolData · اقرأ الإعدادات والكميات قبل تعديلها. لا تتضمن الاستجابة رموزًا أو محتوى ملفات.
configuredقيمة منطقيةمطلوب

هل حُفظت إعدادات المخزون الرقمي.

مثال: true
countsPoolCounts مطلوب

عدد الوحدات حسب حالة المخزون.

مثال: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}
email_modeسلسلة نصيةمطلوب

disabled: بلا رسالة؛ order_link: رابط الطلب؛ code_text: يمكن إضافة الرموز.

القيود
enum
["disabled", "order_link", "code_text"]
مثال: "order_link"
enabledقيمة منطقيةمطلوب

ما إذا كان هذا الإعداد مفعّلًا.

مثال: true
order_versionعدد صحيحمطلوب

إصدار ترتيب تخصيص المخزون.

مثال: 2
product_idسلسلة نصيةمطلوب

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

مثال: "example"
retention_daysعدد صحيح nullمطلوب

null: بلا نهاية؛ 1–3650 يومًا من أول وصول. لا تُحذف الرموز تلقائيًا.

مثال: null
versionعدد صحيحمطلوب

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

مثال: 1

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

تحديث · حد المبيعات — المخزون — محتوى الطلب

SalesLimitUpdate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
expected_versionعدد صحيحمطلوب

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

minimum: 1maximum: 9223372036854775807
مثال: 1
reasonسلسلة نصيةاختياري

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

maxLength: 500
القيمة الافتراضية: ""
sellable_limitعدد صحيحمطلوب

حد البيع: تعني -1 أنه غير محدود، بينما تعطل 0 التوفر للبيع.

minimum: -1maximum: 2147483647
مثال: 1

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

إنشاء · تسوية المخزون — المخزون — محتوى الطلب

StockAdjustmentCreate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
expected_versionعدد صحيحمطلوب

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

minimum: 0maximum: 9223372036854775807
مثال: 0
locationsمصفوفة <LocationQuantity > مطلوب

مواقع المستودع.

minItems: 1maxItems: 100
مثال: [{"location_id":"example","on_hand":1}]
reasonسلسلة نصيةمطلوب

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

minLength: 1maxLength: 500
مثال: "Example"
target_idسلسلة نصيةمطلوب

معرّف المنتج أو المتغير المتأثر بالعملية.

القيود
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
مثال: "example"
target_typeسلسلة نصيةمطلوب

ما إذا كانت العملية تتعلق بمنتج أو بمتغير منتج.

القيود
enum
["product", "variant"]
مثال: "product"
warehouse_idسلسلة نصيةمطلوب

معرّف المستودع.

القيود
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
مثال: "example"

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

تحديث · المخزون — المخزون — محتوى الطلب

StockAdjustmentUpdate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
expected_versionعدد صحيحمطلوب

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

minimum: 1maximum: 9223372036854775807
مثال: 1
locationsمصفوفة <LocationQuantity > مطلوب

مواقع المستودع.

minItems: 1maxItems: 100
مثال: [{"location_id":"example","on_hand":1}]
reasonسلسلة نصيةمطلوب

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

minLength: 1maxLength: 500
مثال: "Example"

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

عرض القائمة · المخزون — المخزون — الاستجابة

StockData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
activeقيمة منطقيةمطلوب

ما إذا كان المورد نشطًا.

مثال: true
availableعدد صحيح nullمطلوب

الكمية المتاحة للبيع؛ تمثل null كمية غير محدودة.

مثال: 5
idسلسلة نصيةمطلوب

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

مثال: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"
manual_reservedعدد صحيحمطلوب

الكمية المحجوزة يدويًا.

مثال: 2
on_handعدد صحيحمطلوب

الكمية الفعلية في المخزون.

مثال: 10
reservedعدد صحيحمطلوب

الكمية المحجوزة لطلبات الشراء.

مثال: 3
sellable_limitعدد صحيحمطلوب

حد البيع: تعني -1 أنه غير محدود، بينما تعطل 0 التوفر للبيع.

مثال: 10
target_idسلسلة نصيةمطلوب

معرّف المنتج أو المتغير المتأثر بالعملية.

مثال: "example"
target_typeسلسلة نصيةمطلوب

ما إذا كانت العملية تتعلق بمنتج أو بمتغير منتج.

القيود
enum
["product", "variant"]
مثال: "product"
total_reservedعدد صحيحمطلوب

إجمالي الكمية المحجوزة.

مثال: 5
updated_atسلسلة نصيةمطلوب

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

format: "date-time"
مثال: "2026-01-01T12:00:00Z"
versionعدد صحيحمطلوب

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

مثال: 1
warehouse_idسلسلة نصيةمطلوب

معرّف المستودع.

مثال: "example"

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

جلب · المخزون — المخزون — الاستجابة

StockDetailData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
activeقيمة منطقيةمطلوب

ما إذا كان المورد نشطًا.

مثال: true
allocationsمصفوفة <AllocationData > مطلوب

الكميات المخصصة لمواقع المستودع.

مثال: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]
availableعدد صحيح nullمطلوب

الكمية المتاحة للبيع؛ تمثل null كمية غير محدودة.

مثال: 5
idسلسلة نصيةمطلوب

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

مثال: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"
manual_reservedعدد صحيحمطلوب

الكمية المحجوزة يدويًا.

مثال: 2
on_handعدد صحيحمطلوب

الكمية الفعلية في المخزون.

مثال: 10
reservedعدد صحيحمطلوب

الكمية المحجوزة لطلبات الشراء.

مثال: 3
sellable_limitعدد صحيحمطلوب

حد البيع: تعني -1 أنه غير محدود، بينما تعطل 0 التوفر للبيع.

مثال: 10
target_idسلسلة نصيةمطلوب

معرّف المنتج أو المتغير المتأثر بالعملية.

مثال: "example"
target_typeسلسلة نصيةمطلوب

ما إذا كانت العملية تتعلق بمنتج أو بمتغير منتج.

القيود
enum
["product", "variant"]
مثال: "product"
total_reservedعدد صحيحمطلوب

إجمالي الكمية المحجوزة.

مثال: 5
updated_atسلسلة نصيةمطلوب

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

format: "date-time"
مثال: "2026-01-01T12:00:00Z"
versionعدد صحيحمطلوب

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

مثال: 1
warehouse_idسلسلة نصيةمطلوب

معرّف المستودع.

مثال: "example"

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

UnitData

UnitData · اقرأ حتى 100 وحدة في الصفحة. تعرض القائمة البيانات الوصفية دون كشف الرموز.
content_stateسلسلة نصيةمطلوب

حالة المحتوى: present / deleting / deleted.

مثال: "present"
delivery_idسلسلة نصية nullمطلوب

معرّف التوريد أو تخصيص الطلب.

مثال: "delivery-example"
filenameسلسلة نصية nullمطلوب

الملف

مثال: null
idسلسلة نصيةمطلوب

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

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000003"
issued_atسلسلة نصية nullمطلوب

وقت التسليم الأول؛ وقبله null.

سلسلة نصية:format: "date-time"
مثال: null
kindسلسلة نصيةمطلوب

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

القيود
enum
["file", "code"]
مثال: "code"
location_idسلسلة نصية nullمطلوب

معرّف الموقع داخل المستودع.

مثال: "location-digital"
mime_typeسلسلة نصية nullمطلوب

نوع محتوى الوسائط.

مثال: null
payload_idسلسلة نصيةمطلوب

معرّف المحتوى؛ ليس رابط تنزيل عامًا.

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000004"
product_idسلسلة نصيةمطلوب

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

مثال: "example"
size_bytesعدد صحيح nullمطلوب

الحجم بالبايت

مثال: null
sort_orderعدد صحيحمطلوب

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

مثال: 1
stateسلسلة نصيةمطلوب

الحالة

مثال: "available"
versionعدد صحيحمطلوب

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

مثال: 1
warehouse_idسلسلة نصية nullمطلوب

معرّف المستودع.

مثال: "warehouse-main"

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

UnitDeletion

UnitDeletion · أزل رمزًا أو ملفًا غير مباع مع ذكر السبب. تُرفض الوحدات المحجوزة أو المخصصة.
expected_versionعدد صحيحمطلوب

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

minimum: 1
مثال: 1
reasonسلسلة نصيةمطلوب

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

minLength: 1maxLength: 500
مثال: "Withdraw a revoked license"

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

UnitReorder

UnitReorder · أرسل الصفحة الكاملة دون تصفية بالترتيب المطلوب. يعيد الإصدار القديم 409.
expected_order_versionعدد صحيحمطلوب

إصدار ترتيب التخصيص، وليس إصدار طلب العميل.

minimum: 1
مثال: 1
unit_idsمصفوفة <سلسلة نصية> مطلوب

جميع وحدات الصفحة غير المصفاة بالترتيب المطلوب.

minItems: 2maxItems: 100
مصفوفة:format: "uuid"
مثال: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorسلسلة نصية nullاختياري

مؤشر الصفحة غير المصفاة؛ null للصفحة الأولى.

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

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

UnitReplacement

UnitReplacement · استبدل الرمز أو الملف دون تغيير ترتيبه. يُحفظ التعديل في سجل المخزون.
codeسلسلة نصية nullاختياري

النص الدقيق للرمز الرقمي. حافظ على حالة الأحرف والمسافات الداخلية.

سلسلة نصية:minLength: 1maxLength: 512
مثال: "SYNTHETIC-REPLACEMENT"
expected_versionعدد صحيحمطلوب

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

minimum: 1
مثال: 1
reasonسلسلة نصيةمطلوب

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

minLength: 1maxLength: 500
مثال: "Replace an invalid activation code"
upload_idسلسلة نصية nullاختياري

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

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

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

UnitsData

UnitsData · اقرأ حتى 100 وحدة في الصفحة. تعرض القائمة البيانات الوصفية دون كشف الرموز.
order_versionعدد صحيحمطلوب

إصدار ترتيب تخصيص المخزون.

مثال: 2
totalعدد صحيحمطلوب

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

مثال: 1
unitsمصفوفة <UnitData > مطلوب

بيانات الوحدات الوصفية؛ يتطلب المحتوى طلبًا منفصلًا مصرحًا به.

مثال: [{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]

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