Hoppa till huvudinnehåll
DELETE
Avbryt en beställning av hemtestkit genom att sätta dess status till cancelled. Den avbrutna beställningen av hemtestkit returneras i svaret. Endast en beställning med status pending kan avbrytas. När den har status dispatched har kitet packats och märkts av logistikpartnern, och en avbeställning returnerar 409 – precis som för en beställning med status activated. Om kitet redan har beställts från logistikpartnern avbeställer vi det där innan vi avbryter din beställning, och anropet misslyckas om de inte tar tillbaka det: 409 när kitet redan är packat och märkt, 502 när logistikpartnern nekade avbeställningen eller inte kunde nås. Vid varje fel ändras ingenting – beställningen förblir aktiv, och det är säkert att försöka igen vid 502. Att avbryta en beställning som redan har status cancelled returnerar 200 med den beställningen, oavsett vilken status den avbröts från. Svaret innehåller Idempotent-Replayed: true så att du kan skilja en upprepning från anropet som utförde ändringen. Se Idempotens. Kräver scopet home_kit_orders_manage.

Förfrågan

Sökvägsparametrar

string
obligatorisk
Unik identifierare (UUID) för beställningen av hemtestkit som ska avbrytas.

Svar

När anropet lyckas returnerar API:et 200 OK med den avbrutna beställningen av hemtestkit och dess inbäddade profil. En beställning som redan var avbruten returnerar samma 200.
string
obligatorisk
Unik identifierare (UUID) för beställningen av hemtestkit.
string
obligatorisk
UUID för profilen som den här beställningen av hemtestkit tillhör.
string
obligatorisk
Status för beställningen av hemtestkit. Är cancelled efter en lyckad avbeställning.
object
obligatorisk
Adressen som kitet ska skickas till – i ett av två format: antingen { location_id } som refererar till en känd testplats, eller inline-adressfälten (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email är valfria – samma fältnamn som i locations-API:et). Ange exakt ett alternativ – en platsreferens eller en inline-adress, inte båda.
string
Laboratoriets provkod som resultaten rapporteras under – tryckt på det fysiska kitet, och det som patienten läser av från lådan som aktiveringskod. null tills kitet är packat. Skrivskyddad.
string
obligatorisk
Tidsstämpel för provtagning rapporterad via Aktivera – när patienten tog sitt prov. null tills kitet är aktiverat.
string
Beställningen av hemtestkit som den här ersätter, när det rör sig om ett ersättningskit. null för en vanlig beställning. Se Skapa beställning av hemtestkit.
string
Anledningen till att ersättningen skickades. null för en vanlig beställning.
string[]
obligatorisk
Adresser som var och en får ett mejl när alla labbresultat är slutgiltiga, i gemener. Tom när funktionen är avstängd. Se Mejl när resultat är klara.
object
obligatorisk
Partnerdefinierade nyckel/värde-par som returneras exakt som de skickades. Finns alltid med – {} när inga värden angetts.
string
obligatorisk
ISO 8601-tidsstämpel för när beställningen av hemtestkit skapades.
string
ISO 8601-tidsstämpel för den senaste uppdateringen. Kan vara null.
object
obligatorisk
Patientprofilen som är kopplad till den här beställningen av hemtestkit.
HomeKitOrderPanel[]
obligatorisk
Panelen som var kopplad till den här beställningen av hemtestkit innan den avbröts – alltid exakt en (ett hemtestkit motsvarar 1:1 en fysisk kitprodukt). Hämta panelinformation (namn, biomarkörer) via Lista paneler.
HomeKitOrderIndividualBiomarker[]
obligatorisk
Enskilda biomarkörer som var kopplade till den här beställningen av hemtestkit innan den avbröts. Stäm av varje biomarker_id mot Lista biomarkörer med home_kit=true för visningsdata.
HomeKitOrderShipmentLink[]
obligatorisk
Paket som var länkade till den här beställningen av hemtestkit innan den avbröts, med äldsta kopplingen först. Läs fullständig paketinformation med Lista försändelser och ?home_kit_order_id=.

Felsvar