Siirry pääsisältöön
DELETE
Peruuta kotitestipakkauksen tilaus asettamalla sen tilaksi cancelled. Peruutettu kotitestipakkauksen tilaus palautetaan vastauksessa. Vain pending-tilassa olevan tilauksen voi peruuttaa. Kun tilaus on tilassa dispatched, logistiikkakumppani on jo pakannut ja merkinnyt pakkauksen, ja peruuttaminen palauttaa tilakoodin 409 — samoin kuin activated-tilassa olevan tilauksen kohdalla. Jos pakkaus on jo tilattu logistiikkakumppanilta, peruutamme sen ensin siellä ennen tilauksesi peruuttamista, ja kutsu epäonnistuu, jos se ei ota sitä takaisin: 409, kun pakkaus on jo pakattu ja merkitty, 502, kun logistiikkakumppani hylkäsi peruutuksen tai siihen ei saatu yhteyttä. Jokaisessa virhetilanteessa mitään ei muuteta — tilaus pysyy voimassa, ja 502-virheen jälkeen voit turvallisesti yrittää uudelleen. Jo cancelled-tilassa olevan tilauksen peruuttaminen palauttaa tilakoodin 200 ja kyseisen tilauksen riippumatta siitä, mistä tilasta se peruutettiin. Vastaus sisältää otsikon Idempotent-Replayed: true, jotta voit erottaa toistokutsun varsinaisen työn tehneestä kutsusta. Katso Idempotenssi. Vaatii home_kit_orders_manage-laajuuden.

Pyyntö

Polkuparametrit

string
vaadittu
Peruutettavan kotitestipakkauksen tilauksen yksilöllinen tunniste (UUID).

Vastaus

Onnistuessaan API palauttaa tilakoodin 200 OK sekä peruutetun kotitestipakkauksen tilauksen ja siihen upotetun profiilin. Jo aiemmin peruutettu tilaus palauttaa saman 200-vastauksen.
string
vaadittu
Kotitestipakkauksen tilauksen yksilöllinen tunniste (UUID).
string
vaadittu
Sen profiilin UUID, jolle tämä kotitestipakkauksen tilaus kuuluu.
string
vaadittu
Kotitestipakkauksen tilauksen tila. On cancelled onnistuneen peruutuksen jälkeen.
object
vaadittu
Osoite, johon pakkaus postitetaan — toinen kahdesta muodosta: joko { location_id }, joka viittaa tunnettuun testipaikkaan, tai suorat osoitekentät (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email valinnaisia — sama sanasto kuin locations-API:ssa). Anna täsmälleen toinen — sijaintiviittaus tai suora osoite, ei molempia.
string
Laboratorion näytekoodi, jonka alla tulokset raportoidaan — painettu fyysiseen pakkaukseen, ja sen potilas lukee rasiasta aktivointikoodina. null, kunnes pakkaus on pakattu. Vain luku.
string
vaadittu
Aktivoi-päätepisteen kautta ilmoitettu näytteenoton aikaleima — ajankohta, jolloin potilas otti näytteensä. null, kunnes pakkaus on aktivoitu.
string
Kotitestipakkauksen tilaus, jonka tämä tilaus korvaa, kun kyseessä on korvaava pakkaus. null normaalissa tilauksessa. Katso Luo kotitestipakkauksen tilaus.
string
Syy korvaavan pakkauksen lähettämiselle. null normaalissa tilauksessa.
string[]
vaadittu
Osoitteet pienillä kirjaimilla, joista jokainen saa yhden sähköpostin kaikkien laboratoriotulosten valmistuttua. Tyhjä, kun toiminto on pois päältä. Katso Tulokset valmiit -sähköpostit.
object
vaadittu
Kumppanin määrittämät avain-arvoparit, jotka palautetaan sellaisinaan. Aina mukana — {} kun arvoja ei ole asetettu.
string
vaadittu
ISO 8601 -aikaleima siitä, milloin kotitestipakkauksen tilaus luotiin.
string
ISO 8601 -aikaleima viimeisimmästä päivityksestä. Voi olla null.
object
vaadittu
Tähän kotitestipakkauksen tilaukseen liittyvä potilasprofiili.
HomeKitOrderPanel[]
vaadittu
Paneeli, joka oli liitetty tähän kotitestipakkauksen tilaukseen ennen peruutusta — aina täsmälleen yksi (kotitestipakkaus vastaa 1:1 fyysistä pakkaustuotetta). Hae paneelin tiedot (nimi, biomarkkerit) käyttämällä Listaa paneelit -päätepistettä.
HomeKitOrderIndividualBiomarker[]
vaadittu
Yksittäiset biomarkkerit, jotka oli liitetty tähän kotitestipakkauksen tilaukseen ennen peruutusta. Hae näyttötiedot kullekin biomarker_id-arvolle Listaa biomarkkerit -päätepisteestä parametrilla home_kit=true.
HomeKitOrderShipmentLink[]
vaadittu
Paketit, jotka oli linkitetty tähän kotitestipakkauksen tilaukseen ennen peruutusta, vanhin linkitys ensin. Lue pakettien täydet tiedot käyttämällä Listaa lähetykset -päätepistettä ja parametria ?home_kit_order_id=.

Virhevastaukset