Saltar al contingut principal
POST
Crea una ordre d’enviament des de la ubicació d’origen especificada. Indiques el laboratori de destinació amb destination_lab. L’enviament va a l’adreça d’enviament registrada d’aquest laboratori. Requereix l’àmbit shipments_manage. Envia una capçalera opcional Idempotency-Key perquè aquesta creació es pugui reintentar amb seguretat — repetir la mateixa clau retorna la resposta original en lloc de crear-ne una segona. Consulta Idempotència.

Sol·licitud

Paràmetres del cos

string
requerit
UUID de la ubicació d’anàlisi d’origen. La ubicació ha d’estar activa i dins del context d’accés de la teva clau API. Fes servir Llista les ubicacions per trobar els ID d’ubicació disponibles.
string
requerit
Laboratori de destinació. Un de zotzklimas, labclinic, nordicgroup, biomes, imd o quade. L’enviament va a l’adreça d’enviament registrada per a aquest laboratori. Un laboratori sense adreça d’enviament registrada retorna 400.
string
UUID de cita opcional per vincular-hi aquest enviament en el moment de crear-lo. La cita ha d’estar dins del context d’accés de la teva clau API. El vincle apareix integrat com una entrada a la matriu appointments de l’enviament i, inversament, com una entrada a la matriu shipments de la cita. Per vincular cites addicionals després de la creació o eliminar el vincle inicial, fes servir Vincula cites a l’enviament i Desvincula cites de l’enviament.
string
requerit
Data de recollida en format YYYY-MM-DD (p. ex., 2026-04-15), interpretada en la zona horària de la ubicació d’origen. Ha de ser un dia feiner (dilluns–divendres), avui o en el futur. Les recollides per al mateix dia no estan disponibles després de les 16:00 Europe/Berlin.
string
requerit
Hora mínima de recollida en format HH:MM (p. ex., 09:00), interpretada com a hora local en la zona horària de la ubicació d’origen. Ha de ser entre 09:00 i 19:00.
string
requerit
Hora màxima de recollida en format HH:MM (p. ex., 12:00), interpretada com a hora local en la zona horària de la ubicació d’origen. Ha de ser entre 09:00 i 19:00. La franja (pickup_time_till - pickup_time_from) ha de ser com a mínim de 2 hores.
integer
predeterminat:"1"
Nombre de paquets. Per defecte és 1.
number
predeterminat:"0.5"
Pes en kg. Per defecte és 0.5.
string
Instruccions per al missatger en la recollida (observacions del remitent). Si s’omet, es fan servir les observacions desades de l’adreça de recollida (o cap si l’adreça no en té). Màxim 128 caràcters.
string
Descripció en text lliure del contingut del paquet, que es mostra al missatger i es retorna com a contents. Màxim 40 caràcters (p. ex., Medizinisch freigestellte Probe).
string
Notes internes opcionals. Màxim 128 caràcters.

Resposta

Si té èxit, l’API retorna 201 Created amb el nou enviament.
string
requerit
Identificador de referència de l’enviament (p. ex., P2604151234).
string
requerit
Estat del cicle de vida de l’enviament. Un de pending, in_transit, delivered, fault o cancelled.
string
requerit
Proveïdor logístic. Pot ser go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups o dhl_express. Un paquet de kit a domicili és dhl_parcel, o dhl_warenpost quan s’envia a l’estranger com a Warenpost International.
string
Número de seguiment extern del proveïdor logístic. Pot ser null.
string
Descripció en text lliure del contingut del paquet, tal com es va indicar en crear-lo. Pot ser null.
string
requerit
Qui ha imprès l’etiqueta: aniva o external. Un enviament que crees tu és aniva.
string
Referència de l’altre paquet d’un enviament de dos paquets. null per a un paquet d’un sol trajecte.
object
Adreça de recollida. Pot ser null.
object
Adreça de lliurament. Mateixa estructura que origin. Pot ser null.
object
Franja de recollida programada. Pot ser null.
string
Notes opcionals. Pot ser null.
object[]
requerit
Esdeveniments cronològics del cicle de vida del proveïdor logístic (el més antic primer). Cada entrada té state, code, detail_code, status, description, location i time. Consulta Obtén l’enviament per a cada camp. Matriu buida just després de la creació. La sincronització en segon pla afegeix esdeveniments a mesura que el proveïdor els comunica.
ShipmentAppointmentLink[]
requerit
Cites vinculades a aquest enviament, el vincle més antic primer. Cada entrada és { id, added_at }; consulta cada id a Obtén la cita. Conté la cita passada mitjançant appointment_id (si n’hi ha) just després de la creació.
ShipmentHomeKitOrderLink[]
requerit
Comandes de kits a domicili vinculades a aquest enviament, amb el mateix format { id, added_at }. Matriu buida per a un enviament que crees tu.
string
Quan es va conciliar l’enviament per última vegada amb el transportista, com a instant UTC. null fins a la primera sincronització.
string
requerit
Marca de temps de creació (ISO 8601).
string
Marca de temps de l’última actualització (ISO 8601). Pot ser null.

Respostes d’error