Saltar al contenido principal
POST
Crea una orden de envío desde la ubicación de origen especificada. Indicas el laboratorio de destino con destination_lab. El envío va a la dirección de envío registrada de ese laboratorio. Requiere el scope shipments_manage. Envía una cabecera opcional Idempotency-Key para que esta creación se pueda reintentar con seguridad: repetir la misma clave devuelve la respuesta original en lugar de crear otra. Consulta Idempotencia.

Solicitud

Parámetros del cuerpo

string
requerido
UUID de la ubicación de pruebas de origen. La ubicación debe estar activa y dentro del contexto de acceso de tu clave de API. Usa Listar ubicaciones para encontrar los ID de ubicación disponibles.
string
requerido
Laboratorio de destino. Uno de zotzklimas, labclinic, nordicgroup, biomes, imd o quade. El envío va a la dirección de envío registrada para este laboratorio. Un laboratorio sin dirección de envío registrada devuelve 400.
string
UUID de cita opcional al que vincular este envío al crearlo. La cita debe estar dentro del contexto de acceso de tu clave de API. El vínculo aparece directamente como una entrada en el array appointments del envío y, de forma recíproca, como una entrada en el array shipments de la cita. Para vincular más citas tras la creación o eliminar el vínculo inicial, usa Vincular citas al envío y Desvincular citas del envío.
string
requerido
Fecha de recogida en formato YYYY-MM-DD (p. ej., 2026-04-15), interpretada en la zona horaria de la ubicación de origen. Debe ser un día laborable (de lunes a viernes), hoy o en el futuro. Las recogidas en el mismo día no están disponibles después de las 16:00 Europe/Berlin.
string
requerido
Hora más temprana de recogida en formato HH:MM (p. ej., 09:00), interpretada como hora local en la zona horaria de la ubicación de origen. Debe estar entre 09:00 y 19:00.
string
requerido
Hora límite de recogida en formato HH:MM (p. ej., 12:00), interpretada como hora local en la zona horaria de la ubicación de origen. Debe estar entre 09:00 y 19:00. La franja (pickup_time_till - pickup_time_from) debe ser de al menos 2 horas.
integer
predeterminado:"1"
Número de paquetes. Por defecto, 1.
number
predeterminado:"0.5"
Peso en kg. Por defecto, 0.5.
string
Instrucciones para el mensajero en la recogida (observaciones del remitente). Si se omite, se usan las observaciones guardadas de la dirección de recogida (o ninguna si la dirección no tiene). Máximo 128 caracteres.
string
Descripción en texto libre del contenido del paquete, que se muestra al mensajero y se devuelve como contents. Máximo 40 caracteres (p. ej., Medizinisch freigestellte Probe).
string
Notas internas opcionales. Máximo 128 caracteres.

Respuesta

Si tiene éxito, la API devuelve 201 Created con el nuevo envío.
string
requerido
Identificador de referencia del envío (p. ej., P2604151234).
string
requerido
Estado del ciclo de vida del envío. Uno de pending, in_transit, delivered, fault o cancelled.
string
requerido
Proveedor logístico. Puede ser go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups o dhl_express. Un paquete de kit a domicilio es dhl_parcel, o dhl_warenpost cuando se envía al extranjero como Warenpost International.
string
Número de seguimiento externo del proveedor logístico. Puede ser null.
string
Descripción en texto libre del contenido del paquete, tal como se indicó al crearlo. Puede ser null.
string
requerido
Quién imprimió la etiqueta: aniva o external. Un envío creado por ti es aniva.
string
Referencia del otro paquete en un envío de dos paquetes. Es null para un paquete solo de ida.
object
Dirección de recogida. Puede ser null.
object
Dirección de entrega. Misma estructura que origin. Puede ser null.
object
Franja de recogida programada. Puede ser null.
string
Notas opcionales. Puede ser null.
object[]
requerido
Eventos cronológicos del ciclo de vida del proveedor logístico (del más antiguo al más reciente). Cada entrada tiene state, code, detail_code, status, description, location y time. Consulta Obtener envío para cada campo. Array vacío justo tras la creación. La sincronización en segundo plano añade eventos a medida que el proveedor los notifica.
ShipmentAppointmentLink[]
requerido
Citas vinculadas a este envío, del vínculo más antiguo al más reciente. Cada entrada es { id, added_at }; consulta cada id en Obtener cita. Contiene la cita pasada mediante appointment_id (si la hay) justo tras la creación.
ShipmentHomeKitOrderLink[]
requerido
Pedidos de kits a domicilio vinculados a este envío, con el mismo formato { id, added_at }. Array vacío para un envío creado por ti.
string
Cuándo se sincronizó por última vez el envío con su transportista, como instante UTC. null hasta la primera sincronización.
string
requerido
Marca de tiempo de creación (ISO 8601).
string
Marca de tiempo de la última actualización (ISO 8601). Puede ser null.

Respuestas de error