Hopp til hovedinnhold
DELETE
Kanseller en bestilling av hjemmetestsett ved å sette statusen til cancelled. Den kansellerte bestillingen av hjemmetestsett returneres i svaret. Bare en bestilling med status pending kan kanselleres. Når den har status dispatched, er settet pakket og merket av logistikkpartneren, og kansellering returnerer 409 – det samme gjelder en bestilling med status activated. Hvis settet allerede er bestilt hos logistikkpartneren, kansellerer vi det der før vi kansellerer bestillingen din, og kallet feiler hvis de ikke vil ta det tilbake: 409 når settet allerede er pakket og merket, 502 når logistikkpartneren avviste kanselleringen eller ikke kunne nås. Ved enhver feil endres ingenting – bestillingen forblir aktiv, og det er trygt å prøve på nytt ved 502. Kansellering av en bestilling som allerede har status cancelled, returnerer 200 med den bestillingen, uansett hvilken status den ble kansellert fra. Svaret inneholder Idempotent-Replayed: true, slik at du kan skille et gjentatt kall fra kallet som utførte endringen. Se Idempotens. Krever scope-et home_kit_orders_manage.

Forespørsel

Stiparametere

string
påkrevd
Unik identifikator (UUID) for bestillingen av hjemmetestsett som skal kanselleres.

Respons

Ved suksess returnerer API-et 200 OK med den kansellerte bestillingen av hjemmetestsett og den innebygde profilen. En bestilling som allerede var kansellert, returnerer samme 200.
string
påkrevd
Unik identifikator (UUID) for bestillingen av hjemmetestsett.
string
påkrevd
UUID for profilen denne bestillingen av hjemmetestsett tilhører.
string
påkrevd
Status for bestillingen av hjemmetestsett. Blir cancelled etter en vellykket kansellering.
object
påkrevd
Adressen settet skal sendes til – én av to former: enten { location_id } som refererer til et kjent teststed, eller direkte adressefelt (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email er valgfrie – samme struktur som i lokasjons-API-et). Oppgi nøyaktig én – en stedsreferanse eller en direkte adresse, ikke begge.
string
Prøvekode hos laboratoriet som resultatene rapporteres under – trykt på det fysiske settet, og det pasienten leser av esken som aktiveringskode. null til settet er pakket. Skrivebeskyttet.
string
påkrevd
Prøvetakingstidspunkt rapportert via Aktiver – når pasienten tok prøven sin. null til settet er aktivert.
string
Bestillingen av hjemmetestsett som denne erstatter, når det er et erstatningssett. null ved en vanlig bestilling. Se Opprett bestilling av hjemmetestsett.
string
Hvorfor erstatningen ble sendt. null ved en vanlig bestilling.
string[]
påkrevd
Adresser som hver får én e-post når alle labresultater er endelige, i små bokstaver. Tom når den er slått av. Se E-poster om klare resultater.
object
påkrevd
Partnerdefinerte nøkkel/verdi-par, returnert uendret. Alltid med – {} når ikke angitt.
string
påkrevd
ISO 8601-tidsstempel for når bestillingen av hjemmetestsett ble opprettet.
string
ISO 8601-tidsstempel for siste oppdatering. Kan være null.
object
påkrevd
Pasientprofilen som er knyttet til denne bestillingen av hjemmetestsett.
HomeKitOrderPanel[]
påkrevd
Panelet som var knyttet til denne bestillingen av hjemmetestsett før kansellering – alltid nøyaktig ett (et hjemmetestsett tilsvarer 1:1 et fysisk settprodukt). Slå opp paneldetaljer (navn, biomarkører) via Vis paneler.
HomeKitOrderIndividualBiomarker[]
påkrevd
Enkeltstående biomarkører som var knyttet til denne bestillingen av hjemmetestsett før kansellering. Kryssreferer hver biomarker_id mot Vis biomarkører med home_kit=true for visningsdata.
HomeKitOrderShipmentLink[]
påkrevd
Pakker som var koblet til denne bestillingen av hjemmetestsett før kansellering, eldste kobling først. Hent fullstendig pakkeinformasjon med Vis forsendelser og ?home_kit_order_id=.

Feilresponser