مرجع الواجهة
الفروع
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/branchesScope branches:read. live = your flows run at that branch; externalCode = your code for it once mapped.
curl -sS "$LP_BASE_URL/partner/v1/branches" \
-H "Authorization: Bearer $LP_API_KEY"الردود
200OKPartnerBranchList
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
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. |
البنية
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-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
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
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
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
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
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
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. |
مثال الرد
{
"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"
}
]
}