Order
Direkte Interaktionen mit der API erfordern ein gültiges Bearer-Token oder einen X-Api-Key-Header, und Ihr Konto oder Schlüssel muss mit einem gültigen, bei RapiD Engineering registrierten Unternehmen verknüpft sein.
GET /api/Order
Gibt eine 200 (OK) Antwort mit einer Liste von Orders im angegebenen Datumsbereich zurück. Jede Order enthält ihre verschachtelten Order Rules, die wiederum ihre Batches enthalten.
- Erfordert gültige
startDate- undendDate-Werte. - Ein optionaler
search-Parameter sucht nach Order-ID, Ordername oder Bestellungsname — wenn angegeben, wird der Datumsbereich ignoriert.
Antwortfelder: Id, OrderName, PurchaseOrderName, ReceivedAt, LastDateTime, ClaimValue, ClaimPercentage und eine verschachtelte Rules-Sammlung.
GET /api/Order/{id}
Gibt eine 200 (OK) Antwort mit einer einzelnen Order zurück, oder 404 wenn nicht gefunden.
Antwortfelder: Id, OrderName, PurchaseOrderName, ReceivedAt, LastDateTime, ClaimValue, ClaimPercentage (ohne verschachtelte Rules).
GET /api/Order/Latest
Gibt eine 200 (OK) Antwort mit der zuletzt aktualisierten Order zurück (einschließlich ihrer Rules und deren Batches), oder 404 wenn keine Orders vorhanden sind.
POST /api/Order
Erstellt eine neue Order. Gibt eine 201 (Created) Antwort mit der Id der neuen Order zurück.
Anfragekörper: OrderName, PurchaseOrderName, ReceivedAt.
Note
Produkte werden separat behandelt und sind in keiner Order-Antwort enthalten.
Note
Das Aktualisieren einer Order, das Löschen einer Order und Order-Analyse-Endpunkte sind nicht Teil der externen API.