Saltar para o conteúdo principal
GET
Devolve um catálogo paginado dos biomarcadores que a tua chave de API pode pedir numa origem. Associa-os a marcações ou a kits de teste em casa. Os biomarcadores arquivados são excluídos. Um biomarcador aparece na lista quando um pedido num laboratório que a tua chave pode usar o disponibiliza e o pedido faz a colheita apenas para recipientes que a origem tem. O que decide são os tubos de amostra, não o tipo de analito. Requer o scope panels_access. O objeto pricing também requer o scope prices_view.

Pedido

Parâmetros de consulta

A origem tem uma de duas formas: um local de teste ou um kit de teste em casa. Envia exatamente uma. Enviar nenhuma ou ambas devolve 400.
string
obrigatório
O local onde são feitas as colheitas das marcações. Um biomarcador aparece na lista quando o seu pedido faz a colheita apenas para recipientes que esse local tem. Relaciona com Listar locais.
string
Substitui a tabela de preços que price_cents usa: retail, ou o id de uma tabela de preços que a tua chave pode usar. Obter tabela de preços devolve esse id. Por predefinição, usa a tabela da conta de faturação da tua chave de API; caso contrário, a de venda ao público. retail_cents usa sempre a tabela de venda ao público.
number
Número máximo de resultados a devolver (1–1 000). Omite para devolver todo o catálogo correspondente — é limitado (alguns milhares de registos, no máximo). Quando omitido, pagination.limit devolve o mesmo valor de total.
number
padrão:"0"
Deslocamento de paginação. Tem de ser ≥ 0.

Resposta

Biomarker[]
Array de biomarcadores correspondentes à consulta.
object

Objetos de preço

Os preços têm o mesmo formato em todos os locais onde aparecem — biomarcadores, painéis, a pré-visualização da marcação e um orçamento. Preços explica o modelo subjacente; esta é a referência dos campos. Todos os montantes são números inteiros em cêntimos.
integer | null
Quanto isto custa na tua tabela de preços. 0 é um preço real de zero — o item não é vendido separadamente e o bloco requires ou positions ao lado indica como é vendido. null é diferente: a Aniva não definiu preço para ele, não é sem custo, não pode ser pedido e não soma nada a nenhum total.
integer | null
O mesmo montante na tabela recomendada de venda ao público. Está sempre presente; é igual a price_cents quando a tua chave já usa a tabela de venda ao público.
"routine" | "specialty"
Qual das duas tarifas Aniva da tua tabela definiu o preço deste marcador. Presente apenas quando tem preço próprio.
object[]
As ofertas comerciais que incluem este biomarcador, da mais barata para a mais cara. Com price_cents: 0, estas são a única forma de o pedir; com um price_cents positivo, são os pacotes a que também pertence. Uma posição é faturada uma vez e é sempre entregue por inteiro.
string
Identificador estável da posição. Liga-se a via_position na fatura de uma marcação.
string
Nome da posição visível para o parceiro.
integer | null
Quanto custa a posição inteira na tua tabela de preços, faturada uma vez. retail_cents surge ao lado.
number[]
Todos os biomarcadores que a posição fornece, incluindo o que consultaste.
number[]
Os restantes elementos além do biomarcador que consultaste — o que vem junto quando o compras.
object[]
Presente quando este biomarcador é um rácio. Encomendá-lo adiciona estes componentes ao carrinho com os respetivos preços, e cada componente é pago uma só vez por carrinho, independentemente de quantos rácios dependam dele. O price_cents do próprio rácio é faturado além dos seus componentes. A maioria dos rácios custa 0. Cada entrada inclui id, name, price_cents e retail_cents.Um rácio cujos componentes não tenham todos preço fica totalmente fora do catálogo — nunca aparece com price_cents: null.
Os painéis trazem apenas price_cents e retail_cents: um painel tem um único preço de catálogo, sem posições nem componentes.

Respostas de erro