Naar hoofdinhoud gaan
DELETE
Annuleer een thuistestkitbestelling door de status op cancelled te zetten. De geannuleerde thuistestkitbestelling wordt in de response geretourneerd. Alleen een bestelling met de status pending kan worden geannuleerd. Zodra deze dispatched is, is de kit door fulfilment verpakt en gelabeld, en retourneert annuleren 409 — net als bij een bestelling met de status activated. Als de kit al bij fulfilment is besteld, annuleren wij deze eerst daar voordat we jouw bestelling annuleren, en mislukt de aanroep als zij deze niet terugnemen: 409 als de kit al is verpakt en gelabeld, 502 als fulfilment de annulering weigerde of niet bereikbaar was. In elk foutgeval verandert er niets — de bestelling blijft actief en een 502 kun je veilig opnieuw proberen. Het annuleren van een bestelling die al cancelled is, retourneert 200 met die bestelling, ongeacht vanuit welke status deze is geannuleerd. De response bevat Idempotent-Replayed: true zodat je een herhaling kunt onderscheiden van de aanroep die het werk heeft uitgevoerd. Zie Idempotentie. Vereist de scope home_kit_orders_manage.

Verzoek

Padparameters

string
vereist
Unieke identifier (UUID) van de te annuleren thuistestkitbestelling.

Respons

Bij succes retourneert de API 200 OK met de geannuleerde thuistestkitbestelling en het ingesloten profiel. Een bestelling die al was geannuleerd, retourneert dezelfde 200.
string
vereist
Unieke identifier (UUID) van de thuistestkitbestelling.
string
vereist
UUID van het profiel waarbij deze thuistestkitbestelling hoort.
string
vereist
Status van de thuistestkitbestelling. Is cancelled na een geslaagde annulering.
object
vereist
Het adres waar de kit naartoe wordt gestuurd — in een van twee vormen: ofwel { location_id } dat verwijst naar een bekende testlocatie, ofwel de inline adresvelden (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email optioneel — dezelfde velden als de locations-API). Geef precies één vorm op — een locatieverwijzing of een inline adres, niet beide.
string
Monstercode van het laboratorium waaronder de resultaten worden gerapporteerd — afgedrukt op de fysieke kit, en wat de patiënt van de doos afleest als activeringscode. null totdat de kit is verpakt. Alleen-lezen.
string
vereist
Afnametijdstempel doorgegeven via Activeren — wanneer de patiënt het monster heeft afgenomen. null totdat de kit is geactiveerd.
string
De thuistestkitbestelling die door deze bestelling wordt vervangen, als het een vervangende kit is. null bij een normale bestelling. Zie Thuistestkitbestelling aanmaken.
string
Waarom de vervangende kit is verstuurd. null bij een normale bestelling.
string[]
vereist
E-mailadressen die elk één e-mail krijgen zodra alle labresultaten definitief zijn, in kleine letters. Leeg wanneer uitgeschakeld. Zie E-mails bij beschikbare resultaten.
object
vereist
Door de partner gedefinieerde sleutel-waardeparen, letterlijk teruggegeven. Altijd aanwezig — {} indien niet ingesteld.
string
vereist
ISO 8601-tijdstempel waarop de thuistestkitbestelling is aangemaakt.
string
ISO 8601-tijdstempel van de laatste update. Kan null zijn.
object
vereist
Het patiëntprofiel dat bij deze thuistestkitbestelling hoort.
HomeKitOrderPanel[]
vereist
Het panel dat voor annulering aan deze thuistestkitbestelling was gekoppeld — altijd precies één (een thuistestkit komt 1:1 overeen met een fysiek kitproduct). Zoek panelgegevens (naam, biomarkers) op via Panels ophalen.
HomeKitOrderIndividualBiomarker[]
vereist
Losse biomarkers die voor annulering aan deze thuistestkitbestelling waren gekoppeld. Zoek elke biomarker_id op via Biomarkers ophalen met home_kit=true voor weergavegegevens.
HomeKitOrderShipmentLink[]
vereist
Pakketten die voor annulering aan deze thuistestkitbestelling waren gekoppeld, oudste koppeling eerst. Lees de volledige pakketten uit met Zendingen ophalen en ?home_kit_order_id=.

Foutresponsen