مرجع الواجهة
المنيو
The published menu with your codes, and the mapping between Let's Pizza ids and your codes.
GETThe published menu with your codes#
/partner/v1/catalogScope 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).
curl -sS "$LP_BASE_URL/partner/v1/catalog" \
-H "Authorization: Bearer $LP_API_KEY"المعاملات
| الاسم | الموضع | النوع | الوصف |
|---|---|---|---|
If-None-Match | header | string |
الردود
200OKPartnerCatalog
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
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. |
البنية
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-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. |
مثال الرد
{
"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#
/partner/v1/mappingsScope 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).
curl -sS "$LP_BASE_URL/partner/v1/mappings" \
-H "Authorization: Bearer $LP_API_KEY"الردود
200OKPartnerMappingList
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
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. |
البنية
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-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. |
مثال الرد
{
"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#
/partner/v1/mappingsScope 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.
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 * | header | string | Your 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-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. |
البنية
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-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. |
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. |
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-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. |
مثال الرد
{
"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#
/partner/v1/catalog/importsScope catalog:write. Newest first, with what became of each.
curl -sS "$LP_BASE_URL/partner/v1/catalog/imports" \
-H "Authorization: Bearer $LP_API_KEY"الردود
200OKany
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
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. |
البنية
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. |
مثال الرد
nullPOSTSend your menu#
/partner/v1/catalog/importsScope 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).
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 * | header | string | Your 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-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. |
البنية
idstringمطلوبالطول: 1 – 64
partnerIdstringمطلوبالطول: 1 – 64
envIntegrationModeمطلوبالقيم:
"sandbox""live"modestringمطلوبالقيم:
"full""delta"statusCatalogImportStatusمطلوبالقيم:
"rejected""staged""published""discarded""superseded"reasonstringمطلوبيقبل nullcountsobjectمطلوبالحقول الداخلية (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مطلوبيقبل nullcreatedAtstring<date-time>مطلوبdecidedAtstring<date-time>مطلوبيقبل nulldecidedBystringمطلوبيقبل null
400INVALID_REQUEST (field, detail.issues), IDEMPOTENCY_KEY_REQUIREDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
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. |
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. |
403CATALOG_SOURCE_REQUIRED, SCOPE_REQUIRED, PARTNER_SUSPENDED, IP_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. |
422IDEMPOTENCY_KEY_REUSEDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
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. |
مثال الرد
{
"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#
/partner/v1/catalog/imports/{id}Scope catalog:write.
curl -sS "$LP_BASE_URL/partner/v1/catalog/imports/7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01" \
-H "Authorization: Bearer $LP_API_KEY"المعاملات
| الاسم | الموضع | النوع | الوصف |
|---|---|---|---|
id * | path | string |
الردود
200OKCatalogImport
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
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. |
البنية
idstringمطلوبالطول: 1 – 64
partnerIdstringمطلوبالطول: 1 – 64
envIntegrationModeمطلوبالقيم:
"sandbox""live"modestringمطلوبالقيم:
"full""delta"statusCatalogImportStatusمطلوبالقيم:
"rejected""staged""published""discarded""superseded"reasonstringمطلوبيقبل nullcountsobjectمطلوبالحقول الداخلية (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مطلوبيقبل nullcreatedAtstring<date-time>مطلوبdecidedAtstring<date-time>مطلوبيقبل nulldecidedBystringمطلوبيقبل 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. |
404IMPORT_NOT_FOUNDPartnerError
الترويسات
| الاسم | النوع | الوصف |
|---|---|---|
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. |
مثال الرد
{
"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"
}