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

مرجع الواجهة

التقارير

Your day as Let’s Pizza counts it, and the daily reconciliation.

GETYour day per branch#

GET/partner/v1/reports/daily

Scope 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.

المصادقة
مفتاح الشريك في ترويسة Authorization
الصلاحيات المطلوبة
reports:read
curl -sS "$LP_BASE_URL/partner/v1/reports/daily?date=string" \
  -H "Authorization: Bearer $LP_API_KEY"

المعاملات

الاسمالموضعالنوعالوصف
date *querystring
branchIdquerystring

الردود

200OKPartnerDailyReport

الترويسات

الاسمالنوعالوصف
X-Request-IdstringThe 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-LimitintegerThe key's requests per minute.
RateLimit-RemainingintegerRequests left in the current minute.
RateLimit-ResetintegerSeconds until the minute window resets.

البنية

  • datestringمطلوب
  • branchesPartnerDayBranch[]مطلوب
    الحقول الداخلية (8)
    • branchIdstringمطلوب

      الطول: 1 – 64

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

      القيمة: ≥ 0

    • servedintegerمطلوب

      القيمة: ≥ 0

    • endedintegerمطلوب

      القيمة: ≥ 0

    • openintegerمطلوب

      القيمة: ≥ 0

    • servedTotalintegerمطلوب

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

      القيمة: ≥ 0

    • refundedintegerمطلوب

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

      القيمة: ≥ 0

  • ordersobject[]مطلوب
    الحقول الداخلية (7)
    • orderIdstringمطلوب

      الطول: 1 – 64

    • numberstringمطلوب
    • branchIdstringمطلوب

      الطول: 1 – 64

    • statusstringمطلوب

      القيم: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

    • totalintegerمطلوب

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

      القيمة: ≥ 0

    • externalOrderNostringمطلوبيقبل null
    • createdAtstring<date-time>مطلوب
400INVALID_REQUEST (field: date)PartnerError

الترويسات

الاسمالنوعالوصف
X-Request-IdstringThe 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

الترويسات

الاسمالنوعالوصف
X-Request-IdstringThe 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

الترويسات

الاسمالنوعالوصف
X-Request-IdstringThe 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

الترويسات

الاسمالنوعالوصف
X-Request-IdstringThe 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

الترويسات

الاسمالنوعالوصف
X-Request-IdstringThe 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.

مثال الرد

200 · PartnerDailyReport
{
  "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#

POST/partner/v1/reports/reconciliation

Scope 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.

المصادقة
مفتاح الشريك في ترويسة Authorization
الصلاحيات المطلوبة
reports:read
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"
      ]
    }
  ]
}'

جسم الطلب PartnerReconciliationRequest

  • datestringمطلوب
  • branchesobject[]مطلوب

    العناصر: 1 – 200

    الحقول الداخلية (4)
    • branchIdstringمطلوب

      الطول: 1 – 64

    • servedintegerمطلوب

      القيمة: ≥ 0

    • servedTotalintegerمطلوب

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

      القيمة: ≥ 0

    • externalOrderNosstring[]اختياري

      العناصر: ≤ 5000

الردود

200OKPartnerReconciliation

الترويسات

الاسمالنوعالوصف
X-Request-IdstringThe 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-LimitintegerThe key's requests per minute.
RateLimit-RemainingintegerRequests left in the current minute.
RateLimit-ResetintegerSeconds until the minute window resets.

البنية

  • datestringمطلوب
  • matchedbooleanمطلوب
  • branchesobject[]مطلوب
    الحقول الداخلية (6)
    • branchIdstringمطلوب

      الطول: 1 – 64

    • oursobjectمطلوب
      الحقول الداخلية (2)
      • servedintegerمطلوب
      • servedTotalintegerمطلوب
    • theirsobjectمطلوب
      الحقول الداخلية (2)
      • servedintegerمطلوب
      • servedTotalintegerمطلوب
    • matchedbooleanمطلوب
    • missingAtPartnerstring[]مطلوب
    • unknownAtLpstring[]مطلوب
400INVALID_REQUESTPartnerError

الترويسات

الاسمالنوعالوصف
X-Request-IdstringThe 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

الترويسات

الاسمالنوعالوصف
X-Request-IdstringThe 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

الترويسات

الاسمالنوعالوصف
X-Request-IdstringThe 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

الترويسات

الاسمالنوعالوصف
X-Request-IdstringThe 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

الترويسات

الاسمالنوعالوصف
X-Request-IdstringThe 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.

مثال الرد

200 · PartnerReconciliation
{
  "date": "string",
  "matched": true,
  "branches": [
    {
      "branchId": "28",
      "ours": {
        "served": 0,
        "servedTotal": 0
      },
      "theirs": {
        "served": 0,
        "servedTotal": 0
      },
      "matched": true,
      "missingAtPartner": [
        "string"
      ],
      "unknownAtLp": [
        "string"
      ]
    }
  ]
}