API Reference

Base URL: https://orderger-api.hamidalqwaysim.workers.dev

Get your real credentials. To get your API Key and Branch ID, create an OrderGer account and open Integration Center. للحصول على API Key و Branch ID، أنشئ حساب في OrderGer وافتح مركز الربط.

Authentication

Authorization: Bearer YOUR_ORDERGER_API_KEY
Content-Type: application/json
X-OrderGer-Branch-ID: YOUR_BRANCH_ID

API versioning

Current major: v1. Path prefix: /api/v1/.... New fields are added in a backwards-compatible way. Deprecations are announced at least 90 days in advance and surfaced via the X-OrderGer-Api-Version response header.

Endpoints

Method	Path	Purpose
GET	/api/v1/branches	List branches for this API key
POST	/api/v1/orders	Create order
GET	/api/v1/orders/{id}	Get order
PATCH	/api/v1/orders/{id}	Update order fields
PATCH	/api/v1/orders/{id}/status	Update status
POST	/api/v1/orders/{id}/cancel	Cancel order
POST	/api/v1/test-order	Get a sample test payload

Create Order — full payload

POST https://orderger-api.hamidalqwaysim.workers.dev/api/v1/orders

Headers:
  Authorization: Bearer YOUR_ORDERGER_API_KEY
  Content-Type: application/json
  X-OrderGer-Branch-ID: YOUR_BRANCH_ID

Body:
{
  "external_order_id": "WEB-10052",
  "source": {
    "website_name": "Your Site",
    "domain": "yourdomain.com",
    "page_url": "https://yourdomain.com/checkout"
  },
  "utm": { "source": "google", "medium": "cpc", "campaign": "ramadan-deal" },
  "integration_type": "woocommerce",
  "branch_id": "YOUR_BRANCH_ID",
  "type": "delivery",
  "test": false,
  "customer": {
    "name": "Ahmad Ali",
    "phone": "+9627XXXXXXXX",
    "whatsapp": "+9627XXXXXXXX",
    "email": "ahmad@example.com"
  },
  "delivery": {
    "city": "Irbid",
    "area": "University Street",
    "address": "Full customer address here",
    "lat": 32.555,
    "lng": 35.850,
    "maps_url": "https://maps.google.com/?q=32.555,35.850"
  },
  "items": [
    {
      "name": "Chicken Shawarma Meal",
      "quantity": 2,
      "unit_price": 2.50,
      "total": 5.00,
      "options": [ { "name": "Sauce", "value": "Garlic" } ]
    }
  ],
  "pricing": {
    "subtotal": 5.00,
    "delivery_fee": 1.00,
    "discount": 0,
    "tax": 0,
    "total": 6.00,
    "currency": "JOD"
  },
  "payment": { "method": "cash_on_delivery", "status": "unpaid" },
  "delivery_finance": {
    "fee_charged_to_customer": 1.00,
    "actual_cost_to_restaurant": 1.25,
    "currency": "JOD",
    "provider": "internal_courier"
  },
  "notes": "Please call before arrival"
}

This is a sample request. Create an account to generate your real API Key and Branch ID.

Success

{
  "success": true,
  "orderger_order_id": "ord_xxx",
  "status": "pending_acceptance",
  "delivery_qr_url": "https://orderger-api.hamidalqwaysim.workers.dev/d/<token>",
  "message": "Order received and sent to restaurant app"
}

Errors

HTTP	error	Meaning
400	missing_required_field	A required field is missing (see `field`).
401	invalid_api_key	Bad or disabled API key.
402	insufficient_balance	Wallet balance is zero. Top up to receive live orders.
404	branch_not_found	Branch isn't on this business.
409	duplicate_order	Same `external_order_id` already received.
429	rate_limited	60 req/min per key by default.

Webhooks

See Webhooks for events, signature verification, and retry behavior.