Order
Direkte interaksjoner med API-et krever et gyldig Bearer-token eller en X-Api-Key-header, og kontoen eller nøkkelen din må være knyttet til et gyldig selskap registrert hos RapiD Engineering.
GET /api/Order
Returnerer en 200 (OK) respons med en liste over ordrer i det angitte datointervallet. Hver ordre inkluderer sine nestede Order Rules, som igjen inkluderer sine Batches.
- Krever gyldige
startDate- ogendDate-verdier. - En valgfri
search-parameter søker etter ordre-ID, ordrenavn eller innkjøpsordrenavn — når oppgitt ignoreres datointervallet.
Responsfelt: Id, OrderName, PurchaseOrderName, ReceivedAt, LastDateTime, ClaimValue, ClaimPercentage, og en nestet Rules-samling.
GET /api/Order/{id}
Returnerer en 200 (OK) respons med en enkelt ordre, eller 404 hvis den ikke finnes.
Responsfelt: Id, OrderName, PurchaseOrderName, ReceivedAt, LastDateTime, ClaimValue, ClaimPercentage (uten nestede Rules).
GET /api/Order/Latest
Returnerer en 200 (OK) respons med den sist oppdaterte ordren (inkludert dens Rules og deres Batches), eller 404 hvis ingen ordrer finnes.
POST /api/Order
Oppretter en ny ordre. Returnerer en 201 (Created) respons med den nye ordrens Id.
Forespørselsinnhold: OrderName, PurchaseOrderName, ReceivedAt.
Note
Produkter håndteres separat og vil ikke bli inkludert i noen ordre-respons.
Note
Oppdatering av en ordre, sletting av en ordre og ordre-analyse-endepunkter er ikke en del av det eksterne API-et.