API reference
Models
Every data structure of the partner API.
PartnerSettings#
ordersobjectrequiredChild attributes (5)
deliveryOrderDeliveryrequiredHow you learn about orders: none, pull, webhooks, or connector (we call your system).
Values:
"none""pull""webhooks""connector"acceptanceOrderAcceptancerequiredWho accepts a new order: lp (our branch board) or partner (your system).
Values:
"lp""partner"ackMinutesintegerrequiredMinutes an order waits for your acknowledgement before the branch is alerted (0 = no alert).
value 0 – 120
statusesPartnerStatusTarget[]requiredThe statuses your system may report.
Values:
"accepted""rejected""preparing""ready""picked_up""cancelled""out_for_delivery""delivered""delivery_failed"items ≤ 9
connectorstringrequirednullableThe connector used when delivery is `connector`.
length ≤ 40
catalogobjectrequiredChild attributes (5)
sourcebooleanrequiredTrue: your system is the menu source (only one partner may be).
fieldsCatalogField[]requiredThe menu fields your system owns; the rest (pictures, order) stay the console's.
Values:
"names""descriptions""prices""sizes""groups""options""categories""availability"items ≤ 8
publishCatalogPublishPolicyrequiredWhat happens to a menu you send: manual review, auto_prices (price-only changes publish by themselves), or auto.
Values:
"manual""auto_prices""auto"maxPriceChangePctintegerrequiredThe largest price change, in percent, that publishes by itself.
value 0 – 100
maxRemovalsintegerrequiredThe most items an automatic publish may remove.
value 0 – 1000
availabilitybooleanrequiredTrue: your availability flags apply (they only take items off; staff flags stay staff's).
invoicesobjectrequiredChild attributes (1)
issuerInvoiceIssuerrequiredWho issues the customer's tax invoice: lp (our platform) or partner (your system).
Values:
"lp""partner"
customerDatastringrequiredValues:
"full""masked"liveBranchesstring[]requiredThe branches where your flows are switched on; empty until we switch them on with you.
items ≤ 200
PartnerMe#
partnerobjectrequiredThe partner the key belongs to.
Child attributes (3)
idstringrequiredThe partner's id at Let's Pizza.
length 1 – 64
namestringrequiredThe partner name, as the console shows it.
kindPartnerKindrequiredWhat the system is; decides the default settings and scopes.
Values:
"erp""pos""kds""delivery""marketplace""accounting""analytics""other"
keyobjectrequiredThe key this request was made with.
Child attributes (8)
idstringrequiredlength 1 – 64
envIntegrationModerequiredThe key's environment: sandbox or live.
Values:
"sandbox""live"labelstringrequiredThe key's label, chosen by Let's Pizza.
prefixstringrequiredThe first characters of the key, to tell keys apart; never the key.
scopesPartnerScope[]requiredThe 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[]requirednullableThe branches the key may act on; null = every branch.
ratePerMinuteintegerrequiredRequests per minute allowed for this key.
expiresAtstring<date-time>requirednullableWhen the key expires; null = no end.
environmentIntegrationModerequiredThe environment of the host that answered; always the key's own.
Values:
"sandbox""live"settingsPartnerSettingsrequiredHow orders, statuses, the menu and invoices flow for your system.
Child attributes (6)
ordersobjectrequiredChild attributes (5)
deliveryOrderDeliveryrequiredHow you learn about orders: none, pull, webhooks, or connector (we call your system).
Values:
"none""pull""webhooks""connector"acceptanceOrderAcceptancerequiredWho accepts a new order: lp (our branch board) or partner (your system).
Values:
"lp""partner"ackMinutesintegerrequiredMinutes an order waits for your acknowledgement before the branch is alerted (0 = no alert).
value 0 – 120
statusesPartnerStatusTarget[]requiredThe statuses your system may report.
Values:
"accepted""rejected""preparing""ready""picked_up""cancelled""out_for_delivery""delivered""delivery_failed"items ≤ 9
connectorstringrequirednullableThe connector used when delivery is `connector`.
length ≤ 40
catalogobjectrequiredChild attributes (5)
sourcebooleanrequiredTrue: your system is the menu source (only one partner may be).
fieldsCatalogField[]requiredThe menu fields your system owns; the rest (pictures, order) stay the console's.
Values:
"names""descriptions""prices""sizes""groups""options""categories""availability"items ≤ 8
publishCatalogPublishPolicyrequiredWhat happens to a menu you send: manual review, auto_prices (price-only changes publish by themselves), or auto.
Values:
"manual""auto_prices""auto"maxPriceChangePctintegerrequiredThe largest price change, in percent, that publishes by itself.
value 0 – 100
maxRemovalsintegerrequiredThe most items an automatic publish may remove.
value 0 – 1000
availabilitybooleanrequiredTrue: your availability flags apply (they only take items off; staff flags stay staff's).
invoicesobjectrequiredChild attributes (1)
issuerInvoiceIssuerrequiredWho issues the customer's tax invoice: lp (our platform) or partner (your system).
Values:
"lp""partner"
customerDatastringrequiredValues:
"full""masked"liveBranchesstring[]requiredThe branches where your flows are switched on; empty until we switch them on with you.
items ≤ 200
apiVersionstringrequiredThe API version.
Values:
"v1"serverTimestring<date-time>requiredThe server clock: compare it with yours before checking signatures.
PartnerBranch#
idstringrequiredThe branch's Let's Pizza id; stable.
length 1 – 64
namesLocalizedrequiredThe branch name in Arabic and English.
Child attributes (2)
arstringrequiredenstringrequired
phonestringrequiredThe branch phone, in international format.
locationobjectrequiredWhere the branch is.
Child attributes (2)
latnumberrequiredlngnumberrequired
fulfilmentobjectrequiredHow the branch serves orders.
Child attributes (2)
deliverybooleanrequiredpickupbooleanrequired
pausedbooleanrequiredClosed by staff now, whatever the hours say.
livebooleanrequiredYour flows run at this branch.
externalCodestringrequirednullableYour code for this branch, from the mappings; null until mapped.
Localized#
arstringrequiredenstringrequired
PartnerBranchList#
itemsPartnerBranch[]requiredThe branches the key may act on.
Child attributes (8)
idstringrequiredThe branch's Let's Pizza id; stable.
length 1 – 64
namesLocalizedrequiredThe branch name in Arabic and English.
Child attributes (2)
arstringrequiredenstringrequired
phonestringrequiredThe branch phone, in international format.
locationobjectrequiredWhere the branch is.
Child attributes (2)
latnumberrequiredlngnumberrequired
fulfilmentobjectrequiredHow the branch serves orders.
Child attributes (2)
deliverybooleanrequiredpickupbooleanrequired
pausedbooleanrequiredClosed by staff now, whatever the hours say.
livebooleanrequiredYour flows run at this branch.
externalCodestringrequirednullableYour code for this branch, from the mappings; null until mapped.
PartnerError#
codestringrequiredA stable code: build your logic on it.
messageLocalizedrequiredA message for people, in both languages; its wording may change.
Child attributes (2)
arstringrequiredenstringrequired
fieldstringrequirednullableThe offending field of your request, if any.
retryablebooleanrequiredTrue: the same request may succeed later. False: change it first.
requestIdstringrequiredThe X-Request-Id: quote it to support.
detailobjectoptionalExtra facts for some codes: the scopes needed, seconds to wait, the current status of an order.
An object with free keys.
PartnerMapping#
kindPartnerMappingKindrequiredValues:
"branch""category""product""group""option""tender"ourIdstringrequiredlength 1 – 64
codestringrequiredlength 1 – 50
variantstringrequirednullablelength 1 – 50
unitstringrequirednullablelength 1 – 20
ourNameobjectrequirednullableChild attributes (2)
arstringrequiredenstringrequired
updatedAtstring<date-time>required
PartnerMappingList#
envIntegrationModerequiredValues:
"sandbox""live"itemsPartnerMapping[]requiredChild attributes (7)
kindPartnerMappingKindrequiredValues:
"branch""category""product""group""option""tender"ourIdstringrequiredlength 1 – 64
codestringrequiredlength 1 – 50
variantstringrequirednullablelength 1 – 50
unitstringrequirednullablelength 1 – 20
ourNameobjectrequirednullableChild attributes (2)
arstringrequiredenstringrequired
updatedAtstring<date-time>required
PutPartnerMappingsRequest#
modestringrequiredValues:
"merge""replace"dryRunbooleanoptionalitemsobject[]requireditems ≤ 5000
Child attributes (5)
kindPartnerMappingKindrequiredValues:
"branch""category""product""group""option""tender"ourIdstringrequiredlength 1 – 64
codestringrequiredlength 1 – 50
variantstringoptionalnullablelength 1 – 50
unitstringoptionalnullablelength 1 – 20
PartnerMappingIssue#
indexintegerrequiredvalue ≥ 0
codestringrequiredValues:
"UNKNOWN_ID""DUPLICATE_ROW""CODE_TAKEN"fieldstringrequiredvaluestringrequired
PartnerMappingResult#
dryRunbooleanrequiredokbooleanrequiredaddedintegerrequiredvalue ≥ 0
updatedintegerrequiredvalue ≥ 0
unchangedintegerrequiredvalue ≥ 0
removedintegerrequiredvalue ≥ 0
errorsPartnerMappingIssue[]requiredChild attributes (4)
indexintegerrequiredvalue ≥ 0
codestringrequiredValues:
"UNKNOWN_ID""DUPLICATE_ROW""CODE_TAKEN"fieldstringrequiredvaluestringrequired
PartnerOrderExternal#
branchCodestringrequirednullablelinesobject[]requiredChild attributes (5)
lineIndexintegerrequiredvalue ≥ 0
codestringrequirednullablevariantstringrequirednullableunitstringrequirednullableoptionsobject[]requiredChild attributes (4)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
codestringrequirednullablevariantstringrequirednullable
tenderCodestringrequirednullableunmappedobject[]requiredChild attributes (2)
kindPartnerMappingKindrequiredValues:
"branch""category""product""group""option""tender"ourIdstringrequired
PartnerOrder#
orderOrderrequiredChild attributes (25)
idstringrequiredlength 1 – 64
numberstringrequiredstatusstringrequiredValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"channelstringrequiredValues:
"app""web""console""pos""dine_in"branchIdstringrequiredlength 1 – 64
fulfilmentstringrequiredValues:
"delivery""pickup"paymentMethodstringrequiredValues:
"pay_at_branch""cash_on_delivery""online"catalogVersionstringrequiredlinesOrderLine[]requiredChild attributes (5)
lineIndexintegerrequiredvalue ≥ 0
lineCartLinerequiredChild attributes (5)
productIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
selectionsCartSelection[]requiredChild attributes (5)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
notestringoptionallength ≤ 200
sourceobjectoptionalChild attributes (2)
experiencestringrequiredValues:
"classic""graphical"modestringoptionallength ≤ 32
unitPriceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
lineTotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
snapshotLineSnapshotrequiredChild attributes (2)
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
optionsSnapshotOption[]requiredChild attributes (7)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
qtyintegerrequiredvalue ≥ 1
priceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
subtotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
discountsDiscount[]requiredChild attributes (4)
kindstringrequiredValues:
"coupon""offer"codestringoptionalnamesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
amountintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
discountTotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
deliveryFeeintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
totalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
vatobjectrequiredChild attributes (3)
rateBpsintegerrequiredamountintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
includesDeliveryFeebooleanrequired
scheduledForstring<date-time>optionalnotestringoptionalcutlerybooleanoptionalifUnavailablestringoptionaldeliveryobjectoptionalChild attributes (5)
addressstringrequiredlength 3 – 300
detailsstringoptionallength ≤ 300
locationobjectoptionalChild attributes (2)
latnumberrequiredvalue -90 – 90
lngnumberrequiredvalue -180 – 180
contactNamestringrequiredlength 1 – 80
contactPhonestringrequiredlength 9 – 20
courierobjectoptionalChild attributes (2)
namestringrequiredphonestringoptional
tenderstringoptionalpaidAtstring<date-time>optionalcreatedAtstring<date-time>requiredhistoryStatusChange[]requiredChild attributes (7)
fromstringrequirednullableValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"tostringrequiredValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"atstring<date-time>requiredactorStatusChangeActorrequiredValues:
"customer""staff""system""payment""partner"reasonstringoptionalreasonCodestringoptionalreturnedToBranchbooleanoptional
statePartnerOrderStaterequiredValues:
"awaiting_ack""acked""closed"ackDueAtstring<date-time>requirednullableackedAtstring<date-time>requirednullableexternalOrderNostringrequirednullableexternalReceiptNostringrequirednullableexternalPartnerOrderExternalrequiredChild attributes (4)
branchCodestringrequirednullablelinesobject[]requiredChild attributes (5)
lineIndexintegerrequiredvalue ≥ 0
codestringrequirednullablevariantstringrequirednullableunitstringrequirednullableoptionsobject[]requiredChild attributes (4)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
codestringrequirednullablevariantstringrequirednullable
tenderCodestringrequirednullableunmappedobject[]requiredChild attributes (2)
kindPartnerMappingKindrequiredValues:
"branch""category""product""group""option""tender"ourIdstringrequired
updatedAtstring<date-time>required
Order#
idstringrequiredlength 1 – 64
numberstringrequiredstatusstringrequiredValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"channelstringrequiredValues:
"app""web""console""pos""dine_in"branchIdstringrequiredlength 1 – 64
fulfilmentstringrequiredValues:
"delivery""pickup"paymentMethodstringrequiredValues:
"pay_at_branch""cash_on_delivery""online"catalogVersionstringrequiredlinesOrderLine[]requiredChild attributes (5)
lineIndexintegerrequiredvalue ≥ 0
lineCartLinerequiredChild attributes (5)
productIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
selectionsCartSelection[]requiredChild attributes (5)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
notestringoptionallength ≤ 200
sourceobjectoptionalChild attributes (2)
experiencestringrequiredValues:
"classic""graphical"modestringoptionallength ≤ 32
unitPriceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
lineTotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
snapshotLineSnapshotrequiredChild attributes (2)
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
optionsSnapshotOption[]requiredChild attributes (7)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
qtyintegerrequiredvalue ≥ 1
priceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
subtotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
discountsDiscount[]requiredChild attributes (4)
kindstringrequiredValues:
"coupon""offer"codestringoptionalnamesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
amountintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
discountTotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
deliveryFeeintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
totalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
vatobjectrequiredChild attributes (3)
rateBpsintegerrequiredamountintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
includesDeliveryFeebooleanrequired
scheduledForstring<date-time>optionalnotestringoptionalcutlerybooleanoptionalifUnavailablestringoptionaldeliveryobjectoptionalChild attributes (5)
addressstringrequiredlength 3 – 300
detailsstringoptionallength ≤ 300
locationobjectoptionalChild attributes (2)
latnumberrequiredvalue -90 – 90
lngnumberrequiredvalue -180 – 180
contactNamestringrequiredlength 1 – 80
contactPhonestringrequiredlength 9 – 20
courierobjectoptionalChild attributes (2)
namestringrequiredphonestringoptional
tenderstringoptionalpaidAtstring<date-time>optionalcreatedAtstring<date-time>requiredhistoryStatusChange[]requiredChild attributes (7)
fromstringrequirednullableValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"tostringrequiredValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"atstring<date-time>requiredactorStatusChangeActorrequiredValues:
"customer""staff""system""payment""partner"reasonstringoptionalreasonCodestringoptionalreturnedToBranchbooleanoptional
OrderLine#
lineIndexintegerrequiredvalue ≥ 0
lineCartLinerequiredChild attributes (5)
productIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
selectionsCartSelection[]requiredChild attributes (5)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
notestringoptionallength ≤ 200
sourceobjectoptionalChild attributes (2)
experiencestringrequiredValues:
"classic""graphical"modestringoptionallength ≤ 32
unitPriceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
lineTotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
snapshotLineSnapshotrequiredChild attributes (2)
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
optionsSnapshotOption[]requiredChild attributes (7)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
qtyintegerrequiredvalue ≥ 1
priceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
CartLine#
productIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
selectionsCartSelection[]requiredChild attributes (5)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
notestringoptionallength ≤ 200
sourceobjectoptionalChild attributes (2)
experiencestringrequiredValues:
"classic""graphical"modestringoptionallength ≤ 32
CartSelection#
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
LineSnapshot#
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
optionsSnapshotOption[]requiredChild attributes (7)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
qtyintegerrequiredvalue ≥ 1
priceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
SnapshotOption#
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
qtyintegerrequiredvalue ≥ 1
priceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
Discount#
kindstringrequiredValues:
"coupon""offer"codestringoptionalnamesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
amountintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
DeliveryDetails#
addressstringrequiredlength 3 – 300
detailsstringoptionallength ≤ 300
locationobjectoptionalChild attributes (2)
latnumberrequiredvalue -90 – 90
lngnumberrequiredvalue -180 – 180
contactNamestringrequiredlength 1 – 80
contactPhonestringrequiredlength 9 – 20
GeoPoint#
latnumberrequiredvalue -90 – 90
lngnumberrequiredvalue -180 – 180
Courier#
namestringrequiredphonestringoptional
StatusChange#
fromstringrequirednullableValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"tostringrequiredValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"atstring<date-time>requiredactorStatusChangeActorrequiredValues:
"customer""staff""system""payment""partner"reasonstringoptionalreasonCodestringoptionalreturnedToBranchbooleanoptional
PartnerOrderPage#
itemsPartnerOrder[]requiredChild attributes (8)
orderOrderrequiredChild attributes (25)
idstringrequiredlength 1 – 64
numberstringrequiredstatusstringrequiredValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"channelstringrequiredValues:
"app""web""console""pos""dine_in"branchIdstringrequiredlength 1 – 64
fulfilmentstringrequiredValues:
"delivery""pickup"paymentMethodstringrequiredValues:
"pay_at_branch""cash_on_delivery""online"catalogVersionstringrequiredlinesOrderLine[]requiredChild attributes (5)
lineIndexintegerrequiredvalue ≥ 0
lineCartLinerequiredChild attributes (5)
productIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
selectionsCartSelection[]requiredChild attributes (5)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
notestringoptionallength ≤ 200
sourceobjectoptionalChild attributes (2)
experiencestringrequiredValues:
"classic""graphical"modestringoptionallength ≤ 32
unitPriceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
lineTotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
snapshotLineSnapshotrequiredChild attributes (2)
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
optionsSnapshotOption[]requiredChild attributes (7)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
qtyintegerrequiredvalue ≥ 1
priceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
subtotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
discountsDiscount[]requiredChild attributes (4)
kindstringrequiredValues:
"coupon""offer"codestringoptionalnamesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
amountintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
discountTotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
deliveryFeeintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
totalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
vatobjectrequiredChild attributes (3)
rateBpsintegerrequiredamountintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
includesDeliveryFeebooleanrequired
scheduledForstring<date-time>optionalnotestringoptionalcutlerybooleanoptionalifUnavailablestringoptionaldeliveryobjectoptionalChild attributes (5)
addressstringrequiredlength 3 – 300
detailsstringoptionallength ≤ 300
locationobjectoptionalChild attributes (2)
latnumberrequiredvalue -90 – 90
lngnumberrequiredvalue -180 – 180
contactNamestringrequiredlength 1 – 80
contactPhonestringrequiredlength 9 – 20
courierobjectoptionalChild attributes (2)
namestringrequiredphonestringoptional
tenderstringoptionalpaidAtstring<date-time>optionalcreatedAtstring<date-time>requiredhistoryStatusChange[]requiredChild attributes (7)
fromstringrequirednullableValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"tostringrequiredValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"atstring<date-time>requiredactorStatusChangeActorrequiredValues:
"customer""staff""system""payment""partner"reasonstringoptionalreasonCodestringoptionalreturnedToBranchbooleanoptional
statePartnerOrderStaterequiredValues:
"awaiting_ack""acked""closed"ackDueAtstring<date-time>requirednullableackedAtstring<date-time>requirednullableexternalOrderNostringrequirednullableexternalReceiptNostringrequirednullableexternalPartnerOrderExternalrequiredChild attributes (4)
branchCodestringrequirednullablelinesobject[]requiredChild attributes (5)
lineIndexintegerrequiredvalue ≥ 0
codestringrequirednullablevariantstringrequirednullableunitstringrequirednullableoptionsobject[]requiredChild attributes (4)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
codestringrequirednullablevariantstringrequirednullable
tenderCodestringrequirednullableunmappedobject[]requiredChild attributes (2)
kindPartnerMappingKindrequiredValues:
"branch""category""product""group""option""tender"ourIdstringrequired
updatedAtstring<date-time>required
nextCursorstringrequirednullable
AckOrderRequest#
externalOrderNostringoptionallength 1 – 50
externalReceiptNostringoptionallength 1 – 50
PartnerStatusRequest#
eventIdstringrequiredlength 1 – 64
toPartnerStatusTargetrequiredValues:
"accepted""rejected""preparing""ready""picked_up""cancelled""out_for_delivery""delivered""delivery_failed"expectedFromstringoptionalValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"reasonCodestringoptionalreasonTextstringoptionallength 1 – 300
occurredAtstring<date-time>requiredestimatedReadyAtstring<date-time>optional
PartnerCancelRequest#
eventIdstringrequiredlength 1 – 64
reasonCodeExitReasonCoderequiredValues:
"customer_unreachable""wrong_address""customer_refused""accident_or_damage""kitchen_error""out_of_stock""customer_request""other"reasonTextstringoptionallength 1 – 300
occurredAtstring<date-time>required
PartnerStatusResult#
outcomestringrequiredValues:
"applied""duplicate""ignored""parked"statusstringrequiredValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"reasonstringrequirednullable
PartnerOrderEventRequest#
eventIdstringrequiredlength 1 – 64
typestringrequiredValues:
"receipt_issued""invoice_issued""payment_collected""note"receiptNostringoptionallength 1 – 50
invoiceNostringoptionallength 1 – 50
invoiceQrstringoptionallength ≤ 1000
amountintegeroptionalAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
tenderstringoptionalValues:
"cash""card"notestringoptionallength 1 – 300
occurredAtstring<date-time>required
PartnerOrderEventResult#
outcomestringrequiredValues:
"recorded""duplicate"
PartnerCatalog#
catalogCatalogrequiredChild attributes (6)
versionCatalogVersionrequiredChild attributes (4)
idstringrequiredlength ≥ 1
statusstringrequiredValues:
"draft""published"sourcestringrequiredValues:
"taker""console""foodics""partner"createdAtstring<date-time>required
currencystringrequiredValues:
"SAR"categoriesCategory[]requiredChild attributes (5)
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
imagestringoptionalsortintegerrequiredexternalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
groupsModifierGroup[]requiredChild attributes (12)
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
rolestringrequiredValues:
"choice""extra""removal""cross_sell""bundle_slot"selectionstringrequiredValues:
"single""multi"builderobjectoptionalChild attributes (3)
partstringrequiredValues:
"dough""edge""sauce""cheese""topping""fresh""finish"placementbooleanrequiredamountbooleanrequired
minSelectintegerrequiredvalue ≥ 0
maxSelectintegerrequirednullablevalue ≥ 1
perOptionMaxQtyintegerrequiredvalue ≥ 1
optionsGroupOption[]requiredChild attributes (9)
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
priceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
priceBySizeobjectoptionalChild attributes (2)
mediumintegeroptionalAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
largeintegeroptionalAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
builderobjectoptionalChild attributes (2)
placementbooleanoptionalamountstring[]optionalValues:
"light""extra"items ≤ 2
imagestringoptionallinkedProductIdstringoptionallength 1 – 64
hiddenbooleanoptionalexternalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
defaultOptionIdstringoptionallength 1 – 64
descriptionsobjectoptionalChild attributes (2)
arstringrequiredenstringrequired
externalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
productsProduct[]requiredChild attributes (15)
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
descriptionsLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
imagestringrequiredcategoryIdstringrequiredlength 1 – 64
kindstringrequiredValues:
"simple""bundle"basePriceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
groupIdsstring[]requiredsizeFamilyobjectoptionalChild attributes (2)
familyIdstringrequiredlength 1 – 64
sizestringrequiredValues:
"medium""large"
slicesintegeroptionalvalue 1 – 64
prepMinutesintegerrequiredvalue ≥ 0
tagsstring[]requiredValues:
"vegetarian""spicy""best_seller""new"sortintegerrequiredbuilderobjectoptionalChild attributes (4)
baseArtstringrequireddrawnGroupIdsstring[]requiredmodestringoptionalValues:
"customize""scratch"rulesobjectoptionalChild attributes (4)
maxToppingsTotalintegeroptionalvalue 1 – 200
maxPerHalfintegeroptionalvalue 1 – 200
requireOneOfstring[][]optionalitems ≤ 20
forbidTogetherstring[][]optionalitems ≤ 200
externalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
builderArtobjectoptionalChild attributes (3)
toppingsBuilderTopping[]requiredChild attributes (5)
optionIdstringrequiredlength 1 – 64
piecesBuilderPiece[]requireditems ≥ 1
Child attributes (4)
filestringrequiredwnumberrequiredvalue ≥ 0
hnumberrequiredvalue ≥ 0
rnumberrequiredvalue ≥ 0
countintegerrequiredvalue ≥ 1
scalenumberrequiredvalue ≥ 0
patchbooleanrequired
saucesBuilderSauce[]requiredChild attributes (3)
optionIdstringrequiredlength 1 – 64
colorstringrequiredhighlightstringrequired
optionsobjectoptionalAn object with free keys.
externalobjectrequiredChild attributes (4)
categoriesobjectrequiredAn object with free keys.
productsobjectrequiredAn object with free keys.
groupsobjectrequiredAn object with free keys.
optionsobjectrequiredAn object with free keys.
Catalog#
versionCatalogVersionrequiredChild attributes (4)
idstringrequiredlength ≥ 1
statusstringrequiredValues:
"draft""published"sourcestringrequiredValues:
"taker""console""foodics""partner"createdAtstring<date-time>required
currencystringrequiredValues:
"SAR"categoriesCategory[]requiredChild attributes (5)
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
imagestringoptionalsortintegerrequiredexternalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
groupsModifierGroup[]requiredChild attributes (12)
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
rolestringrequiredValues:
"choice""extra""removal""cross_sell""bundle_slot"selectionstringrequiredValues:
"single""multi"builderobjectoptionalChild attributes (3)
partstringrequiredValues:
"dough""edge""sauce""cheese""topping""fresh""finish"placementbooleanrequiredamountbooleanrequired
minSelectintegerrequiredvalue ≥ 0
maxSelectintegerrequirednullablevalue ≥ 1
perOptionMaxQtyintegerrequiredvalue ≥ 1
optionsGroupOption[]requiredChild attributes (9)
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
priceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
priceBySizeobjectoptionalChild attributes (2)
mediumintegeroptionalAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
largeintegeroptionalAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
builderobjectoptionalChild attributes (2)
placementbooleanoptionalamountstring[]optionalValues:
"light""extra"items ≤ 2
imagestringoptionallinkedProductIdstringoptionallength 1 – 64
hiddenbooleanoptionalexternalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
defaultOptionIdstringoptionallength 1 – 64
descriptionsobjectoptionalChild attributes (2)
arstringrequiredenstringrequired
externalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
productsProduct[]requiredChild attributes (15)
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
descriptionsLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
imagestringrequiredcategoryIdstringrequiredlength 1 – 64
kindstringrequiredValues:
"simple""bundle"basePriceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
groupIdsstring[]requiredsizeFamilyobjectoptionalChild attributes (2)
familyIdstringrequiredlength 1 – 64
sizestringrequiredValues:
"medium""large"
slicesintegeroptionalvalue 1 – 64
prepMinutesintegerrequiredvalue ≥ 0
tagsstring[]requiredValues:
"vegetarian""spicy""best_seller""new"sortintegerrequiredbuilderobjectoptionalChild attributes (4)
baseArtstringrequireddrawnGroupIdsstring[]requiredmodestringoptionalValues:
"customize""scratch"rulesobjectoptionalChild attributes (4)
maxToppingsTotalintegeroptionalvalue 1 – 200
maxPerHalfintegeroptionalvalue 1 – 200
requireOneOfstring[][]optionalitems ≤ 20
forbidTogetherstring[][]optionalitems ≤ 200
externalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
builderArtobjectoptionalChild attributes (3)
toppingsBuilderTopping[]requiredChild attributes (5)
optionIdstringrequiredlength 1 – 64
piecesBuilderPiece[]requireditems ≥ 1
Child attributes (4)
filestringrequiredwnumberrequiredvalue ≥ 0
hnumberrequiredvalue ≥ 0
rnumberrequiredvalue ≥ 0
countintegerrequiredvalue ≥ 1
scalenumberrequiredvalue ≥ 0
patchbooleanrequired
saucesBuilderSauce[]requiredChild attributes (3)
optionIdstringrequiredlength 1 – 64
colorstringrequiredhighlightstringrequired
optionsobjectoptionalAn object with free keys.
CatalogVersion#
idstringrequiredlength ≥ 1
statusstringrequiredValues:
"draft""published"sourcestringrequiredValues:
"taker""console""foodics""partner"createdAtstring<date-time>required
Category#
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
imagestringoptionalsortintegerrequiredexternalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
ExternalRef#
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
ModifierGroup#
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
rolestringrequiredValues:
"choice""extra""removal""cross_sell""bundle_slot"selectionstringrequiredValues:
"single""multi"builderobjectoptionalChild attributes (3)
partstringrequiredValues:
"dough""edge""sauce""cheese""topping""fresh""finish"placementbooleanrequiredamountbooleanrequired
minSelectintegerrequiredvalue ≥ 0
maxSelectintegerrequirednullablevalue ≥ 1
perOptionMaxQtyintegerrequiredvalue ≥ 1
optionsGroupOption[]requiredChild attributes (9)
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
priceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
priceBySizeobjectoptionalChild attributes (2)
mediumintegeroptionalAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
largeintegeroptionalAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
builderobjectoptionalChild attributes (2)
placementbooleanoptionalamountstring[]optionalValues:
"light""extra"items ≤ 2
imagestringoptionallinkedProductIdstringoptionallength 1 – 64
hiddenbooleanoptionalexternalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
defaultOptionIdstringoptionallength 1 – 64
descriptionsobjectoptionalChild attributes (2)
arstringrequiredenstringrequired
externalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
GroupBuilderHints#
partstringrequiredValues:
"dough""edge""sauce""cheese""topping""fresh""finish"placementbooleanrequiredamountbooleanrequired
GroupOption#
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
priceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
priceBySizeobjectoptionalChild attributes (2)
mediumintegeroptionalAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
largeintegeroptionalAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
builderobjectoptionalChild attributes (2)
placementbooleanoptionalamountstring[]optionalValues:
"light""extra"items ≤ 2
imagestringoptionallinkedProductIdstringoptionallength 1 – 64
hiddenbooleanoptionalexternalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
OptionBuilderHints#
placementbooleanoptionalamountstring[]optionalValues:
"light""extra"items ≤ 2
Product#
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
descriptionsLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
imagestringrequiredcategoryIdstringrequiredlength 1 – 64
kindstringrequiredValues:
"simple""bundle"basePriceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
groupIdsstring[]requiredsizeFamilyobjectoptionalChild attributes (2)
familyIdstringrequiredlength 1 – 64
sizestringrequiredValues:
"medium""large"
slicesintegeroptionalvalue 1 – 64
prepMinutesintegerrequiredvalue ≥ 0
tagsstring[]requiredValues:
"vegetarian""spicy""best_seller""new"sortintegerrequiredbuilderobjectoptionalChild attributes (4)
baseArtstringrequireddrawnGroupIdsstring[]requiredmodestringoptionalValues:
"customize""scratch"rulesobjectoptionalChild attributes (4)
maxToppingsTotalintegeroptionalvalue 1 – 200
maxPerHalfintegeroptionalvalue 1 – 200
requireOneOfstring[][]optionalitems ≤ 20
forbidTogetherstring[][]optionalitems ≤ 200
externalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
BuilderProfile#
baseArtstringrequireddrawnGroupIdsstring[]requiredmodestringoptionalValues:
"customize""scratch"rulesobjectoptionalChild attributes (4)
maxToppingsTotalintegeroptionalvalue 1 – 200
maxPerHalfintegeroptionalvalue 1 – 200
requireOneOfstring[][]optionalitems ≤ 20
forbidTogetherstring[][]optionalitems ≤ 200
BuilderRules#
maxToppingsTotalintegeroptionalvalue 1 – 200
maxPerHalfintegeroptionalvalue 1 – 200
requireOneOfstring[][]optionalitems ≤ 20
forbidTogetherstring[][]optionalitems ≤ 200
BuilderArt#
toppingsBuilderTopping[]requiredChild attributes (5)
optionIdstringrequiredlength 1 – 64
piecesBuilderPiece[]requireditems ≥ 1
Child attributes (4)
filestringrequiredwnumberrequiredvalue ≥ 0
hnumberrequiredvalue ≥ 0
rnumberrequiredvalue ≥ 0
countintegerrequiredvalue ≥ 1
scalenumberrequiredvalue ≥ 0
patchbooleanrequired
saucesBuilderSauce[]requiredChild attributes (3)
optionIdstringrequiredlength 1 – 64
colorstringrequiredhighlightstringrequired
optionsobjectoptionalAn object with free keys.
BuilderTopping#
optionIdstringrequiredlength 1 – 64
piecesBuilderPiece[]requireditems ≥ 1
Child attributes (4)
filestringrequiredwnumberrequiredvalue ≥ 0
hnumberrequiredvalue ≥ 0
rnumberrequiredvalue ≥ 0
countintegerrequiredvalue ≥ 1
scalenumberrequiredvalue ≥ 0
patchbooleanrequired
BuilderPiece#
filestringrequiredwnumberrequiredvalue ≥ 0
hnumberrequiredvalue ≥ 0
rnumberrequiredvalue ≥ 0
BuilderSauce#
optionIdstringrequiredlength 1 – 64
colorstringrequiredhighlightstringrequired
BuilderOptionArt#
piecestringoptionallength ≥ 1
layerstringoptionalnullablelength ≥ 1
doughstringoptionalValues:
"classic""thin""pan"edgestringoptionalValues:
"classic""cheese""garlic"cheesestringoptionalValues:
"none""light""regular""extra"patchstringoptionalshapestringoptionalValues:
"dice""crumble""torn""shred""slice""crescent""blob"drizzlestringoptionalsprinklestringoptionalhighlightstringoptionalvesselstringoptionalValues:
"squeeze_bottle""oil_cruet"tintstringoptionalcountintegeroptionalvalue ≥ 1
sizenumberoptionalvalue ≥ 0
postbooleanoptionalprebooleanoptionalthinbooleanoptional
PartnerOrderPayments#
orderIdstringrequiredlength 1 – 64
paymentMethodstringrequiredValues:
"pay_at_branch""cash_on_delivery""online"totalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
paidintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
refundedintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
attemptsobject[]requiredChild attributes (4)
idstringrequiredlength 1 – 64
statusstringrequiredamountintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
createdAtstring<date-time>required
refundsRefund[]requiredChild attributes (10)
idstringrequiredlength 1 – 64
orderIdstringrequiredlength 1 – 64
intentIdstringrequirednullablelength 1 – 64
amountintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
reasonstringrequiredValues:
"cancelled_by_customer""cancelled_by_branch""rejected""item_unavailable""quality""other"notestringoptionallength ≤ 500
statusstringrequiredValues:
"requested""processing""succeeded""failed"requestedBystringrequiredlength ≥ 1
createdAtstring<date-time>requiredsettledAtstring<date-time>optional
Refund#
idstringrequiredlength 1 – 64
orderIdstringrequiredlength 1 – 64
intentIdstringrequirednullablelength 1 – 64
amountintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
reasonstringrequiredValues:
"cancelled_by_customer""cancelled_by_branch""rejected""item_unavailable""quality""other"notestringoptionallength ≤ 500
statusstringrequiredValues:
"requested""processing""succeeded""failed"requestedBystringrequiredlength ≥ 1
createdAtstring<date-time>requiredsettledAtstring<date-time>optional
SaveWebhookRequest#
namestringrequiredlength 1 – 80
urlstringrequiredlength 8 – 500
eventsWebhookEventType[]requiredValues:
"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[]optionalnullableitems ≤ 200
piibooleanoptionalactivebooleanoptional
WebhookSubscription#
idstringrequiredlength 1 – 64
namestringrequiredurlstringrequiredeventsWebhookEventType[]requiredValues:
"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[]requirednullablepiibooleanrequiredactivebooleanrequiredpausedAtstring<date-time>requirednullablepausedReasonstringrequirednullablesecretHintstringrequiredcreatedAtstring<date-time>requiredcreatedBystringrequirednullablepartnerIdstringrequirednullableupdatedAtstring<date-time>requiredlastDeliveryAtstring<date-time>requirednullablefailureCountintegerrequiredvalue ≥ 0
waitingintegerrequiredvalue ≥ 0
deadintegerrequiredvalue ≥ 0
WebhookSecretIssued#
subscriptionWebhookSubscriptionrequiredChild attributes (18)
idstringrequiredlength 1 – 64
namestringrequiredurlstringrequiredeventsWebhookEventType[]requiredValues:
"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[]requirednullablepiibooleanrequiredactivebooleanrequiredpausedAtstring<date-time>requirednullablepausedReasonstringrequirednullablesecretHintstringrequiredcreatedAtstring<date-time>requiredcreatedBystringrequirednullablepartnerIdstringrequirednullableupdatedAtstring<date-time>requiredlastDeliveryAtstring<date-time>requirednullablefailureCountintegerrequiredvalue ≥ 0
waitingintegerrequiredvalue ≥ 0
deadintegerrequiredvalue ≥ 0
secretstringrequired
WebhookDelivery#
idstringrequiredlength 1 – 64
subscriptionIdstringrequiredlength 1 – 64
eventIdstringrequirednullableeventTypeWebhookEventTyperequiredValues:
"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"subjectstringrequirednullablebranchIdstringrequirednullableattemptintegerrequiredvalue ≥ 0
statusWebhookDeliveryStatusrequiredValues:
"pending""delivered""failed""dead"httpStatusintegerrequirednullabledurationMsintegerrequirednullableerrorstringrequirednullablenextAtstring<date-time>requirednullablecreatedAtstring<date-time>requiredlastAttemptAtstring<date-time>requirednullabledeliveredAtstring<date-time>requirednullablereplayOfstringrequirednullable
WebhookDeliveryPage#
deliveriesWebhookDelivery[]requiredChild attributes (16)
idstringrequiredlength 1 – 64
subscriptionIdstringrequiredlength 1 – 64
eventIdstringrequirednullableeventTypeWebhookEventTyperequiredValues:
"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"subjectstringrequirednullablebranchIdstringrequirednullableattemptintegerrequiredvalue ≥ 0
statusWebhookDeliveryStatusrequiredValues:
"pending""delivered""failed""dead"httpStatusintegerrequirednullabledurationMsintegerrequirednullableerrorstringrequirednullablenextAtstring<date-time>requirednullablecreatedAtstring<date-time>requiredlastAttemptAtstring<date-time>requirednullabledeliveredAtstring<date-time>requirednullablereplayOfstringrequirednullable
nextBeforestringoptional
PartnerMenu#
modestringrequiredValues:
"full""delta"dryRunbooleanoptionalcategoriesobject[]optionalitems ≤ 500
Child attributes (5)
codestringrequiredlength 1 – 50
nameArstringrequiredlength 1 – 120
nameEnstringrequiredlength 1 – 120
sortOrderintegeroptionalblockedbooleanoptional
itemsobject[]optionalitems ≤ 3000
Child attributes (10)
codestringrequiredlength 1 – 50
nameArstringrequiredlength 1 – 120
nameEnstringrequiredlength 1 – 120
descriptionArstringoptionallength ≤ 500
descriptionEnstringoptionallength ≤ 500
categoryCodestringoptionallength 1 – 50
priceintegeroptionalvalue ≥ 0
variantsobject[]optionalitems ≤ 10
Child attributes (3)
codestringrequiredlength 1 – 50
priceintegerrequiredvalue ≥ 0
blockedbooleanoptional
groupCodesstring[]optionalitems ≤ 50
blockedbooleanoptional
groupsobject[]optionalitems ≤ 500
Child attributes (7)
codestringrequiredlength 1 – 50
nameArstringrequiredlength 1 – 120
nameEnstringrequiredlength 1 – 120
minSelectintegeroptionalvalue ≥ 0
maxSelectintegeroptionalnullablevalue ≥ 1
maxPerOptionintegeroptionalvalue ≥ 1
optionsobject[]requireditems ≤ 200
Child attributes (6)
codestringrequiredlength 1 – 50
nameArstringrequiredlength 1 – 120
nameEnstringrequiredlength 1 – 120
priceintegerrequiredvalue ≥ 0
pricesBySizeobjectoptionalChild attributes (2)
mediumintegeroptionalvalue ≥ 0
largeintegeroptionalvalue ≥ 0
blockedbooleanoptional
CatalogImportUnknown#
kindstringrequiredValues:
"category""item""variant""group""option"codestringrequirednamestringrequiredpriceintegerrequirednullable
CatalogImport#
idstringrequiredlength 1 – 64
partnerIdstringrequiredlength 1 – 64
envIntegrationModerequiredValues:
"sandbox""live"modestringrequiredValues:
"full""delta"statusCatalogImportStatusrequiredValues:
"rejected""staged""published""discarded""superseded"reasonstringrequirednullablecountsobjectrequiredChild attributes (7)
categoriesintegerrequireditemsintegerrequiredgroupsintegerrequiredoptionsintegerrequiredappliedintegerrequiredunknownintegerrequiredtakenOffintegerrequired
unknownCatalogImportUnknown[]requiredChild attributes (4)
kindstringrequiredValues:
"category""item""variant""group""option"codestringrequirednamestringrequiredpriceintegerrequirednullable
takenOffstring[]requiredissuesCatalogIssue[]requiredChild attributes (4)
severitystringrequiredValues:
"error""warning"codestringrequiredrefstringrequireddetailstringoptional
diffobjectrequirednullableChild attributes (9)
productsAddedstring[]requiredproductsRemovedstring[]requiredproductsChangedstring[]requiredpriceChangesobject[]requiredChild attributes (3)
productIdstringrequiredlength 1 – 64
fromintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
tointegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
optionPriceChangesobject[]requiredChild attributes (5)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
sizestringoptionalValues:
"medium""large"fromintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
tointegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
groupsAddedstring[]requiredgroupsRemovedstring[]requiredgroupsChangedstring[]requiredcategoriesChangedbooleanrequired
versionIdstringrequirednullablecreatedAtstring<date-time>requireddecidedAtstring<date-time>requirednullabledecidedBystringrequirednullable
CatalogIssue#
severitystringrequiredValues:
"error""warning"codestringrequiredrefstringrequireddetailstringoptional
CatalogDiff#
productsAddedstring[]requiredproductsRemovedstring[]requiredproductsChangedstring[]requiredpriceChangesobject[]requiredChild attributes (3)
productIdstringrequiredlength 1 – 64
fromintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
tointegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
optionPriceChangesobject[]requiredChild attributes (5)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
sizestringoptionalValues:
"medium""large"fromintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
tointegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
groupsAddedstring[]requiredgroupsRemovedstring[]requiredgroupsChangedstring[]requiredcategoriesChangedbooleanrequired
PartnerAvailabilityItem#
kindstringrequiredValues:
"product""option"idstringoptionallength 1 – 64
codestringoptionallength 1 – 50
variantstringoptionallength 1 – 50
availablebooleanrequired
PartnerAvailabilityRequest#
itemsPartnerAvailabilityItem[]requireditems ≤ 2000
Child attributes (5)
kindstringrequiredValues:
"product""option"idstringoptionallength 1 – 64
codestringoptionallength 1 – 50
variantstringoptionallength 1 – 50
availablebooleanrequired
PartnerAvailabilityResult#
branchIdstringrequiredlength 1 – 64
offintegerrequiredvalue ≥ 0
onintegerrequiredvalue ≥ 0
keptStaffintegerrequiredvalue ≥ 0
unknownstring[]requiredunavailableobject[]requiredChild attributes (2)
kindstringrequiredValues:
"product""option"idstringrequiredlength 1 – 64
PartnerPushMessage#
versionnumberrequiredValues:
1idstringrequiredtypestringrequiredValues:
"order.created""order.cancelled"occurredAtstring<date-time>requiredpartnerIdstringrequiredlength 1 – 64
dataobjectrequiredChild attributes (1)
orderPartnerOrderrequiredChild attributes (8)
orderOrderrequiredChild attributes (25)
idstringrequiredlength 1 – 64
numberstringrequiredstatusstringrequiredValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"channelstringrequiredValues:
"app""web""console""pos""dine_in"branchIdstringrequiredlength 1 – 64
fulfilmentstringrequiredValues:
"delivery""pickup"paymentMethodstringrequiredValues:
"pay_at_branch""cash_on_delivery""online"catalogVersionstringrequiredlinesOrderLine[]requiredChild attributes (5)
lineIndexintegerrequiredvalue ≥ 0
lineCartLinerequiredChild attributes (5)
productIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
selectionsCartSelection[]requiredChild attributes (5)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
notestringoptionallength ≤ 200
sourceobjectoptionalChild attributes (2)
experiencestringrequiredValues:
"classic""graphical"modestringoptionallength ≤ 32
unitPriceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
lineTotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
snapshotLineSnapshotrequiredChild attributes (2)
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
optionsSnapshotOption[]requiredChild attributes (7)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
qtyintegerrequiredvalue ≥ 1
priceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
subtotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
discountsDiscount[]requiredChild attributes (4)
kindstringrequiredValues:
"coupon""offer"codestringoptionalnamesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
amountintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
discountTotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
deliveryFeeintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
totalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
vatobjectrequiredChild attributes (3)
rateBpsintegerrequiredamountintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
includesDeliveryFeebooleanrequired
scheduledForstring<date-time>optionalnotestringoptionalcutlerybooleanoptionalifUnavailablestringoptionaldeliveryobjectoptionalChild attributes (5)
addressstringrequiredlength 3 – 300
detailsstringoptionallength ≤ 300
locationobjectoptionalChild attributes (2)
latnumberrequiredvalue -90 – 90
lngnumberrequiredvalue -180 – 180
contactNamestringrequiredlength 1 – 80
contactPhonestringrequiredlength 9 – 20
courierobjectoptionalChild attributes (2)
namestringrequiredphonestringoptional
tenderstringoptionalpaidAtstring<date-time>optionalcreatedAtstring<date-time>requiredhistoryStatusChange[]requiredChild attributes (7)
fromstringrequirednullableValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"tostringrequiredValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"atstring<date-time>requiredactorStatusChangeActorrequiredValues:
"customer""staff""system""payment""partner"reasonstringoptionalreasonCodestringoptionalreturnedToBranchbooleanoptional
statePartnerOrderStaterequiredValues:
"awaiting_ack""acked""closed"ackDueAtstring<date-time>requirednullableackedAtstring<date-time>requirednullableexternalOrderNostringrequirednullableexternalReceiptNostringrequirednullableexternalPartnerOrderExternalrequiredChild attributes (4)
branchCodestringrequirednullablelinesobject[]requiredChild attributes (5)
lineIndexintegerrequiredvalue ≥ 0
codestringrequirednullablevariantstringrequirednullableunitstringrequirednullableoptionsobject[]requiredChild attributes (4)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
codestringrequirednullablevariantstringrequirednullable
tenderCodestringrequirednullableunmappedobject[]requiredChild attributes (2)
kindPartnerMappingKindrequiredValues:
"branch""category""product""group""option""tender"ourIdstringrequired
updatedAtstring<date-time>required
PartnerPushAnswer#
externalOrderNostringoptionallength 1 – 50
externalReceiptNostringoptionallength 1 – 50
PartnerDayBranch#
branchIdstringrequiredlength 1 – 64
externalCodestringrequirednullableordersintegerrequiredvalue ≥ 0
servedintegerrequiredvalue ≥ 0
endedintegerrequiredvalue ≥ 0
openintegerrequiredvalue ≥ 0
servedTotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
refundedintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
PartnerDailyReport#
datestringrequiredbranchesPartnerDayBranch[]requiredChild attributes (8)
branchIdstringrequiredlength 1 – 64
externalCodestringrequirednullableordersintegerrequiredvalue ≥ 0
servedintegerrequiredvalue ≥ 0
endedintegerrequiredvalue ≥ 0
openintegerrequiredvalue ≥ 0
servedTotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
refundedintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
ordersobject[]requiredChild attributes (7)
orderIdstringrequiredlength 1 – 64
numberstringrequiredbranchIdstringrequiredlength 1 – 64
statusstringrequiredValues:
"pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"totalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
externalOrderNostringrequirednullablecreatedAtstring<date-time>required
PartnerReconciliationRequest#
datestringrequiredbranchesobject[]requireditems 1 – 200
Child attributes (4)
branchIdstringrequiredlength 1 – 64
servedintegerrequiredvalue ≥ 0
servedTotalintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
externalOrderNosstring[]optionalitems ≤ 5000
PartnerReconciliation#
datestringrequiredmatchedbooleanrequiredbranchesobject[]requiredChild attributes (6)
branchIdstringrequiredlength 1 – 64
oursobjectrequiredChild attributes (2)
servedintegerrequiredservedTotalintegerrequired
theirsobjectrequiredChild attributes (2)
servedintegerrequiredservedTotalintegerrequired
matchedbooleanrequiredmissingAtPartnerstring[]requiredunknownAtLpstring[]required
PartnerTokenRequest#
grant_typestringrequiredlength ≤ 40
client_idstringrequiredlength 1 – 64
client_secretstringrequiredlength 10 – 200
scopestringoptionallength ≤ 500
PartnerTokenResponse#
access_tokenstringrequiredtoken_typestringrequiredValues:
"Bearer"expires_inintegerrequiredvalue ≥ 1
scopestringrequired
PartnerSandboxOrderRequest#
branchIdstringrequiredlength 1 – 64
fulfilmentstringrequiredValues:
"pickup""delivery"linesCartLine[]optionalitems 1 – 20
Child attributes (5)
productIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
selectionsCartSelection[]requiredChild attributes (5)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
qtyintegerrequiredvalue ≥ 1
placementstringoptionalValues:
"whole""left""right"amountstringoptionalValues:
"light""regular""extra"
notestringoptionallength ≤ 200
sourceobjectoptionalChild attributes (2)
experiencestringrequiredValues:
"classic""graphical"modestringoptionallength ≤ 32
paymentMethodstringoptionalValues:
"pay_at_branch""cash_on_delivery"deliveryobjectoptionalChild attributes (5)
addressstringrequiredlength 3 – 300
detailsstringoptionallength ≤ 300
locationobjectoptionalChild attributes (2)
latnumberrequiredvalue -90 – 90
lngnumberrequiredvalue -180 – 180
contactNamestringrequiredlength 1 – 80
contactPhonestringrequiredlength 9 – 20
PartnerRequestLogRow#
idintegerrequiredvalue ≥ 1
requestIdstringrequiredkeyIdstringrequirednullablelength 1 – 64
keyPrefixstringrequirednullableenvIntegrationModerequiredValues:
"sandbox""live"methodstringrequiredpathstringrequiredstatusintegerrequirederrorCodestringrequirednullabledurationMsintegerrequiredvalue ≥ 0
ipstringrequirednullableatstring<date-time>required
PartnerRequestLogPage#
itemsPartnerRequestLogRow[]requiredChild attributes (12)
idintegerrequiredvalue ≥ 1
requestIdstringrequiredkeyIdstringrequirednullablelength 1 – 64
keyPrefixstringrequirednullableenvIntegrationModerequiredValues:
"sandbox""live"methodstringrequiredpathstringrequiredstatusintegerrequirederrorCodestringrequirednullabledurationMsintegerrequiredvalue ≥ 0
ipstringrequirednullableatstring<date-time>required
nextBeforeintegerrequirednullable
Enumerations#
| Name | Values |
|---|---|
PartnerKind | erpposkdsdeliverymarketplaceaccountinganalyticsother |
PartnerScope | branches:readcatalog:readcatalog:writeavailability:writeorders:readorders:ackorders:statusorders:cancelorders:eventspayments:readreports:readwebhooks:managemappings:write |
OrderDelivery | nonepullwebhooksconnector |
OrderAcceptance | lppartner |
PartnerStatusTarget | acceptedrejectedpreparingreadypicked_upcancelledout_for_deliverydelivereddelivery_failed |
CatalogField | namesdescriptionspricessizesgroupsoptionscategoriesavailability |
CatalogPublishPolicy | manualauto_pricesauto |
InvoiceIssuer | lppartner |
IntegrationMode | sandboxlive |
PartnerMappingKind | branchcategoryproductgroupoptiontender |
PartnerOrderState | awaiting_ackackedclosed |
IfUnavailable | callreplaceremovecancel |
Tender | cashcard |
StatusChangeActor | customerstaffsystempaymentpartner |
ExitReasonCode | customer_unreachablewrong_addresscustomer_refusedaccident_or_damagekitchen_errorout_of_stockcustomer_requestother |
WebhookEventType | order.createdorder.acceptedorder.preparingorder.readyorder.out_for_deliveryorder.deliveredorder.picked_uporder.cancelledorder.rejectedorder.failed_deliveryorder.not_collectedorder.ack_overduepayment.succeededpayment.refundedinvoice.issuedbranch.closedbranch.openedbranch.busyavailability.changedcatalog.publishedping |
WebhookDeliveryStatus | pendingdeliveredfaileddead |
WebhookPauseReason | manualfailures |
CatalogImportStatus | rejectedstagedpublisheddiscardedsuperseded |