Let's Pizza Developersv1.0.0

API reference

Sandbox

Tools that exist on the sandbox only: test orders.

POSTPlace a test order#

POST/partner/v1/sandbox/orders

Sandbox only (403 SANDBOX_ONLY on production). Scopes orders:read and orders:status. A real order on the sandbox, made the way a customer’s is (quote, then order), so it reaches your feed, your webhooks and your connector like any order — at a branch your key may act on. Lines absent = one Margherita. Then move it with your status calls, or let the sandbox branch staff do it.

Authentication
Partner key in the Authorization header
Scopes required
orders:readorders:status
curl -sS -X POST "$LP_BASE_URL/partner/v1/sandbox/orders" \
  -H "Authorization: Bearer $LP_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "branchId": "28",
  "fulfilment": "pickup",
  "paymentMethod": "pay_at_branch"
}'

Request body PartnerSandboxOrderRequest

  • branchIdstringrequired

    length 1 – 64

  • fulfilmentstringrequired

    Values: "pickup""delivery"

  • linesCartLine[]optional

    items 1 – 20

    Child attributes (5)
    • productIdstringrequired

      length 1 – 64

    • qtyintegerrequired

      value ≥ 1

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

        length 1 – 64

      • optionIdstringrequired

        length 1 – 64

      • qtyintegerrequired

        value ≥ 1

      • placementstringoptional

        Values: "whole""left""right"

      • amountstringoptional

        Values: "light""regular""extra"

    • notestringoptional

      length ≤ 200

    • sourceobjectoptional
      Child attributes (2)
      • experiencestringrequired

        Values: "classic""graphical"

      • modestringoptional

        length ≤ 32

  • paymentMethodstringoptional

    Values: "pay_at_branch""cash_on_delivery"

  • deliveryobjectoptional
    Child attributes (5)
    • addressstringrequired

      length 3 – 300

    • detailsstringoptional

      length ≤ 300

    • locationobjectoptional
      Child attributes (2)
      • latnumberrequired

        value -90 – 90

      • lngnumberrequired

        value -180 – 180

    • contactNamestringrequired

      length 1 – 80

    • contactPhonestringrequired

      length 9 – 20

Responses

201CreatedOrder

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

  • numberstringrequired
  • statusstringrequired

    Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

  • channelstringrequired

    Values: "app""web""console""pos""dine_in"

  • branchIdstringrequired

    length 1 – 64

  • fulfilmentstringrequired

    Values: "delivery""pickup"

  • paymentMethodstringrequired

    Values: "pay_at_branch""cash_on_delivery""online"

  • catalogVersionstringrequired
  • linesOrderLine[]required
    Child attributes (5)
    • lineIndexintegerrequired

      value ≥ 0

    • lineCartLinerequired
      Child attributes (5)
      • productIdstringrequired

        length 1 – 64

      • qtyintegerrequired

        value ≥ 1

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

          length 1 – 64

        • optionIdstringrequired

          length 1 – 64

        • qtyintegerrequired

          value ≥ 1

        • placementstringoptional

          Values: "whole""left""right"

        • amountstringoptional

          Values: "light""regular""extra"

      • notestringoptional

        length ≤ 200

      • sourceobjectoptional
        Child attributes (2)
        • experiencestringrequired

          Values: "classic""graphical"

        • modestringoptional

          length ≤ 32

    • unitPriceintegerrequired

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

      value ≥ 0

    • lineTotalintegerrequired

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

      value ≥ 0

    • snapshotLineSnapshotrequired
      Child attributes (2)
      • namesLocalizedrequired
        Child attributes (2)
        • arstringrequired
        • enstringrequired
      • optionsSnapshotOption[]required
        Child attributes (7)
        • groupIdstringrequired

          length 1 – 64

        • optionIdstringrequired

          length 1 – 64

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

          value ≥ 1

        • priceintegerrequired

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

          value ≥ 0

        • placementstringoptional

          Values: "whole""left""right"

        • amountstringoptional

          Values: "light""regular""extra"

  • subtotalintegerrequired

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

    value ≥ 0

  • discountsDiscount[]required
    Child attributes (4)
    • kindstringrequired

      Values: "coupon""offer"

    • codestringoptional
    • namesLocalizedrequired
      Child attributes (2)
      • arstringrequired
      • enstringrequired
    • amountintegerrequired

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

      value ≥ 0

  • discountTotalintegerrequired

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

    value ≥ 0

  • deliveryFeeintegerrequired

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

    value ≥ 0

  • totalintegerrequired

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

    value ≥ 0

  • vatobjectrequired
    Child attributes (3)
    • rateBpsintegerrequired
    • amountintegerrequired

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

      value ≥ 0

    • includesDeliveryFeebooleanrequired
  • scheduledForstring<date-time>optional
  • notestringoptional
  • cutlerybooleanoptional
  • ifUnavailablestringoptional
  • deliveryobjectoptional
    Child attributes (5)
    • addressstringrequired

      length 3 – 300

    • detailsstringoptional

      length ≤ 300

    • locationobjectoptional
      Child attributes (2)
      • latnumberrequired

        value -90 – 90

      • lngnumberrequired

        value -180 – 180

    • contactNamestringrequired

      length 1 – 80

    • contactPhonestringrequired

      length 9 – 20

  • courierobjectoptional
    Child attributes (2)
    • namestringrequired
    • phonestringoptional
  • tenderstringoptional
  • paidAtstring<date-time>optional
  • createdAtstring<date-time>required
  • historyStatusChange[]required
    Child attributes (7)
    • fromstringrequirednullable

      Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

    • tostringrequired

      Values: "pending_payment""payment_failed""placed""accepted""preparing""ready""out_for_delivery""delivered""picked_up""cancelled""rejected""delivery_failed""not_collected"

    • atstring<date-time>required
    • actorStatusChangeActorrequired

      Values: "customer""staff""system""payment""partner"

    • reasonstringoptional
    • reasonCodestringoptional
    • returnedToBranchbooleanoptional
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.
403SANDBOX_ONLY, BRANCH_NOT_ALLOWED, SCOPE_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.
422SANDBOX_QUOTE_INVALID (detail.errors: the quote’s codes, e.g. BRANCH_CLOSED)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.
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 · Order
{
  "id": "7f3a2c10-5b8e-4d21-9c47-1a2b3c4d5e01",
  "number": "261119-0041",
  "status": "placed",
  "channel": "app",
  "branchId": "28",
  "fulfilment": "delivery",
  "paymentMethod": "cash_on_delivery",
  "catalogVersion": "taker-2026-10-06.5d01b76bc1",
  "lines": [
    {
      "lineIndex": 0,
      "line": {
        "productId": "649",
        "qty": 2,
        "selections": [
          {
            "groupId": "1362",
            "optionId": "11836",
            "qty": 1
          }
        ],
        "source": {
          "experience": "classic"
        }
      },
      "unitPrice": 4200,
      "lineTotal": 8400,
      "snapshot": {
        "names": {
          "ar": "مارقريتا",
          "en": "Margherita Pizza"
        },
        "options": [
          {
            "groupId": "1362",
            "optionId": "11836",
            "names": {
              "ar": "صلصة طماطم",
              "en": "Tomato Sauce"
            },
            "qty": 1,
            "price": 0
          }
        ]
      }
    },
    {
      "lineIndex": 1,
      "line": {
        "productId": "740",
        "qty": 2,
        "selections": [],
        "source": {
          "experience": "classic"
        }
      },
      "unitPrice": 600,
      "lineTotal": 1200,
      "snapshot": {
        "names": {
          "ar": "كولا",
          "en": "Coca Cola Can"
        },
        "options": []
      }
    }
  ],
  "subtotal": 9600,
  "discounts": [],
  "discountTotal": 0,
  "deliveryFee": 1800,
  "total": 11400,
  "vat": {
    "rateBps": 1500,
    "amount": 1487,
    "includesDeliveryFee": true
  },
  "cutlery": false,
  "ifUnavailable": "call",
  "delivery": {
    "address": "حي المعذر الشمالي، شارع الأمير سلطان، عمارة 14",
    "details": "الدور الثاني، شقة 5، بجوار الصيدلية",
    "location": {
      "lat": 24.6921,
      "lng": 46.6853
    },
    "contactName": "عبدالله",
    "contactPhone": "+966500000000"
  },
  "createdAt": "2026-11-19T19:30:12+03:00",
  "history": [
    {
      "from": null,
      "to": "placed",
      "at": "2026-11-19T19:30:12+03:00",
      "actor": "customer"
    }
  ]
}