API reference
Reports
Your day as Let’s Pizza counts it, and the daily reconciliation.
GETYour day per branch#
/partner/v1/reports/dailyScope reports:read. Your orders created on a Riyadh calendar day (00:00–24:00 +03:00) at the branches your key may see: per branch how many, served (delivered or picked up), ended unserved, still open, the served total and refunds (halalas, VAT-inclusive); and the served orders with your order numbers. Use it every morning for the day before.
curl -sS "$LP_BASE_URL/partner/v1/reports/daily?date=string" \
-H "Authorization: Bearer $LP_API_KEY"Parameters
| Name | In | Type | Description |
|---|---|---|---|
date * | query | string | |
branchId | query | string |
Responses
200OKPartnerDailyReport
Headers
| Name | Type | Description |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
RateLimit-Limit | integer | The key's requests per minute. |
RateLimit-Remaining | integer | Requests left in the current minute. |
RateLimit-Reset | integer | Seconds until the minute window resets. |
Schema
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
400INVALID_REQUEST (field: date)PartnerError
Headers
| Name | Type | Description |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError
Headers
| Name | Type | Description |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
403PARTNER_SUSPENDED, IP_NOT_ALLOWED, SCOPE_REQUIRED (detail.required lists the scopes), BRANCH_NOT_ALLOWEDPartnerError
Headers
| Name | Type | Description |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
429RATE_LIMITED: wait Retry-After seconds (also in detail.retryAfterSeconds)PartnerError
Headers
| Name | Type | Description |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
500INTERNAL_ERROR: retryable; quote the X-Request-Id if it persistsPartnerError
Headers
| Name | Type | Description |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
Example response
{
"date": "string",
"branches": [
{
"branchId": "28",
"externalCode": "STORE-28",
"orders": 0,
"served": 0,
"ended": 0,
"open": 0,
"servedTotal": 0,
"refunded": 0
}
],
"orders": [
{
"orderId": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
"number": "261119-0041",
"branchId": "28",
"status": "pending_payment",
"total": 0,
"externalOrderNo": "string",
"createdAt": "2026-11-19T19:30:12+03:00"
}
]
}POSTCompare your count of a day with ours#
/partner/v1/reports/reconciliationScope reports:read. Send your served count and total per branch (and, best, your order numbers): the answer says per branch whether they match, which of your numbers we do not know, and which of our served orders you did not list. Nothing is stored.
curl -sS -X POST "$LP_BASE_URL/partner/v1/reports/reconciliation" \
-H "Authorization: Bearer $LP_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"date": "string",
"branches": [
{
"branchId": "28",
"served": 0,
"servedTotal": 0,
"externalOrderNos": [
"string"
]
}
]
}'Request body 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
Responses
200OKPartnerReconciliation
Headers
| Name | Type | Description |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
RateLimit-Limit | integer | The key's requests per minute. |
RateLimit-Remaining | integer | Requests left in the current minute. |
RateLimit-Reset | integer | Seconds until the minute window resets. |
Schema
datestringrequiredmatchedbooleanrequiredbranchesobject[]requiredChild attributes (6)
branchIdstringrequiredlength 1 – 64
oursobjectrequiredChild attributes (2)
servedintegerrequiredservedTotalintegerrequired
theirsobjectrequiredChild attributes (2)
servedintegerrequiredservedTotalintegerrequired
matchedbooleanrequiredmissingAtPartnerstring[]requiredunknownAtLpstring[]required
400INVALID_REQUESTPartnerError
Headers
| Name | Type | Description |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError
Headers
| Name | Type | Description |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
403PARTNER_SUSPENDED, IP_NOT_ALLOWED, SCOPE_REQUIRED (detail.required lists the scopes), BRANCH_NOT_ALLOWEDPartnerError
Headers
| Name | Type | Description |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
429RATE_LIMITED: wait Retry-After seconds (also in detail.retryAfterSeconds)PartnerError
Headers
| Name | Type | Description |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
500INTERNAL_ERROR: retryable; quote the X-Request-Id if it persistsPartnerError
Headers
| Name | Type | Description |
|---|---|---|
X-Request-Id | string | The id of this request: quote it to support. Send your own (8–64 of A-Z a-z 0-9 . _ -) to trace a call end to end. |
Example response
{
"date": "string",
"matched": true,
"branches": [
{
"branchId": "28",
"ours": {
"served": 0,
"servedTotal": 0
},
"theirs": {
"served": 0,
"servedTotal": 0
},
"matched": true,
"missingAtPartner": [
"string"
],
"unknownAtLp": [
"string"
]
}
]
}