Passer au contenu principal
Le flux de commandes renvoie les commandes récentes pour l’espace de travail clé API. Utilisez-le pour les exportations planifiées, les synchronisations de rapports légères et les intégrations comptables.

SDK Demande

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

Demande REST

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

Paramètres de requête

ParamètreTaperRemarques
apiKeychaîneRequis pour la route REST.
datechaîneDate de début facultative. Utilise le fuseau horaire de l’espace de travail.
endDatechaîneDate de fin facultative. Les plages de dates ne peuvent pas dépasser 5 jours.

Autorisations

Le rôle clé API doit :
restaurant:order:read

Réponse

{
  "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"
    }
  ]
}

Limites

  • Le flux renvoie jusqu’à 50 commandes par demande.
  • Les plages de dates ne peuvent pas dépasser 5 jours.
  • L’itinéraire REST est à tarif limité. Si vous recevez 429, attendez avant de réessayer.

Bon modèle de synchronisation

  1. Exécutez le flux selon un calendrier.
  2. Stockez la dernière plage de dates réussie dans votre système.
  3. Tirez une petite plage de dates.
  4. Insérer les commandes par id.
  5. Conservez les identifiants de paiement pour le rapprochement.
Utilisez le fuseau horaire de l’espace de travail lors du choix des fenêtres de date.