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

مرجع الواجهة

المنيو

The published menu with your codes, and the mapping between Let's Pizza ids and your codes.

GETThe published menu with your codes#

GET/partner/v1/catalog

Scope catalog:read. The menu customers see now (categories, products — one per size —, modifier groups and options with their prices in halalas, VAT-inclusive), and under external your code for every id you mapped. Send If-None-Match with the last ETag: 304 when nothing changed (the menu or your mappings).

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

المعاملات

الاسمالموضعالنوعالوصف
If-None-Matchheaderstring

الردود

200OKPartnerCatalog

الترويسات

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

البنية

  • catalogCatalogمطلوب
    الحقول الداخلية (6)
    • versionCatalogVersionمطلوب
      الحقول الداخلية (4)
      • idstringمطلوب

        الطول: ≥ 1

      • statusstringمطلوب

        القيم: "draft""published"

      • sourcestringمطلوب

        القيم: "taker""console""foodics""partner"

      • createdAtstring<date-time>مطلوب
    • currencystringمطلوب

      القيم: "SAR"

    • categoriesCategory[]مطلوب
      الحقول الداخلية (5)
      • idstringمطلوب

        الطول: 1 – 64

      • namesLocalizedمطلوب
        الحقول الداخلية (2)
        • arstringمطلوب
        • enstringمطلوب
      • imagestringاختياري
      • sortintegerمطلوب
      • externalobjectاختياري
        الحقول الداخلية (2)
        • sourcestringمطلوب

          القيم: "taker""foodics""console"

        • idstringمطلوب
    • groupsModifierGroup[]مطلوب
      الحقول الداخلية (12)
      • idstringمطلوب

        الطول: 1 – 64

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

        القيم: "choice""extra""removal""cross_sell""bundle_slot"

      • selectionstringمطلوب

        القيم: "single""multi"

      • builderobjectاختياري
        الحقول الداخلية (3)
        • partstringمطلوب

          القيم: "dough""edge""sauce""cheese""topping""fresh""finish"

        • placementbooleanمطلوب
        • amountbooleanمطلوب
      • minSelectintegerمطلوب

        القيمة: ≥ 0

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

        القيمة: ≥ 1

      • perOptionMaxQtyintegerمطلوب

        القيمة: ≥ 1

      • optionsGroupOption[]مطلوب
        الحقول الداخلية (9)
        • idstringمطلوب

          الطول: 1 – 64

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

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

          القيمة: ≥ 0

        • priceBySizeobjectاختياري
          الحقول الداخلية (2)
          • mediumintegerاختياري

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

            القيمة: ≥ 0

          • largeintegerاختياري

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

            القيمة: ≥ 0

        • builderobjectاختياري
          الحقول الداخلية (2)
          • placementbooleanاختياري
          • amountstring[]اختياري

            القيم: "light""extra"

            العناصر: ≤ 2

        • imagestringاختياري
        • linkedProductIdstringاختياري

          الطول: 1 – 64

        • hiddenbooleanاختياري
        • externalobjectاختياري
          الحقول الداخلية (2)
          • sourcestringمطلوب

            القيم: "taker""foodics""console"

          • idstringمطلوب
      • defaultOptionIdstringاختياري

        الطول: 1 – 64

      • descriptionsobjectاختياري
        الحقول الداخلية (2)
        • arstringمطلوب
        • enstringمطلوب
      • externalobjectاختياري
        الحقول الداخلية (2)
        • sourcestringمطلوب

          القيم: "taker""foodics""console"

        • idstringمطلوب
    • productsProduct[]مطلوب
      الحقول الداخلية (15)
      • idstringمطلوب

        الطول: 1 – 64

      • namesLocalizedمطلوب
        الحقول الداخلية (2)
        • arstringمطلوب
        • enstringمطلوب
      • descriptionsLocalizedمطلوب
        الحقول الداخلية (2)
        • arstringمطلوب
        • enstringمطلوب
      • imagestringمطلوب
      • categoryIdstringمطلوب

        الطول: 1 – 64

      • kindstringمطلوب

        القيم: "simple""bundle"

      • basePriceintegerمطلوب

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

        القيمة: ≥ 0

      • groupIdsstring[]مطلوب
      • sizeFamilyobjectاختياري
        الحقول الداخلية (2)
        • familyIdstringمطلوب

          الطول: 1 – 64

        • sizestringمطلوب

          القيم: "medium""large"

      • slicesintegerاختياري

        القيمة: 1 – 64

      • prepMinutesintegerمطلوب

        القيمة: ≥ 0

      • tagsstring[]مطلوب

        القيم: "vegetarian""spicy""best_seller""new"

      • sortintegerمطلوب
      • builderobjectاختياري
        الحقول الداخلية (4)
        • baseArtstringمطلوب
        • drawnGroupIdsstring[]مطلوب
        • modestringاختياري

          القيم: "customize""scratch"

        • rulesobjectاختياري
          الحقول الداخلية (4)
          • maxToppingsTotalintegerاختياري

            القيمة: 1 – 200

          • maxPerHalfintegerاختياري

            القيمة: 1 – 200

          • requireOneOfstring[][]اختياري

            العناصر: ≤ 20

          • forbidTogetherstring[][]اختياري

            العناصر: ≤ 200

      • externalobjectاختياري
        الحقول الداخلية (2)
        • sourcestringمطلوب

          القيم: "taker""foodics""console"

        • idstringمطلوب
    • builderArtobjectاختياري
      الحقول الداخلية (3)
      • toppingsBuilderTopping[]مطلوب
        الحقول الداخلية (5)
        • optionIdstringمطلوب

          الطول: 1 – 64

        • piecesBuilderPiece[]مطلوب

          العناصر: ≥ 1

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

            القيمة: ≥ 0

          • hnumberمطلوب

            القيمة: ≥ 0

          • rnumberمطلوب

            القيمة: ≥ 0

        • countintegerمطلوب

          القيمة: ≥ 1

        • scalenumberمطلوب

          القيمة: ≥ 0

        • patchbooleanمطلوب
      • saucesBuilderSauce[]مطلوب
        الحقول الداخلية (3)
        • optionIdstringمطلوب

          الطول: 1 – 64

        • colorstringمطلوب
        • highlightstringمطلوب
      • optionsobjectاختياري

        كائن بمفاتيح حرّة.

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

      كائن بمفاتيح حرّة.

    • productsobjectمطلوب

      كائن بمفاتيح حرّة.

    • groupsobjectمطلوب

      كائن بمفاتيح حرّة.

    • optionsobjectمطلوب

      كائن بمفاتيح حرّة.

304Not modified
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 · PartnerCatalog
{
  "catalog": {
    "version": {
      "id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
      "status": "draft",
      "source": "taker",
      "createdAt": "2026-11-19T19:30:12+03:00"
    },
    "currency": "SAR",
    "categories": [
      {
        "id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
        "names": {
          "ar": "التخصصي",
          "en": "At Takhassusi"
        },
        "image": "string",
        "sort": 0,
        "external": {
          "source": "taker",
          "id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01"
        }
      }
    ],
    "groups": [
      {
        "id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
        "names": {
          "ar": "التخصصي",
          "en": "At Takhassusi"
        },
        "role": "choice",
        "selection": "single",
        "builder": {
          "part": "dough",
          "placement": true,
          "amount": true
        },
        "minSelect": 0,
        "maxSelect": 1,
        "perOptionMaxQty": 1,
        "options": [
          {
            "id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
            "names": {
              "ar": "التخصصي",
              "en": "At Takhassusi"
            },
            "price": 0,
            "priceBySize": {
              "medium": 0,
              "large": 0
            },
            "builder": {
              "placement": true,
              "amount": [
                "light"
              ]
            },
            "image": "string",
            "linkedProductId": "string",
            "hidden": true,
            "external": {
              "source": "taker",
              "id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01"
            }
          }
        ],
        "defaultOptionId": "string",
        "descriptions": {
          "ar": "string",
          "en": "string"
        },
        "external": {
          "source": "taker",
          "id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01"
        }
      }
    ],
    "products": [
      {
        "id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
        "names": {
          "ar": "التخصصي",
          "en": "At Takhassusi"
        },
        "descriptions": {
          "ar": "string",
          "en": "string"
        },
        "image": "string",
        "categoryId": "string",
        "kind": "simple",
        "basePrice": 0,
        "groupIds": [
          "string"
        ],
        "sizeFamily": {
          "familyId": "string",
          "size": "medium"
        },
        "slices": 1,
        "prepMinutes": 0,
        "tags": [
          "vegetarian"
        ],
        "sort": 0,
        "builder": {
          "baseArt": "string",
          "drawnGroupIds": [
            "string"
          ],
          "mode": "customize",
          "rules": {
            "maxToppingsTotal": 1,
            "maxPerHalf": 1,
            "requireOneOf": [
              [
                "string"
              ]
            ],
            "forbidTogether": [
              [
                "string"
              ]
            ]
          }
        },
        "external": {
          "source": "taker",
          "id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01"
        }
      }
    ],
    "builderArt": {
      "toppings": [
        {
          "optionId": "string",
          "pieces": [
            {
              "file": "string",
              "w": 0.5,
              "h": 0.5,
              "r": 0.5
            }
          ],
          "count": 1,
          "scale": 0.5,
          "patch": true
        }
      ],
      "sauces": [
        {
          "optionId": "string",
          "color": "string",
          "highlight": "string"
        }
      ],
      "options": {}
    }
  },
  "external": {
    "categories": {},
    "products": {},
    "groups": {},
    "options": {}
  }
}

GETYour codes for our ids#

GET/partner/v1/mappings

Scope catalog:read. Every mapping of this key's environment: branches, categories, products (with your size as variant), groups, options, tenders (online_card, online_apple_pay, online_stc_pay, cash_on_delivery, card_on_delivery, pay_at_branch, card_at_branch).

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

الردود

200OKPartnerMappingList

الترويسات

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

البنية

  • envIntegrationModeمطلوب

    القيم: "sandbox""live"

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

      القيم: "branch""category""product""group""option""tender"

    • ourIdstringمطلوب

      الطول: 1 – 64

    • codestringمطلوب

      الطول: 1 – 50

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

      الطول: 1 – 50

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

      الطول: 1 – 20

    • ourNameobjectمطلوبيقبل null
      الحقول الداخلية (2)
      • arstringمطلوب
      • enstringمطلوب
    • updatedAtstring<date-time>مطلوب
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 · PartnerMappingList
{
  "env": "sandbox",
  "items": [
    {
      "kind": "branch",
      "ourId": "string",
      "code": "string",
      "variant": "string",
      "unit": "string",
      "ourName": {
        "ar": "string",
        "en": "string"
      },
      "updatedAt": "2026-11-19T19:30:12+03:00"
    }
  ]
}

PUTSet your codes#

PUT/partner/v1/mappings

Scope mappings:write. All or nothing: any bad row refuses the whole request (422 with errors[]: UNKNOWN_ID, DUPLICATE_ROW, CODE_TAKEN). merge adds and replaces the rows sent; replace also removes the mappings of the kinds sent that are not listed. dryRun checks and counts only. An order whose branch, products or options are not mapped still reaches you: external.unmapped lists what is missing.

المصادقة
مفتاح الشريك في ترويسة Authorization
الصلاحيات المطلوبة
mappings:write
curl -sS -X PUT "$LP_BASE_URL/partner/v1/mappings" \
  -H "Authorization: Bearer $LP_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  --data '{
  "mode": "merge",
  "dryRun": true,
  "items": [
    {
      "kind": "branch",
      "ourId": "string",
      "code": "string",
      "variant": "string",
      "unit": "string"
    }
  ]
}'

المعاملات

الاسمالموضعالنوعالوصف
Idempotency-Key *headerstringYour unique id of this request (≤ 128 characters). A repeat with the same key and body returns the first answer; the same key with another body is 422 IDEMPOTENCY_KEY_REUSED.

جسم الطلب PutPartnerMappingsRequest

  • modestringمطلوب

    القيم: "merge""replace"

  • dryRunbooleanاختياري
  • itemsobject[]مطلوب

    العناصر: ≤ 5000

    الحقول الداخلية (5)
    • kindPartnerMappingKindمطلوب

      القيم: "branch""category""product""group""option""tender"

    • ourIdstringمطلوب

      الطول: 1 – 64

    • codestringمطلوب

      الطول: 1 – 50

    • variantstringاختيارييقبل null

      الطول: 1 – 50

    • unitstringاختيارييقبل null

      الطول: 1 – 20

الردود

200OKPartnerMappingResult

الترويسات

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

البنية

  • dryRunbooleanمطلوب
  • okbooleanمطلوب
  • addedintegerمطلوب

    القيمة: ≥ 0

  • updatedintegerمطلوب

    القيمة: ≥ 0

  • unchangedintegerمطلوب

    القيمة: ≥ 0

  • removedintegerمطلوب

    القيمة: ≥ 0

  • errorsPartnerMappingIssue[]مطلوب
    الحقول الداخلية (4)
    • indexintegerمطلوب

      القيمة: ≥ 0

    • codestringمطلوب

      القيم: "UNKNOWN_ID""DUPLICATE_ROW""CODE_TAKEN"

    • fieldstringمطلوب
    • valuestringمطلوب
400INVALID_REQUEST (field, detail.issues), IDEMPOTENCY_KEY_REQUIREDPartnerError

الترويسات

الاسمالنوعالوصف
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.
422MAPPINGS_REFUSED (nothing changed; detail.errors[] of {index, code: UNKNOWN_ID | DUPLICATE_ROW | CODE_TAKEN, field, value}; not kept as the Idempotency-Key answer, so the corrected request may reuse the key), IDEMPOTENCY_KEY_REUSEDPartnerError

الترويسات

الاسمالنوعالوصف
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 · PartnerMappingResult
{
  "dryRun": true,
  "ok": true,
  "added": 0,
  "updated": 0,
  "unchanged": 0,
  "removed": 0,
  "errors": [
    {
      "index": 0,
      "code": "UNKNOWN_ID",
      "field": "string",
      "value": "string"
    }
  ]
}

GETYour last menus#

GET/partner/v1/catalog/imports

Scope catalog:write. Newest first, with what became of each.

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

الردود

200OKany

الترويسات

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

البنية

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 · CatalogImportList
null

POSTSend your menu#

POST/partner/v1/catalog/imports

Scope catalog:write, and your settings must name you the menu source. Your codes are matched to Let's Pizza ids through your mappings; only the fields your settings give you change (names, descriptions, prices, groups, options, categories, availability). Pictures, the pizza builder, display order and sections stay with Let's Pizza. A code with no mapping is listed in unknown, never added on its own. blocked, and in a full menu a mapped product you no longer list, take the item off at your live branches (never a deletion). The candidate is checked like any menu edit (issues) and compared with what customers see (diff). Then your publish policy decides: manual waits for Let's Pizza staff (staged); auto_prices publishes price-only changes within maxPriceChangePct; auto publishes unless more than maxRemovals products would go. dryRun returns the report without keeping it. A newer menu replaces a staged one (superseded).

المصادقة
مفتاح الشريك في ترويسة Authorization
الصلاحيات المطلوبة
catalog:write
curl -sS -X POST "$LP_BASE_URL/partner/v1/catalog/imports" \
  -H "Authorization: Bearer $LP_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  --data '{
  "mode": "full",
  "dryRun": true,
  "categories": [
    {
      "code": "string",
      "nameAr": "string",
      "nameEn": "string",
      "sortOrder": 0,
      "blocked": true
    }
  ],
  "items": [
    {
      "code": "string",
      "nameAr": "string",
      "nameEn": "string",
      "descriptionAr": "string",
      "descriptionEn": "string",
      "categoryCode": "string",
      "price": 0,
      "variants": [
        {
          "code": "string",
          "price": 0,
          "blocked": true
        }
      ],
      "groupCodes": [
        "string"
      ],
      "blocked": true
    }
  ],
  "groups": [
    {
      "code": "string",
      "nameAr": "string",
      "nameEn": "string",
      "minSelect": 0,
      "maxSelect": 1,
      "maxPerOption": 1,
      "options": [
        {
          "code": "string",
          "nameAr": "string",
          "nameEn": "string",
          "price": 0,
          "pricesBySize": {
            "medium": 0,
            "large": 0
          },
          "blocked": true
        }
      ]
    }
  ]
}'

المعاملات

الاسمالموضعالنوعالوصف
Idempotency-Key *headerstringYour unique id of this request (≤ 128 characters). A repeat with the same key and body returns the first answer; the same key with another body is 422 IDEMPOTENCY_KEY_REUSED.

جسم الطلب PartnerMenu

  • modestringمطلوب

    القيم: "full""delta"

  • dryRunbooleanاختياري
  • categoriesobject[]اختياري

    العناصر: ≤ 500

    الحقول الداخلية (5)
    • codestringمطلوب

      الطول: 1 – 50

    • nameArstringمطلوب

      الطول: 1 – 120

    • nameEnstringمطلوب

      الطول: 1 – 120

    • sortOrderintegerاختياري
    • blockedbooleanاختياري
  • itemsobject[]اختياري

    العناصر: ≤ 3000

    الحقول الداخلية (10)
    • codestringمطلوب

      الطول: 1 – 50

    • nameArstringمطلوب

      الطول: 1 – 120

    • nameEnstringمطلوب

      الطول: 1 – 120

    • descriptionArstringاختياري

      الطول: ≤ 500

    • descriptionEnstringاختياري

      الطول: ≤ 500

    • categoryCodestringاختياري

      الطول: 1 – 50

    • priceintegerاختياري

      القيمة: ≥ 0

    • variantsobject[]اختياري

      العناصر: ≤ 10

      الحقول الداخلية (3)
      • codestringمطلوب

        الطول: 1 – 50

      • priceintegerمطلوب

        القيمة: ≥ 0

      • blockedbooleanاختياري
    • groupCodesstring[]اختياري

      العناصر: ≤ 50

    • blockedbooleanاختياري
  • groupsobject[]اختياري

    العناصر: ≤ 500

    الحقول الداخلية (7)
    • codestringمطلوب

      الطول: 1 – 50

    • nameArstringمطلوب

      الطول: 1 – 120

    • nameEnstringمطلوب

      الطول: 1 – 120

    • minSelectintegerاختياري

      القيمة: ≥ 0

    • maxSelectintegerاختيارييقبل null

      القيمة: ≥ 1

    • maxPerOptionintegerاختياري

      القيمة: ≥ 1

    • optionsobject[]مطلوب

      العناصر: ≤ 200

      الحقول الداخلية (6)
      • codestringمطلوب

        الطول: 1 – 50

      • nameArstringمطلوب

        الطول: 1 – 120

      • nameEnstringمطلوب

        الطول: 1 – 120

      • priceintegerمطلوب

        القيمة: ≥ 0

      • pricesBySizeobjectاختياري
        الحقول الداخلية (2)
        • mediumintegerاختياري

          القيمة: ≥ 0

        • largeintegerاختياري

          القيمة: ≥ 0

      • blockedbooleanاختياري

الردود

201Received (status says what became of it)CatalogImport

الترويسات

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

البنية

  • idstringمطلوب

    الطول: 1 – 64

  • partnerIdstringمطلوب

    الطول: 1 – 64

  • envIntegrationModeمطلوب

    القيم: "sandbox""live"

  • modestringمطلوب

    القيم: "full""delta"

  • statusCatalogImportStatusمطلوب

    القيم: "rejected""staged""published""discarded""superseded"

  • reasonstringمطلوبيقبل null
  • countsobjectمطلوب
    الحقول الداخلية (7)
    • categoriesintegerمطلوب
    • itemsintegerمطلوب
    • groupsintegerمطلوب
    • optionsintegerمطلوب
    • appliedintegerمطلوب
    • unknownintegerمطلوب
    • takenOffintegerمطلوب
  • unknownCatalogImportUnknown[]مطلوب
    الحقول الداخلية (4)
    • kindstringمطلوب

      القيم: "category""item""variant""group""option"

    • codestringمطلوب
    • namestringمطلوب
    • priceintegerمطلوبيقبل null
  • takenOffstring[]مطلوب
  • issuesCatalogIssue[]مطلوب
    الحقول الداخلية (4)
    • severitystringمطلوب

      القيم: "error""warning"

    • codestringمطلوب
    • refstringمطلوب
    • detailstringاختياري
  • diffobjectمطلوبيقبل null
    الحقول الداخلية (9)
    • productsAddedstring[]مطلوب
    • productsRemovedstring[]مطلوب
    • productsChangedstring[]مطلوب
    • priceChangesobject[]مطلوب
      الحقول الداخلية (3)
      • productIdstringمطلوب

        الطول: 1 – 64

      • fromintegerمطلوب

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

        القيمة: ≥ 0

      • tointegerمطلوب

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

        القيمة: ≥ 0

    • optionPriceChangesobject[]مطلوب
      الحقول الداخلية (5)
      • groupIdstringمطلوب

        الطول: 1 – 64

      • optionIdstringمطلوب

        الطول: 1 – 64

      • sizestringاختياري

        القيم: "medium""large"

      • fromintegerمطلوب

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

        القيمة: ≥ 0

      • tointegerمطلوب

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

        القيمة: ≥ 0

    • groupsAddedstring[]مطلوب
    • groupsRemovedstring[]مطلوب
    • groupsChangedstring[]مطلوب
    • categoriesChangedbooleanمطلوب
  • versionIdstringمطلوبيقبل null
  • createdAtstring<date-time>مطلوب
  • decidedAtstring<date-time>مطلوبيقبل null
  • decidedBystringمطلوبيقبل null
400INVALID_REQUEST (field, detail.issues), IDEMPOTENCY_KEY_REQUIREDPartnerError

الترويسات

الاسمالنوعالوصف
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.
403CATALOG_SOURCE_REQUIRED, SCOPE_REQUIRED, PARTNER_SUSPENDED, IP_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.
422IDEMPOTENCY_KEY_REUSEDPartnerError

الترويسات

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

مثال الرد

201 · CatalogImport
{
  "id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
  "partnerId": "string",
  "env": "sandbox",
  "mode": "full",
  "status": "rejected",
  "reason": "string",
  "counts": {
    "categories": 0,
    "items": 0,
    "groups": 0,
    "options": 0,
    "applied": 0,
    "unknown": 0,
    "takenOff": 0
  },
  "unknown": [
    {
      "kind": "category",
      "code": "string",
      "name": "string",
      "price": 0
    }
  ],
  "takenOff": [
    "string"
  ],
  "issues": [
    {
      "severity": "error",
      "code": "string",
      "ref": "string",
      "detail": "string"
    }
  ],
  "diff": {
    "productsAdded": [
      "string"
    ],
    "productsRemoved": [
      "string"
    ],
    "productsChanged": [
      "string"
    ],
    "priceChanges": [
      {
        "productId": "string",
        "from": 0,
        "to": 0
      }
    ],
    "optionPriceChanges": [
      {
        "groupId": "string",
        "optionId": "string",
        "size": "medium",
        "from": 0,
        "to": 0
      }
    ],
    "groupsAdded": [
      "string"
    ],
    "groupsRemoved": [
      "string"
    ],
    "groupsChanged": [
      "string"
    ],
    "categoriesChanged": true
  },
  "versionId": "string",
  "createdAt": "2026-11-19T19:30:12+03:00",
  "decidedAt": "2026-11-19T19:30:12+03:00",
  "decidedBy": "string"
}

GETOne menu import#

GET/partner/v1/catalog/imports/{id}

Scope catalog:write.

المصادقة
مفتاح الشريك في ترويسة Authorization
الصلاحيات المطلوبة
catalog:write
curl -sS "$LP_BASE_URL/partner/v1/catalog/imports/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01" \
  -H "Authorization: Bearer $LP_API_KEY"

المعاملات

الاسمالموضعالنوعالوصف
id *pathstring

الردود

200OKCatalogImport

الترويسات

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

البنية

  • idstringمطلوب

    الطول: 1 – 64

  • partnerIdstringمطلوب

    الطول: 1 – 64

  • envIntegrationModeمطلوب

    القيم: "sandbox""live"

  • modestringمطلوب

    القيم: "full""delta"

  • statusCatalogImportStatusمطلوب

    القيم: "rejected""staged""published""discarded""superseded"

  • reasonstringمطلوبيقبل null
  • countsobjectمطلوب
    الحقول الداخلية (7)
    • categoriesintegerمطلوب
    • itemsintegerمطلوب
    • groupsintegerمطلوب
    • optionsintegerمطلوب
    • appliedintegerمطلوب
    • unknownintegerمطلوب
    • takenOffintegerمطلوب
  • unknownCatalogImportUnknown[]مطلوب
    الحقول الداخلية (4)
    • kindstringمطلوب

      القيم: "category""item""variant""group""option"

    • codestringمطلوب
    • namestringمطلوب
    • priceintegerمطلوبيقبل null
  • takenOffstring[]مطلوب
  • issuesCatalogIssue[]مطلوب
    الحقول الداخلية (4)
    • severitystringمطلوب

      القيم: "error""warning"

    • codestringمطلوب
    • refstringمطلوب
    • detailstringاختياري
  • diffobjectمطلوبيقبل null
    الحقول الداخلية (9)
    • productsAddedstring[]مطلوب
    • productsRemovedstring[]مطلوب
    • productsChangedstring[]مطلوب
    • priceChangesobject[]مطلوب
      الحقول الداخلية (3)
      • productIdstringمطلوب

        الطول: 1 – 64

      • fromintegerمطلوب

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

        القيمة: ≥ 0

      • tointegerمطلوب

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

        القيمة: ≥ 0

    • optionPriceChangesobject[]مطلوب
      الحقول الداخلية (5)
      • groupIdstringمطلوب

        الطول: 1 – 64

      • optionIdstringمطلوب

        الطول: 1 – 64

      • sizestringاختياري

        القيم: "medium""large"

      • fromintegerمطلوب

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

        القيمة: ≥ 0

      • tointegerمطلوب

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

        القيمة: ≥ 0

    • groupsAddedstring[]مطلوب
    • groupsRemovedstring[]مطلوب
    • groupsChangedstring[]مطلوب
    • categoriesChangedbooleanمطلوب
  • versionIdstringمطلوبيقبل null
  • createdAtstring<date-time>مطلوب
  • decidedAtstring<date-time>مطلوبيقبل null
  • decidedBystringمطلوبيقبل 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.
404IMPORT_NOT_FOUNDPartnerError

الترويسات

الاسمالنوعالوصف
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 · CatalogImport
{
  "id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
  "partnerId": "string",
  "env": "sandbox",
  "mode": "full",
  "status": "rejected",
  "reason": "string",
  "counts": {
    "categories": 0,
    "items": 0,
    "groups": 0,
    "options": 0,
    "applied": 0,
    "unknown": 0,
    "takenOff": 0
  },
  "unknown": [
    {
      "kind": "category",
      "code": "string",
      "name": "string",
      "price": 0
    }
  ],
  "takenOff": [
    "string"
  ],
  "issues": [
    {
      "severity": "error",
      "code": "string",
      "ref": "string",
      "detail": "string"
    }
  ],
  "diff": {
    "productsAdded": [
      "string"
    ],
    "productsRemoved": [
      "string"
    ],
    "productsChanged": [
      "string"
    ],
    "priceChanges": [
      {
        "productId": "string",
        "from": 0,
        "to": 0
      }
    ],
    "optionPriceChanges": [
      {
        "groupId": "string",
        "optionId": "string",
        "size": "medium",
        "from": 0,
        "to": 0
      }
    ],
    "groupsAdded": [
      "string"
    ],
    "groupsRemoved": [
      "string"
    ],
    "groupsChanged": [
      "string"
    ],
    "categoriesChanged": true
  },
  "versionId": "string",
  "createdAt": "2026-11-19T19:30:12+03:00",
  "decidedAt": "2026-11-19T19:30:12+03:00",
  "decidedBy": "string"
}