Skip to main content
The order feed returns recent orders for the API key workspace. Use it for scheduled exports, lightweight reporting syncs, and accounting integrations.

​
SDK Request

const feed = await plato.v1.orders.externalOrderFeed.query({
  apiKey: process.env.PLATO_API_KEY!,
  date: "2026-06-17",
  endDate: "2026-06-19",
});

​
REST Request

GET /api/v1/orders/external-feed

curl "https://api.plato.ae/api/v1/orders/external-feed?apiKey=$PLATO_API_KEY&date=2026-06-17"

​
Query Parameters

ParameterTypeNotes
apiKeystringRequired for the REST route.
datestringOptional start date. Uses the workspace time zone.
endDatestringOptional end date. Date ranges cannot exceed 5 days.

​
Permissions

The API key role needs: 
restaurant:order:read

​
Response

{
  "count": 2,
  "workspaceId": "workspace_123",
  "data": [
    {
      "id": "order_123",
      "referenceNumber": 1042,
      "status": "COMPLETED",
      "subTotal": 120,
      "vatAmount": 6,
      "promoCodeDiscount": 0,
      "discount": 0,
      "totalPriceWithoutDiscount": 126,
      "totalWithoutCharges": 126,
      "totalPrice": 126,
      "chargesDiscountable": [],
      "chargesNonDiscountable": [],
      "payments": [
        {
          "id": "payment_123",
          "type": "SALE",
          "method": "CARD",
          "totalAmount": 126,
          "currency": "AED",
          "status": "PAID",
          "refundMetadata": null
        }
      ],
      "createdAt": "2026-06-17T08:20:00.000Z"
    }
  ]
}

​
Limits

  • The feed returns up to 50 orders per request.
  • Date ranges cannot exceed 5 days.
  • The REST route is rate limited. If you receive 429, wait before retrying.

​
Good Sync Pattern

  1. Run the feed on a schedule.
  2. Store the last successful date range in your system.
  3. Pull a small date range.
  4. Upsert orders by id.
  5. Keep payment ids for reconciliation.
Use the workspace time zone when choosing date windows.