Order
Directe interacties met de API vereisen een geldig Bearer-token of een X-Api-Key-header, en uw account of sleutel moet gekoppeld zijn aan een geldig bedrijf dat geregistreerd is bij RapiD Engineering.
GET /api/Order
Retourneert een 200 (OK) respons met een lijst van orders in het opgegeven datumbereik. Elke order bevat de bijbehorende Order Rules, die op hun beurt hun Batches bevatten.
- Vereist geldige
startDate- enendDate-waarden. - Een optionele
search-parameter zoekt op order-ID, ordernaam of inkoopordernaam — wanneer opgegeven wordt het datumbereik genegeerd.
Antwoordvelden: Id, OrderName, PurchaseOrderName, ReceivedAt, LastDateTime, ClaimValue, ClaimPercentage, en een geneste Rules-collectie.
GET /api/Order/{id}
Retourneert een 200 (OK) respons met een enkele order, of 404 als deze niet gevonden is.
Antwoordvelden: Id, OrderName, PurchaseOrderName, ReceivedAt, LastDateTime, ClaimValue, ClaimPercentage (zonder geneste Rules).
GET /api/Order/Latest
Retourneert een 200 (OK) respons met de meest recent bijgewerkte order (inclusief Rules en hun Batches), of 404 als er geen orders bestaan.
POST /api/Order
Maakt een nieuwe order aan. Retourneert een 201 (Created) respons met het Id van de nieuwe order.
Verzoekinhoud: OrderName, PurchaseOrderName, ReceivedAt.
Note
Producten worden apart afgehandeld en worden niet opgenomen in een order-respons.
Note
Het bijwerken van een order, het verwijderen van een order en order-analyse-endpoints maken geen deel uit van de externe API.