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

البداية

الأخطاء

كل رفض من الواجهة يأتي في غلاف واحد اسمه PartnerError، برمز ثابت ورسالة بلغتين.

غلاف الخطأ#

403 · PartnerError
{
  "code": "SCOPE_REQUIRED",
  "message": {
    "ar": "هذا المفتاح لا يملك الصلاحية المطلوبة لهذا الطلب.",
    "en": "This key lacks the scope this request needs."
  },
  "field": null,
  "retryable": false,
  "requestId": "req_01JD7Q8W3K2M",
  "detail": {
    "required": [
      "branches:read"
    ]
  }
}
  • code ثابت لا يتغيّر: ابنِ منطقك عليه.
  • message للبشر بلغتين، وقد يتغيّر نصه.
  • field الحقل المخالف إن وُجد.
  • retryable true فقط للرموز 408 و429 و5xx: الطلب نفسه قد ينجح لاحقاً. false: غيّر الطلب أولاً.
  • requestId رقم الطلب لإرساله إلى الدعم.

رموز الأخطاء#

الرمزHTTPالمعنىإعادة المحاولة
UNAUTHENTICATED401مفتاح الوصول مفقود أو غير صحيح أو ملغى.لا
KEY_EXPIRED401انتهت صلاحية مفتاح الوصول: اطلب مفتاحاً جديداً.لا
KEY_ENVIRONMENT_MISMATCH401هذا المفتاح لبيئة أخرى: مفاتيح الاختبار تعمل على بيئة الاختبار فقط، ومفاتيح الإنتاج على الإنتاج فقط.لا
PARTNER_SUSPENDED403حساب الشريك موقوف مؤقتاً. تواصل مع فريق ليتس بيتزا.لا
IP_NOT_ALLOWED403العنوان الذي جاء منه الطلب غير مسموح لهذا المفتاح.لا
SCOPE_REQUIRED403هذا المفتاح لا يملك الصلاحية المطلوبة لهذا الطلب.لا
BRANCH_NOT_ALLOWED403هذا المفتاح لا يعمل على هذا الفرع.لا
RATE_LIMITED429طلبات كثيرة في وقت قصير. أعد المحاولة بعد المدة المذكورة.نعم
INVALID_REQUEST400الطلب لا يطابق المواصفة.لا
INVALID_JSON400جسم الطلب ليس JSON صالحاً.لا
PAYLOAD_TOO_LARGE413جسم الطلب أكبر من الحد المسموح.لا
IDEMPOTENCY_KEY_REQUIRED400ترويسة Idempotency-Key مطلوبة لهذا الطلب (حتى 128 حرفاً).لا
IDEMPOTENCY_KEY_REUSED422استُخدم مفتاح Idempotency-Key نفسه مع طلب مختلف.لا
NOT_FOUND404غير موجود.لا
ORDER_NOT_FOUND404الطلب غير موجود ضمن طلباتك.لا
ACK_CONFLICT409سبق إقرار الطلب برقم مختلف.لا
STATUS_CHANGED409تغيّرت حالة الطلب منذ قرأتها. اقرأ الطلب ثم أعد الإرسال.لا
STATUS_NOT_ALLOWED403هذه الحالة غير مسموح لك بإرسالها في إعداداتك.لا
TRANSITION_NOT_ALLOWED—لا يمكن نقل الطلب إلى هذه الحالة من حالته الحالية.—
BRANCH_NOT_LIVE409الربط غير مفعّل بعد في فرع هذا الطلب.لا
EVENT_ID_REUSED409معرّف الحدث eventId مستخدم سابقاً لطلب آخر.لا
REASON_REQUIRED422هذه الحالة تحتاج سبباً: reasonCode أو reasonText.لا
CATALOG_SOURCE_REQUIRED403هذا الشريك ليس مصدر المنيو في إعداداته.لا
AVAILABILITY_NOT_ENABLED403إرسال التوفّر غير مفعّل لهذا الشريك.لا
IMPORT_NOT_FOUND404عملية استيراد المنيو غير موجودة.لا
SANDBOX_ONLY403هذه الأداة تعمل في بيئة الاختبار فقط.لا
SANDBOX_QUOTE_INVALID422تعذّر تسعير الطلب التجريبي: راجع detail.errors (مثلاً الفرع مغلق).لا
MAPPINGS_REFUSED422رُفض طلب الربط كاملاً ولم يتغيّر شيء: راجع detail.errors.لا
WEBHOOK_NOT_FOUND404الاشتراك غير موجود ضمن اشتراكاتك.لا
WEBHOOK_INVALID422بيانات الاشتراك غير صالحة: راجع detail.issues.لا
FIELD_REQUIRED422حقل مطلوب لهذا النوع من الأحداث مفقود.لا
CONFLICT409تعارض مع الحالة الحالية.لا
FORBIDDEN403غير مسموح.لا
INTERNAL_ERROR500خطأ غير متوقع لدينا. أعد المحاولة لاحقاً، وإن تكرر فأرسل رقم الطلب X-Request-Id إلى الدعم.نعم
SERVICE_UNAVAILABLE503الخدمة غير متاحة مؤقتاً. أعد المحاولة لاحقاً.نعم

متى تعيد المحاولة#

الردماذا تفعل
400 · 404 · 409 · 422لا تعد المحاولة. أصلح الطلب أو البيانات أولاً.
401 · 403لا تعد المحاولة. راجع المفتاح وصلاحياته، وأبلغ فريقك.
429انتظر Retry-After ثم أعد المحاولة.
408 · 5xx · انقطاعأعد المحاولة بتباعد متزايد (مثلاً 1 ثم 2 ثم 4 ثوانٍ…) بالمفتاح Idempotency-Key نفسه.