Saltar para o conteúdo principal
DELETE
Cancela uma encomenda de kit de teste em casa ao definir o seu estado como cancelled. A encomenda de kit de teste em casa cancelada é devolvida na resposta. Só é possível cancelar uma encomenda pending. Assim que estiver dispatched, o kit já foi embalado e etiquetado pela logística e o cancelamento devolve 409 — tal como acontece com uma encomenda activated. Se o kit já tiver sido encomendado à logística, cancelamo-lo lá antes de cancelar o teu, e a chamada falha quando não aceitam o cancelamento: 409 quando o kit já está embalado e etiquetado, 502 quando a logística recusou o cancelamento ou não foi possível contactá-la. Em qualquer caso de falha, nada é alterado — a encomenda mantém-se ativa e é seguro tentar novamente após um 502. Cancelar uma encomenda que já está cancelled devolve 200 com essa encomenda, independentemente do estado a partir do qual foi cancelada. A resposta inclui Idempotent-Replayed: true para poderes distinguir uma repetição da chamada que realizou a ação. Consulta Idempotência. Requer o âmbito home_kit_orders_manage.

Pedido

Parâmetros de caminho

string
obrigatório
Identificador único (UUID) da encomenda de kit de teste em casa a cancelar.

Resposta

Em caso de sucesso, a API devolve 200 OK com a encomenda de kit de teste em casa cancelada e o perfil incorporado. Uma encomenda que já estava cancelada devolve o mesmo 200.
string
obrigatório
Identificador único da encomenda de kit de teste em casa (UUID).
string
obrigatório
UUID do perfil a que pertence esta encomenda de kit de teste em casa.
string
obrigatório
Estado da encomenda de kit de teste em casa. Será cancelled após um cancelamento bem-sucedido.
object
obrigatório
A morada para onde enviar o kit — um de dois formatos: { location_id }, que referencia um local de teste conhecido, ou os campos de morada inline (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email opcionais — o mesmo vocabulário da API de localizações). Indica exatamente um — uma referência de localização ou uma morada inline, não ambos.
string
Código de amostra de laboratório sob o qual os resultados são comunicados — impresso no kit físico e o que o paciente lê na caixa como código de ativação. null até o kit ser embalado. Só de leitura.
string
obrigatório
Data e hora da colheita comunicadas através de Ativar — quando o paciente recolheu a amostra. null até o kit ser ativado.
string
A encomenda de kit de teste em casa que esta substitui, quando se trata de um kit de substituição. null numa encomenda normal. Consulta Criar encomenda de kit de teste em casa.
string
Motivo do envio da substituição. null numa encomenda normal.
string[]
obrigatório
Endereços que recebem um e-mail assim que todos os resultados laboratoriais forem definitivos, em minúsculas. Vazio quando desativado. Consulta E-mails de resultados prontos.
object
obrigatório
Pares chave/valor definidos pelo parceiro, devolvidos sem alterações. Sempre presente — {} quando não definido.
string
obrigatório
Data e hora ISO 8601 de criação da encomenda de kit de teste em casa.
string
Data e hora ISO 8601 da última atualização. Pode ser null.
object
obrigatório
O perfil do paciente associado a esta encomenda de kit de teste em casa.
HomeKitOrderPanel[]
obrigatório
O painel que estava associado a esta encomenda de kit de teste em casa antes do cancelamento — sempre exatamente um (um kit de teste em casa corresponde 1:1 a um produto de kit físico). Consulta os detalhes do painel (nome, biomarcadores) através de Listar painéis.
HomeKitOrderIndividualBiomarker[]
obrigatório
Biomarcadores avulso que estavam associados a esta encomenda de kit de teste em casa antes do cancelamento. Cruza cada biomarker_id com Listar biomarcadores com home_kit=true para obter os dados de apresentação.
HomeKitOrderShipmentLink[]
obrigatório
Volumes que estavam associados a esta encomenda de kit de teste em casa antes do cancelamento, da associação mais antiga para a mais recente. Lê os volumes completos com Listar envios e ?home_kit_order_id=.

Respostas de erro