Let's Pizza Developersv1.0.0

API reference

Models

Every data structure of the partner API.

PartnerSettings#

  • ordersobjectrequired
    Child attributes (5)
    • deliveryOrderDeliveryrequired

      How you learn about orders: none, pull, webhooks, or connector (we call your system).

      Values: "none""pull""webhooks""connector"

    • acceptanceOrderAcceptancerequired

      Who accepts a new order: lp (our branch board) or partner (your system).

      Values: "lp""partner"

    • ackMinutesintegerrequired

      Minutes an order waits for your acknowledgement before the branch is alerted (0 = no alert).

      value 0 – 120

    • statusesPartnerStatusTarget[]required

      The statuses your system may report.

      Values: "accepted""rejected""preparing""ready""picked_up""cancelled""out_for_delivery""delivered""delivery_failed"

      items ≤ 9

    • connectorstringrequirednullable

      The connector used when delivery is `connector`.

      length ≤ 40

  • catalogobjectrequired
    Child attributes (5)
    • sourcebooleanrequired

      True: your system is the menu source (only one partner may be).

    • fieldsCatalogField[]required

      The menu fields your system owns; the rest (pictures, order) stay the console's.

      Values: "names""descriptions""prices""sizes""groups""options""categories""availability"

      items ≤ 8

    • publishCatalogPublishPolicyrequired

      What happens to a menu you send: manual review, auto_prices (price-only changes publish by themselves), or auto.

      Values: "manual""auto_prices""auto"

    • maxPriceChangePctintegerrequired

      The largest price change, in percent, that publishes by itself.

      value 0 – 100

    • maxRemovalsintegerrequired

      The most items an automatic publish may remove.

      value 0 – 1000

  • availabilitybooleanrequired

    True: your availability flags apply (they only take items off; staff flags stay staff's).

  • invoicesobjectrequired
    Child attributes (1)
    • issuerInvoiceIssuerrequired

      Who issues the customer's tax invoice: lp (our platform) or partner (your system).

      Values: "lp""partner"

  • customerDatastringrequired

    Values: "full""masked"

  • liveBranchesstring[]required

    The branches where your flows are switched on; empty until we switch them on with you.

    items ≤ 200

PartnerMe#

  • partnerobjectrequired

    The partner the key belongs to.

    Child attributes (3)
    • idstringrequired

      The partner's id at Let's Pizza.

      length 1 – 64

    • namestringrequired

      The partner name, as the console shows it.

    • kindPartnerKindrequired

      What the system is; decides the default settings and scopes.

      Values: "erp""pos""kds""delivery""marketplace""accounting""analytics""other"

  • keyobjectrequired

    The key this request was made with.

    Child attributes (8)
    • idstringrequired

      length 1 – 64

    • envIntegrationModerequired

      The key's environment: sandbox or live.

      Values: "sandbox""live"

    • labelstringrequired

      The key's label, chosen by Let's Pizza.

    • prefixstringrequired

      The first characters of the key, to tell keys apart; never the key.

    • scopesPartnerScope[]required

      The scopes the key carries.

      Values: "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[]requirednullable

      The branches the key may act on; null = every branch.

    • ratePerMinuteintegerrequired

      Requests per minute allowed for this key.

    • expiresAtstring<date-time>requirednullable

      When the key expires; null = no end.

  • environmentIntegrationModerequired

    The environment of the host that answered; always the key's own.

    Values: "sandbox""live"

  • settingsPartnerSettingsrequired

    How orders, statuses, the menu and invoices flow for your system.

    Child attributes (6)
    • ordersobjectrequired
      Child attributes (5)
      • deliveryOrderDeliveryrequired

        How you learn about orders: none, pull, webhooks, or connector (we call your system).

        Values: "none""pull""webhooks""connector"

      • acceptanceOrderAcceptancerequired

        Who accepts a new order: lp (our branch board) or partner (your system).

        Values: "lp""partner"

      • ackMinutesintegerrequired

        Minutes an order waits for your acknowledgement before the branch is alerted (0 = no alert).

        value 0 – 120

      • statusesPartnerStatusTarget[]required

        The statuses your system may report.

        Values: "accepted""rejected""preparing""ready""picked_up""cancelled""out_for_delivery""delivered""delivery_failed"

        items ≤ 9

      • connectorstringrequirednullable

        The connector used when delivery is `connector`.

        length ≤ 40

    • catalogobjectrequired
      Child attributes (5)
      • sourcebooleanrequired

        True: your system is the menu source (only one partner may be).

      • fieldsCatalogField[]required

        The menu fields your system owns; the rest (pictures, order) stay the console's.

        Values: "names""descriptions""prices""sizes""groups""options""categories""availability"

        items ≤ 8

      • publishCatalogPublishPolicyrequired

        What happens to a menu you send: manual review, auto_prices (price-only changes publish by themselves), or auto.

        Values: "manual""auto_prices""auto"

      • maxPriceChangePctintegerrequired

        The largest price change, in percent, that publishes by itself.

        value 0 – 100

      • maxRemovalsintegerrequired

        The most items an automatic publish may remove.

        value 0 – 1000

    • availabilitybooleanrequired

      True: your availability flags apply (they only take items off; staff flags stay staff's).

    • invoicesobjectrequired
      Child attributes (1)
      • issuerInvoiceIssuerrequired

        Who issues the customer's tax invoice: lp (our platform) or partner (your system).

        Values: "lp""partner"

    • customerDatastringrequired

      Values: "full""masked"

    • liveBranchesstring[]required

      The branches where your flows are switched on; empty until we switch them on with you.

      items ≤ 200

  • apiVersionstringrequired

    The API version.

    Values: "v1"

  • serverTimestring<date-time>required

    The server clock: compare it with yours before checking signatures.

PartnerBranch#

  • idstringrequired

    The branch's Let's Pizza id; stable.

    length 1 – 64

  • namesLocalizedrequired

    The branch name in Arabic and English.

    Child attributes (2)
    • arstringrequired
    • enstringrequired
  • phonestringrequired

    The branch phone, in international format.

  • locationobjectrequired

    Where the branch is.

    Child attributes (2)
    • latnumberrequired
    • lngnumberrequired
  • fulfilmentobjectrequired

    How the branch serves orders.

    Child attributes (2)
    • deliverybooleanrequired
    • pickupbooleanrequired
  • pausedbooleanrequired

    Closed by staff now, whatever the hours say.

  • livebooleanrequired

    Your flows run at this branch.

  • externalCodestringrequirednullable

    Your code for this branch, from the mappings; null until mapped.

Localized#

  • arstringrequired
  • enstringrequired

PartnerBranchList#

  • itemsPartnerBranch[]required

    The branches the key may act on.

    Child attributes (8)
    • idstringrequired

      The branch's Let's Pizza id; stable.

      length 1 – 64

    • namesLocalizedrequired

      The branch name in Arabic and English.

      Child attributes (2)
      • arstringrequired
      • enstringrequired
    • phonestringrequired

      The branch phone, in international format.

    • locationobjectrequired

      Where the branch is.

      Child attributes (2)
      • latnumberrequired
      • lngnumberrequired
    • fulfilmentobjectrequired

      How the branch serves orders.

      Child attributes (2)
      • deliverybooleanrequired
      • pickupbooleanrequired
    • pausedbooleanrequired

      Closed by staff now, whatever the hours say.

    • livebooleanrequired

      Your flows run at this branch.

    • externalCodestringrequirednullable

      Your code for this branch, from the mappings; null until mapped.

PartnerError#

  • codestringrequired

    A stable code: build your logic on it.

  • messageLocalizedrequired

    A message for people, in both languages; its wording may change.

    Child attributes (2)
    • arstringrequired
    • enstringrequired
  • fieldstringrequirednullable

    The offending field of your request, if any.

  • retryablebooleanrequired

    True: the same request may succeed later. False: change it first.

  • requestIdstringrequired

    The X-Request-Id: quote it to support.

  • detailobjectoptional

    Extra facts for some codes: the scopes needed, seconds to wait, the current status of an order.

    An object with free keys.

PartnerMapping#

  • kindPartnerMappingKindrequired

    Values: "branch""category""product""group""option""tender"

  • ourIdstringrequired

    length 1 – 64

  • codestringrequired

    length 1 – 50

  • variantstringrequirednullable

    length 1 – 50

  • unitstringrequirednullable

    length 1 – 20

  • ourNameobjectrequirednullable
    Child attributes (2)
    • arstringrequired
    • enstringrequired
  • updatedAtstring<date-time>required

PartnerMappingList#

  • envIntegrationModerequired

    Values: "sandbox""live"

  • itemsPartnerMapping[]required
    Child attributes (7)
    • kindPartnerMappingKindrequired

      Values: "branch""category""product""group""option""tender"

    • ourIdstringrequired

      length 1 – 64

    • codestringrequired

      length 1 – 50

    • variantstringrequirednullable

      length 1 – 50

    • unitstringrequirednullable

      length 1 – 20

    • ourNameobjectrequirednullable
      Child attributes (2)
      • arstringrequired
      • enstringrequired
    • updatedAtstring<date-time>required

PutPartnerMappingsRequest#

  • modestringrequired

    Values: "merge""replace"

  • dryRunbooleanoptional
  • itemsobject[]required

    items ≤ 5000

    Child attributes (5)
    • kindPartnerMappingKindrequired

      Values: "branch""category""product""group""option""tender"

    • ourIdstringrequired

      length 1 – 64

    • codestringrequired

      length 1 – 50

    • variantstringoptionalnullable

      length 1 – 50

    • unitstringoptionalnullable

      length 1 – 20

PartnerMappingIssue#

  • indexintegerrequired

    value ≥ 0

  • codestringrequired

    Values: "UNKNOWN_ID""DUPLICATE_ROW""CODE_TAKEN"

  • fieldstringrequired
  • valuestringrequired

PartnerMappingResult#

  • dryRunbooleanrequired
  • okbooleanrequired
  • addedintegerrequired

    value ≥ 0

  • updatedintegerrequired

    value ≥ 0

  • unchangedintegerrequired

    value ≥ 0

  • removedintegerrequired

    value ≥ 0

  • errorsPartnerMappingIssue[]required
    Child attributes (4)
    • indexintegerrequired

      value ≥ 0

    • codestringrequired

      Values: "UNKNOWN_ID""DUPLICATE_ROW""CODE_TAKEN"

    • fieldstringrequired
    • valuestringrequired

PartnerOrderExternal#

  • branchCodestringrequirednullable
  • linesobject[]required
    Child attributes (5)
    • lineIndexintegerrequired

      value ≥ 0

    • codestringrequirednullable
    • variantstringrequirednullable
    • unitstringrequirednullable
    • optionsobject[]required
      Child attributes (4)
      • groupIdstringrequired

        length 1 – 64

      • optionIdstringrequired

        length 1 – 64

      • codestringrequirednullable
      • variantstringrequirednullable
  • tenderCodestringrequirednullable
  • unmappedobject[]required
    Child attributes (2)
    • kindPartnerMappingKindrequired

      Values: "branch""category""product""group""option""tender"

    • ourIdstringrequired

PartnerOrder#

  • orderOrderrequired
    Child attributes (25)
    • idstringrequired

      length 1 – 64

    • numberstringrequired
    • statusstringrequired

      Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

    • channelstringrequired

      Values: "app""web""console""pos""dine_in"

    • branchIdstringrequired

      length 1 – 64

    • fulfilmentstringrequired

      Values: "delivery""pickup"

    • paymentMethodstringrequired

      Values: "pay_at_branch""cash_on_delivery""online"

    • catalogVersionstringrequired
    • linesOrderLine[]required
      Child attributes (5)
      • lineIndexintegerrequired

        value ≥ 0

      • lineCartLinerequired
        Child attributes (5)
        • productIdstringrequired

          length 1 – 64

        • qtyintegerrequired

          value ≥ 1

        • selectionsCartSelection[]required
          Child attributes (5)
          • groupIdstringrequired

            length 1 – 64

          • optionIdstringrequired

            length 1 – 64

          • qtyintegerrequired

            value ≥ 1

          • placementstringoptional

            Values: "whole""left""right"

          • amountstringoptional

            Values: "light""regular""extra"

        • notestringoptional

          length ≤ 200

        • sourceobjectoptional
          Child attributes (2)
          • experiencestringrequired

            Values: "classic""graphical"

          • modestringoptional

            length ≤ 32

      • unitPriceintegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

      • lineTotalintegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

      • snapshotLineSnapshotrequired
        Child attributes (2)
        • namesLocalizedrequired
          Child attributes (2)
          • arstringrequired
          • enstringrequired
        • optionsSnapshotOption[]required
          Child attributes (7)
          • groupIdstringrequired

            length 1 – 64

          • optionIdstringrequired

            length 1 – 64

          • namesLocalizedrequired
            Child attributes (2)
            • arstringrequired
            • enstringrequired
          • qtyintegerrequired

            value ≥ 1

          • priceintegerrequired

            Amount in halalas (1 riyal = 100), VAT-inclusive

            value ≥ 0

          • placementstringoptional

            Values: "whole""left""right"

          • amountstringoptional

            Values: "light""regular""extra"

    • subtotalintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • discountsDiscount[]required
      Child attributes (4)
      • kindstringrequired

        Values: "coupon""offer"

      • codestringoptional
      • namesLocalizedrequired
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • amountintegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

    • discountTotalintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • deliveryFeeintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • totalintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • vatobjectrequired
      Child attributes (3)
      • rateBpsintegerrequired
      • amountintegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

      • includesDeliveryFeebooleanrequired
    • scheduledForstring<date-time>optional
    • notestringoptional
    • cutlerybooleanoptional
    • ifUnavailablestringoptional
    • deliveryobjectoptional
      Child attributes (5)
      • addressstringrequired

        length 3 – 300

      • detailsstringoptional

        length ≤ 300

      • locationobjectoptional
        Child attributes (2)
        • latnumberrequired

          value -90 – 90

        • lngnumberrequired

          value -180 – 180

      • contactNamestringrequired

        length 1 – 80

      • contactPhonestringrequired

        length 9 – 20

    • courierobjectoptional
      Child attributes (2)
      • namestringrequired
      • phonestringoptional
    • tenderstringoptional
    • paidAtstring<date-time>optional
    • createdAtstring<date-time>required
    • historyStatusChange[]required
      Child attributes (7)
      • fromstringrequirednullable

        Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

      • tostringrequired

        Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

      • atstring<date-time>required
      • actorStatusChangeActorrequired

        Values: "customer""staff""system""payment""partner"

      • reasonstringoptional
      • reasonCodestringoptional
      • returnedToBranchbooleanoptional
  • statePartnerOrderStaterequired

    Values: "awaiting_ack""acked""closed"

  • ackDueAtstring<date-time>requirednullable
  • ackedAtstring<date-time>requirednullable
  • externalOrderNostringrequirednullable
  • externalReceiptNostringrequirednullable
  • externalPartnerOrderExternalrequired
    Child attributes (4)
    • branchCodestringrequirednullable
    • linesobject[]required
      Child attributes (5)
      • lineIndexintegerrequired

        value ≥ 0

      • codestringrequirednullable
      • variantstringrequirednullable
      • unitstringrequirednullable
      • optionsobject[]required
        Child attributes (4)
        • groupIdstringrequired

          length 1 – 64

        • optionIdstringrequired

          length 1 – 64

        • codestringrequirednullable
        • variantstringrequirednullable
    • tenderCodestringrequirednullable
    • unmappedobject[]required
      Child attributes (2)
      • kindPartnerMappingKindrequired

        Values: "branch""category""product""group""option""tender"

      • ourIdstringrequired
  • updatedAtstring<date-time>required

Order#

  • idstringrequired

    length 1 – 64

  • numberstringrequired
  • statusstringrequired

    Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

  • channelstringrequired

    Values: "app""web""console""pos""dine_in"

  • branchIdstringrequired

    length 1 – 64

  • fulfilmentstringrequired

    Values: "delivery""pickup"

  • paymentMethodstringrequired

    Values: "pay_at_branch""cash_on_delivery""online"

  • catalogVersionstringrequired
  • linesOrderLine[]required
    Child attributes (5)
    • lineIndexintegerrequired

      value ≥ 0

    • lineCartLinerequired
      Child attributes (5)
      • productIdstringrequired

        length 1 – 64

      • qtyintegerrequired

        value ≥ 1

      • selectionsCartSelection[]required
        Child attributes (5)
        • groupIdstringrequired

          length 1 – 64

        • optionIdstringrequired

          length 1 – 64

        • qtyintegerrequired

          value ≥ 1

        • placementstringoptional

          Values: "whole""left""right"

        • amountstringoptional

          Values: "light""regular""extra"

      • notestringoptional

        length ≤ 200

      • sourceobjectoptional
        Child attributes (2)
        • experiencestringrequired

          Values: "classic""graphical"

        • modestringoptional

          length ≤ 32

    • unitPriceintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • lineTotalintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • snapshotLineSnapshotrequired
      Child attributes (2)
      • namesLocalizedrequired
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • optionsSnapshotOption[]required
        Child attributes (7)
        • groupIdstringrequired

          length 1 – 64

        • optionIdstringrequired

          length 1 – 64

        • namesLocalizedrequired
          Child attributes (2)
          • arstringrequired
          • enstringrequired
        • qtyintegerrequired

          value ≥ 1

        • priceintegerrequired

          Amount in halalas (1 riyal = 100), VAT-inclusive

          value ≥ 0

        • placementstringoptional

          Values: "whole""left""right"

        • amountstringoptional

          Values: "light""regular""extra"

  • subtotalintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • discountsDiscount[]required
    Child attributes (4)
    • kindstringrequired

      Values: "coupon""offer"

    • codestringoptional
    • namesLocalizedrequired
      Child attributes (2)
      • arstringrequired
      • enstringrequired
    • amountintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

  • discountTotalintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • deliveryFeeintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • totalintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • vatobjectrequired
    Child attributes (3)
    • rateBpsintegerrequired
    • amountintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • includesDeliveryFeebooleanrequired
  • scheduledForstring<date-time>optional
  • notestringoptional
  • cutlerybooleanoptional
  • ifUnavailablestringoptional
  • deliveryobjectoptional
    Child attributes (5)
    • addressstringrequired

      length 3 – 300

    • detailsstringoptional

      length ≤ 300

    • locationobjectoptional
      Child attributes (2)
      • latnumberrequired

        value -90 – 90

      • lngnumberrequired

        value -180 – 180

    • contactNamestringrequired

      length 1 – 80

    • contactPhonestringrequired

      length 9 – 20

  • courierobjectoptional
    Child attributes (2)
    • namestringrequired
    • phonestringoptional
  • tenderstringoptional
  • paidAtstring<date-time>optional
  • createdAtstring<date-time>required
  • historyStatusChange[]required
    Child attributes (7)
    • fromstringrequirednullable

      Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

    • tostringrequired

      Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

    • atstring<date-time>required
    • actorStatusChangeActorrequired

      Values: "customer""staff""system""payment""partner"

    • reasonstringoptional
    • reasonCodestringoptional
    • returnedToBranchbooleanoptional

OrderLine#

  • lineIndexintegerrequired

    value ≥ 0

  • lineCartLinerequired
    Child attributes (5)
    • productIdstringrequired

      length 1 – 64

    • qtyintegerrequired

      value ≥ 1

    • selectionsCartSelection[]required
      Child attributes (5)
      • groupIdstringrequired

        length 1 – 64

      • optionIdstringrequired

        length 1 – 64

      • qtyintegerrequired

        value ≥ 1

      • placementstringoptional

        Values: "whole""left""right"

      • amountstringoptional

        Values: "light""regular""extra"

    • notestringoptional

      length ≤ 200

    • sourceobjectoptional
      Child attributes (2)
      • experiencestringrequired

        Values: "classic""graphical"

      • modestringoptional

        length ≤ 32

  • unitPriceintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • lineTotalintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • snapshotLineSnapshotrequired
    Child attributes (2)
    • namesLocalizedrequired
      Child attributes (2)
      • arstringrequired
      • enstringrequired
    • optionsSnapshotOption[]required
      Child attributes (7)
      • groupIdstringrequired

        length 1 – 64

      • optionIdstringrequired

        length 1 – 64

      • namesLocalizedrequired
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • qtyintegerrequired

        value ≥ 1

      • priceintegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

      • placementstringoptional

        Values: "whole""left""right"

      • amountstringoptional

        Values: "light""regular""extra"

CartLine#

  • productIdstringrequired

    length 1 – 64

  • qtyintegerrequired

    value ≥ 1

  • selectionsCartSelection[]required
    Child attributes (5)
    • groupIdstringrequired

      length 1 – 64

    • optionIdstringrequired

      length 1 – 64

    • qtyintegerrequired

      value ≥ 1

    • placementstringoptional

      Values: "whole""left""right"

    • amountstringoptional

      Values: "light""regular""extra"

  • notestringoptional

    length ≤ 200

  • sourceobjectoptional
    Child attributes (2)
    • experiencestringrequired

      Values: "classic""graphical"

    • modestringoptional

      length ≤ 32

CartSelection#

  • groupIdstringrequired

    length 1 – 64

  • optionIdstringrequired

    length 1 – 64

  • qtyintegerrequired

    value ≥ 1

  • placementstringoptional

    Values: "whole""left""right"

  • amountstringoptional

    Values: "light""regular""extra"

LineSnapshot#

  • namesLocalizedrequired
    Child attributes (2)
    • arstringrequired
    • enstringrequired
  • optionsSnapshotOption[]required
    Child attributes (7)
    • groupIdstringrequired

      length 1 – 64

    • optionIdstringrequired

      length 1 – 64

    • namesLocalizedrequired
      Child attributes (2)
      • arstringrequired
      • enstringrequired
    • qtyintegerrequired

      value ≥ 1

    • priceintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • placementstringoptional

      Values: "whole""left""right"

    • amountstringoptional

      Values: "light""regular""extra"

SnapshotOption#

  • groupIdstringrequired

    length 1 – 64

  • optionIdstringrequired

    length 1 – 64

  • namesLocalizedrequired
    Child attributes (2)
    • arstringrequired
    • enstringrequired
  • qtyintegerrequired

    value ≥ 1

  • priceintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • placementstringoptional

    Values: "whole""left""right"

  • amountstringoptional

    Values: "light""regular""extra"

Discount#

  • kindstringrequired

    Values: "coupon""offer"

  • codestringoptional
  • namesLocalizedrequired
    Child attributes (2)
    • arstringrequired
    • enstringrequired
  • amountintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

DeliveryDetails#

  • addressstringrequired

    length 3 – 300

  • detailsstringoptional

    length ≤ 300

  • locationobjectoptional
    Child attributes (2)
    • latnumberrequired

      value -90 – 90

    • lngnumberrequired

      value -180 – 180

  • contactNamestringrequired

    length 1 – 80

  • contactPhonestringrequired

    length 9 – 20

GeoPoint#

  • latnumberrequired

    value -90 – 90

  • lngnumberrequired

    value -180 – 180

Courier#

  • namestringrequired
  • phonestringoptional

StatusChange#

  • fromstringrequirednullable

    Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

  • tostringrequired

    Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

  • atstring<date-time>required
  • actorStatusChangeActorrequired

    Values: "customer""staff""system""payment""partner"

  • reasonstringoptional
  • reasonCodestringoptional
  • returnedToBranchbooleanoptional

PartnerOrderPage#

  • itemsPartnerOrder[]required
    Child attributes (8)
    • orderOrderrequired
      Child attributes (25)
      • idstringrequired

        length 1 – 64

      • numberstringrequired
      • statusstringrequired

        Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

      • channelstringrequired

        Values: "app""web""console""pos""dine_in"

      • branchIdstringrequired

        length 1 – 64

      • fulfilmentstringrequired

        Values: "delivery""pickup"

      • paymentMethodstringrequired

        Values: "pay_at_branch""cash_on_delivery""online"

      • catalogVersionstringrequired
      • linesOrderLine[]required
        Child attributes (5)
        • lineIndexintegerrequired

          value ≥ 0

        • lineCartLinerequired
          Child attributes (5)
          • productIdstringrequired

            length 1 – 64

          • qtyintegerrequired

            value ≥ 1

          • selectionsCartSelection[]required
            Child attributes (5)
            • groupIdstringrequired

              length 1 – 64

            • optionIdstringrequired

              length 1 – 64

            • qtyintegerrequired

              value ≥ 1

            • placementstringoptional

              Values: "whole""left""right"

            • amountstringoptional

              Values: "light""regular""extra"

          • notestringoptional

            length ≤ 200

          • sourceobjectoptional
            Child attributes (2)
            • experiencestringrequired

              Values: "classic""graphical"

            • modestringoptional

              length ≤ 32

        • unitPriceintegerrequired

          Amount in halalas (1 riyal = 100), VAT-inclusive

          value ≥ 0

        • lineTotalintegerrequired

          Amount in halalas (1 riyal = 100), VAT-inclusive

          value ≥ 0

        • snapshotLineSnapshotrequired
          Child attributes (2)
          • namesLocalizedrequired
            Child attributes (2)
            • arstringrequired
            • enstringrequired
          • optionsSnapshotOption[]required
            Child attributes (7)
            • groupIdstringrequired

              length 1 – 64

            • optionIdstringrequired

              length 1 – 64

            • namesLocalizedrequired
              Child attributes (2)
              • arstringrequired
              • enstringrequired
            • qtyintegerrequired

              value ≥ 1

            • priceintegerrequired

              Amount in halalas (1 riyal = 100), VAT-inclusive

              value ≥ 0

            • placementstringoptional

              Values: "whole""left""right"

            • amountstringoptional

              Values: "light""regular""extra"

      • subtotalintegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

      • discountsDiscount[]required
        Child attributes (4)
        • kindstringrequired

          Values: "coupon""offer"

        • codestringoptional
        • namesLocalizedrequired
          Child attributes (2)
          • arstringrequired
          • enstringrequired
        • amountintegerrequired

          Amount in halalas (1 riyal = 100), VAT-inclusive

          value ≥ 0

      • discountTotalintegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

      • deliveryFeeintegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

      • totalintegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

      • vatobjectrequired
        Child attributes (3)
        • rateBpsintegerrequired
        • amountintegerrequired

          Amount in halalas (1 riyal = 100), VAT-inclusive

          value ≥ 0

        • includesDeliveryFeebooleanrequired
      • scheduledForstring<date-time>optional
      • notestringoptional
      • cutlerybooleanoptional
      • ifUnavailablestringoptional
      • deliveryobjectoptional
        Child attributes (5)
        • addressstringrequired

          length 3 – 300

        • detailsstringoptional

          length ≤ 300

        • locationobjectoptional
          Child attributes (2)
          • latnumberrequired

            value -90 – 90

          • lngnumberrequired

            value -180 – 180

        • contactNamestringrequired

          length 1 – 80

        • contactPhonestringrequired

          length 9 – 20

      • courierobjectoptional
        Child attributes (2)
        • namestringrequired
        • phonestringoptional
      • tenderstringoptional
      • paidAtstring<date-time>optional
      • createdAtstring<date-time>required
      • historyStatusChange[]required
        Child attributes (7)
        • fromstringrequirednullable

          Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

        • tostringrequired

          Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

        • atstring<date-time>required
        • actorStatusChangeActorrequired

          Values: "customer""staff""system""payment""partner"

        • reasonstringoptional
        • reasonCodestringoptional
        • returnedToBranchbooleanoptional
    • statePartnerOrderStaterequired

      Values: "awaiting_ack""acked""closed"

    • ackDueAtstring<date-time>requirednullable
    • ackedAtstring<date-time>requirednullable
    • externalOrderNostringrequirednullable
    • externalReceiptNostringrequirednullable
    • externalPartnerOrderExternalrequired
      Child attributes (4)
      • branchCodestringrequirednullable
      • linesobject[]required
        Child attributes (5)
        • lineIndexintegerrequired

          value ≥ 0

        • codestringrequirednullable
        • variantstringrequirednullable
        • unitstringrequirednullable
        • optionsobject[]required
          Child attributes (4)
          • groupIdstringrequired

            length 1 – 64

          • optionIdstringrequired

            length 1 – 64

          • codestringrequirednullable
          • variantstringrequirednullable
      • tenderCodestringrequirednullable
      • unmappedobject[]required
        Child attributes (2)
        • kindPartnerMappingKindrequired

          Values: "branch""category""product""group""option""tender"

        • ourIdstringrequired
    • updatedAtstring<date-time>required
  • nextCursorstringrequirednullable

AckOrderRequest#

  • externalOrderNostringoptional

    length 1 – 50

  • externalReceiptNostringoptional

    length 1 – 50

PartnerStatusRequest#

  • eventIdstringrequired

    length 1 – 64

  • toPartnerStatusTargetrequired

    Values: "accepted""rejected""preparing""ready""picked_up""cancelled""out_for_delivery""delivered""delivery_failed"

  • expectedFromstringoptional

    Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

  • reasonCodestringoptional
  • reasonTextstringoptional

    length 1 – 300

  • occurredAtstring<date-time>required
  • estimatedReadyAtstring<date-time>optional

PartnerCancelRequest#

  • eventIdstringrequired

    length 1 – 64

  • reasonCodeExitReasonCoderequired

    Values: "customer_unreachable""wrong_address""customer_refused""accident_or_damage""kitchen_error""out_of_stock""customer_request""other"

  • reasonTextstringoptional

    length 1 – 300

  • occurredAtstring<date-time>required

PartnerStatusResult#

  • outcomestringrequired

    Values: "applied""duplicate""ignored""parked"

  • statusstringrequired

    Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

  • reasonstringrequirednullable

PartnerOrderEventRequest#

  • eventIdstringrequired

    length 1 – 64

  • typestringrequired

    Values: "receipt_issued""invoice_issued""payment_collected""note"

  • receiptNostringoptional

    length 1 – 50

  • invoiceNostringoptional

    length 1 – 50

  • invoiceQrstringoptional

    length ≤ 1000

  • amountintegeroptional

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • tenderstringoptional

    Values: "cash""card"

  • notestringoptional

    length 1 – 300

  • occurredAtstring<date-time>required

PartnerOrderEventResult#

  • outcomestringrequired

    Values: "recorded""duplicate"

PartnerCatalog#

  • catalogCatalogrequired
    Child attributes (6)
    • versionCatalogVersionrequired
      Child attributes (4)
      • idstringrequired

        length ≥ 1

      • statusstringrequired

        Values: "draft""published"

      • sourcestringrequired

        Values: "taker""console""foodics""partner"

      • createdAtstring<date-time>required
    • currencystringrequired

      Values: "SAR"

    • categoriesCategory[]required
      Child attributes (5)
      • idstringrequired

        length 1 – 64

      • namesLocalizedrequired
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • imagestringoptional
      • sortintegerrequired
      • externalobjectoptional
        Child attributes (2)
        • sourcestringrequired

          Values: "taker""foodics""console"

        • idstringrequired
    • groupsModifierGroup[]required
      Child attributes (12)
      • idstringrequired

        length 1 – 64

      • namesLocalizedrequired
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • rolestringrequired

        Values: "choice""extra""removal""cross_sell""bundle_slot"

      • selectionstringrequired

        Values: "single""multi"

      • builderobjectoptional
        Child attributes (3)
        • partstringrequired

          Values: "dough""edge""sauce""cheese""topping""fresh""finish"

        • placementbooleanrequired
        • amountbooleanrequired
      • minSelectintegerrequired

        value ≥ 0

      • maxSelectintegerrequirednullable

        value ≥ 1

      • perOptionMaxQtyintegerrequired

        value ≥ 1

      • optionsGroupOption[]required
        Child attributes (9)
        • idstringrequired

          length 1 – 64

        • namesLocalizedrequired
          Child attributes (2)
          • arstringrequired
          • enstringrequired
        • priceintegerrequired

          Amount in halalas (1 riyal = 100), VAT-inclusive

          value ≥ 0

        • priceBySizeobjectoptional
          Child attributes (2)
          • mediumintegeroptional

            Amount in halalas (1 riyal = 100), VAT-inclusive

            value ≥ 0

          • largeintegeroptional

            Amount in halalas (1 riyal = 100), VAT-inclusive

            value ≥ 0

        • builderobjectoptional
          Child attributes (2)
          • placementbooleanoptional
          • amountstring[]optional

            Values: "light""extra"

            items ≤ 2

        • imagestringoptional
        • linkedProductIdstringoptional

          length 1 – 64

        • hiddenbooleanoptional
        • externalobjectoptional
          Child attributes (2)
          • sourcestringrequired

            Values: "taker""foodics""console"

          • idstringrequired
      • defaultOptionIdstringoptional

        length 1 – 64

      • descriptionsobjectoptional
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • externalobjectoptional
        Child attributes (2)
        • sourcestringrequired

          Values: "taker""foodics""console"

        • idstringrequired
    • productsProduct[]required
      Child attributes (15)
      • idstringrequired

        length 1 – 64

      • namesLocalizedrequired
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • descriptionsLocalizedrequired
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • imagestringrequired
      • categoryIdstringrequired

        length 1 – 64

      • kindstringrequired

        Values: "simple""bundle"

      • basePriceintegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

      • groupIdsstring[]required
      • sizeFamilyobjectoptional
        Child attributes (2)
        • familyIdstringrequired

          length 1 – 64

        • sizestringrequired

          Values: "medium""large"

      • slicesintegeroptional

        value 1 – 64

      • prepMinutesintegerrequired

        value ≥ 0

      • tagsstring[]required

        Values: "vegetarian""spicy""best_seller""new"

      • sortintegerrequired
      • builderobjectoptional
        Child attributes (4)
        • baseArtstringrequired
        • drawnGroupIdsstring[]required
        • modestringoptional

          Values: "customize""scratch"

        • rulesobjectoptional
          Child attributes (4)
          • maxToppingsTotalintegeroptional

            value 1 – 200

          • maxPerHalfintegeroptional

            value 1 – 200

          • requireOneOfstring[][]optional

            items ≤ 20

          • forbidTogetherstring[][]optional

            items ≤ 200

      • externalobjectoptional
        Child attributes (2)
        • sourcestringrequired

          Values: "taker""foodics""console"

        • idstringrequired
    • builderArtobjectoptional
      Child attributes (3)
      • toppingsBuilderTopping[]required
        Child attributes (5)
        • optionIdstringrequired

          length 1 – 64

        • piecesBuilderPiece[]required

          items ≥ 1

          Child attributes (4)
          • filestringrequired
          • wnumberrequired

            value ≥ 0

          • hnumberrequired

            value ≥ 0

          • rnumberrequired

            value ≥ 0

        • countintegerrequired

          value ≥ 1

        • scalenumberrequired

          value ≥ 0

        • patchbooleanrequired
      • saucesBuilderSauce[]required
        Child attributes (3)
        • optionIdstringrequired

          length 1 – 64

        • colorstringrequired
        • highlightstringrequired
      • optionsobjectoptional

        An object with free keys.

  • externalobjectrequired
    Child attributes (4)
    • categoriesobjectrequired

      An object with free keys.

    • productsobjectrequired

      An object with free keys.

    • groupsobjectrequired

      An object with free keys.

    • optionsobjectrequired

      An object with free keys.

Catalog#

  • versionCatalogVersionrequired
    Child attributes (4)
    • idstringrequired

      length ≥ 1

    • statusstringrequired

      Values: "draft""published"

    • sourcestringrequired

      Values: "taker""console""foodics""partner"

    • createdAtstring<date-time>required
  • currencystringrequired

    Values: "SAR"

  • categoriesCategory[]required
    Child attributes (5)
    • idstringrequired

      length 1 – 64

    • namesLocalizedrequired
      Child attributes (2)
      • arstringrequired
      • enstringrequired
    • imagestringoptional
    • sortintegerrequired
    • externalobjectoptional
      Child attributes (2)
      • sourcestringrequired

        Values: "taker""foodics""console"

      • idstringrequired
  • groupsModifierGroup[]required
    Child attributes (12)
    • idstringrequired

      length 1 – 64

    • namesLocalizedrequired
      Child attributes (2)
      • arstringrequired
      • enstringrequired
    • rolestringrequired

      Values: "choice""extra""removal""cross_sell""bundle_slot"

    • selectionstringrequired

      Values: "single""multi"

    • builderobjectoptional
      Child attributes (3)
      • partstringrequired

        Values: "dough""edge""sauce""cheese""topping""fresh""finish"

      • placementbooleanrequired
      • amountbooleanrequired
    • minSelectintegerrequired

      value ≥ 0

    • maxSelectintegerrequirednullable

      value ≥ 1

    • perOptionMaxQtyintegerrequired

      value ≥ 1

    • optionsGroupOption[]required
      Child attributes (9)
      • idstringrequired

        length 1 – 64

      • namesLocalizedrequired
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • priceintegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

      • priceBySizeobjectoptional
        Child attributes (2)
        • mediumintegeroptional

          Amount in halalas (1 riyal = 100), VAT-inclusive

          value ≥ 0

        • largeintegeroptional

          Amount in halalas (1 riyal = 100), VAT-inclusive

          value ≥ 0

      • builderobjectoptional
        Child attributes (2)
        • placementbooleanoptional
        • amountstring[]optional

          Values: "light""extra"

          items ≤ 2

      • imagestringoptional
      • linkedProductIdstringoptional

        length 1 – 64

      • hiddenbooleanoptional
      • externalobjectoptional
        Child attributes (2)
        • sourcestringrequired

          Values: "taker""foodics""console"

        • idstringrequired
    • defaultOptionIdstringoptional

      length 1 – 64

    • descriptionsobjectoptional
      Child attributes (2)
      • arstringrequired
      • enstringrequired
    • externalobjectoptional
      Child attributes (2)
      • sourcestringrequired

        Values: "taker""foodics""console"

      • idstringrequired
  • productsProduct[]required
    Child attributes (15)
    • idstringrequired

      length 1 – 64

    • namesLocalizedrequired
      Child attributes (2)
      • arstringrequired
      • enstringrequired
    • descriptionsLocalizedrequired
      Child attributes (2)
      • arstringrequired
      • enstringrequired
    • imagestringrequired
    • categoryIdstringrequired

      length 1 – 64

    • kindstringrequired

      Values: "simple""bundle"

    • basePriceintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • groupIdsstring[]required
    • sizeFamilyobjectoptional
      Child attributes (2)
      • familyIdstringrequired

        length 1 – 64

      • sizestringrequired

        Values: "medium""large"

    • slicesintegeroptional

      value 1 – 64

    • prepMinutesintegerrequired

      value ≥ 0

    • tagsstring[]required

      Values: "vegetarian""spicy""best_seller""new"

    • sortintegerrequired
    • builderobjectoptional
      Child attributes (4)
      • baseArtstringrequired
      • drawnGroupIdsstring[]required
      • modestringoptional

        Values: "customize""scratch"

      • rulesobjectoptional
        Child attributes (4)
        • maxToppingsTotalintegeroptional

          value 1 – 200

        • maxPerHalfintegeroptional

          value 1 – 200

        • requireOneOfstring[][]optional

          items ≤ 20

        • forbidTogetherstring[][]optional

          items ≤ 200

    • externalobjectoptional
      Child attributes (2)
      • sourcestringrequired

        Values: "taker""foodics""console"

      • idstringrequired
  • builderArtobjectoptional
    Child attributes (3)
    • toppingsBuilderTopping[]required
      Child attributes (5)
      • optionIdstringrequired

        length 1 – 64

      • piecesBuilderPiece[]required

        items ≥ 1

        Child attributes (4)
        • filestringrequired
        • wnumberrequired

          value ≥ 0

        • hnumberrequired

          value ≥ 0

        • rnumberrequired

          value ≥ 0

      • countintegerrequired

        value ≥ 1

      • scalenumberrequired

        value ≥ 0

      • patchbooleanrequired
    • saucesBuilderSauce[]required
      Child attributes (3)
      • optionIdstringrequired

        length 1 – 64

      • colorstringrequired
      • highlightstringrequired
    • optionsobjectoptional

      An object with free keys.

CatalogVersion#

  • idstringrequired

    length ≥ 1

  • statusstringrequired

    Values: "draft""published"

  • sourcestringrequired

    Values: "taker""console""foodics""partner"

  • createdAtstring<date-time>required

Category#

  • idstringrequired

    length 1 – 64

  • namesLocalizedrequired
    Child attributes (2)
    • arstringrequired
    • enstringrequired
  • imagestringoptional
  • sortintegerrequired
  • externalobjectoptional
    Child attributes (2)
    • sourcestringrequired

      Values: "taker""foodics""console"

    • idstringrequired

ExternalRef#

  • sourcestringrequired

    Values: "taker""foodics""console"

  • idstringrequired

ModifierGroup#

  • idstringrequired

    length 1 – 64

  • namesLocalizedrequired
    Child attributes (2)
    • arstringrequired
    • enstringrequired
  • rolestringrequired

    Values: "choice""extra""removal""cross_sell""bundle_slot"

  • selectionstringrequired

    Values: "single""multi"

  • builderobjectoptional
    Child attributes (3)
    • partstringrequired

      Values: "dough""edge""sauce""cheese""topping""fresh""finish"

    • placementbooleanrequired
    • amountbooleanrequired
  • minSelectintegerrequired

    value ≥ 0

  • maxSelectintegerrequirednullable

    value ≥ 1

  • perOptionMaxQtyintegerrequired

    value ≥ 1

  • optionsGroupOption[]required
    Child attributes (9)
    • idstringrequired

      length 1 – 64

    • namesLocalizedrequired
      Child attributes (2)
      • arstringrequired
      • enstringrequired
    • priceintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • priceBySizeobjectoptional
      Child attributes (2)
      • mediumintegeroptional

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

      • largeintegeroptional

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

    • builderobjectoptional
      Child attributes (2)
      • placementbooleanoptional
      • amountstring[]optional

        Values: "light""extra"

        items ≤ 2

    • imagestringoptional
    • linkedProductIdstringoptional

      length 1 – 64

    • hiddenbooleanoptional
    • externalobjectoptional
      Child attributes (2)
      • sourcestringrequired

        Values: "taker""foodics""console"

      • idstringrequired
  • defaultOptionIdstringoptional

    length 1 – 64

  • descriptionsobjectoptional
    Child attributes (2)
    • arstringrequired
    • enstringrequired
  • externalobjectoptional
    Child attributes (2)
    • sourcestringrequired

      Values: "taker""foodics""console"

    • idstringrequired

GroupBuilderHints#

  • partstringrequired

    Values: "dough""edge""sauce""cheese""topping""fresh""finish"

  • placementbooleanrequired
  • amountbooleanrequired

GroupOption#

  • idstringrequired

    length 1 – 64

  • namesLocalizedrequired
    Child attributes (2)
    • arstringrequired
    • enstringrequired
  • priceintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • priceBySizeobjectoptional
    Child attributes (2)
    • mediumintegeroptional

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • largeintegeroptional

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

  • builderobjectoptional
    Child attributes (2)
    • placementbooleanoptional
    • amountstring[]optional

      Values: "light""extra"

      items ≤ 2

  • imagestringoptional
  • linkedProductIdstringoptional

    length 1 – 64

  • hiddenbooleanoptional
  • externalobjectoptional
    Child attributes (2)
    • sourcestringrequired

      Values: "taker""foodics""console"

    • idstringrequired

OptionBuilderHints#

  • placementbooleanoptional
  • amountstring[]optional

    Values: "light""extra"

    items ≤ 2

Product#

  • idstringrequired

    length 1 – 64

  • namesLocalizedrequired
    Child attributes (2)
    • arstringrequired
    • enstringrequired
  • descriptionsLocalizedrequired
    Child attributes (2)
    • arstringrequired
    • enstringrequired
  • imagestringrequired
  • categoryIdstringrequired

    length 1 – 64

  • kindstringrequired

    Values: "simple""bundle"

  • basePriceintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • groupIdsstring[]required
  • sizeFamilyobjectoptional
    Child attributes (2)
    • familyIdstringrequired

      length 1 – 64

    • sizestringrequired

      Values: "medium""large"

  • slicesintegeroptional

    value 1 – 64

  • prepMinutesintegerrequired

    value ≥ 0

  • tagsstring[]required

    Values: "vegetarian""spicy""best_seller""new"

  • sortintegerrequired
  • builderobjectoptional
    Child attributes (4)
    • baseArtstringrequired
    • drawnGroupIdsstring[]required
    • modestringoptional

      Values: "customize""scratch"

    • rulesobjectoptional
      Child attributes (4)
      • maxToppingsTotalintegeroptional

        value 1 – 200

      • maxPerHalfintegeroptional

        value 1 – 200

      • requireOneOfstring[][]optional

        items ≤ 20

      • forbidTogetherstring[][]optional

        items ≤ 200

  • externalobjectoptional
    Child attributes (2)
    • sourcestringrequired

      Values: "taker""foodics""console"

    • idstringrequired

BuilderProfile#

  • baseArtstringrequired
  • drawnGroupIdsstring[]required
  • modestringoptional

    Values: "customize""scratch"

  • rulesobjectoptional
    Child attributes (4)
    • maxToppingsTotalintegeroptional

      value 1 – 200

    • maxPerHalfintegeroptional

      value 1 – 200

    • requireOneOfstring[][]optional

      items ≤ 20

    • forbidTogetherstring[][]optional

      items ≤ 200

BuilderRules#

  • maxToppingsTotalintegeroptional

    value 1 – 200

  • maxPerHalfintegeroptional

    value 1 – 200

  • requireOneOfstring[][]optional

    items ≤ 20

  • forbidTogetherstring[][]optional

    items ≤ 200

BuilderArt#

  • toppingsBuilderTopping[]required
    Child attributes (5)
    • optionIdstringrequired

      length 1 – 64

    • piecesBuilderPiece[]required

      items ≥ 1

      Child attributes (4)
      • filestringrequired
      • wnumberrequired

        value ≥ 0

      • hnumberrequired

        value ≥ 0

      • rnumberrequired

        value ≥ 0

    • countintegerrequired

      value ≥ 1

    • scalenumberrequired

      value ≥ 0

    • patchbooleanrequired
  • saucesBuilderSauce[]required
    Child attributes (3)
    • optionIdstringrequired

      length 1 – 64

    • colorstringrequired
    • highlightstringrequired
  • optionsobjectoptional

    An object with free keys.

BuilderTopping#

  • optionIdstringrequired

    length 1 – 64

  • piecesBuilderPiece[]required

    items ≥ 1

    Child attributes (4)
    • filestringrequired
    • wnumberrequired

      value ≥ 0

    • hnumberrequired

      value ≥ 0

    • rnumberrequired

      value ≥ 0

  • countintegerrequired

    value ≥ 1

  • scalenumberrequired

    value ≥ 0

  • patchbooleanrequired

BuilderPiece#

  • filestringrequired
  • wnumberrequired

    value ≥ 0

  • hnumberrequired

    value ≥ 0

  • rnumberrequired

    value ≥ 0

BuilderSauce#

  • optionIdstringrequired

    length 1 – 64

  • colorstringrequired
  • highlightstringrequired

BuilderOptionArt#

  • piecestringoptional

    length ≥ 1

  • layerstringoptionalnullable

    length ≥ 1

  • doughstringoptional

    Values: "classic""thin""pan"

  • edgestringoptional

    Values: "classic""cheese""garlic"

  • cheesestringoptional

    Values: "none""light""regular""extra"

  • patchstringoptional
  • shapestringoptional

    Values: "dice""crumble""torn""shred""slice""crescent""blob"

  • drizzlestringoptional
  • sprinklestringoptional
  • highlightstringoptional
  • vesselstringoptional

    Values: "squeeze_bottle""oil_cruet"

  • tintstringoptional
  • countintegeroptional

    value ≥ 1

  • sizenumberoptional

    value ≥ 0

  • postbooleanoptional
  • prebooleanoptional
  • thinbooleanoptional

PartnerOrderPayments#

  • orderIdstringrequired

    length 1 – 64

  • paymentMethodstringrequired

    Values: "pay_at_branch""cash_on_delivery""online"

  • totalintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • paidintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • refundedintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • attemptsobject[]required
    Child attributes (4)
    • idstringrequired

      length 1 – 64

    • statusstringrequired
    • amountintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • createdAtstring<date-time>required
  • refundsRefund[]required
    Child attributes (10)
    • idstringrequired

      length 1 – 64

    • orderIdstringrequired

      length 1 – 64

    • intentIdstringrequirednullable

      length 1 – 64

    • amountintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • reasonstringrequired

      Values: "cancelled_by_customer""cancelled_by_branch""rejected""item_unavailable""quality""other"

    • notestringoptional

      length ≤ 500

    • statusstringrequired

      Values: "requested""processing""succeeded""failed"

    • requestedBystringrequired

      length ≥ 1

    • createdAtstring<date-time>required
    • settledAtstring<date-time>optional

Refund#

  • idstringrequired

    length 1 – 64

  • orderIdstringrequired

    length 1 – 64

  • intentIdstringrequirednullable

    length 1 – 64

  • amountintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • reasonstringrequired

    Values: "cancelled_by_customer""cancelled_by_branch""rejected""item_unavailable""quality""other"

  • notestringoptional

    length ≤ 500

  • statusstringrequired

    Values: "requested""processing""succeeded""failed"

  • requestedBystringrequired

    length ≥ 1

  • createdAtstring<date-time>required
  • settledAtstring<date-time>optional

SaveWebhookRequest#

  • namestringrequired

    length 1 – 80

  • urlstringrequired

    length 8 – 500

  • eventsWebhookEventType[]required

    Values: "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"

    items 1 – 21

  • branchesstring[]optionalnullable

    items ≤ 200

  • piibooleanoptional
  • activebooleanoptional

WebhookSubscription#

  • idstringrequired

    length 1 – 64

  • namestringrequired
  • urlstringrequired
  • eventsWebhookEventType[]required

    Values: "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[]requirednullable
  • piibooleanrequired
  • activebooleanrequired
  • pausedAtstring<date-time>requirednullable
  • pausedReasonstringrequirednullable
  • secretHintstringrequired
  • createdAtstring<date-time>required
  • createdBystringrequirednullable
  • partnerIdstringrequirednullable
  • updatedAtstring<date-time>required
  • lastDeliveryAtstring<date-time>requirednullable
  • failureCountintegerrequired

    value ≥ 0

  • waitingintegerrequired

    value ≥ 0

  • deadintegerrequired

    value ≥ 0

WebhookSecretIssued#

  • subscriptionWebhookSubscriptionrequired
    Child attributes (18)
    • idstringrequired

      length 1 – 64

    • namestringrequired
    • urlstringrequired
    • eventsWebhookEventType[]required

      Values: "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[]requirednullable
    • piibooleanrequired
    • activebooleanrequired
    • pausedAtstring<date-time>requirednullable
    • pausedReasonstringrequirednullable
    • secretHintstringrequired
    • createdAtstring<date-time>required
    • createdBystringrequirednullable
    • partnerIdstringrequirednullable
    • updatedAtstring<date-time>required
    • lastDeliveryAtstring<date-time>requirednullable
    • failureCountintegerrequired

      value ≥ 0

    • waitingintegerrequired

      value ≥ 0

    • deadintegerrequired

      value ≥ 0

  • secretstringrequired

WebhookDelivery#

  • idstringrequired

    length 1 – 64

  • subscriptionIdstringrequired

    length 1 – 64

  • eventIdstringrequirednullable
  • eventTypeWebhookEventTyperequired

    Values: "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"

  • subjectstringrequirednullable
  • branchIdstringrequirednullable
  • attemptintegerrequired

    value ≥ 0

  • statusWebhookDeliveryStatusrequired

    Values: "pending""delivered""failed""dead"

  • httpStatusintegerrequirednullable
  • durationMsintegerrequirednullable
  • errorstringrequirednullable
  • nextAtstring<date-time>requirednullable
  • createdAtstring<date-time>required
  • lastAttemptAtstring<date-time>requirednullable
  • deliveredAtstring<date-time>requirednullable
  • replayOfstringrequirednullable

WebhookDeliveryPage#

  • deliveriesWebhookDelivery[]required
    Child attributes (16)
    • idstringrequired

      length 1 – 64

    • subscriptionIdstringrequired

      length 1 – 64

    • eventIdstringrequirednullable
    • eventTypeWebhookEventTyperequired

      Values: "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"

    • subjectstringrequirednullable
    • branchIdstringrequirednullable
    • attemptintegerrequired

      value ≥ 0

    • statusWebhookDeliveryStatusrequired

      Values: "pending""delivered""failed""dead"

    • httpStatusintegerrequirednullable
    • durationMsintegerrequirednullable
    • errorstringrequirednullable
    • nextAtstring<date-time>requirednullable
    • createdAtstring<date-time>required
    • lastAttemptAtstring<date-time>requirednullable
    • deliveredAtstring<date-time>requirednullable
    • replayOfstringrequirednullable
  • nextBeforestringoptional

PartnerMenu#

  • modestringrequired

    Values: "full""delta"

  • dryRunbooleanoptional
  • categoriesobject[]optional

    items ≤ 500

    Child attributes (5)
    • codestringrequired

      length 1 – 50

    • nameArstringrequired

      length 1 – 120

    • nameEnstringrequired

      length 1 – 120

    • sortOrderintegeroptional
    • blockedbooleanoptional
  • itemsobject[]optional

    items ≤ 3000

    Child attributes (10)
    • codestringrequired

      length 1 – 50

    • nameArstringrequired

      length 1 – 120

    • nameEnstringrequired

      length 1 – 120

    • descriptionArstringoptional

      length ≤ 500

    • descriptionEnstringoptional

      length ≤ 500

    • categoryCodestringoptional

      length 1 – 50

    • priceintegeroptional

      value ≥ 0

    • variantsobject[]optional

      items ≤ 10

      Child attributes (3)
      • codestringrequired

        length 1 – 50

      • priceintegerrequired

        value ≥ 0

      • blockedbooleanoptional
    • groupCodesstring[]optional

      items ≤ 50

    • blockedbooleanoptional
  • groupsobject[]optional

    items ≤ 500

    Child attributes (7)
    • codestringrequired

      length 1 – 50

    • nameArstringrequired

      length 1 – 120

    • nameEnstringrequired

      length 1 – 120

    • minSelectintegeroptional

      value ≥ 0

    • maxSelectintegeroptionalnullable

      value ≥ 1

    • maxPerOptionintegeroptional

      value ≥ 1

    • optionsobject[]required

      items ≤ 200

      Child attributes (6)
      • codestringrequired

        length 1 – 50

      • nameArstringrequired

        length 1 – 120

      • nameEnstringrequired

        length 1 – 120

      • priceintegerrequired

        value ≥ 0

      • pricesBySizeobjectoptional
        Child attributes (2)
        • mediumintegeroptional

          value ≥ 0

        • largeintegeroptional

          value ≥ 0

      • blockedbooleanoptional

CatalogImportUnknown#

  • kindstringrequired

    Values: "category""item""variant""group""option"

  • codestringrequired
  • namestringrequired
  • priceintegerrequirednullable

CatalogImport#

  • idstringrequired

    length 1 – 64

  • partnerIdstringrequired

    length 1 – 64

  • envIntegrationModerequired

    Values: "sandbox""live"

  • modestringrequired

    Values: "full""delta"

  • statusCatalogImportStatusrequired

    Values: "rejected""staged""published""discarded""superseded"

  • reasonstringrequirednullable
  • countsobjectrequired
    Child attributes (7)
    • categoriesintegerrequired
    • itemsintegerrequired
    • groupsintegerrequired
    • optionsintegerrequired
    • appliedintegerrequired
    • unknownintegerrequired
    • takenOffintegerrequired
  • unknownCatalogImportUnknown[]required
    Child attributes (4)
    • kindstringrequired

      Values: "category""item""variant""group""option"

    • codestringrequired
    • namestringrequired
    • priceintegerrequirednullable
  • takenOffstring[]required
  • issuesCatalogIssue[]required
    Child attributes (4)
    • severitystringrequired

      Values: "error""warning"

    • codestringrequired
    • refstringrequired
    • detailstringoptional
  • diffobjectrequirednullable
    Child attributes (9)
    • productsAddedstring[]required
    • productsRemovedstring[]required
    • productsChangedstring[]required
    • priceChangesobject[]required
      Child attributes (3)
      • productIdstringrequired

        length 1 – 64

      • fromintegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

      • tointegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

    • optionPriceChangesobject[]required
      Child attributes (5)
      • groupIdstringrequired

        length 1 – 64

      • optionIdstringrequired

        length 1 – 64

      • sizestringoptional

        Values: "medium""large"

      • fromintegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

      • tointegerrequired

        Amount in halalas (1 riyal = 100), VAT-inclusive

        value ≥ 0

    • groupsAddedstring[]required
    • groupsRemovedstring[]required
    • groupsChangedstring[]required
    • categoriesChangedbooleanrequired
  • versionIdstringrequirednullable
  • createdAtstring<date-time>required
  • decidedAtstring<date-time>requirednullable
  • decidedBystringrequirednullable

CatalogIssue#

  • severitystringrequired

    Values: "error""warning"

  • codestringrequired
  • refstringrequired
  • detailstringoptional

CatalogDiff#

  • productsAddedstring[]required
  • productsRemovedstring[]required
  • productsChangedstring[]required
  • priceChangesobject[]required
    Child attributes (3)
    • productIdstringrequired

      length 1 – 64

    • fromintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • tointegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

  • optionPriceChangesobject[]required
    Child attributes (5)
    • groupIdstringrequired

      length 1 – 64

    • optionIdstringrequired

      length 1 – 64

    • sizestringoptional

      Values: "medium""large"

    • fromintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • tointegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

  • groupsAddedstring[]required
  • groupsRemovedstring[]required
  • groupsChangedstring[]required
  • categoriesChangedbooleanrequired

PartnerAvailabilityItem#

  • kindstringrequired

    Values: "product""option"

  • idstringoptional

    length 1 – 64

  • codestringoptional

    length 1 – 50

  • variantstringoptional

    length 1 – 50

  • availablebooleanrequired

PartnerAvailabilityRequest#

  • itemsPartnerAvailabilityItem[]required

    items ≤ 2000

    Child attributes (5)
    • kindstringrequired

      Values: "product""option"

    • idstringoptional

      length 1 – 64

    • codestringoptional

      length 1 – 50

    • variantstringoptional

      length 1 – 50

    • availablebooleanrequired

PartnerAvailabilityResult#

  • branchIdstringrequired

    length 1 – 64

  • offintegerrequired

    value ≥ 0

  • onintegerrequired

    value ≥ 0

  • keptStaffintegerrequired

    value ≥ 0

  • unknownstring[]required
  • unavailableobject[]required
    Child attributes (2)
    • kindstringrequired

      Values: "product""option"

    • idstringrequired

      length 1 – 64

PartnerPushMessage#

  • versionnumberrequired

    Values: 1

  • idstringrequired
  • typestringrequired

    Values: "order.created""order.cancelled"

  • occurredAtstring<date-time>required
  • partnerIdstringrequired

    length 1 – 64

  • dataobjectrequired
    Child attributes (1)
    • orderPartnerOrderrequired
      Child attributes (8)
      • orderOrderrequired
        Child attributes (25)
        • idstringrequired

          length 1 – 64

        • numberstringrequired
        • statusstringrequired

          Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

        • channelstringrequired

          Values: "app""web""console""pos""dine_in"

        • branchIdstringrequired

          length 1 – 64

        • fulfilmentstringrequired

          Values: "delivery""pickup"

        • paymentMethodstringrequired

          Values: "pay_at_branch""cash_on_delivery""online"

        • catalogVersionstringrequired
        • linesOrderLine[]required
          Child attributes (5)
          • lineIndexintegerrequired

            value ≥ 0

          • lineCartLinerequired
            Child attributes (5)
            • productIdstringrequired

              length 1 – 64

            • qtyintegerrequired

              value ≥ 1

            • selectionsCartSelection[]required
              Child attributes (5)
              • groupIdstringrequired

                length 1 – 64

              • optionIdstringrequired

                length 1 – 64

              • qtyintegerrequired

                value ≥ 1

              • placementstringoptional

                Values: "whole""left""right"

              • amountstringoptional

                Values: "light""regular""extra"

            • notestringoptional

              length ≤ 200

            • sourceobjectoptional
              Child attributes (2)
              • experiencestringrequired

                Values: "classic""graphical"

              • modestringoptional

                length ≤ 32

          • unitPriceintegerrequired

            Amount in halalas (1 riyal = 100), VAT-inclusive

            value ≥ 0

          • lineTotalintegerrequired

            Amount in halalas (1 riyal = 100), VAT-inclusive

            value ≥ 0

          • snapshotLineSnapshotrequired
            Child attributes (2)
            • namesLocalizedrequired
              Child attributes (2)
              • arstringrequired
              • enstringrequired
            • optionsSnapshotOption[]required
              Child attributes (7)
              • groupIdstringrequired

                length 1 – 64

              • optionIdstringrequired

                length 1 – 64

              • namesLocalizedrequired
                Child attributes (2)
                • arstringrequired
                • enstringrequired
              • qtyintegerrequired

                value ≥ 1

              • priceintegerrequired

                Amount in halalas (1 riyal = 100), VAT-inclusive

                value ≥ 0

              • placementstringoptional

                Values: "whole""left""right"

              • amountstringoptional

                Values: "light""regular""extra"

        • subtotalintegerrequired

          Amount in halalas (1 riyal = 100), VAT-inclusive

          value ≥ 0

        • discountsDiscount[]required
          Child attributes (4)
          • kindstringrequired

            Values: "coupon""offer"

          • codestringoptional
          • namesLocalizedrequired
            Child attributes (2)
            • arstringrequired
            • enstringrequired
          • amountintegerrequired

            Amount in halalas (1 riyal = 100), VAT-inclusive

            value ≥ 0

        • discountTotalintegerrequired

          Amount in halalas (1 riyal = 100), VAT-inclusive

          value ≥ 0

        • deliveryFeeintegerrequired

          Amount in halalas (1 riyal = 100), VAT-inclusive

          value ≥ 0

        • totalintegerrequired

          Amount in halalas (1 riyal = 100), VAT-inclusive

          value ≥ 0

        • vatobjectrequired
          Child attributes (3)
          • rateBpsintegerrequired
          • amountintegerrequired

            Amount in halalas (1 riyal = 100), VAT-inclusive

            value ≥ 0

          • includesDeliveryFeebooleanrequired
        • scheduledForstring<date-time>optional
        • notestringoptional
        • cutlerybooleanoptional
        • ifUnavailablestringoptional
        • deliveryobjectoptional
          Child attributes (5)
          • addressstringrequired

            length 3 – 300

          • detailsstringoptional

            length ≤ 300

          • locationobjectoptional
            Child attributes (2)
            • latnumberrequired

              value -90 – 90

            • lngnumberrequired

              value -180 – 180

          • contactNamestringrequired

            length 1 – 80

          • contactPhonestringrequired

            length 9 – 20

        • courierobjectoptional
          Child attributes (2)
          • namestringrequired
          • phonestringoptional
        • tenderstringoptional
        • paidAtstring<date-time>optional
        • createdAtstring<date-time>required
        • historyStatusChange[]required
          Child attributes (7)
          • fromstringrequirednullable

            Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

          • tostringrequired

            Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

          • atstring<date-time>required
          • actorStatusChangeActorrequired

            Values: "customer""staff""system""payment""partner"

          • reasonstringoptional
          • reasonCodestringoptional
          • returnedToBranchbooleanoptional
      • statePartnerOrderStaterequired

        Values: "awaiting_ack""acked""closed"

      • ackDueAtstring<date-time>requirednullable
      • ackedAtstring<date-time>requirednullable
      • externalOrderNostringrequirednullable
      • externalReceiptNostringrequirednullable
      • externalPartnerOrderExternalrequired
        Child attributes (4)
        • branchCodestringrequirednullable
        • linesobject[]required
          Child attributes (5)
          • lineIndexintegerrequired

            value ≥ 0

          • codestringrequirednullable
          • variantstringrequirednullable
          • unitstringrequirednullable
          • optionsobject[]required
            Child attributes (4)
            • groupIdstringrequired

              length 1 – 64

            • optionIdstringrequired

              length 1 – 64

            • codestringrequirednullable
            • variantstringrequirednullable
        • tenderCodestringrequirednullable
        • unmappedobject[]required
          Child attributes (2)
          • kindPartnerMappingKindrequired

            Values: "branch""category""product""group""option""tender"

          • ourIdstringrequired
      • updatedAtstring<date-time>required

PartnerPushAnswer#

  • externalOrderNostringoptional

    length 1 – 50

  • externalReceiptNostringoptional

    length 1 – 50

PartnerDayBranch#

  • branchIdstringrequired

    length 1 – 64

  • externalCodestringrequirednullable
  • ordersintegerrequired

    value ≥ 0

  • servedintegerrequired

    value ≥ 0

  • endedintegerrequired

    value ≥ 0

  • openintegerrequired

    value ≥ 0

  • servedTotalintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

  • refundedintegerrequired

    Amount in halalas (1 riyal = 100), VAT-inclusive

    value ≥ 0

PartnerDailyReport#

  • datestringrequired
  • branchesPartnerDayBranch[]required
    Child attributes (8)
    • branchIdstringrequired

      length 1 – 64

    • externalCodestringrequirednullable
    • ordersintegerrequired

      value ≥ 0

    • servedintegerrequired

      value ≥ 0

    • endedintegerrequired

      value ≥ 0

    • openintegerrequired

      value ≥ 0

    • servedTotalintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • refundedintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

  • ordersobject[]required
    Child attributes (7)
    • orderIdstringrequired

      length 1 – 64

    • numberstringrequired
    • branchIdstringrequired

      length 1 – 64

    • statusstringrequired

      Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

    • totalintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • externalOrderNostringrequirednullable
    • createdAtstring<date-time>required

PartnerReconciliationRequest#

  • datestringrequired
  • branchesobject[]required

    items 1 – 200

    Child attributes (4)
    • branchIdstringrequired

      length 1 – 64

    • servedintegerrequired

      value ≥ 0

    • servedTotalintegerrequired

      Amount in halalas (1 riyal = 100), VAT-inclusive

      value ≥ 0

    • externalOrderNosstring[]optional

      items ≤ 5000

PartnerReconciliation#

  • datestringrequired
  • matchedbooleanrequired
  • branchesobject[]required
    Child attributes (6)
    • branchIdstringrequired

      length 1 – 64

    • oursobjectrequired
      Child attributes (2)
      • servedintegerrequired
      • servedTotalintegerrequired
    • theirsobjectrequired
      Child attributes (2)
      • servedintegerrequired
      • servedTotalintegerrequired
    • matchedbooleanrequired
    • missingAtPartnerstring[]required
    • unknownAtLpstring[]required

PartnerTokenRequest#

  • grant_typestringrequired

    length ≤ 40

  • client_idstringrequired

    length 1 – 64

  • client_secretstringrequired

    length 10 – 200

  • scopestringoptional

    length ≤ 500

PartnerTokenResponse#

  • access_tokenstringrequired
  • token_typestringrequired

    Values: "Bearer"

  • expires_inintegerrequired

    value ≥ 1

  • scopestringrequired

PartnerSandboxOrderRequest#

  • branchIdstringrequired

    length 1 – 64

  • fulfilmentstringrequired

    Values: "pickup""delivery"

  • linesCartLine[]optional

    items 1 – 20

    Child attributes (5)
    • productIdstringrequired

      length 1 – 64

    • qtyintegerrequired

      value ≥ 1

    • selectionsCartSelection[]required
      Child attributes (5)
      • groupIdstringrequired

        length 1 – 64

      • optionIdstringrequired

        length 1 – 64

      • qtyintegerrequired

        value ≥ 1

      • placementstringoptional

        Values: "whole""left""right"

      • amountstringoptional

        Values: "light""regular""extra"

    • notestringoptional

      length ≤ 200

    • sourceobjectoptional
      Child attributes (2)
      • experiencestringrequired

        Values: "classic""graphical"

      • modestringoptional

        length ≤ 32

  • paymentMethodstringoptional

    Values: "pay_at_branch""cash_on_delivery"

  • deliveryobjectoptional
    Child attributes (5)
    • addressstringrequired

      length 3 – 300

    • detailsstringoptional

      length ≤ 300

    • locationobjectoptional
      Child attributes (2)
      • latnumberrequired

        value -90 – 90

      • lngnumberrequired

        value -180 – 180

    • contactNamestringrequired

      length 1 – 80

    • contactPhonestringrequired

      length 9 – 20

PartnerRequestLogRow#

  • idintegerrequired

    value ≥ 1

  • requestIdstringrequired
  • keyIdstringrequirednullable

    length 1 – 64

  • keyPrefixstringrequirednullable
  • envIntegrationModerequired

    Values: "sandbox""live"

  • methodstringrequired
  • pathstringrequired
  • statusintegerrequired
  • errorCodestringrequirednullable
  • durationMsintegerrequired

    value ≥ 0

  • ipstringrequirednullable
  • atstring<date-time>required

PartnerRequestLogPage#

  • itemsPartnerRequestLogRow[]required
    Child attributes (12)
    • idintegerrequired

      value ≥ 1

    • requestIdstringrequired
    • keyIdstringrequirednullable

      length 1 – 64

    • keyPrefixstringrequirednullable
    • envIntegrationModerequired

      Values: "sandbox""live"

    • methodstringrequired
    • pathstringrequired
    • statusintegerrequired
    • errorCodestringrequirednullable
    • durationMsintegerrequired

      value ≥ 0

    • ipstringrequirednullable
    • atstring<date-time>required
  • nextBeforeintegerrequirednullable

Enumerations#

NameValues
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