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

مرجع الواجهة

الفروع

Let's Pizza branches as the key may see them (hours and zones stay in the Let's Pizza console).

GETThe branches the key may act on#

GET/partner/v1/branches

Scope branches:read. live = your flows run at that branch; externalCode = your code for it once mapped.

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

الردود

200OKPartnerBranchList

الترويسات

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

البنية

  • itemsPartnerBranch[]مطلوب

    الفروع المسموح بها للمفتاح.

    الحقول الداخلية (8)
    • idstringمطلوب

      معرّف الفرع لدى ليتس بيتزا، ثابت لا يتغيّر.

      الطول: 1 – 64

    • namesLocalizedمطلوب

      اسم الفرع بالعربية والإنجليزية.

      الحقول الداخلية (2)
      • arstringمطلوب
      • enstringمطلوب
    • phonestringمطلوب

      هاتف الفرع بصيغة دولية.

    • locationobjectمطلوب

      موقع الفرع على الخريطة.

      الحقول الداخلية (2)
      • latnumberمطلوب
      • lngnumberمطلوب
    • fulfilmentobjectمطلوب

      طرق الاستلام التي يقدّمها الفرع.

      الحقول الداخلية (2)
      • deliverybooleanمطلوب
      • pickupbooleanمطلوب
    • pausedbooleanمطلوب

      أوقف الموظفون الفرع الآن، مهما كانت أوقات العمل.

    • livebooleanمطلوب

      تدفقات نظامك مفعّلة في هذا الفرع.

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

      رمز الفرع في نظامك من جدول الربط، و null حتى يُربط.

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 · PartnerBranchList
{
  "items": [
    {
      "id": "28",
      "names": {
        "ar": "التخصصي",
        "en": "At Takhassusi"
      },
      "phone": "+966550920955",
      "location": {
        "lat": 24.684674035598,
        "lng": 46.67496908366
      },
      "fulfilment": {
        "delivery": true,
        "pickup": true
      },
      "paused": false,
      "live": true,
      "externalCode": "STORE-28"
    }
  ]
}