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#
/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"Parameters
| Name | In | Type | Description |
|---|---|---|---|
If-None-Match | header | string |
Responses
200OKPartnerCatalog
Headers
| Name | Type | Description |
|---|---|---|
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. |
Schema
catalogCatalogrequiredChild attributes (6)
versionCatalogVersionrequiredChild attributes (4)
idstringrequiredlength ≥ 1
statusstringrequiredValues:
"draft""published"sourcestringrequiredValues:
"taker""console""foodics""partner"createdAtstring<date-time>required
currencystringrequiredValues:
"SAR"categoriesCategory[]requiredChild attributes (5)
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
imagestringoptionalsortintegerrequiredexternalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
groupsModifierGroup[]requiredChild attributes (12)
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
rolestringrequiredValues:
"choice""extra""removal""cross_sell""bundle_slot"selectionstringrequiredValues:
"single""multi"builderobjectoptionalChild attributes (3)
partstringrequiredValues:
"dough""edge""sauce""cheese""topping""fresh""finish"placementbooleanrequiredamountbooleanrequired
minSelectintegerrequiredvalue ≥ 0
maxSelectintegerrequirednullablevalue ≥ 1
perOptionMaxQtyintegerrequiredvalue ≥ 1
optionsGroupOption[]requiredChild attributes (9)
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
priceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
priceBySizeobjectoptionalChild attributes (2)
mediumintegeroptionalAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
largeintegeroptionalAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
builderobjectoptionalChild attributes (2)
placementbooleanoptionalamountstring[]optionalValues:
"light""extra"items ≤ 2
imagestringoptionallinkedProductIdstringoptionallength 1 – 64
hiddenbooleanoptionalexternalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
defaultOptionIdstringoptionallength 1 – 64
descriptionsobjectoptionalChild attributes (2)
arstringrequiredenstringrequired
externalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
productsProduct[]requiredChild attributes (15)
idstringrequiredlength 1 – 64
namesLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
descriptionsLocalizedrequiredChild attributes (2)
arstringrequiredenstringrequired
imagestringrequiredcategoryIdstringrequiredlength 1 – 64
kindstringrequiredValues:
"simple""bundle"basePriceintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
groupIdsstring[]requiredsizeFamilyobjectoptionalChild attributes (2)
familyIdstringrequiredlength 1 – 64
sizestringrequiredValues:
"medium""large"
slicesintegeroptionalvalue 1 – 64
prepMinutesintegerrequiredvalue ≥ 0
tagsstring[]requiredValues:
"vegetarian""spicy""best_seller""new"sortintegerrequiredbuilderobjectoptionalChild attributes (4)
baseArtstringrequireddrawnGroupIdsstring[]requiredmodestringoptionalValues:
"customize""scratch"rulesobjectoptionalChild attributes (4)
maxToppingsTotalintegeroptionalvalue 1 – 200
maxPerHalfintegeroptionalvalue 1 – 200
requireOneOfstring[][]optionalitems ≤ 20
forbidTogetherstring[][]optionalitems ≤ 200
externalobjectoptionalChild attributes (2)
sourcestringrequiredValues:
"taker""foodics""console"idstringrequired
builderArtobjectoptionalChild attributes (3)
toppingsBuilderTopping[]requiredChild attributes (5)
optionIdstringrequiredlength 1 – 64
piecesBuilderPiece[]requireditems ≥ 1
Child attributes (4)
filestringrequiredwnumberrequiredvalue ≥ 0
hnumberrequiredvalue ≥ 0
rnumberrequiredvalue ≥ 0
countintegerrequiredvalue ≥ 1
scalenumberrequiredvalue ≥ 0
patchbooleanrequired
saucesBuilderSauce[]requiredChild attributes (3)
optionIdstringrequiredlength 1 – 64
colorstringrequiredhighlightstringrequired
optionsobjectoptionalAn object with free keys.
externalobjectrequiredChild attributes (4)
categoriesobjectrequiredAn object with free keys.
productsobjectrequiredAn object with free keys.
groupsobjectrequiredAn object with free keys.
optionsobjectrequiredAn 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
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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. |
Example response
{
"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"Responses
200OKPartnerMappingList
Headers
| Name | Type | Description |
|---|---|---|
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. |
Schema
envIntegrationModerequiredValues:
"sandbox""live"itemsPartnerMapping[]requiredChild attributes (7)
kindPartnerMappingKindrequiredValues:
"branch""category""product""group""option""tender"ourIdstringrequiredlength 1 – 64
codestringrequiredlength 1 – 50
variantstringrequirednullablelength 1 – 50
unitstringrequirednullablelength 1 – 20
ourNameobjectrequirednullableChild attributes (2)
arstringrequiredenstringrequired
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
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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. |
Example response
{
"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"
}
]
}'Parameters
| Name | In | Type | Description |
|---|---|---|---|
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. |
Request body PutPartnerMappingsRequest
modestringrequiredValues:
"merge""replace"dryRunbooleanoptionalitemsobject[]requireditems ≤ 5000
Child attributes (5)
kindPartnerMappingKindrequiredValues:
"branch""category""product""group""option""tender"ourIdstringrequiredlength 1 – 64
codestringrequiredlength 1 – 50
variantstringoptionalnullablelength 1 – 50
unitstringoptionalnullablelength 1 – 20
Responses
200OKPartnerMappingResult
Headers
| Name | Type | Description |
|---|---|---|
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. |
Schema
dryRunbooleanrequiredokbooleanrequiredaddedintegerrequiredvalue ≥ 0
updatedintegerrequiredvalue ≥ 0
unchangedintegerrequiredvalue ≥ 0
removedintegerrequiredvalue ≥ 0
errorsPartnerMappingIssue[]requiredChild attributes (4)
indexintegerrequiredvalue ≥ 0
codestringrequiredValues:
"UNKNOWN_ID""DUPLICATE_ROW""CODE_TAKEN"fieldstringrequiredvaluestringrequired
400INVALID_REQUEST (field, detail.issues), IDEMPOTENCY_KEY_REQUIREDPartnerError
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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. |
Example response
{
"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"Responses
200OKany
Headers
| Name | Type | Description |
|---|---|---|
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. |
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
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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. |
Example response
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
}
]
}
]
}'Parameters
| Name | In | Type | Description |
|---|---|---|---|
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. |
Request body PartnerMenu
modestringrequiredValues:
"full""delta"dryRunbooleanoptionalcategoriesobject[]optionalitems ≤ 500
Child attributes (5)
codestringrequiredlength 1 – 50
nameArstringrequiredlength 1 – 120
nameEnstringrequiredlength 1 – 120
sortOrderintegeroptionalblockedbooleanoptional
itemsobject[]optionalitems ≤ 3000
Child attributes (10)
codestringrequiredlength 1 – 50
nameArstringrequiredlength 1 – 120
nameEnstringrequiredlength 1 – 120
descriptionArstringoptionallength ≤ 500
descriptionEnstringoptionallength ≤ 500
categoryCodestringoptionallength 1 – 50
priceintegeroptionalvalue ≥ 0
variantsobject[]optionalitems ≤ 10
Child attributes (3)
codestringrequiredlength 1 – 50
priceintegerrequiredvalue ≥ 0
blockedbooleanoptional
groupCodesstring[]optionalitems ≤ 50
blockedbooleanoptional
groupsobject[]optionalitems ≤ 500
Child attributes (7)
codestringrequiredlength 1 – 50
nameArstringrequiredlength 1 – 120
nameEnstringrequiredlength 1 – 120
minSelectintegeroptionalvalue ≥ 0
maxSelectintegeroptionalnullablevalue ≥ 1
maxPerOptionintegeroptionalvalue ≥ 1
optionsobject[]requireditems ≤ 200
Child attributes (6)
codestringrequiredlength 1 – 50
nameArstringrequiredlength 1 – 120
nameEnstringrequiredlength 1 – 120
priceintegerrequiredvalue ≥ 0
pricesBySizeobjectoptionalChild attributes (2)
mediumintegeroptionalvalue ≥ 0
largeintegeroptionalvalue ≥ 0
blockedbooleanoptional
Responses
201Received (status says what became of it)CatalogImport
Headers
| Name | Type | Description |
|---|---|---|
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. |
Schema
idstringrequiredlength 1 – 64
partnerIdstringrequiredlength 1 – 64
envIntegrationModerequiredValues:
"sandbox""live"modestringrequiredValues:
"full""delta"statusCatalogImportStatusrequiredValues:
"rejected""staged""published""discarded""superseded"reasonstringrequirednullablecountsobjectrequiredChild attributes (7)
categoriesintegerrequireditemsintegerrequiredgroupsintegerrequiredoptionsintegerrequiredappliedintegerrequiredunknownintegerrequiredtakenOffintegerrequired
unknownCatalogImportUnknown[]requiredChild attributes (4)
kindstringrequiredValues:
"category""item""variant""group""option"codestringrequirednamestringrequiredpriceintegerrequirednullable
takenOffstring[]requiredissuesCatalogIssue[]requiredChild attributes (4)
severitystringrequiredValues:
"error""warning"codestringrequiredrefstringrequireddetailstringoptional
diffobjectrequirednullableChild attributes (9)
productsAddedstring[]requiredproductsRemovedstring[]requiredproductsChangedstring[]requiredpriceChangesobject[]requiredChild attributes (3)
productIdstringrequiredlength 1 – 64
fromintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
tointegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
optionPriceChangesobject[]requiredChild attributes (5)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
sizestringoptionalValues:
"medium""large"fromintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
tointegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
groupsAddedstring[]requiredgroupsRemovedstring[]requiredgroupsChangedstring[]requiredcategoriesChangedbooleanrequired
versionIdstringrequirednullablecreatedAtstring<date-time>requireddecidedAtstring<date-time>requirednullabledecidedBystringrequirednullable
400INVALID_REQUEST (field, detail.issues), IDEMPOTENCY_KEY_REQUIREDPartnerError
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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. |
Example response
{
"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"Parameters
| Name | In | Type | Description |
|---|---|---|---|
id * | path | string |
Responses
200OKCatalogImport
Headers
| Name | Type | Description |
|---|---|---|
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. |
Schema
idstringrequiredlength 1 – 64
partnerIdstringrequiredlength 1 – 64
envIntegrationModerequiredValues:
"sandbox""live"modestringrequiredValues:
"full""delta"statusCatalogImportStatusrequiredValues:
"rejected""staged""published""discarded""superseded"reasonstringrequirednullablecountsobjectrequiredChild attributes (7)
categoriesintegerrequireditemsintegerrequiredgroupsintegerrequiredoptionsintegerrequiredappliedintegerrequiredunknownintegerrequiredtakenOffintegerrequired
unknownCatalogImportUnknown[]requiredChild attributes (4)
kindstringrequiredValues:
"category""item""variant""group""option"codestringrequirednamestringrequiredpriceintegerrequirednullable
takenOffstring[]requiredissuesCatalogIssue[]requiredChild attributes (4)
severitystringrequiredValues:
"error""warning"codestringrequiredrefstringrequireddetailstringoptional
diffobjectrequirednullableChild attributes (9)
productsAddedstring[]requiredproductsRemovedstring[]requiredproductsChangedstring[]requiredpriceChangesobject[]requiredChild attributes (3)
productIdstringrequiredlength 1 – 64
fromintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
tointegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
optionPriceChangesobject[]requiredChild attributes (5)
groupIdstringrequiredlength 1 – 64
optionIdstringrequiredlength 1 – 64
sizestringoptionalValues:
"medium""large"fromintegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
tointegerrequiredAmount in halalas (1 riyal = 100), VAT-inclusive
value ≥ 0
groupsAddedstring[]requiredgroupsRemovedstring[]requiredgroupsChangedstring[]requiredcategoriesChangedbooleanrequired
versionIdstringrequirednullablecreatedAtstring<date-time>requireddecidedAtstring<date-time>requirednullabledecidedBystringrequirednullable
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
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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
Headers
| Name | Type | Description |
|---|---|---|
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. |
Example response
{
"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"
}