مرجع الواجهة
النماذج
كل بنى البيانات في واجهة الشركاء.
PartnerSettings#
ordersobjectمطلوبالحقول الداخلية (5)
deliveryOrderDeliveryمطلوبكيف تصلك الطلبات: none بلا طلبات، pull بالسحب، webhooks بالإشعارات، connector نتصل نحن بنظامك.
القيم:
"none""pull""webhooks""connector"acceptanceOrderAcceptanceمطلوبمن يقبل الطلب الجديد: lp لوحة الفرع لدينا، أو partner نظامك.
القيم:
"lp""partner"ackMinutesintegerمطلوبالدقائق التي ينتظرها الطلب تأكيد استلامك قبل تنبيه الفرع (0 بلا تنبيه).
القيمة: 0 – 120
statusesPartnerStatusTarget[]مطلوبالحالات التي يحق لنظامك إبلاغها.
القيم:
"accepted""rejected""preparing""ready""picked_up""cancelled""out_for_delivery""delivered""delivery_failed"العناصر: ≤ 9
connectorstringمطلوبيقبل nullالموصّل المستخدم عندما تكون طريقة الاستلام connector.
الطول: ≤ 40
catalogobjectمطلوبالحقول الداخلية (5)
sourcebooleanمطلوبtrue: نظامك مصدر المنيو (شريك واحد فقط يكون كذلك).
fieldsCatalogField[]مطلوبحقول المنيو التي يملكها نظامك، ويبقى الباقي (الصور والترتيب) في لوحة التحكم.
القيم:
"names""descriptions""prices""sizes""groups""options""categories""availability"العناصر: ≤ 8
publishCatalogPublishPolicyمطلوبما يحدث للمنيو المرسل: manual مراجعة يدوية، auto_prices نشر تلقائي لتغيّر الأسعار فقط، auto نشر تلقائي بعد الفحوص.
القيم:
"manual""auto_prices""auto"maxPriceChangePctintegerمطلوبأقصى نسبة تغيّر في السعر تُنشر تلقائياً.
القيمة: 0 – 100
maxRemovalsintegerمطلوبأقصى عدد أصناف يجوز أن يختفي في نشر تلقائي.
القيمة: 0 – 1000
availabilitybooleanمطلوبtrue: يُطبَّق توفّر الأصناف الذي يرسله نظامك (يوقف الأصناف فقط، ولا يلغي إيقاف الموظفين).
invoicesobjectمطلوبالحقول الداخلية (1)
issuerInvoiceIssuerمطلوبمن يُصدر الفاتورة الضريبية للعميل: lp منصتنا، أو partner نظامك.
القيم:
"lp""partner"
customerDatastringمطلوبالقيم:
"full""masked"liveBranchesstring[]مطلوبالفروع المفعّلة لنظامك، وتبقى فارغة حتى نفعّلها معك.
العناصر: ≤ 200
PartnerMe#
partnerobjectمطلوبالشريك الذي يملك المفتاح.
الحقول الداخلية (3)
idstringمطلوبمعرّف الشريك لدى ليتس بيتزا.
الطول: 1 – 64
namestringمطلوباسم الشريك كما يظهر في لوحة التحكم.
kindPartnerKindمطلوبنوع النظام، ويحدد الإعدادات والصلاحيات الافتراضية.
القيم:
"erp""pos""kds""delivery""marketplace""accounting""analytics""other"
keyobjectمطلوبالمفتاح الذي أُرسل في هذا الطلب.
الحقول الداخلية (8)
idstringمطلوبالطول: 1 – 64
envIntegrationModeمطلوببيئة المفتاح: الاختبار أو الإنتاج.
القيم:
"sandbox""live"labelstringمطلوباسم المفتاح الذي اختاره فريق ليتس بيتزا.
prefixstringمطلوبأول أحرف المفتاح للتمييز بين المفاتيح، وليس المفتاح نفسه.
scopesPartnerScope[]مطلوبالصلاحيات التي يحملها المفتاح.
القيم:
"branches:read""catalog:read""catalog:write""availability:write""orders:read""orders:ack""orders:status""orders:cancel""orders:events""payments:read""reports:read""webhooks:manage""mappings:write"branchesstring[]مطلوبيقبل nullالفروع التي يعمل عليها المفتاح، و null تعني كل الفروع.
ratePerMinuteintegerمطلوبعدد الطلبات المسموح بها في الدقيقة لهذا المفتاح.
expiresAtstring<date-time>مطلوبيقبل nullتاريخ انتهاء المفتاح، و null تعني بلا تاريخ انتهاء.
environmentIntegrationModeمطلوببيئة الخادم الذي أجاب، وتطابق بيئة المفتاح دائماً.
القيم:
"sandbox""live"settingsPartnerSettingsمطلوبكيف تسير الطلبات والحالات والمنيو والفواتير مع نظامك.
الحقول الداخلية (6)
ordersobjectمطلوبالحقول الداخلية (5)
deliveryOrderDeliveryمطلوبكيف تصلك الطلبات: none بلا طلبات، pull بالسحب، webhooks بالإشعارات، connector نتصل نحن بنظامك.
القيم:
"none""pull""webhooks""connector"acceptanceOrderAcceptanceمطلوبمن يقبل الطلب الجديد: lp لوحة الفرع لدينا، أو partner نظامك.
القيم:
"lp""partner"ackMinutesintegerمطلوبالدقائق التي ينتظرها الطلب تأكيد استلامك قبل تنبيه الفرع (0 بلا تنبيه).
القيمة: 0 – 120
statusesPartnerStatusTarget[]مطلوبالحالات التي يحق لنظامك إبلاغها.
القيم:
"accepted""rejected""preparing""ready""picked_up""cancelled""out_for_delivery""delivered""delivery_failed"العناصر: ≤ 9
connectorstringمطلوبيقبل nullالموصّل المستخدم عندما تكون طريقة الاستلام connector.
الطول: ≤ 40
catalogobjectمطلوبالحقول الداخلية (5)
sourcebooleanمطلوبtrue: نظامك مصدر المنيو (شريك واحد فقط يكون كذلك).
fieldsCatalogField[]مطلوبحقول المنيو التي يملكها نظامك، ويبقى الباقي (الصور والترتيب) في لوحة التحكم.
القيم:
"names""descriptions""prices""sizes""groups""options""categories""availability"العناصر: ≤ 8
publishCatalogPublishPolicyمطلوبما يحدث للمنيو المرسل: manual مراجعة يدوية، auto_prices نشر تلقائي لتغيّر الأسعار فقط، auto نشر تلقائي بعد الفحوص.
القيم:
"manual""auto_prices""auto"maxPriceChangePctintegerمطلوبأقصى نسبة تغيّر في السعر تُنشر تلقائياً.
القيمة: 0 – 100
maxRemovalsintegerمطلوبأقصى عدد أصناف يجوز أن يختفي في نشر تلقائي.
القيمة: 0 – 1000
availabilitybooleanمطلوبtrue: يُطبَّق توفّر الأصناف الذي يرسله نظامك (يوقف الأصناف فقط، ولا يلغي إيقاف الموظفين).
invoicesobjectمطلوبالحقول الداخلية (1)
issuerInvoiceIssuerمطلوبمن يُصدر الفاتورة الضريبية للعميل: lp منصتنا، أو partner نظامك.
القيم:
"lp""partner"
customerDatastringمطلوبالقيم:
"full""masked"liveBranchesstring[]مطلوبالفروع المفعّلة لنظامك، وتبقى فارغة حتى نفعّلها معك.
العناصر: ≤ 200
apiVersionstringمطلوبإصدار الواجهة.
القيم:
"v1"serverTimestring<date-time>مطلوبساعة الخادم: قارنها بساعتك قبل التحقق من التواقيع.
PartnerBranch#
idstringمطلوبمعرّف الفرع لدى ليتس بيتزا، ثابت لا يتغيّر.
الطول: 1 – 64
namesLocalizedمطلوباسم الفرع بالعربية والإنجليزية.
الحقول الداخلية (2)
arstringمطلوبenstringمطلوب
phonestringمطلوبهاتف الفرع بصيغة دولية.
locationobjectمطلوبموقع الفرع على الخريطة.
الحقول الداخلية (2)
latnumberمطلوبlngnumberمطلوب
fulfilmentobjectمطلوبطرق الاستلام التي يقدّمها الفرع.
الحقول الداخلية (2)
deliverybooleanمطلوبpickupbooleanمطلوب
pausedbooleanمطلوبأوقف الموظفون الفرع الآن، مهما كانت أوقات العمل.
livebooleanمطلوبتدفقات نظامك مفعّلة في هذا الفرع.
externalCodestringمطلوبيقبل nullرمز الفرع في نظامك من جدول الربط، و null حتى يُربط.
Localized#
arstringمطلوبenstringمطلوب
PartnerBranchList#
itemsPartnerBranch[]مطلوبالفروع المسموح بها للمفتاح.
الحقول الداخلية (8)
idstringمطلوبمعرّف الفرع لدى ليتس بيتزا، ثابت لا يتغيّر.
الطول: 1 – 64
namesLocalizedمطلوباسم الفرع بالعربية والإنجليزية.
الحقول الداخلية (2)
arstringمطلوبenstringمطلوب
phonestringمطلوبهاتف الفرع بصيغة دولية.
locationobjectمطلوبموقع الفرع على الخريطة.
الحقول الداخلية (2)
latnumberمطلوبlngnumberمطلوب
fulfilmentobjectمطلوبطرق الاستلام التي يقدّمها الفرع.
الحقول الداخلية (2)
deliverybooleanمطلوبpickupbooleanمطلوب
pausedbooleanمطلوبأوقف الموظفون الفرع الآن، مهما كانت أوقات العمل.
livebooleanمطلوبتدفقات نظامك مفعّلة في هذا الفرع.
externalCodestringمطلوبيقبل nullرمز الفرع في نظامك من جدول الربط، و null حتى يُربط.
PartnerError#
codestringمطلوبرمز ثابت للخطأ، تبني عليه منطقك.
messageLocalizedمطلوبوصف للبشر بالعربية والإنجليزية، قد يتغيّر نصه.
الحقول الداخلية (2)
arstringمطلوبenstringمطلوب
fieldstringمطلوبيقبل nullالحقل المخالف في طلبك، إن وُجد.
retryablebooleanمطلوبtrue: قد ينجح الطلب نفسه لاحقاً. false: غيّر الطلب أولاً.
requestIdstringمطلوبرقم الطلب X-Request-Id، اذكره عند التواصل مع الدعم.
detailobjectاختياريمعلومات إضافية لبعض الرموز: الصلاحيات المطلوبة، ثواني الانتظار، الحالة الحالية للطلب.
كائن بمفاتيح حرّة.
PartnerMapping#
kindPartnerMappingKindمطلوبالقيم:
"branch""category""product""group""option""tender"ourIdstringمطلوبالطول: 1 – 64
codestringمطلوبالطول: 1 – 50
variantstringمطلوبيقبل nullالطول: 1 – 50
unitstringمطلوبيقبل nullالطول: 1 – 20
ourNameobjectمطلوبيقبل nullالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
updatedAtstring<date-time>مطلوب
PartnerMappingList#
envIntegrationModeمطلوبالقيم:
"sandbox""live"itemsPartnerMapping[]مطلوبالحقول الداخلية (7)
kindPartnerMappingKindمطلوبالقيم:
"branch""category""product""group""option""tender"ourIdstringمطلوبالطول: 1 – 64
codestringمطلوبالطول: 1 – 50
variantstringمطلوبيقبل nullالطول: 1 – 50
unitstringمطلوبيقبل nullالطول: 1 – 20
ourNameobjectمطلوبيقبل nullالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
updatedAtstring<date-time>مطلوب
PutPartnerMappingsRequest#
modestringمطلوبالقيم:
"merge""replace"dryRunbooleanاختياريitemsobject[]مطلوبالعناصر: ≤ 5000
الحقول الداخلية (5)
kindPartnerMappingKindمطلوبالقيم:
"branch""category""product""group""option""tender"ourIdstringمطلوبالطول: 1 – 64
codestringمطلوبالطول: 1 – 50
variantstringاختيارييقبل nullالطول: 1 – 50
unitstringاختيارييقبل nullالطول: 1 – 20
PartnerMappingIssue#
indexintegerمطلوبالقيمة: ≥ 0
codestringمطلوبالقيم:
"UNKNOWN_ID""DUPLICATE_ROW""CODE_TAKEN"fieldstringمطلوبvaluestringمطلوب
PartnerMappingResult#
dryRunbooleanمطلوبokbooleanمطلوبaddedintegerمطلوبالقيمة: ≥ 0
updatedintegerمطلوبالقيمة: ≥ 0
unchangedintegerمطلوبالقيمة: ≥ 0
removedintegerمطلوبالقيمة: ≥ 0
errorsPartnerMappingIssue[]مطلوبالحقول الداخلية (4)
indexintegerمطلوبالقيمة: ≥ 0
codestringمطلوبالقيم:
"UNKNOWN_ID""DUPLICATE_ROW""CODE_TAKEN"fieldstringمطلوبvaluestringمطلوب
PartnerOrderExternal#
branchCodestringمطلوبيقبل nulllinesobject[]مطلوبالحقول الداخلية (5)
lineIndexintegerمطلوبالقيمة: ≥ 0
codestringمطلوبيقبل nullvariantstringمطلوبيقبل nullunitstringمطلوبيقبل nulloptionsobject[]مطلوبالحقول الداخلية (4)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
codestringمطلوبيقبل nullvariantstringمطلوبيقبل null
tenderCodestringمطلوبيقبل nullunmappedobject[]مطلوبالحقول الداخلية (2)
kindPartnerMappingKindمطلوبالقيم:
"branch""category""product""group""option""tender"ourIdstringمطلوب
PartnerOrder#
orderOrderمطلوبالحقول الداخلية (25)
idstringمطلوبالطول: 1 – 64
numberstringمطلوبstatusstringمطلوبالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"channelstringمطلوبالقيم:
"app""web""console""pos""dine_in"branchIdstringمطلوبالطول: 1 – 64
fulfilmentstringمطلوبالقيم:
"delivery""pickup"paymentMethodstringمطلوبالقيم:
"pay_at_branch""cash_on_delivery""online"catalogVersionstringمطلوبlinesOrderLine[]مطلوبالحقول الداخلية (5)
lineIndexintegerمطلوبالقيمة: ≥ 0
lineCartLineمطلوبالحقول الداخلية (5)
productIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
selectionsCartSelection[]مطلوبالحقول الداخلية (5)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
notestringاختياريالطول: ≤ 200
sourceobjectاختياريالحقول الداخلية (2)
experiencestringمطلوبالقيم:
"classic""graphical"modestringاختياريالطول: ≤ 32
unitPriceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
lineTotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
snapshotLineSnapshotمطلوبالحقول الداخلية (2)
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
optionsSnapshotOption[]مطلوبالحقول الداخلية (7)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
qtyintegerمطلوبالقيمة: ≥ 1
priceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
subtotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
discountsDiscount[]مطلوبالحقول الداخلية (4)
kindstringمطلوبالقيم:
"coupon""offer"codestringاختياريnamesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
amountintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
discountTotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
deliveryFeeintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
totalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
vatobjectمطلوبالحقول الداخلية (3)
rateBpsintegerمطلوبamountintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
includesDeliveryFeebooleanمطلوب
scheduledForstring<date-time>اختياريnotestringاختياريcutlerybooleanاختياريifUnavailablestringاختياريdeliveryobjectاختياريالحقول الداخلية (5)
addressstringمطلوبالطول: 3 – 300
detailsstringاختياريالطول: ≤ 300
locationobjectاختياريالحقول الداخلية (2)
latnumberمطلوبالقيمة: -90 – 90
lngnumberمطلوبالقيمة: -180 – 180
contactNamestringمطلوبالطول: 1 – 80
contactPhonestringمطلوبالطول: 9 – 20
courierobjectاختياريالحقول الداخلية (2)
namestringمطلوبphonestringاختياري
tenderstringاختياريpaidAtstring<date-time>اختياريcreatedAtstring<date-time>مطلوبhistoryStatusChange[]مطلوبالحقول الداخلية (7)
fromstringمطلوبيقبل nullالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"tostringمطلوبالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"atstring<date-time>مطلوبactorStatusChangeActorمطلوبالقيم:
"customer""staff""system""payment""partner"reasonstringاختياريreasonCodestringاختياريreturnedToBranchbooleanاختياري
statePartnerOrderStateمطلوبالقيم:
"awaiting_ack""acked""closed"ackDueAtstring<date-time>مطلوبيقبل nullackedAtstring<date-time>مطلوبيقبل nullexternalOrderNostringمطلوبيقبل nullexternalReceiptNostringمطلوبيقبل nullexternalPartnerOrderExternalمطلوبالحقول الداخلية (4)
branchCodestringمطلوبيقبل nulllinesobject[]مطلوبالحقول الداخلية (5)
lineIndexintegerمطلوبالقيمة: ≥ 0
codestringمطلوبيقبل nullvariantstringمطلوبيقبل nullunitstringمطلوبيقبل nulloptionsobject[]مطلوبالحقول الداخلية (4)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
codestringمطلوبيقبل nullvariantstringمطلوبيقبل null
tenderCodestringمطلوبيقبل nullunmappedobject[]مطلوبالحقول الداخلية (2)
kindPartnerMappingKindمطلوبالقيم:
"branch""category""product""group""option""tender"ourIdstringمطلوب
updatedAtstring<date-time>مطلوب
Order#
idstringمطلوبالطول: 1 – 64
numberstringمطلوبstatusstringمطلوبالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"channelstringمطلوبالقيم:
"app""web""console""pos""dine_in"branchIdstringمطلوبالطول: 1 – 64
fulfilmentstringمطلوبالقيم:
"delivery""pickup"paymentMethodstringمطلوبالقيم:
"pay_at_branch""cash_on_delivery""online"catalogVersionstringمطلوبlinesOrderLine[]مطلوبالحقول الداخلية (5)
lineIndexintegerمطلوبالقيمة: ≥ 0
lineCartLineمطلوبالحقول الداخلية (5)
productIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
selectionsCartSelection[]مطلوبالحقول الداخلية (5)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
notestringاختياريالطول: ≤ 200
sourceobjectاختياريالحقول الداخلية (2)
experiencestringمطلوبالقيم:
"classic""graphical"modestringاختياريالطول: ≤ 32
unitPriceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
lineTotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
snapshotLineSnapshotمطلوبالحقول الداخلية (2)
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
optionsSnapshotOption[]مطلوبالحقول الداخلية (7)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
qtyintegerمطلوبالقيمة: ≥ 1
priceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
subtotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
discountsDiscount[]مطلوبالحقول الداخلية (4)
kindstringمطلوبالقيم:
"coupon""offer"codestringاختياريnamesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
amountintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
discountTotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
deliveryFeeintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
totalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
vatobjectمطلوبالحقول الداخلية (3)
rateBpsintegerمطلوبamountintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
includesDeliveryFeebooleanمطلوب
scheduledForstring<date-time>اختياريnotestringاختياريcutlerybooleanاختياريifUnavailablestringاختياريdeliveryobjectاختياريالحقول الداخلية (5)
addressstringمطلوبالطول: 3 – 300
detailsstringاختياريالطول: ≤ 300
locationobjectاختياريالحقول الداخلية (2)
latnumberمطلوبالقيمة: -90 – 90
lngnumberمطلوبالقيمة: -180 – 180
contactNamestringمطلوبالطول: 1 – 80
contactPhonestringمطلوبالطول: 9 – 20
courierobjectاختياريالحقول الداخلية (2)
namestringمطلوبphonestringاختياري
tenderstringاختياريpaidAtstring<date-time>اختياريcreatedAtstring<date-time>مطلوبhistoryStatusChange[]مطلوبالحقول الداخلية (7)
fromstringمطلوبيقبل nullالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"tostringمطلوبالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"atstring<date-time>مطلوبactorStatusChangeActorمطلوبالقيم:
"customer""staff""system""payment""partner"reasonstringاختياريreasonCodestringاختياريreturnedToBranchbooleanاختياري
OrderLine#
lineIndexintegerمطلوبالقيمة: ≥ 0
lineCartLineمطلوبالحقول الداخلية (5)
productIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
selectionsCartSelection[]مطلوبالحقول الداخلية (5)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
notestringاختياريالطول: ≤ 200
sourceobjectاختياريالحقول الداخلية (2)
experiencestringمطلوبالقيم:
"classic""graphical"modestringاختياريالطول: ≤ 32
unitPriceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
lineTotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
snapshotLineSnapshotمطلوبالحقول الداخلية (2)
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
optionsSnapshotOption[]مطلوبالحقول الداخلية (7)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
qtyintegerمطلوبالقيمة: ≥ 1
priceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
CartLine#
productIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
selectionsCartSelection[]مطلوبالحقول الداخلية (5)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
notestringاختياريالطول: ≤ 200
sourceobjectاختياريالحقول الداخلية (2)
experiencestringمطلوبالقيم:
"classic""graphical"modestringاختياريالطول: ≤ 32
CartSelection#
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
LineSnapshot#
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
optionsSnapshotOption[]مطلوبالحقول الداخلية (7)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
qtyintegerمطلوبالقيمة: ≥ 1
priceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
SnapshotOption#
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
qtyintegerمطلوبالقيمة: ≥ 1
priceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
Discount#
kindstringمطلوبالقيم:
"coupon""offer"codestringاختياريnamesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
amountintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
DeliveryDetails#
addressstringمطلوبالطول: 3 – 300
detailsstringاختياريالطول: ≤ 300
locationobjectاختياريالحقول الداخلية (2)
latnumberمطلوبالقيمة: -90 – 90
lngnumberمطلوبالقيمة: -180 – 180
contactNamestringمطلوبالطول: 1 – 80
contactPhonestringمطلوبالطول: 9 – 20
GeoPoint#
latnumberمطلوبالقيمة: -90 – 90
lngnumberمطلوبالقيمة: -180 – 180
Courier#
namestringمطلوبphonestringاختياري
StatusChange#
fromstringمطلوبيقبل nullالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"tostringمطلوبالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"atstring<date-time>مطلوبactorStatusChangeActorمطلوبالقيم:
"customer""staff""system""payment""partner"reasonstringاختياريreasonCodestringاختياريreturnedToBranchbooleanاختياري
PartnerOrderPage#
itemsPartnerOrder[]مطلوبالحقول الداخلية (8)
orderOrderمطلوبالحقول الداخلية (25)
idstringمطلوبالطول: 1 – 64
numberstringمطلوبstatusstringمطلوبالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"channelstringمطلوبالقيم:
"app""web""console""pos""dine_in"branchIdstringمطلوبالطول: 1 – 64
fulfilmentstringمطلوبالقيم:
"delivery""pickup"paymentMethodstringمطلوبالقيم:
"pay_at_branch""cash_on_delivery""online"catalogVersionstringمطلوبlinesOrderLine[]مطلوبالحقول الداخلية (5)
lineIndexintegerمطلوبالقيمة: ≥ 0
lineCartLineمطلوبالحقول الداخلية (5)
productIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
selectionsCartSelection[]مطلوبالحقول الداخلية (5)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
notestringاختياريالطول: ≤ 200
sourceobjectاختياريالحقول الداخلية (2)
experiencestringمطلوبالقيم:
"classic""graphical"modestringاختياريالطول: ≤ 32
unitPriceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
lineTotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
snapshotLineSnapshotمطلوبالحقول الداخلية (2)
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
optionsSnapshotOption[]مطلوبالحقول الداخلية (7)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
qtyintegerمطلوبالقيمة: ≥ 1
priceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
subtotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
discountsDiscount[]مطلوبالحقول الداخلية (4)
kindstringمطلوبالقيم:
"coupon""offer"codestringاختياريnamesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
amountintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
discountTotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
deliveryFeeintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
totalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
vatobjectمطلوبالحقول الداخلية (3)
rateBpsintegerمطلوبamountintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
includesDeliveryFeebooleanمطلوب
scheduledForstring<date-time>اختياريnotestringاختياريcutlerybooleanاختياريifUnavailablestringاختياريdeliveryobjectاختياريالحقول الداخلية (5)
addressstringمطلوبالطول: 3 – 300
detailsstringاختياريالطول: ≤ 300
locationobjectاختياريالحقول الداخلية (2)
latnumberمطلوبالقيمة: -90 – 90
lngnumberمطلوبالقيمة: -180 – 180
contactNamestringمطلوبالطول: 1 – 80
contactPhonestringمطلوبالطول: 9 – 20
courierobjectاختياريالحقول الداخلية (2)
namestringمطلوبphonestringاختياري
tenderstringاختياريpaidAtstring<date-time>اختياريcreatedAtstring<date-time>مطلوبhistoryStatusChange[]مطلوبالحقول الداخلية (7)
fromstringمطلوبيقبل nullالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"tostringمطلوبالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"atstring<date-time>مطلوبactorStatusChangeActorمطلوبالقيم:
"customer""staff""system""payment""partner"reasonstringاختياريreasonCodestringاختياريreturnedToBranchbooleanاختياري
statePartnerOrderStateمطلوبالقيم:
"awaiting_ack""acked""closed"ackDueAtstring<date-time>مطلوبيقبل nullackedAtstring<date-time>مطلوبيقبل nullexternalOrderNostringمطلوبيقبل nullexternalReceiptNostringمطلوبيقبل nullexternalPartnerOrderExternalمطلوبالحقول الداخلية (4)
branchCodestringمطلوبيقبل nulllinesobject[]مطلوبالحقول الداخلية (5)
lineIndexintegerمطلوبالقيمة: ≥ 0
codestringمطلوبيقبل nullvariantstringمطلوبيقبل nullunitstringمطلوبيقبل nulloptionsobject[]مطلوبالحقول الداخلية (4)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
codestringمطلوبيقبل nullvariantstringمطلوبيقبل null
tenderCodestringمطلوبيقبل nullunmappedobject[]مطلوبالحقول الداخلية (2)
kindPartnerMappingKindمطلوبالقيم:
"branch""category""product""group""option""tender"ourIdstringمطلوب
updatedAtstring<date-time>مطلوب
nextCursorstringمطلوبيقبل null
AckOrderRequest#
externalOrderNostringاختياريالطول: 1 – 50
externalReceiptNostringاختياريالطول: 1 – 50
PartnerStatusRequest#
eventIdstringمطلوبالطول: 1 – 64
toPartnerStatusTargetمطلوبالقيم:
"accepted""rejected""preparing""ready""picked_up""cancelled""out_for_delivery""delivered""delivery_failed"expectedFromstringاختياريالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"reasonCodestringاختياريreasonTextstringاختياريالطول: 1 – 300
occurredAtstring<date-time>مطلوبestimatedReadyAtstring<date-time>اختياري
PartnerCancelRequest#
eventIdstringمطلوبالطول: 1 – 64
reasonCodeExitReasonCodeمطلوبالقيم:
"customer_unreachable""wrong_address""customer_refused""accident_or_damage""kitchen_error""out_of_stock""customer_request""other"reasonTextstringاختياريالطول: 1 – 300
occurredAtstring<date-time>مطلوب
PartnerStatusResult#
outcomestringمطلوبالقيم:
"applied""duplicate""ignored""parked"statusstringمطلوبالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"reasonstringمطلوبيقبل null
PartnerOrderEventRequest#
eventIdstringمطلوبالطول: 1 – 64
typestringمطلوبالقيم:
"receipt_issued""invoice_issued""payment_collected""note"receiptNostringاختياريالطول: 1 – 50
invoiceNostringاختياريالطول: 1 – 50
invoiceQrstringاختياريالطول: ≤ 1000
amountintegerاختياريAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
tenderstringاختياريالقيم:
"cash""card"notestringاختياريالطول: 1 – 300
occurredAtstring<date-time>مطلوب
PartnerOrderEventResult#
outcomestringمطلوبالقيم:
"recorded""duplicate"
PartnerCatalog#
catalogCatalogمطلوبالحقول الداخلية (6)
versionCatalogVersionمطلوبالحقول الداخلية (4)
idstringمطلوبالطول: ≥ 1
statusstringمطلوبالقيم:
"draft""published"sourcestringمطلوبالقيم:
"taker""console""foodics""partner"createdAtstring<date-time>مطلوب
currencystringمطلوبالقيم:
"SAR"categoriesCategory[]مطلوبالحقول الداخلية (5)
idstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
imagestringاختياريsortintegerمطلوبexternalobjectاختياريالحقول الداخلية (2)
sourcestringمطلوبالقيم:
"taker""foodics""console"idstringمطلوب
groupsModifierGroup[]مطلوبالحقول الداخلية (12)
idstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
rolestringمطلوبالقيم:
"choice""extra""removal""cross_sell""bundle_slot"selectionstringمطلوبالقيم:
"single""multi"builderobjectاختياريالحقول الداخلية (3)
partstringمطلوبالقيم:
"dough""edge""sauce""cheese""topping""fresh""finish"placementbooleanمطلوبamountbooleanمطلوب
minSelectintegerمطلوبالقيمة: ≥ 0
maxSelectintegerمطلوبيقبل nullالقيمة: ≥ 1
perOptionMaxQtyintegerمطلوبالقيمة: ≥ 1
optionsGroupOption[]مطلوبالحقول الداخلية (9)
idstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
priceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
priceBySizeobjectاختياريالحقول الداخلية (2)
mediumintegerاختياريAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
largeintegerاختياريAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
builderobjectاختياريالحقول الداخلية (2)
placementbooleanاختياريamountstring[]اختياريالقيم:
"light""extra"العناصر: ≤ 2
imagestringاختياريlinkedProductIdstringاختياريالطول: 1 – 64
hiddenbooleanاختياريexternalobjectاختياريالحقول الداخلية (2)
sourcestringمطلوبالقيم:
"taker""foodics""console"idstringمطلوب
defaultOptionIdstringاختياريالطول: 1 – 64
descriptionsobjectاختياريالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
externalobjectاختياريالحقول الداخلية (2)
sourcestringمطلوبالقيم:
"taker""foodics""console"idstringمطلوب
productsProduct[]مطلوبالحقول الداخلية (15)
idstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
descriptionsLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
imagestringمطلوبcategoryIdstringمطلوبالطول: 1 – 64
kindstringمطلوبالقيم:
"simple""bundle"basePriceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
groupIdsstring[]مطلوبsizeFamilyobjectاختياريالحقول الداخلية (2)
familyIdstringمطلوبالطول: 1 – 64
sizestringمطلوبالقيم:
"medium""large"
slicesintegerاختياريالقيمة: 1 – 64
prepMinutesintegerمطلوبالقيمة: ≥ 0
tagsstring[]مطلوبالقيم:
"vegetarian""spicy""best_seller""new"sortintegerمطلوبbuilderobjectاختياريالحقول الداخلية (4)
baseArtstringمطلوبdrawnGroupIdsstring[]مطلوبmodestringاختياريالقيم:
"customize""scratch"rulesobjectاختياريالحقول الداخلية (4)
maxToppingsTotalintegerاختياريالقيمة: 1 – 200
maxPerHalfintegerاختياريالقيمة: 1 – 200
requireOneOfstring[][]اختياريالعناصر: ≤ 20
forbidTogetherstring[][]اختياريالعناصر: ≤ 200
externalobjectاختياريالحقول الداخلية (2)
sourcestringمطلوبالقيم:
"taker""foodics""console"idstringمطلوب
builderArtobjectاختياريالحقول الداخلية (3)
toppingsBuilderTopping[]مطلوبالحقول الداخلية (5)
optionIdstringمطلوبالطول: 1 – 64
piecesBuilderPiece[]مطلوبالعناصر: ≥ 1
الحقول الداخلية (4)
filestringمطلوبwnumberمطلوبالقيمة: ≥ 0
hnumberمطلوبالقيمة: ≥ 0
rnumberمطلوبالقيمة: ≥ 0
countintegerمطلوبالقيمة: ≥ 1
scalenumberمطلوبالقيمة: ≥ 0
patchbooleanمطلوب
saucesBuilderSauce[]مطلوبالحقول الداخلية (3)
optionIdstringمطلوبالطول: 1 – 64
colorstringمطلوبhighlightstringمطلوب
optionsobjectاختياريكائن بمفاتيح حرّة.
externalobjectمطلوبالحقول الداخلية (4)
categoriesobjectمطلوبكائن بمفاتيح حرّة.
productsobjectمطلوبكائن بمفاتيح حرّة.
groupsobjectمطلوبكائن بمفاتيح حرّة.
optionsobjectمطلوبكائن بمفاتيح حرّة.
Catalog#
versionCatalogVersionمطلوبالحقول الداخلية (4)
idstringمطلوبالطول: ≥ 1
statusstringمطلوبالقيم:
"draft""published"sourcestringمطلوبالقيم:
"taker""console""foodics""partner"createdAtstring<date-time>مطلوب
currencystringمطلوبالقيم:
"SAR"categoriesCategory[]مطلوبالحقول الداخلية (5)
idstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
imagestringاختياريsortintegerمطلوبexternalobjectاختياريالحقول الداخلية (2)
sourcestringمطلوبالقيم:
"taker""foodics""console"idstringمطلوب
groupsModifierGroup[]مطلوبالحقول الداخلية (12)
idstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
rolestringمطلوبالقيم:
"choice""extra""removal""cross_sell""bundle_slot"selectionstringمطلوبالقيم:
"single""multi"builderobjectاختياريالحقول الداخلية (3)
partstringمطلوبالقيم:
"dough""edge""sauce""cheese""topping""fresh""finish"placementbooleanمطلوبamountbooleanمطلوب
minSelectintegerمطلوبالقيمة: ≥ 0
maxSelectintegerمطلوبيقبل nullالقيمة: ≥ 1
perOptionMaxQtyintegerمطلوبالقيمة: ≥ 1
optionsGroupOption[]مطلوبالحقول الداخلية (9)
idstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
priceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
priceBySizeobjectاختياريالحقول الداخلية (2)
mediumintegerاختياريAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
largeintegerاختياريAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
builderobjectاختياريالحقول الداخلية (2)
placementbooleanاختياريamountstring[]اختياريالقيم:
"light""extra"العناصر: ≤ 2
imagestringاختياريlinkedProductIdstringاختياريالطول: 1 – 64
hiddenbooleanاختياريexternalobjectاختياريالحقول الداخلية (2)
sourcestringمطلوبالقيم:
"taker""foodics""console"idstringمطلوب
defaultOptionIdstringاختياريالطول: 1 – 64
descriptionsobjectاختياريالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
externalobjectاختياريالحقول الداخلية (2)
sourcestringمطلوبالقيم:
"taker""foodics""console"idstringمطلوب
productsProduct[]مطلوبالحقول الداخلية (15)
idstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
descriptionsLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
imagestringمطلوبcategoryIdstringمطلوبالطول: 1 – 64
kindstringمطلوبالقيم:
"simple""bundle"basePriceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
groupIdsstring[]مطلوبsizeFamilyobjectاختياريالحقول الداخلية (2)
familyIdstringمطلوبالطول: 1 – 64
sizestringمطلوبالقيم:
"medium""large"
slicesintegerاختياريالقيمة: 1 – 64
prepMinutesintegerمطلوبالقيمة: ≥ 0
tagsstring[]مطلوبالقيم:
"vegetarian""spicy""best_seller""new"sortintegerمطلوبbuilderobjectاختياريالحقول الداخلية (4)
baseArtstringمطلوبdrawnGroupIdsstring[]مطلوبmodestringاختياريالقيم:
"customize""scratch"rulesobjectاختياريالحقول الداخلية (4)
maxToppingsTotalintegerاختياريالقيمة: 1 – 200
maxPerHalfintegerاختياريالقيمة: 1 – 200
requireOneOfstring[][]اختياريالعناصر: ≤ 20
forbidTogetherstring[][]اختياريالعناصر: ≤ 200
externalobjectاختياريالحقول الداخلية (2)
sourcestringمطلوبالقيم:
"taker""foodics""console"idstringمطلوب
builderArtobjectاختياريالحقول الداخلية (3)
toppingsBuilderTopping[]مطلوبالحقول الداخلية (5)
optionIdstringمطلوبالطول: 1 – 64
piecesBuilderPiece[]مطلوبالعناصر: ≥ 1
الحقول الداخلية (4)
filestringمطلوبwnumberمطلوبالقيمة: ≥ 0
hnumberمطلوبالقيمة: ≥ 0
rnumberمطلوبالقيمة: ≥ 0
countintegerمطلوبالقيمة: ≥ 1
scalenumberمطلوبالقيمة: ≥ 0
patchbooleanمطلوب
saucesBuilderSauce[]مطلوبالحقول الداخلية (3)
optionIdstringمطلوبالطول: 1 – 64
colorstringمطلوبhighlightstringمطلوب
optionsobjectاختياريكائن بمفاتيح حرّة.
CatalogVersion#
idstringمطلوبالطول: ≥ 1
statusstringمطلوبالقيم:
"draft""published"sourcestringمطلوبالقيم:
"taker""console""foodics""partner"createdAtstring<date-time>مطلوب
Category#
idstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
imagestringاختياريsortintegerمطلوبexternalobjectاختياريالحقول الداخلية (2)
sourcestringمطلوبالقيم:
"taker""foodics""console"idstringمطلوب
ExternalRef#
sourcestringمطلوبالقيم:
"taker""foodics""console"idstringمطلوب
ModifierGroup#
idstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
rolestringمطلوبالقيم:
"choice""extra""removal""cross_sell""bundle_slot"selectionstringمطلوبالقيم:
"single""multi"builderobjectاختياريالحقول الداخلية (3)
partstringمطلوبالقيم:
"dough""edge""sauce""cheese""topping""fresh""finish"placementbooleanمطلوبamountbooleanمطلوب
minSelectintegerمطلوبالقيمة: ≥ 0
maxSelectintegerمطلوبيقبل nullالقيمة: ≥ 1
perOptionMaxQtyintegerمطلوبالقيمة: ≥ 1
optionsGroupOption[]مطلوبالحقول الداخلية (9)
idstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
priceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
priceBySizeobjectاختياريالحقول الداخلية (2)
mediumintegerاختياريAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
largeintegerاختياريAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
builderobjectاختياريالحقول الداخلية (2)
placementbooleanاختياريamountstring[]اختياريالقيم:
"light""extra"العناصر: ≤ 2
imagestringاختياريlinkedProductIdstringاختياريالطول: 1 – 64
hiddenbooleanاختياريexternalobjectاختياريالحقول الداخلية (2)
sourcestringمطلوبالقيم:
"taker""foodics""console"idstringمطلوب
defaultOptionIdstringاختياريالطول: 1 – 64
descriptionsobjectاختياريالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
externalobjectاختياريالحقول الداخلية (2)
sourcestringمطلوبالقيم:
"taker""foodics""console"idstringمطلوب
GroupBuilderHints#
partstringمطلوبالقيم:
"dough""edge""sauce""cheese""topping""fresh""finish"placementbooleanمطلوبamountbooleanمطلوب
GroupOption#
idstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
priceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
priceBySizeobjectاختياريالحقول الداخلية (2)
mediumintegerاختياريAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
largeintegerاختياريAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
builderobjectاختياريالحقول الداخلية (2)
placementbooleanاختياريamountstring[]اختياريالقيم:
"light""extra"العناصر: ≤ 2
imagestringاختياريlinkedProductIdstringاختياريالطول: 1 – 64
hiddenbooleanاختياريexternalobjectاختياريالحقول الداخلية (2)
sourcestringمطلوبالقيم:
"taker""foodics""console"idstringمطلوب
OptionBuilderHints#
placementbooleanاختياريamountstring[]اختياريالقيم:
"light""extra"العناصر: ≤ 2
Product#
idstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
descriptionsLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
imagestringمطلوبcategoryIdstringمطلوبالطول: 1 – 64
kindstringمطلوبالقيم:
"simple""bundle"basePriceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
groupIdsstring[]مطلوبsizeFamilyobjectاختياريالحقول الداخلية (2)
familyIdstringمطلوبالطول: 1 – 64
sizestringمطلوبالقيم:
"medium""large"
slicesintegerاختياريالقيمة: 1 – 64
prepMinutesintegerمطلوبالقيمة: ≥ 0
tagsstring[]مطلوبالقيم:
"vegetarian""spicy""best_seller""new"sortintegerمطلوبbuilderobjectاختياريالحقول الداخلية (4)
baseArtstringمطلوبdrawnGroupIdsstring[]مطلوبmodestringاختياريالقيم:
"customize""scratch"rulesobjectاختياريالحقول الداخلية (4)
maxToppingsTotalintegerاختياريالقيمة: 1 – 200
maxPerHalfintegerاختياريالقيمة: 1 – 200
requireOneOfstring[][]اختياريالعناصر: ≤ 20
forbidTogetherstring[][]اختياريالعناصر: ≤ 200
externalobjectاختياريالحقول الداخلية (2)
sourcestringمطلوبالقيم:
"taker""foodics""console"idstringمطلوب
BuilderProfile#
baseArtstringمطلوبdrawnGroupIdsstring[]مطلوبmodestringاختياريالقيم:
"customize""scratch"rulesobjectاختياريالحقول الداخلية (4)
maxToppingsTotalintegerاختياريالقيمة: 1 – 200
maxPerHalfintegerاختياريالقيمة: 1 – 200
requireOneOfstring[][]اختياريالعناصر: ≤ 20
forbidTogetherstring[][]اختياريالعناصر: ≤ 200
BuilderRules#
maxToppingsTotalintegerاختياريالقيمة: 1 – 200
maxPerHalfintegerاختياريالقيمة: 1 – 200
requireOneOfstring[][]اختياريالعناصر: ≤ 20
forbidTogetherstring[][]اختياريالعناصر: ≤ 200
BuilderArt#
toppingsBuilderTopping[]مطلوبالحقول الداخلية (5)
optionIdstringمطلوبالطول: 1 – 64
piecesBuilderPiece[]مطلوبالعناصر: ≥ 1
الحقول الداخلية (4)
filestringمطلوبwnumberمطلوبالقيمة: ≥ 0
hnumberمطلوبالقيمة: ≥ 0
rnumberمطلوبالقيمة: ≥ 0
countintegerمطلوبالقيمة: ≥ 1
scalenumberمطلوبالقيمة: ≥ 0
patchbooleanمطلوب
saucesBuilderSauce[]مطلوبالحقول الداخلية (3)
optionIdstringمطلوبالطول: 1 – 64
colorstringمطلوبhighlightstringمطلوب
optionsobjectاختياريكائن بمفاتيح حرّة.
BuilderTopping#
optionIdstringمطلوبالطول: 1 – 64
piecesBuilderPiece[]مطلوبالعناصر: ≥ 1
الحقول الداخلية (4)
filestringمطلوبwnumberمطلوبالقيمة: ≥ 0
hnumberمطلوبالقيمة: ≥ 0
rnumberمطلوبالقيمة: ≥ 0
countintegerمطلوبالقيمة: ≥ 1
scalenumberمطلوبالقيمة: ≥ 0
patchbooleanمطلوب
BuilderPiece#
filestringمطلوبwnumberمطلوبالقيمة: ≥ 0
hnumberمطلوبالقيمة: ≥ 0
rnumberمطلوبالقيمة: ≥ 0
BuilderSauce#
optionIdstringمطلوبالطول: 1 – 64
colorstringمطلوبhighlightstringمطلوب
BuilderOptionArt#
piecestringاختياريالطول: ≥ 1
layerstringاختيارييقبل nullالطول: ≥ 1
doughstringاختياريالقيم:
"classic""thin""pan"edgestringاختياريالقيم:
"classic""cheese""garlic"cheesestringاختياريالقيم:
"none""light""regular""extra"patchstringاختياريshapestringاختياريالقيم:
"dice""crumble""torn""shred""slice""crescent""blob"drizzlestringاختياريsprinklestringاختياريhighlightstringاختياريvesselstringاختياريالقيم:
"squeeze_bottle""oil_cruet"tintstringاختياريcountintegerاختياريالقيمة: ≥ 1
sizenumberاختياريالقيمة: ≥ 0
postbooleanاختياريprebooleanاختياريthinbooleanاختياري
PartnerOrderPayments#
orderIdstringمطلوبالطول: 1 – 64
paymentMethodstringمطلوبالقيم:
"pay_at_branch""cash_on_delivery""online"totalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
paidintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
refundedintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
attemptsobject[]مطلوبالحقول الداخلية (4)
idstringمطلوبالطول: 1 – 64
statusstringمطلوبamountintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
createdAtstring<date-time>مطلوب
refundsRefund[]مطلوبالحقول الداخلية (10)
idstringمطلوبالطول: 1 – 64
orderIdstringمطلوبالطول: 1 – 64
intentIdstringمطلوبيقبل nullالطول: 1 – 64
amountintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
reasonstringمطلوبالقيم:
"cancelled_by_customer""cancelled_by_branch""rejected""item_unavailable""quality""other"notestringاختياريالطول: ≤ 500
statusstringمطلوبالقيم:
"requested""processing""succeeded""failed"requestedBystringمطلوبالطول: ≥ 1
createdAtstring<date-time>مطلوبsettledAtstring<date-time>اختياري
Refund#
idstringمطلوبالطول: 1 – 64
orderIdstringمطلوبالطول: 1 – 64
intentIdstringمطلوبيقبل nullالطول: 1 – 64
amountintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
reasonstringمطلوبالقيم:
"cancelled_by_customer""cancelled_by_branch""rejected""item_unavailable""quality""other"notestringاختياريالطول: ≤ 500
statusstringمطلوبالقيم:
"requested""processing""succeeded""failed"requestedBystringمطلوبالطول: ≥ 1
createdAtstring<date-time>مطلوبsettledAtstring<date-time>اختياري
SaveWebhookRequest#
namestringمطلوبالطول: 1 – 80
urlstringمطلوبالطول: 8 – 500
eventsWebhookEventType[]مطلوبالقيم:
"order.created""order.accepted""order.preparing""order.ready""order.out_for_delivery""order.delivered""order.picked_up""order.cancelled""order.rejected""order.failed_delivery""order.not_collected""order.ack_overdue""payment.succeeded""payment.refunded""invoice.issued""branch.closed""branch.opened""branch.busy""availability.changed""catalog.published""ping"العناصر: 1 – 21
branchesstring[]اختيارييقبل nullالعناصر: ≤ 200
piibooleanاختياريactivebooleanاختياري
WebhookSubscription#
idstringمطلوبالطول: 1 – 64
namestringمطلوبurlstringمطلوبeventsWebhookEventType[]مطلوبالقيم:
"order.created""order.accepted""order.preparing""order.ready""order.out_for_delivery""order.delivered""order.picked_up""order.cancelled""order.rejected""order.failed_delivery""order.not_collected""order.ack_overdue""payment.succeeded""payment.refunded""invoice.issued""branch.closed""branch.opened""branch.busy""availability.changed""catalog.published""ping"branchesstring[]مطلوبيقبل nullpiibooleanمطلوبactivebooleanمطلوبpausedAtstring<date-time>مطلوبيقبل nullpausedReasonstringمطلوبيقبل nullsecretHintstringمطلوبcreatedAtstring<date-time>مطلوبcreatedBystringمطلوبيقبل nullpartnerIdstringمطلوبيقبل nullupdatedAtstring<date-time>مطلوبlastDeliveryAtstring<date-time>مطلوبيقبل nullfailureCountintegerمطلوبالقيمة: ≥ 0
waitingintegerمطلوبالقيمة: ≥ 0
deadintegerمطلوبالقيمة: ≥ 0
WebhookSecretIssued#
subscriptionWebhookSubscriptionمطلوبالحقول الداخلية (18)
idstringمطلوبالطول: 1 – 64
namestringمطلوبurlstringمطلوبeventsWebhookEventType[]مطلوبالقيم:
"order.created""order.accepted""order.preparing""order.ready""order.out_for_delivery""order.delivered""order.picked_up""order.cancelled""order.rejected""order.failed_delivery""order.not_collected""order.ack_overdue""payment.succeeded""payment.refunded""invoice.issued""branch.closed""branch.opened""branch.busy""availability.changed""catalog.published""ping"branchesstring[]مطلوبيقبل nullpiibooleanمطلوبactivebooleanمطلوبpausedAtstring<date-time>مطلوبيقبل nullpausedReasonstringمطلوبيقبل nullsecretHintstringمطلوبcreatedAtstring<date-time>مطلوبcreatedBystringمطلوبيقبل nullpartnerIdstringمطلوبيقبل nullupdatedAtstring<date-time>مطلوبlastDeliveryAtstring<date-time>مطلوبيقبل nullfailureCountintegerمطلوبالقيمة: ≥ 0
waitingintegerمطلوبالقيمة: ≥ 0
deadintegerمطلوبالقيمة: ≥ 0
secretstringمطلوب
WebhookDelivery#
idstringمطلوبالطول: 1 – 64
subscriptionIdstringمطلوبالطول: 1 – 64
eventIdstringمطلوبيقبل nulleventTypeWebhookEventTypeمطلوبالقيم:
"order.created""order.accepted""order.preparing""order.ready""order.out_for_delivery""order.delivered""order.picked_up""order.cancelled""order.rejected""order.failed_delivery""order.not_collected""order.ack_overdue""payment.succeeded""payment.refunded""invoice.issued""branch.closed""branch.opened""branch.busy""availability.changed""catalog.published""ping"subjectstringمطلوبيقبل nullbranchIdstringمطلوبيقبل nullattemptintegerمطلوبالقيمة: ≥ 0
statusWebhookDeliveryStatusمطلوبالقيم:
"pending""delivered""failed""dead"httpStatusintegerمطلوبيقبل nulldurationMsintegerمطلوبيقبل nullerrorstringمطلوبيقبل nullnextAtstring<date-time>مطلوبيقبل nullcreatedAtstring<date-time>مطلوبlastAttemptAtstring<date-time>مطلوبيقبل nulldeliveredAtstring<date-time>مطلوبيقبل nullreplayOfstringمطلوبيقبل null
WebhookDeliveryPage#
deliveriesWebhookDelivery[]مطلوبالحقول الداخلية (16)
idstringمطلوبالطول: 1 – 64
subscriptionIdstringمطلوبالطول: 1 – 64
eventIdstringمطلوبيقبل nulleventTypeWebhookEventTypeمطلوبالقيم:
"order.created""order.accepted""order.preparing""order.ready""order.out_for_delivery""order.delivered""order.picked_up""order.cancelled""order.rejected""order.failed_delivery""order.not_collected""order.ack_overdue""payment.succeeded""payment.refunded""invoice.issued""branch.closed""branch.opened""branch.busy""availability.changed""catalog.published""ping"subjectstringمطلوبيقبل nullbranchIdstringمطلوبيقبل nullattemptintegerمطلوبالقيمة: ≥ 0
statusWebhookDeliveryStatusمطلوبالقيم:
"pending""delivered""failed""dead"httpStatusintegerمطلوبيقبل nulldurationMsintegerمطلوبيقبل nullerrorstringمطلوبيقبل nullnextAtstring<date-time>مطلوبيقبل nullcreatedAtstring<date-time>مطلوبlastAttemptAtstring<date-time>مطلوبيقبل nulldeliveredAtstring<date-time>مطلوبيقبل nullreplayOfstringمطلوبيقبل null
nextBeforestringاختياري
PartnerMenu#
modestringمطلوبالقيم:
"full""delta"dryRunbooleanاختياريcategoriesobject[]اختياريالعناصر: ≤ 500
الحقول الداخلية (5)
codestringمطلوبالطول: 1 – 50
nameArstringمطلوبالطول: 1 – 120
nameEnstringمطلوبالطول: 1 – 120
sortOrderintegerاختياريblockedbooleanاختياري
itemsobject[]اختياريالعناصر: ≤ 3000
الحقول الداخلية (10)
codestringمطلوبالطول: 1 – 50
nameArstringمطلوبالطول: 1 – 120
nameEnstringمطلوبالطول: 1 – 120
descriptionArstringاختياريالطول: ≤ 500
descriptionEnstringاختياريالطول: ≤ 500
categoryCodestringاختياريالطول: 1 – 50
priceintegerاختياريالقيمة: ≥ 0
variantsobject[]اختياريالعناصر: ≤ 10
الحقول الداخلية (3)
codestringمطلوبالطول: 1 – 50
priceintegerمطلوبالقيمة: ≥ 0
blockedbooleanاختياري
groupCodesstring[]اختياريالعناصر: ≤ 50
blockedbooleanاختياري
groupsobject[]اختياريالعناصر: ≤ 500
الحقول الداخلية (7)
codestringمطلوبالطول: 1 – 50
nameArstringمطلوبالطول: 1 – 120
nameEnstringمطلوبالطول: 1 – 120
minSelectintegerاختياريالقيمة: ≥ 0
maxSelectintegerاختيارييقبل nullالقيمة: ≥ 1
maxPerOptionintegerاختياريالقيمة: ≥ 1
optionsobject[]مطلوبالعناصر: ≤ 200
الحقول الداخلية (6)
codestringمطلوبالطول: 1 – 50
nameArstringمطلوبالطول: 1 – 120
nameEnstringمطلوبالطول: 1 – 120
priceintegerمطلوبالقيمة: ≥ 0
pricesBySizeobjectاختياريالحقول الداخلية (2)
mediumintegerاختياريالقيمة: ≥ 0
largeintegerاختياريالقيمة: ≥ 0
blockedbooleanاختياري
CatalogImportUnknown#
kindstringمطلوبالقيم:
"category""item""variant""group""option"codestringمطلوبnamestringمطلوبpriceintegerمطلوبيقبل null
CatalogImport#
idstringمطلوبالطول: 1 – 64
partnerIdstringمطلوبالطول: 1 – 64
envIntegrationModeمطلوبالقيم:
"sandbox""live"modestringمطلوبالقيم:
"full""delta"statusCatalogImportStatusمطلوبالقيم:
"rejected""staged""published""discarded""superseded"reasonstringمطلوبيقبل nullcountsobjectمطلوبالحقول الداخلية (7)
categoriesintegerمطلوبitemsintegerمطلوبgroupsintegerمطلوبoptionsintegerمطلوبappliedintegerمطلوبunknownintegerمطلوبtakenOffintegerمطلوب
unknownCatalogImportUnknown[]مطلوبالحقول الداخلية (4)
kindstringمطلوبالقيم:
"category""item""variant""group""option"codestringمطلوبnamestringمطلوبpriceintegerمطلوبيقبل null
takenOffstring[]مطلوبissuesCatalogIssue[]مطلوبالحقول الداخلية (4)
severitystringمطلوبالقيم:
"error""warning"codestringمطلوبrefstringمطلوبdetailstringاختياري
diffobjectمطلوبيقبل nullالحقول الداخلية (9)
productsAddedstring[]مطلوبproductsRemovedstring[]مطلوبproductsChangedstring[]مطلوبpriceChangesobject[]مطلوبالحقول الداخلية (3)
productIdstringمطلوبالطول: 1 – 64
fromintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
tointegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
optionPriceChangesobject[]مطلوبالحقول الداخلية (5)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
sizestringاختياريالقيم:
"medium""large"fromintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
tointegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
groupsAddedstring[]مطلوبgroupsRemovedstring[]مطلوبgroupsChangedstring[]مطلوبcategoriesChangedbooleanمطلوب
versionIdstringمطلوبيقبل nullcreatedAtstring<date-time>مطلوبdecidedAtstring<date-time>مطلوبيقبل nulldecidedBystringمطلوبيقبل null
CatalogIssue#
severitystringمطلوبالقيم:
"error""warning"codestringمطلوبrefstringمطلوبdetailstringاختياري
CatalogDiff#
productsAddedstring[]مطلوبproductsRemovedstring[]مطلوبproductsChangedstring[]مطلوبpriceChangesobject[]مطلوبالحقول الداخلية (3)
productIdstringمطلوبالطول: 1 – 64
fromintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
tointegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
optionPriceChangesobject[]مطلوبالحقول الداخلية (5)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
sizestringاختياريالقيم:
"medium""large"fromintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
tointegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
groupsAddedstring[]مطلوبgroupsRemovedstring[]مطلوبgroupsChangedstring[]مطلوبcategoriesChangedbooleanمطلوب
PartnerAvailabilityItem#
kindstringمطلوبالقيم:
"product""option"idstringاختياريالطول: 1 – 64
codestringاختياريالطول: 1 – 50
variantstringاختياريالطول: 1 – 50
availablebooleanمطلوب
PartnerAvailabilityRequest#
itemsPartnerAvailabilityItem[]مطلوبالعناصر: ≤ 2000
الحقول الداخلية (5)
kindstringمطلوبالقيم:
"product""option"idstringاختياريالطول: 1 – 64
codestringاختياريالطول: 1 – 50
variantstringاختياريالطول: 1 – 50
availablebooleanمطلوب
PartnerAvailabilityResult#
branchIdstringمطلوبالطول: 1 – 64
offintegerمطلوبالقيمة: ≥ 0
onintegerمطلوبالقيمة: ≥ 0
keptStaffintegerمطلوبالقيمة: ≥ 0
unknownstring[]مطلوبunavailableobject[]مطلوبالحقول الداخلية (2)
kindstringمطلوبالقيم:
"product""option"idstringمطلوبالطول: 1 – 64
PartnerPushMessage#
versionnumberمطلوبالقيم:
1idstringمطلوبtypestringمطلوبالقيم:
"order.created""order.cancelled"occurredAtstring<date-time>مطلوبpartnerIdstringمطلوبالطول: 1 – 64
dataobjectمطلوبالحقول الداخلية (1)
orderPartnerOrderمطلوبالحقول الداخلية (8)
orderOrderمطلوبالحقول الداخلية (25)
idstringمطلوبالطول: 1 – 64
numberstringمطلوبstatusstringمطلوبالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"channelstringمطلوبالقيم:
"app""web""console""pos""dine_in"branchIdstringمطلوبالطول: 1 – 64
fulfilmentstringمطلوبالقيم:
"delivery""pickup"paymentMethodstringمطلوبالقيم:
"pay_at_branch""cash_on_delivery""online"catalogVersionstringمطلوبlinesOrderLine[]مطلوبالحقول الداخلية (5)
lineIndexintegerمطلوبالقيمة: ≥ 0
lineCartLineمطلوبالحقول الداخلية (5)
productIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
selectionsCartSelection[]مطلوبالحقول الداخلية (5)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
notestringاختياريالطول: ≤ 200
sourceobjectاختياريالحقول الداخلية (2)
experiencestringمطلوبالقيم:
"classic""graphical"modestringاختياريالطول: ≤ 32
unitPriceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
lineTotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
snapshotLineSnapshotمطلوبالحقول الداخلية (2)
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
optionsSnapshotOption[]مطلوبالحقول الداخلية (7)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
namesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
qtyintegerمطلوبالقيمة: ≥ 1
priceintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
subtotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
discountsDiscount[]مطلوبالحقول الداخلية (4)
kindstringمطلوبالقيم:
"coupon""offer"codestringاختياريnamesLocalizedمطلوبالحقول الداخلية (2)
arstringمطلوبenstringمطلوب
amountintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
discountTotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
deliveryFeeintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
totalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
vatobjectمطلوبالحقول الداخلية (3)
rateBpsintegerمطلوبamountintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
includesDeliveryFeebooleanمطلوب
scheduledForstring<date-time>اختياريnotestringاختياريcutlerybooleanاختياريifUnavailablestringاختياريdeliveryobjectاختياريالحقول الداخلية (5)
addressstringمطلوبالطول: 3 – 300
detailsstringاختياريالطول: ≤ 300
locationobjectاختياريالحقول الداخلية (2)
latnumberمطلوبالقيمة: -90 – 90
lngnumberمطلوبالقيمة: -180 – 180
contactNamestringمطلوبالطول: 1 – 80
contactPhonestringمطلوبالطول: 9 – 20
courierobjectاختياريالحقول الداخلية (2)
namestringمطلوبphonestringاختياري
tenderstringاختياريpaidAtstring<date-time>اختياريcreatedAtstring<date-time>مطلوبhistoryStatusChange[]مطلوبالحقول الداخلية (7)
fromstringمطلوبيقبل nullالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"tostringمطلوبالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"atstring<date-time>مطلوبactorStatusChangeActorمطلوبالقيم:
"customer""staff""system""payment""partner"reasonstringاختياريreasonCodestringاختياريreturnedToBranchbooleanاختياري
statePartnerOrderStateمطلوبالقيم:
"awaiting_ack""acked""closed"ackDueAtstring<date-time>مطلوبيقبل nullackedAtstring<date-time>مطلوبيقبل nullexternalOrderNostringمطلوبيقبل nullexternalReceiptNostringمطلوبيقبل nullexternalPartnerOrderExternalمطلوبالحقول الداخلية (4)
branchCodestringمطلوبيقبل nulllinesobject[]مطلوبالحقول الداخلية (5)
lineIndexintegerمطلوبالقيمة: ≥ 0
codestringمطلوبيقبل nullvariantstringمطلوبيقبل nullunitstringمطلوبيقبل nulloptionsobject[]مطلوبالحقول الداخلية (4)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
codestringمطلوبيقبل nullvariantstringمطلوبيقبل null
tenderCodestringمطلوبيقبل nullunmappedobject[]مطلوبالحقول الداخلية (2)
kindPartnerMappingKindمطلوبالقيم:
"branch""category""product""group""option""tender"ourIdstringمطلوب
updatedAtstring<date-time>مطلوب
PartnerPushAnswer#
externalOrderNostringاختياريالطول: 1 – 50
externalReceiptNostringاختياريالطول: 1 – 50
PartnerDayBranch#
branchIdstringمطلوبالطول: 1 – 64
externalCodestringمطلوبيقبل nullordersintegerمطلوبالقيمة: ≥ 0
servedintegerمطلوبالقيمة: ≥ 0
endedintegerمطلوبالقيمة: ≥ 0
openintegerمطلوبالقيمة: ≥ 0
servedTotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
refundedintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
PartnerDailyReport#
datestringمطلوبbranchesPartnerDayBranch[]مطلوبالحقول الداخلية (8)
branchIdstringمطلوبالطول: 1 – 64
externalCodestringمطلوبيقبل nullordersintegerمطلوبالقيمة: ≥ 0
servedintegerمطلوبالقيمة: ≥ 0
endedintegerمطلوبالقيمة: ≥ 0
openintegerمطلوبالقيمة: ≥ 0
servedTotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
refundedintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
ordersobject[]مطلوبالحقول الداخلية (7)
orderIdstringمطلوبالطول: 1 – 64
numberstringمطلوبbranchIdstringمطلوبالطول: 1 – 64
statusstringمطلوبالقيم:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"totalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
externalOrderNostringمطلوبيقبل nullcreatedAtstring<date-time>مطلوب
PartnerReconciliationRequest#
datestringمطلوبbranchesobject[]مطلوبالعناصر: 1 – 200
الحقول الداخلية (4)
branchIdstringمطلوبالطول: 1 – 64
servedintegerمطلوبالقيمة: ≥ 0
servedTotalintegerمطلوبAmount in halalas (1 riyal = 100), VAT-inclusive
القيمة: ≥ 0
externalOrderNosstring[]اختياريالعناصر: ≤ 5000
PartnerReconciliation#
datestringمطلوبmatchedbooleanمطلوبbranchesobject[]مطلوبالحقول الداخلية (6)
branchIdstringمطلوبالطول: 1 – 64
oursobjectمطلوبالحقول الداخلية (2)
servedintegerمطلوبservedTotalintegerمطلوب
theirsobjectمطلوبالحقول الداخلية (2)
servedintegerمطلوبservedTotalintegerمطلوب
matchedbooleanمطلوبmissingAtPartnerstring[]مطلوبunknownAtLpstring[]مطلوب
PartnerTokenRequest#
grant_typestringمطلوبالطول: ≤ 40
client_idstringمطلوبالطول: 1 – 64
client_secretstringمطلوبالطول: 10 – 200
scopestringاختياريالطول: ≤ 500
PartnerTokenResponse#
access_tokenstringمطلوبtoken_typestringمطلوبالقيم:
"Bearer"expires_inintegerمطلوبالقيمة: ≥ 1
scopestringمطلوب
PartnerSandboxOrderRequest#
branchIdstringمطلوبالطول: 1 – 64
fulfilmentstringمطلوبالقيم:
"pickup""delivery"linesCartLine[]اختياريالعناصر: 1 – 20
الحقول الداخلية (5)
productIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
selectionsCartSelection[]مطلوبالحقول الداخلية (5)
groupIdstringمطلوبالطول: 1 – 64
optionIdstringمطلوبالطول: 1 – 64
qtyintegerمطلوبالقيمة: ≥ 1
placementstringاختياريالقيم:
"whole""left""right"amountstringاختياريالقيم:
"light""regular""extra"
notestringاختياريالطول: ≤ 200
sourceobjectاختياريالحقول الداخلية (2)
experiencestringمطلوبالقيم:
"classic""graphical"modestringاختياريالطول: ≤ 32
paymentMethodstringاختياريالقيم:
"pay_at_branch""cash_on_delivery"deliveryobjectاختياريالحقول الداخلية (5)
addressstringمطلوبالطول: 3 – 300
detailsstringاختياريالطول: ≤ 300
locationobjectاختياريالحقول الداخلية (2)
latnumberمطلوبالقيمة: -90 – 90
lngnumberمطلوبالقيمة: -180 – 180
contactNamestringمطلوبالطول: 1 – 80
contactPhonestringمطلوبالطول: 9 – 20
PartnerRequestLogRow#
idintegerمطلوبالقيمة: ≥ 1
requestIdstringمطلوبkeyIdstringمطلوبيقبل nullالطول: 1 – 64
keyPrefixstringمطلوبيقبل nullenvIntegrationModeمطلوبالقيم:
"sandbox""live"methodstringمطلوبpathstringمطلوبstatusintegerمطلوبerrorCodestringمطلوبيقبل nulldurationMsintegerمطلوبالقيمة: ≥ 0
ipstringمطلوبيقبل nullatstring<date-time>مطلوب
PartnerRequestLogPage#
itemsPartnerRequestLogRow[]مطلوبالحقول الداخلية (12)
idintegerمطلوبالقيمة: ≥ 1
requestIdstringمطلوبkeyIdstringمطلوبيقبل nullالطول: 1 – 64
keyPrefixstringمطلوبيقبل nullenvIntegrationModeمطلوبالقيم:
"sandbox""live"methodstringمطلوبpathstringمطلوبstatusintegerمطلوبerrorCodestringمطلوبيقبل nulldurationMsintegerمطلوبالقيمة: ≥ 0
ipstringمطلوبيقبل nullatstring<date-time>مطلوب
nextBeforeintegerمطلوبيقبل null
القوائم الثابتة#
| الاسم | القيم |
|---|---|
PartnerKind | erpposkdsdeliverymarketplaceaccountinganalyticsother |
PartnerScope | branches:readcatalog:readcatalog:writeavailability:writeorders:readorders:ackorders:statusorders:cancelorders:eventspayments:readreports:readwebhooks:managemappings:write |
OrderDelivery | nonepullwebhooksconnector |
OrderAcceptance | lppartner |
PartnerStatusTarget | acceptedrejectedpreparingreadypicked_upcancelledout_for_deliverydelivereddelivery_failed |
CatalogField | namesdescriptionspricessizesgroupsoptionscategoriesavailability |
CatalogPublishPolicy | manualauto_pricesauto |
InvoiceIssuer | lppartner |
IntegrationMode | sandboxlive |
PartnerMappingKind | branchcategoryproductgroupoptiontender |
PartnerOrderState | awaiting_ackackedclosed |
IfUnavailable | callreplaceremovecancel |
Tender | cashcard |
StatusChangeActor | customerstaffsystempaymentpartner |
ExitReasonCode | customer_unreachablewrong_addresscustomer_refusedaccident_or_damagekitchen_errorout_of_stockcustomer_requestother |
WebhookEventType | order.createdorder.acceptedorder.preparingorder.readyorder.out_for_deliveryorder.deliveredorder.picked_uporder.cancelledorder.rejectedorder.failed_deliveryorder.not_collectedorder.ack_overduepayment.succeededpayment.refundedinvoice.issuedbranch.closedbranch.openedbranch.busyavailability.changedcatalog.publishedping |
WebhookDeliveryStatus | pendingdeliveredfaileddead |
WebhookPauseReason | manualfailures |
CatalogImportStatus | rejectedstagedpublisheddiscardedsuperseded |