Vai al contenuto principale
GET
Restituisce un catalogo impaginato dei biomarcatori che la tua chiave API può ordinare da una singola origine. Associali agli appuntamenti o ai kit domiciliari. I biomarcatori archiviati sono esclusi. Un biomarcatore viene elencato quando un ordine presso un laboratorio che la tua chiave può usare lo include e richiede il prelievo solo nei contenitori disponibili presso l’origine. A decidere sono le provette, non il tipo di analita. Richiede lo scope panels_access. L’oggetto pricing richiede anche lo scope prices_view.

Richiesta

Parametri di query

L’origine può avere due forme: una sede per esami o un kit domiciliare. Inviane esattamente una. Nessuna o entrambe restituiscono 400.
string
obbligatorio
La sede in cui vengono effettuati i prelievi degli appuntamenti. Un biomarcatore viene elencato quando il suo ordine richiede il prelievo solo nei contenitori disponibili in quella sede. Correla con Elenca sedi.
string
Sostituisci il listino prezzi usato da price_cents: retail, oppure l’id di un listino che la tua chiave può usare. Ottieni listino prezzi restituisce quell’id. Per impostazione predefinita usa il listino dell’account di fatturazione della tua chiave API, altrimenti il listino retail. retail_cents usa sempre il listino retail.
number
Numero massimo di risultati da restituire (1–1.000). Ometti per restituire l’intero catalogo corrispondente — è limitato (al massimo qualche migliaio di righe). Quando omesso, pagination.limit restituisce total.
number
predefinito:"0"
Offset di impaginazione. Deve essere ≥ 0.

Risposta

Biomarker[]
Array di biomarcatori che corrispondono alla query.
object

Oggetti prezzo

La struttura dei prezzi è la stessa ovunque compaia — biomarcatori, pannelli, anteprima dell’appuntamento e preventivo. Prezzi spiega il modello alla base; questo è il riferimento dei campi. Ogni importo è espresso in centesimi interi.
integer | null
Quanto costa sul tuo listino prezzi. 0 è un vero prezzo pari a zero — l’articolo non è venduto singolarmente e il blocco requires o positions accanto indica invece come viene venduto. null è diverso: Aniva non gli ha assegnato un prezzo, non è a costo zero, non può essere ordinato e non aggiunge nulla a nessun totale.
integer | null
Lo stesso importo secondo il listino retail consigliato. Sempre presente; uguale a price_cents quando la tua chiave usa già il listino retail.
"routine" | "specialty"
Quale delle due tariffe Aniva del tuo listino ha determinato il prezzo di questo marcatore. Presente solo quando ha un prezzo proprio.
object[]
Le offerte commerciali che contengono questo biomarcatore, dalla più economica. Con price_cents: 0 sono l’unico modo per ordinarlo; con un price_cents positivo sono i pacchetti di cui fa inoltre parte. Una posizione viene fatturata una sola volta e viene sempre fornita per intero.
string
Identificatore stabile della posizione. Corrisponde a via_position nella fattura di un appuntamento.
string
Nome della posizione visibile ai partner.
integer | null
Quanto costa l’intera posizione nel tuo listino, addebitata una volta sola. retail_cents lo affianca.
number[]
Ogni biomarcatore fornito dalla posizione, compreso quello che hai richiesto.
number[]
Gli elementi diversi dal biomarcatore che hai richiesto — ciò che viene aggiunto quando lo acquisti.
object[]
Presente quando questo biomarcatore è un rapporto. Ordinarlo aggiunge questi componenti al carrello ai rispettivi prezzi, e ogni componente viene pagato una sola volta per carrello, indipendentemente da quanti rapporti si basano su di esso. Il price_cents del rapporto stesso viene addebitato in aggiunta ai suoi componenti. La maggior parte dei rapporti costa 0. Ogni voce contiene id, name, price_cents e retail_cents.Un rapporto i cui componenti non hanno tutti un prezzo è del tutto assente dal catalogo — non appare mai con price_cents: null.
I pannelli hanno solo price_cents e retail_cents: un pannello ha un unico prezzo di catalogo e nessuna posizione o componente.

Risposte di errore