Hoppa till huvudinnehåll
GET
Returnerar en paginerad katalog över de biomarkörer din API-nyckel kan beställa för ett ursprung. Lägg till dem på bokningar eller i hemtestkit. Arkiverade biomarkörer exkluderas. En biomarkör visas i listan när en beställning hos ett labb din nyckel får använda levererar den, och beställningen enbart tas i provkärl som finns för ursprunget. Det är provrören som avgör, inte typen av analyt. Kräver scopet panels_access. Objektet pricing kräver även scopet prices_view.

Förfrågan

Frågeparametrar

Ursprunget har en av två former: en testplats eller ett hemtestkit. Skicka exakt ett av dem. Inget av dem eller båda returnerar 400.
string
obligatorisk
Platsen där blodprovstagningen för bokningarna sker. En biomarkör visas i listan när dess beställning enbart tas i provkärl som finns på platsen. Stäm av mot Lista platser.
string
Åsidosätt vilken prislista price_cents använder: retail, eller id för en prislista som din nyckel får använda. Hämta prislista returnerar detta id. Standard är prislistan på din API-nyckels faktureringskonto, annars slutkundsprislistan. retail_cents är alltid slutkundsprislistan.
number
Max antal resultat att returnera (1–1 000). Utelämna för att returnera hela den matchande katalogen — den är begränsad (högst några tusen rader). När parametern utelämnas returnerar pagination.limit samma värde som total.
number
standard:"0"
Förskjutning vid paginering. Måste vara ≥ 0.

Svar

Biomarker[]
Array med biomarkörer som matchar frågan.
object

Prisobjekt

Prissättningen har samma format överallt där den visas — biomarkörer, paneler, bokningens förhandsgranskning och en offert. Prissättning förklarar modellen bakom den; det här är fältreferensen. Varje belopp anges som heltal i cent.
integer | null
Vad detta kostar enligt din prislista. 0 är ett faktiskt pris på noll — artikeln säljs inte separat, och blocket requires eller positions intill visar hur den säljs i stället. null är något annat: Aniva har inte prissatt den, den är inte kostnadsfri, den kan inte beställas och den lägger inte till något på någon totalsumma.
integer | null
Samma belopp enligt den rekommenderade slutkundsprislistan. Finns alltid med; lika med price_cents när din nyckel redan använder slutkundsprislistan.
"routine" | "specialty"
Vilken av din prislistas två Aniva-tariffer som har prissatt denna markör. Finns bara med när den har ett eget pris.
object[]
De kommersiella erbjudanden som innehåller biomarkören, billigast först. Vid price_cents: 0 är dessa det enda sättet att beställa den; vid ett positivt price_cents är de paket som den också tillhör. En position faktureras en gång och levereras alltid i sin helhet.
string
Stabil positionsidentifierare. Kopplas till via_position på en bokningsfaktura.
string
Positionsnamn som visas för partner.
integer | null
Vad hela positionen kostar i din prislista, debiteras en gång. retail_cents ligger bredvid.
number[]
Alla biomarkörer som positionen levererar, inklusive den du frågade efter.
number[]
Övriga delar utöver den biomarkör du frågade efter – det som följer med när du köper den.
object[]
Finns med när denna biomarkör är en kvot. När du beställer den läggs dessa komponenter i varukorgen till sina egna priser, och en komponent betalas bara en gång per varukorg oavsett hur många kvoter som bygger på den. Kvotens eget price_cents debiteras utöver dess komponenter. De flesta kvoter kostar 0. Varje post innehåller id, name, price_cents och retail_cents.En kvot vars komponenter inte alla är prissatta saknas helt i katalogen – den visas aldrig med price_cents: null.
Paneler har enbart price_cents och retail_cents: en panel har ett enda katalogpris och inga positioner eller komponenter.

Felsvar