Saltar para o conteúdo principal
POST
Cria um pedido de envio a partir do local de origem especificado. Indicas o laboratório de destino com destination_lab. O envio segue para a morada de envio registada desse laboratório. Requer o âmbito shipments_manage. Envia um cabeçalho opcional Idempotency-Key para tornar esta criação segura para repetir — repetir a mesma chave devolve a resposta original em vez de criar outra. Vê Idempotência.

Pedido

Parâmetros do corpo

string
obrigatório
UUID do local de testes de origem. O local tem de estar ativo e dentro do contexto de acesso da tua chave de API. Usa Listar locais para encontrar os IDs de locais disponíveis.
string
obrigatório
Laboratório de destino. Um dos seguintes: zotzklimas, labclinic, nordicgroup, biomes, imd ou quade. O envio segue para a morada de envio registada para este laboratório. Um laboratório sem morada de envio registada devolve 400.
string
UUID opcional da marcação à qual associar este envio no momento da criação. A marcação tem de estar dentro do contexto de acesso da tua chave de API. A associação aparece diretamente como uma entrada no array appointments do envio e, inversamente, como uma entrada no array shipments da marcação. Para associar marcações adicionais após a criação, ou remover a associação inicial, usa Associar marcações a envio e Desassociar marcações de envio.
string
obrigatório
Data de recolha no formato YYYY-MM-DD (por ex., 2026-04-15), interpretada no fuso horário do local de origem. Tem de ser um dia útil (segunda a sexta-feira), hoje ou no futuro. Não existem recolhas no próprio dia após as 16:00 Europe/Berlin.
string
obrigatório
Hora de recolha mais cedo no formato HH:MM (por ex., 09:00), interpretada como hora local no fuso horário do local de origem. Tem de estar entre 09:00 e 19:00.
string
obrigatório
Hora de recolha mais tarde no formato HH:MM (por ex., 12:00), interpretada como hora local no fuso horário do local de origem. Tem de estar entre 09:00 e 19:00. A janela (pickup_time_till - pickup_time_from) tem de ter pelo menos 2 horas.
integer
padrão:"1"
Número de volumes. O valor predefinido é 1.
number
padrão:"0.5"
Peso em kg. O valor predefinido é 0.5.
string
Instruções para o estafeta na recolha (observações do remetente). Quando omitido, são usadas as observações guardadas na morada de recolha (ou nenhumas, se a morada não as tiver). Máximo de 128 caracteres.
string
Descrição em texto livre do conteúdo da encomenda, apresentada ao estafeta e devolvida como contents. Máximo de 40 caracteres (por ex., Medizinisch freigestellte Probe).
string
Notas internas opcionais. Máximo de 128 caracteres.

Resposta

Em caso de sucesso, a API devolve 201 Created com o novo envio.
string
obrigatório
Identificador de referência do envio (por ex., P2604151234).
string
obrigatório
Estado do ciclo de vida do envio. Um dos seguintes: pending, in_transit, delivered, fault ou cancelled.
string
obrigatório
Operador logístico. Um de go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups ou dhl_express. Uma encomenda de kit para casa é dhl_parcel, ou dhl_warenpost quando segue para o estrangeiro como Warenpost International.
string
Número de seguimento externo do operador logístico. Pode ser null.
string
Descrição em texto livre do conteúdo da encomenda, conforme indicado na criação. Pode ser null.
string
obrigatório
Quem imprimiu a etiqueta: aniva ou external. Um envio que crias é aniva.
string
Referência da outra encomenda de uma remessa com duas encomendas. null para uma encomenda só de ida.
object
Morada de recolha. Pode ser null.
object
Morada de entrega. Mesma estrutura que origin. Pode ser null.
object
Janela de recolha agendada. Pode ser null.
string
Notas opcionais. Pode ser null.
object[]
obrigatório
Eventos cronológicos do ciclo de vida do operador logístico (mais antigos primeiro). Cada entrada tem state, code, detail_code, status, description, location e time. Consulta Obter envio para cada campo. Array vazio imediatamente após a criação. A sincronização em segundo plano adiciona eventos à medida que o operador os comunica.
ShipmentAppointmentLink[]
obrigatório
Marcações associadas a este envio, da associação mais antiga para a mais recente. Cada entrada tem o formato { id, added_at }; cruza cada id com Obter marcação. Contém a marcação passada em appointment_id (se existir) imediatamente após a criação.
ShipmentHomeKitOrderLink[]
obrigatório
Pedidos de kits para casa associados a este envio, no mesmo formato { id, added_at }. Array vazio para um envio que crias.
string
Quando o envio foi reconciliado pela última vez com a transportadora, como instante UTC. null até à primeira sincronização.
string
obrigatório
Data e hora de criação (ISO 8601).
string
Data e hora da última atualização (ISO 8601). Pode ser null.

Respostas de erro