API reference
Identity
Who the key is and what it may do.
GETThe key, its partner and settings#
/partner/v1/meAny valid key may call it: the first call to make with a new key. environment is the host’s (always the key’s own, or the key would be refused). settings say how orders, statuses, the menu and invoices flow for your system.
curl -sS "$LP_BASE_URL/partner/v1/me" \
-H "Authorization: Bearer $LP_API_KEY"Responses
200OKPartnerMe
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
partnerobjectrequiredThe partner the key belongs to.
Child attributes (3)
idstringrequiredThe partner's id at Let's Pizza.
length 1 – 64
namestringrequiredThe partner name, as the console shows it.
kindPartnerKindrequiredWhat the system is; decides the default settings and scopes.
Values:
"erp""pos""kds""delivery""marketplace""accounting""analytics""other"
keyobjectrequiredThe key this request was made with.
Child attributes (8)
idstringrequiredlength 1 – 64
envIntegrationModerequiredThe key's environment: sandbox or live.
Values:
"sandbox""live"labelstringrequiredThe key's label, chosen by Let's Pizza.
prefixstringrequiredThe first characters of the key, to tell keys apart; never the key.
scopesPartnerScope[]requiredThe scopes the key carries.
Values:
"branches:read""catalog:read""catalog:write""availability:write""orders:read""orders:ack""orders:status""orders:cancel""orders:events""payments:read""reports:read""webhooks:manage""mappings:write"branchesstring[]requirednullableThe branches the key may act on; null = every branch.
ratePerMinuteintegerrequiredRequests per minute allowed for this key.
expiresAtstring<date-time>requirednullableWhen the key expires; null = no end.
environmentIntegrationModerequiredThe environment of the host that answered; always the key's own.
Values:
"sandbox""live"settingsPartnerSettingsrequiredHow orders, statuses, the menu and invoices flow for your system.
Child attributes (6)
ordersobjectrequiredChild attributes (5)
deliveryOrderDeliveryrequiredHow you learn about orders: none, pull, webhooks, or connector (we call your system).
Values:
"none""pull""webhooks""connector"acceptanceOrderAcceptancerequiredWho accepts a new order: lp (our branch board) or partner (your system).
Values:
"lp""partner"ackMinutesintegerrequiredMinutes an order waits for your acknowledgement before the branch is alerted (0 = no alert).
value 0 – 120
statusesPartnerStatusTarget[]requiredThe statuses your system may report.
Values:
"accepted""rejected""preparing""ready""picked_up""cancelled""out_for_delivery""delivered""delivery_failed"items ≤ 9
connectorstringrequirednullableThe connector used when delivery is `connector`.
length ≤ 40
catalogobjectrequiredChild attributes (5)
sourcebooleanrequiredTrue: your system is the menu source (only one partner may be).
fieldsCatalogField[]requiredThe menu fields your system owns; the rest (pictures, order) stay the console's.
Values:
"names""descriptions""prices""sizes""groups""options""categories""availability"items ≤ 8
publishCatalogPublishPolicyrequiredWhat happens to a menu you send: manual review, auto_prices (price-only changes publish by themselves), or auto.
Values:
"manual""auto_prices""auto"maxPriceChangePctintegerrequiredThe largest price change, in percent, that publishes by itself.
value 0 – 100
maxRemovalsintegerrequiredThe most items an automatic publish may remove.
value 0 – 1000
availabilitybooleanrequiredTrue: your availability flags apply (they only take items off; staff flags stay staff's).
invoicesobjectrequiredChild attributes (1)
issuerInvoiceIssuerrequiredWho issues the customer's tax invoice: lp (our platform) or partner (your system).
Values:
"lp""partner"
customerDatastringrequiredValues:
"full""masked"liveBranchesstring[]requiredThe branches where your flows are switched on; empty until we switch them on with you.
items ≤ 200
apiVersionstringrequiredThe API version.
Values:
"v1"serverTimestring<date-time>requiredThe server clock: compare it with yours before checking signatures.
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
{
"partner": {
"id": "ptn_01JD5ZB2",
"name": "Business Central (EDM)",
"kind": "erp"
},
"key": {
"id": "key_01JD5ZC9",
"env": "sandbox",
"label": "EDM sandbox",
"prefix": "lpk_test_Ab3d",
"scopes": [
"branches:read",
"catalog:read",
"catalog:write",
"availability:write",
"orders:read",
"orders:ack",
"orders:status",
"orders:cancel",
"orders:events",
"payments:read",
"reports:read",
"webhooks:manage",
"mappings:write"
],
"branches": null,
"ratePerMinute": 600,
"expiresAt": null
},
"environment": "sandbox",
"settings": {
"orders": {
"delivery": "pull",
"acceptance": "partner",
"ackMinutes": 3,
"statuses": [
"accepted",
"rejected",
"preparing",
"ready",
"picked_up",
"cancelled"
],
"connector": null
},
"catalog": {
"source": false,
"fields": [
"names",
"prices",
"sizes",
"groups",
"options",
"categories",
"availability"
],
"publish": "manual",
"maxPriceChangePct": 20,
"maxRemovals": 5
},
"availability": true,
"invoices": {
"issuer": "lp"
},
"customerData": "full",
"liveBranches": [
"28"
]
},
"apiVersion": "v1",
"serverTime": "2026-11-19T19:30:12.000+03:00"
}POSTOAuth 2.0 access token (client credentials)#
/partner/v1/oauth/tokenFor systems that prefer OAuth to a fixed key. grant_type=client_credentials, client_id = your key’s id (the key.id of GET /me), client_secret = the key; in a JSON or form body, or in HTTP Basic. The answer is a bearer token lpt_… valid for one hour (never past the key’s own end) with the key’s scopes: send it as Authorization: Bearer exactly like the key. A revoked key stops its tokens at once. Refusals carry detail.error (invalid_client, unsupported_grant_type, invalid_request).
curl -sS -X POST "$LP_BASE_URL/partner/v1/oauth/token" \
-H "Content-Type: application/json" \
--data '{
"grant_type": "client_credentials",
"client_id": "key_01JD5ZC9",
"client_secret": "lpk_test_…"
}'Request body PartnerTokenRequest
grant_typestringrequiredlength ≤ 40
client_idstringrequiredlength 1 – 64
client_secretstringrequiredlength 10 – 200
scopestringoptionallength ≤ 500
Responses
200OKPartnerTokenResponse
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
access_tokenstringrequiredtoken_typestringrequiredValues:
"Bearer"expires_inintegerrequiredvalue ≥ 1
scopestringrequired
400INVALID_REQUEST (detail.error: invalid_request, unsupported_grant_type)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. |
401UNAUTHENTICATED (detail.error: invalid_client), KEY_ENVIRONMENT_MISMATCHPartnerError
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_LIMITEDPartnerError
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
{
"access_token": "lpt_…",
"token_type": "Bearer",
"expires_in": 3600,
"scope": "branches:read catalog:read catalog:write availability:write orders:read orders:ack orders:status orders:cancel orders:events payments:read reports:read webhooks:manage mappings:write"
}GETYour request log#
/partner/v1/logsEvery request of your keys in this environment (refusals included), newest first, kept 30 days; never a body. nextBefore pages back. Quote a requestId to support.
curl -sS "$LP_BASE_URL/partner/v1/logs" \
-H "Authorization: Bearer $LP_API_KEY"Parameters
| Name | In | Type | Description |
|---|---|---|---|
before | query | integer | |
limit | query | integer |
Responses
200OKPartnerRequestLogPage
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
itemsPartnerRequestLogRow[]requiredChild attributes (12)
idintegerrequiredvalue ≥ 1
requestIdstringrequiredkeyIdstringrequirednullablelength 1 – 64
keyPrefixstringrequirednullableenvIntegrationModerequiredValues:
"sandbox""live"methodstringrequiredpathstringrequiredstatusintegerrequirederrorCodestringrequirednullabledurationMsintegerrequiredvalue ≥ 0
ipstringrequirednullableatstring<date-time>required
nextBeforeintegerrequirednullable
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
{
"items": [
{
"id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
"requestId": "req_01JD7Q8W3K2M",
"keyId": "string",
"keyPrefix": "string",
"env": "sandbox",
"method": "string",
"path": "string",
"status": 0,
"errorCode": "string",
"durationMs": 0,
"ip": "string",
"at": "2026-11-19T19:30:12+03:00"
}
],
"nextBefore": 0
}