Let's Pizza Developersv1.0.0

API reference

Menu

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

Authentication
Partner key in the Authorization header
Scopes required
catalog:read
curl -sS "$LP_BASE_URL/partner/v1/catalog" \
  -H "Authorization: Bearer $LP_API_KEY"

Parameters

NameInTypeDescription
If-None-Matchheaderstring

Responses

200OKPartnerCatalog

Headers

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

Schema

  • catalogCatalogrequired
    Child attributes (6)
    • versionCatalogVersionrequired
      Child attributes (4)
      • idstringrequired

        length ≥ 1

      • statusstringrequired

        Values: "draft""published"

      • sourcestringrequired

        Values: "taker""console""foodics""partner"

      • createdAtstring<date-time>required
    • currencystringrequired

      Values: "SAR"

    • categoriesCategory[]required
      Child attributes (5)
      • idstringrequired

        length 1 – 64

      • namesLocalizedrequired
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • imagestringoptional
      • sortintegerrequired
      • externalobjectoptional
        Child attributes (2)
        • sourcestringrequired

          Values: "taker""foodics""console"

        • idstringrequired
    • groupsModifierGroup[]required
      Child attributes (12)
      • idstringrequired

        length 1 – 64

      • namesLocalizedrequired
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • rolestringrequired

        Values: "choice""extra""removal""cross_sell""bundle_slot"

      • selectionstringrequired

        Values: "single""multi"

      • builderobjectoptional
        Child attributes (3)
        • partstringrequired

          Values: "dough""edge""sauce""cheese""topping""fresh""finish"

        • placementbooleanrequired
        • amountbooleanrequired
      • minSelectintegerrequired

        value ≥ 0

      • maxSelectintegerrequirednullable

        value ≥ 1

      • perOptionMaxQtyintegerrequired

        value ≥ 1

      • optionsGroupOption[]required
        Child attributes (9)
        • idstringrequired

          length 1 – 64

        • namesLocalizedrequired
          Child attributes (2)
          • arstringrequired
          • enstringrequired
        • priceintegerrequired

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

          value ≥ 0

        • priceBySizeobjectoptional
          Child attributes (2)
          • mediumintegeroptional

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

            value ≥ 0

          • largeintegeroptional

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

            value ≥ 0

        • builderobjectoptional
          Child attributes (2)
          • placementbooleanoptional
          • amountstring[]optional

            Values: "light""extra"

            items ≤ 2

        • imagestringoptional
        • linkedProductIdstringoptional

          length 1 – 64

        • hiddenbooleanoptional
        • externalobjectoptional
          Child attributes (2)
          • sourcestringrequired

            Values: "taker""foodics""console"

          • idstringrequired
      • defaultOptionIdstringoptional

        length 1 – 64

      • descriptionsobjectoptional
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • externalobjectoptional
        Child attributes (2)
        • sourcestringrequired

          Values: "taker""foodics""console"

        • idstringrequired
    • productsProduct[]required
      Child attributes (15)
      • idstringrequired

        length 1 – 64

      • namesLocalizedrequired
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • descriptionsLocalizedrequired
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • imagestringrequired
      • categoryIdstringrequired

        length 1 – 64

      • kindstringrequired

        Values: "simple""bundle"

      • basePriceintegerrequired

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

        value ≥ 0

      • groupIdsstring[]required
      • sizeFamilyobjectoptional
        Child attributes (2)
        • familyIdstringrequired

          length 1 – 64

        • sizestringrequired

          Values: "medium""large"

      • slicesintegeroptional

        value 1 – 64

      • prepMinutesintegerrequired

        value ≥ 0

      • tagsstring[]required

        Values: "vegetarian""spicy""best_seller""new"

      • sortintegerrequired
      • builderobjectoptional
        Child attributes (4)
        • baseArtstringrequired
        • drawnGroupIdsstring[]required
        • modestringoptional

          Values: "customize""scratch"

        • rulesobjectoptional
          Child attributes (4)
          • maxToppingsTotalintegeroptional

            value 1 – 200

          • maxPerHalfintegeroptional

            value 1 – 200

          • requireOneOfstring[][]optional

            items ≤ 20

          • forbidTogetherstring[][]optional

            items ≤ 200

      • externalobjectoptional
        Child attributes (2)
        • sourcestringrequired

          Values: "taker""foodics""console"

        • idstringrequired
    • builderArtobjectoptional
      Child attributes (3)
      • toppingsBuilderTopping[]required
        Child attributes (5)
        • optionIdstringrequired

          length 1 – 64

        • piecesBuilderPiece[]required

          items ≥ 1

          Child attributes (4)
          • filestringrequired
          • wnumberrequired

            value ≥ 0

          • hnumberrequired

            value ≥ 0

          • rnumberrequired

            value ≥ 0

        • countintegerrequired

          value ≥ 1

        • scalenumberrequired

          value ≥ 0

        • patchbooleanrequired
      • saucesBuilderSauce[]required
        Child attributes (3)
        • optionIdstringrequired

          length 1 – 64

        • colorstringrequired
        • highlightstringrequired
      • optionsobjectoptional

        An object with free keys.

  • externalobjectrequired
    Child attributes (4)
    • categoriesobjectrequired

      An object with free keys.

    • productsobjectrequired

      An object with free keys.

    • groupsobjectrequired

      An object with free keys.

    • optionsobjectrequired

      An object with free keys.

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

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

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

Example response

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

Authentication
Partner key in the Authorization header
Scopes required
catalog:read
curl -sS "$LP_BASE_URL/partner/v1/mappings" \
  -H "Authorization: Bearer $LP_API_KEY"

Responses

200OKPartnerMappingList

Headers

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

Schema

  • envIntegrationModerequired

    Values: "sandbox""live"

  • itemsPartnerMapping[]required
    Child attributes (7)
    • kindPartnerMappingKindrequired

      Values: "branch""category""product""group""option""tender"

    • ourIdstringrequired

      length 1 – 64

    • codestringrequired

      length 1 – 50

    • variantstringrequirednullable

      length 1 – 50

    • unitstringrequirednullable

      length 1 – 20

    • ourNameobjectrequirednullable
      Child attributes (2)
      • arstringrequired
      • enstringrequired
    • updatedAtstring<date-time>required
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

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

Example response

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.

Authentication
Partner key in the Authorization header
Scopes required
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"
    }
  ]
}'

Parameters

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

Request body PutPartnerMappingsRequest

  • modestringrequired

    Values: "merge""replace"

  • dryRunbooleanoptional
  • itemsobject[]required

    items ≤ 5000

    Child attributes (5)
    • kindPartnerMappingKindrequired

      Values: "branch""category""product""group""option""tender"

    • ourIdstringrequired

      length 1 – 64

    • codestringrequired

      length 1 – 50

    • variantstringoptionalnullable

      length 1 – 50

    • unitstringoptionalnullable

      length 1 – 20

Responses

200OKPartnerMappingResult

Headers

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

Schema

  • dryRunbooleanrequired
  • okbooleanrequired
  • addedintegerrequired

    value ≥ 0

  • updatedintegerrequired

    value ≥ 0

  • unchangedintegerrequired

    value ≥ 0

  • removedintegerrequired

    value ≥ 0

  • errorsPartnerMappingIssue[]required
    Child attributes (4)
    • indexintegerrequired

      value ≥ 0

    • codestringrequired

      Values: "UNKNOWN_ID""DUPLICATE_ROW""CODE_TAKEN"

    • fieldstringrequired
    • valuestringrequired
400INVALID_REQUEST (field, detail.issues), IDEMPOTENCY_KEY_REQUIREDPartnerError

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

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

Example response

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.

Authentication
Partner key in the Authorization header
Scopes required
catalog:write
curl -sS "$LP_BASE_URL/partner/v1/catalog/imports" \
  -H "Authorization: Bearer $LP_API_KEY"

Responses

200OKany

Headers

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

Schema

401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

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

Example response

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

Authentication
Partner key in the Authorization header
Scopes required
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
        }
      ]
    }
  ]
}'

Parameters

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

Request body PartnerMenu

  • modestringrequired

    Values: "full""delta"

  • dryRunbooleanoptional
  • categoriesobject[]optional

    items ≤ 500

    Child attributes (5)
    • codestringrequired

      length 1 – 50

    • nameArstringrequired

      length 1 – 120

    • nameEnstringrequired

      length 1 – 120

    • sortOrderintegeroptional
    • blockedbooleanoptional
  • itemsobject[]optional

    items ≤ 3000

    Child attributes (10)
    • codestringrequired

      length 1 – 50

    • nameArstringrequired

      length 1 – 120

    • nameEnstringrequired

      length 1 – 120

    • descriptionArstringoptional

      length ≤ 500

    • descriptionEnstringoptional

      length ≤ 500

    • categoryCodestringoptional

      length 1 – 50

    • priceintegeroptional

      value ≥ 0

    • variantsobject[]optional

      items ≤ 10

      Child attributes (3)
      • codestringrequired

        length 1 – 50

      • priceintegerrequired

        value ≥ 0

      • blockedbooleanoptional
    • groupCodesstring[]optional

      items ≤ 50

    • blockedbooleanoptional
  • groupsobject[]optional

    items ≤ 500

    Child attributes (7)
    • codestringrequired

      length 1 – 50

    • nameArstringrequired

      length 1 – 120

    • nameEnstringrequired

      length 1 – 120

    • minSelectintegeroptional

      value ≥ 0

    • maxSelectintegeroptionalnullable

      value ≥ 1

    • maxPerOptionintegeroptional

      value ≥ 1

    • optionsobject[]required

      items ≤ 200

      Child attributes (6)
      • codestringrequired

        length 1 – 50

      • nameArstringrequired

        length 1 – 120

      • nameEnstringrequired

        length 1 – 120

      • priceintegerrequired

        value ≥ 0

      • pricesBySizeobjectoptional
        Child attributes (2)
        • mediumintegeroptional

          value ≥ 0

        • largeintegeroptional

          value ≥ 0

      • blockedbooleanoptional

Responses

201Received (status says what became of it)CatalogImport

Headers

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

Schema

  • idstringrequired

    length 1 – 64

  • partnerIdstringrequired

    length 1 – 64

  • envIntegrationModerequired

    Values: "sandbox""live"

  • modestringrequired

    Values: "full""delta"

  • statusCatalogImportStatusrequired

    Values: "rejected""staged""published""discarded""superseded"

  • reasonstringrequirednullable
  • countsobjectrequired
    Child attributes (7)
    • categoriesintegerrequired
    • itemsintegerrequired
    • groupsintegerrequired
    • optionsintegerrequired
    • appliedintegerrequired
    • unknownintegerrequired
    • takenOffintegerrequired
  • unknownCatalogImportUnknown[]required
    Child attributes (4)
    • kindstringrequired

      Values: "category""item""variant""group""option"

    • codestringrequired
    • namestringrequired
    • priceintegerrequirednullable
  • takenOffstring[]required
  • issuesCatalogIssue[]required
    Child attributes (4)
    • severitystringrequired

      Values: "error""warning"

    • codestringrequired
    • refstringrequired
    • detailstringoptional
  • diffobjectrequirednullable
    Child attributes (9)
    • productsAddedstring[]required
    • productsRemovedstring[]required
    • productsChangedstring[]required
    • priceChangesobject[]required
      Child attributes (3)
      • productIdstringrequired

        length 1 – 64

      • fromintegerrequired

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

        value ≥ 0

      • tointegerrequired

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

        value ≥ 0

    • optionPriceChangesobject[]required
      Child attributes (5)
      • groupIdstringrequired

        length 1 – 64

      • optionIdstringrequired

        length 1 – 64

      • sizestringoptional

        Values: "medium""large"

      • fromintegerrequired

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

        value ≥ 0

      • tointegerrequired

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

        value ≥ 0

    • groupsAddedstring[]required
    • groupsRemovedstring[]required
    • groupsChangedstring[]required
    • categoriesChangedbooleanrequired
  • versionIdstringrequirednullable
  • createdAtstring<date-time>required
  • decidedAtstring<date-time>requirednullable
  • decidedBystringrequirednullable
400INVALID_REQUEST (field, detail.issues), IDEMPOTENCY_KEY_REQUIREDPartnerError

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

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

Example response

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.

Authentication
Partner key in the Authorization header
Scopes required
catalog:write
curl -sS "$LP_BASE_URL/partner/v1/catalog/imports/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01" \
  -H "Authorization: Bearer $LP_API_KEY"

Parameters

NameInTypeDescription
id *pathstring

Responses

200OKCatalogImport

Headers

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

Schema

  • idstringrequired

    length 1 – 64

  • partnerIdstringrequired

    length 1 – 64

  • envIntegrationModerequired

    Values: "sandbox""live"

  • modestringrequired

    Values: "full""delta"

  • statusCatalogImportStatusrequired

    Values: "rejected""staged""published""discarded""superseded"

  • reasonstringrequirednullable
  • countsobjectrequired
    Child attributes (7)
    • categoriesintegerrequired
    • itemsintegerrequired
    • groupsintegerrequired
    • optionsintegerrequired
    • appliedintegerrequired
    • unknownintegerrequired
    • takenOffintegerrequired
  • unknownCatalogImportUnknown[]required
    Child attributes (4)
    • kindstringrequired

      Values: "category""item""variant""group""option"

    • codestringrequired
    • namestringrequired
    • priceintegerrequirednullable
  • takenOffstring[]required
  • issuesCatalogIssue[]required
    Child attributes (4)
    • severitystringrequired

      Values: "error""warning"

    • codestringrequired
    • refstringrequired
    • detailstringoptional
  • diffobjectrequirednullable
    Child attributes (9)
    • productsAddedstring[]required
    • productsRemovedstring[]required
    • productsChangedstring[]required
    • priceChangesobject[]required
      Child attributes (3)
      • productIdstringrequired

        length 1 – 64

      • fromintegerrequired

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

        value ≥ 0

      • tointegerrequired

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

        value ≥ 0

    • optionPriceChangesobject[]required
      Child attributes (5)
      • groupIdstringrequired

        length 1 – 64

      • optionIdstringrequired

        length 1 – 64

      • sizestringoptional

        Values: "medium""large"

      • fromintegerrequired

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

        value ≥ 0

      • tointegerrequired

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

        value ≥ 0

    • groupsAddedstring[]required
    • groupsRemovedstring[]required
    • groupsChangedstring[]required
    • categoriesChangedbooleanrequired
  • versionIdstringrequirednullable
  • createdAtstring<date-time>required
  • decidedAtstring<date-time>requirednullable
  • decidedBystringrequirednullable
401UNAUTHENTICATED (no key, a wrong or revoked one), KEY_EXPIRED, KEY_ENVIRONMENT_MISMATCH (a test key on production or the other way round)PartnerError

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

NameTypeDescription
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

Headers

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

Example response

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"
}