مطوّرو ليتس بيتزاv1.0.0

مرجع الواجهة

النماذج

كل بنى البيانات في واجهة الشركاء.

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مطلوبيقبل null
  • linesobject[]مطلوب
    الحقول الداخلية (5)
    • lineIndexintegerمطلوب

      القيمة: ≥ 0

    • codestringمطلوبيقبل null
    • variantstringمطلوبيقبل null
    • unitstringمطلوبيقبل null
    • optionsobject[]مطلوب
      الحقول الداخلية (4)
      • groupIdstringمطلوب

        الطول: 1 – 64

      • optionIdstringمطلوب

        الطول: 1 – 64

      • codestringمطلوبيقبل null
      • variantstringمطلوبيقبل null
  • tenderCodestringمطلوبيقبل null
  • unmappedobject[]مطلوب
    الحقول الداخلية (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>مطلوبيقبل null
  • ackedAtstring<date-time>مطلوبيقبل null
  • externalOrderNostringمطلوبيقبل null
  • externalReceiptNostringمطلوبيقبل null
  • externalPartnerOrderExternalمطلوب
    الحقول الداخلية (4)
    • branchCodestringمطلوبيقبل null
    • linesobject[]مطلوب
      الحقول الداخلية (5)
      • lineIndexintegerمطلوب

        القيمة: ≥ 0

      • codestringمطلوبيقبل null
      • variantstringمطلوبيقبل null
      • unitstringمطلوبيقبل null
      • optionsobject[]مطلوب
        الحقول الداخلية (4)
        • groupIdstringمطلوب

          الطول: 1 – 64

        • optionIdstringمطلوب

          الطول: 1 – 64

        • codestringمطلوبيقبل null
        • variantstringمطلوبيقبل null
    • tenderCodestringمطلوبيقبل null
    • unmappedobject[]مطلوب
      الحقول الداخلية (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>مطلوبيقبل null
    • ackedAtstring<date-time>مطلوبيقبل null
    • externalOrderNostringمطلوبيقبل null
    • externalReceiptNostringمطلوبيقبل null
    • externalPartnerOrderExternalمطلوب
      الحقول الداخلية (4)
      • branchCodestringمطلوبيقبل null
      • linesobject[]مطلوب
        الحقول الداخلية (5)
        • lineIndexintegerمطلوب

          القيمة: ≥ 0

        • codestringمطلوبيقبل null
        • variantstringمطلوبيقبل null
        • unitstringمطلوبيقبل null
        • optionsobject[]مطلوب
          الحقول الداخلية (4)
          • groupIdstringمطلوب

            الطول: 1 – 64

          • optionIdstringمطلوب

            الطول: 1 – 64

          • codestringمطلوبيقبل null
          • variantstringمطلوبيقبل null
      • tenderCodestringمطلوبيقبل null
      • unmappedobject[]مطلوب
        الحقول الداخلية (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[]مطلوبيقبل null
  • piibooleanمطلوب
  • activebooleanمطلوب
  • pausedAtstring<date-time>مطلوبيقبل null
  • pausedReasonstringمطلوبيقبل null
  • secretHintstringمطلوب
  • createdAtstring<date-time>مطلوب
  • createdBystringمطلوبيقبل null
  • partnerIdstringمطلوبيقبل null
  • updatedAtstring<date-time>مطلوب
  • lastDeliveryAtstring<date-time>مطلوبيقبل null
  • failureCountintegerمطلوب

    القيمة: ≥ 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[]مطلوبيقبل null
    • piibooleanمطلوب
    • activebooleanمطلوب
    • pausedAtstring<date-time>مطلوبيقبل null
    • pausedReasonstringمطلوبيقبل null
    • secretHintstringمطلوب
    • createdAtstring<date-time>مطلوب
    • createdBystringمطلوبيقبل null
    • partnerIdstringمطلوبيقبل null
    • updatedAtstring<date-time>مطلوب
    • lastDeliveryAtstring<date-time>مطلوبيقبل null
    • failureCountintegerمطلوب

      القيمة: ≥ 0

    • waitingintegerمطلوب

      القيمة: ≥ 0

    • deadintegerمطلوب

      القيمة: ≥ 0

  • secretstringمطلوب

WebhookDelivery#

  • idstringمطلوب

    الطول: 1 – 64

  • subscriptionIdstringمطلوب

    الطول: 1 – 64

  • eventIdstringمطلوبيقبل null
  • eventTypeWebhookEventTypeمطلوب

    القيم: "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مطلوبيقبل null
  • branchIdstringمطلوبيقبل null
  • attemptintegerمطلوب

    القيمة: ≥ 0

  • statusWebhookDeliveryStatusمطلوب

    القيم: "pending""delivered""failed""dead"

  • httpStatusintegerمطلوبيقبل null
  • durationMsintegerمطلوبيقبل null
  • errorstringمطلوبيقبل null
  • nextAtstring<date-time>مطلوبيقبل null
  • createdAtstring<date-time>مطلوب
  • lastAttemptAtstring<date-time>مطلوبيقبل null
  • deliveredAtstring<date-time>مطلوبيقبل null
  • replayOfstringمطلوبيقبل null

WebhookDeliveryPage#

  • deliveriesWebhookDelivery[]مطلوب
    الحقول الداخلية (16)
    • idstringمطلوب

      الطول: 1 – 64

    • subscriptionIdstringمطلوب

      الطول: 1 – 64

    • eventIdstringمطلوبيقبل null
    • eventTypeWebhookEventTypeمطلوب

      القيم: "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مطلوبيقبل null
    • branchIdstringمطلوبيقبل null
    • attemptintegerمطلوب

      القيمة: ≥ 0

    • statusWebhookDeliveryStatusمطلوب

      القيم: "pending""delivered""failed""dead"

    • httpStatusintegerمطلوبيقبل null
    • durationMsintegerمطلوبيقبل null
    • errorstringمطلوبيقبل null
    • nextAtstring<date-time>مطلوبيقبل null
    • createdAtstring<date-time>مطلوب
    • lastAttemptAtstring<date-time>مطلوبيقبل null
    • deliveredAtstring<date-time>مطلوبيقبل null
    • replayOfstringمطلوبيقبل 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مطلوبيقبل null
  • countsobjectمطلوب
    الحقول الداخلية (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مطلوبيقبل null
  • createdAtstring<date-time>مطلوب
  • decidedAtstring<date-time>مطلوبيقبل null
  • decidedBystringمطلوبيقبل 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مطلوب

    القيم: 1

  • idstringمطلوب
  • 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>مطلوبيقبل null
      • ackedAtstring<date-time>مطلوبيقبل null
      • externalOrderNostringمطلوبيقبل null
      • externalReceiptNostringمطلوبيقبل null
      • externalPartnerOrderExternalمطلوب
        الحقول الداخلية (4)
        • branchCodestringمطلوبيقبل null
        • linesobject[]مطلوب
          الحقول الداخلية (5)
          • lineIndexintegerمطلوب

            القيمة: ≥ 0

          • codestringمطلوبيقبل null
          • variantstringمطلوبيقبل null
          • unitstringمطلوبيقبل null
          • optionsobject[]مطلوب
            الحقول الداخلية (4)
            • groupIdstringمطلوب

              الطول: 1 – 64

            • optionIdstringمطلوب

              الطول: 1 – 64

            • codestringمطلوبيقبل null
            • variantstringمطلوبيقبل null
        • tenderCodestringمطلوبيقبل null
        • unmappedobject[]مطلوب
          الحقول الداخلية (2)
          • kindPartnerMappingKindمطلوب

            القيم: "branch""category""product""group""option""tender"

          • ourIdstringمطلوب
      • updatedAtstring<date-time>مطلوب

PartnerPushAnswer#

  • externalOrderNostringاختياري

    الطول: 1 – 50

  • externalReceiptNostringاختياري

    الطول: 1 – 50

PartnerDayBranch#

  • branchIdstringمطلوب

    الطول: 1 – 64

  • externalCodestringمطلوبيقبل null
  • ordersintegerمطلوب

    القيمة: ≥ 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مطلوبيقبل null
    • ordersintegerمطلوب

      القيمة: ≥ 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مطلوبيقبل null
    • createdAtstring<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مطلوبيقبل null
  • envIntegrationModeمطلوب

    القيم: "sandbox""live"

  • methodstringمطلوب
  • pathstringمطلوب
  • statusintegerمطلوب
  • errorCodestringمطلوبيقبل null
  • durationMsintegerمطلوب

    القيمة: ≥ 0

  • ipstringمطلوبيقبل null
  • atstring<date-time>مطلوب

PartnerRequestLogPage#

  • itemsPartnerRequestLogRow[]مطلوب
    الحقول الداخلية (12)
    • idintegerمطلوب

      القيمة: ≥ 1

    • requestIdstringمطلوب
    • keyIdstringمطلوبيقبل null

      الطول: 1 – 64

    • keyPrefixstringمطلوبيقبل null
    • envIntegrationModeمطلوب

      القيم: "sandbox""live"

    • methodstringمطلوب
    • pathstringمطلوب
    • statusintegerمطلوب
    • errorCodestringمطلوبيقبل null
    • durationMsintegerمطلوب

      القيمة: ≥ 0

    • ipstringمطلوبيقبل null
    • atstring<date-time>مطلوب
  • nextBeforeintegerمطلوبيقبل null

القوائم الثابتة#

الاسمالقيم
PartnerKinderpposkdsdeliverymarketplaceaccountinganalyticsother
PartnerScopebranches:readcatalog:readcatalog:writeavailability:writeorders:readorders:ackorders:statusorders:cancelorders:eventspayments:readreports:readwebhooks:managemappings:write
OrderDeliverynonepullwebhooksconnector
OrderAcceptancelppartner
PartnerStatusTargetacceptedrejectedpreparingreadypicked_upcancelledout_for_deliverydelivereddelivery_failed
CatalogFieldnamesdescriptionspricessizesgroupsoptionscategoriesavailability
CatalogPublishPolicymanualauto_pricesauto
InvoiceIssuerlppartner
IntegrationModesandboxlive
PartnerMappingKindbranchcategoryproductgroupoptiontender
PartnerOrderStateawaiting_ackackedclosed
IfUnavailablecallreplaceremovecancel
Tendercashcard
StatusChangeActorcustomerstaffsystempaymentpartner
ExitReasonCodecustomer_unreachablewrong_addresscustomer_refusedaccident_or_damagekitchen_errorout_of_stockcustomer_requestother
WebhookEventTypeorder.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
WebhookDeliveryStatuspendingdeliveredfaileddead
WebhookPauseReasonmanualfailures
CatalogImportStatusrejectedstagedpublisheddiscardedsuperseded