Ana içeriğe atla
DELETE
Bir evde test kiti siparişinin durumunu cancelled olarak ayarlayıp iptal et. İptal edilen evde test kiti siparişi yanıtta döndürülür. Yalnızca pending durumundaki bir sipariş iptal edilebilir. Sipariş dispatched olduğunda kit lojistik merkezi tarafından paketlenip etiketlenmiş olur ve iptal işlemi 409 döndürür — activated durumundaki bir siparişte de aynı durum geçerlidir. Kit lojistik merkezinden zaten sipariş edildiyse, seninkini iptal etmeden önce orada iptal ederiz ve geri almayı kabul etmediklerinde çağrı başarısız olur: kit zaten paketlenip etiketlendiyse 409, lojistik merkezi iptali reddettiyse veya merkeze ulaşılamadıysa 502. Her başarısızlık durumunda hiçbir şey değişmez — sipariş aktif kalır ve 502 güvenle yeniden denenebilir. Zaten cancelled durumunda olan bir siparişi iptal etmek, hangi durumdan iptal edilmiş olursa olsun o siparişle birlikte 200 döndürür. Yanıt, tekrar çağrısını işlemi gerçekleştiren çağrıdan ayırt edebilmen için Idempotent-Replayed: true taşır. Bkz. İdempotentlik. home_kit_orders_manage kapsamını gerektirir.

İstek

Yol parametreleri

string
gerekli
İptal edilecek evde test kiti siparişinin benzersiz kimliği (UUID).

Yanıt

Başarılı olduğunda API, iptal edilen evde test kiti siparişi ve gömülü profiliyle birlikte 200 OK döndürür. Zaten iptal edilmiş bir sipariş de aynı 200 yanıtını döndürür.
string
gerekli
Benzersiz evde test kiti siparişi kimliği (UUID).
string
gerekli
Bu evde test kiti siparişinin ait olduğu profilin UUID’si.
string
gerekli
Evde test kiti siparişi durumu. Başarılı bir iptalden sonra cancelled olur.
object
gerekli
Kitin postalanacağı adres — iki biçimden biri: bilinen bir test konumuna referans veren { location_id } veya satır içi adres alanları (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email isteğe bağlı — konumlar API’siyle aynı terminoloji). Tam olarak birini belirt — konum referansı veya satır içi adres, ikisi birden değil.
string
Sonuçların altında raporlandığı laboratuvar örnek kodu — fiziksel kitin üzerinde basılıdır ve hastanın kutudan etkinleştirme kodu olarak okuduğu koddur. Kit paketlenene kadar null. Salt okunur.
string
gerekli
Etkinleştir üzerinden bildirilen örnek alma zaman damgası — hastanın örneğini ne zaman aldığı. Kit etkinleştirilene kadar null.
string
Bu bir değişim kiti olduğunda, yerini aldığı evde test kiti siparişi. Normal bir siparişte null. Bkz. Evde test kiti siparişi oluştur.
string
Değişim kitinin neden gönderildiği. Normal bir siparişte null.
string[]
gerekli
Tüm laboratuvar sonuçları kesinleştiğinde her birine bir e-posta gönderilen, küçük harfe çevrilmiş adresler. Kapalıyken boştur. Bkz. Sonuçlar hazır e-postaları.
object
gerekli
İş ortağı tarafından tanımlanan ve aynen geri döndürülen anahtar/değer çiftleri. Her zaman mevcuttur — ayarlanmadığında {}.
string
gerekli
Evde test kiti siparişinin oluşturulduğu zamanın ISO 8601 zaman damgası.
string
Son güncellemenin ISO 8601 zaman damgası. null olabilir.
object
gerekli
Bu evde test kiti siparişiyle ilişkili hasta profili.
HomeKitOrderPanel[]
gerekli
İptalden önce bu evde test kiti siparişine ekli olan panel — her zaman tam olarak bir tane (bir evde test kiti, fiziksel bir kit ürünüyle 1:1 eşleşir). Panel ayrıntılarına (ad, biyobelirteçler) Panelleri listele üzerinden bak.
HomeKitOrderIndividualBiomarker[]
gerekli
İptalden önce bu evde test kiti siparişine ekli olan tekil biyobelirteçler. Görüntüleme verileri için her biomarker_id değerini home_kit=true ile Biyobelirteçleri listele üzerinden karşılaştır.
HomeKitOrderShipmentLink[]
gerekli
İptalden önce bu evde test kiti siparişine bağlanan paketler, en eski bağlantı önce gelecek şekilde. Paketlerin tümünü Gönderileri listele ve ?home_kit_order_id= ile oku.

Hata yanıtları