Vai al contenuto principale
POST
Crea un ordine di spedizione dalla sede di origine specificata. Indichi il laboratorio di destinazione con destination_lab. La spedizione va all’indirizzo di spedizione registrato per quel laboratorio. Richiede lo scope shipments_manage. Invia un header opzionale Idempotency-Key per poter ripetere questa creazione in sicurezza — ripetere la stessa chiave restituisce la risposta originale invece di crearne una seconda. Vedi Idempotenza.

Richiesta

Parametri del body

string
obbligatorio
UUID della sede del test di origine. La sede deve essere attiva e nel contesto di accesso della tua chiave API. Usa Elenca sedi per trovare gli ID delle sedi disponibili.
string
obbligatorio
Laboratorio di destinazione. Uno tra zotzklimas, labclinic, nordicgroup, biomes, imd o quade. La spedizione va all’indirizzo di spedizione registrato per questo laboratorio. Un laboratorio senza un indirizzo di spedizione registrato restituisce 400.
string
UUID facoltativo dell’appuntamento a cui collegare questa spedizione al momento della creazione. L’appuntamento deve essere nel contesto di accesso della tua chiave API. Il collegamento compare direttamente come voce nell’array appointments della spedizione e, viceversa, come voce nell’array shipments dell’appuntamento. Per collegare altri appuntamenti dopo la creazione, o rimuovere il collegamento iniziale, usa Collega appuntamenti alla spedizione e Scollega appuntamenti dalla spedizione.
string
obbligatorio
Data di ritiro in formato YYYY-MM-DD (es. 2026-04-15), interpretata nel fuso orario della sede di origine. Deve essere un giorno feriale (lunedì–venerdì), oggi o in futuro. I ritiri in giornata non sono disponibili dopo le 16:00 Europe/Berlin.
string
obbligatorio
Orario minimo di ritiro in formato HH:MM (es. 09:00), interpretato come ora locale nel fuso orario della sede di origine. Deve essere compreso tra 09:00 e 19:00.
string
obbligatorio
Orario massimo di ritiro in formato HH:MM (es. 12:00), interpretato come ora locale nel fuso orario della sede di origine. Deve essere compreso tra 09:00 e 19:00. La fascia (pickup_time_till - pickup_time_from) deve durare almeno 2 ore.
integer
predefinito:"1"
Numero di colli. Il valore predefinito è 1.
number
predefinito:"0.5"
Peso in kg. Il valore predefinito è 0.5.
string
Istruzioni per il corriere al ritiro (note del mittente). Se omesso, vengono usate le note salvate dell’indirizzo di ritiro (o nessuna se l’indirizzo non ne ha). Massimo 128 caratteri.
string
Descrizione in testo libero del contenuto del pacco, mostrata al corriere e restituita come contents. Massimo 40 caratteri (es. Medizinisch freigestellte Probe).
string
Note interne facoltative. Massimo 128 caratteri.

Risposta

In caso di successo, l’API restituisce 201 Created con la nuova spedizione.
string
obbligatorio
Identificativo di riferimento della spedizione (es. P2604151234).
string
obbligatorio
Stato del ciclo di vita della spedizione. Uno tra pending, in_transit, delivered, fault o cancelled.
string
obbligatorio
Fornitore logistico. Uno tra go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups o dhl_express. Un pacco con kit a domicilio è dhl_parcel, oppure dhl_warenpost quando viene spedito all’estero come Warenpost International.
string
Numero di tracciamento esterno del fornitore logistico. Può essere null.
string
Descrizione in testo libero del contenuto del pacco, come fornita alla creazione. Può essere null.
string
obbligatorio
Chi ha stampato l’etichetta: aniva o external. Una spedizione creata da te è aniva.
string
Riferimento dell’altro pacco in una spedizione a due pacchi. null per un pacco di sola andata.
object
Indirizzo di ritiro. Può essere null.
object
Indirizzo di consegna. Stessa struttura di origin. Può essere null.
object
Fascia di ritiro programmata. Può essere null.
string
Note facoltative. Può essere null.
object[]
obbligatorio
Eventi cronologici del ciclo di vita dal fornitore logistico (dal più vecchio al più recente). Ogni voce contiene state, code, detail_code, status, description, location e time. Consulta Ottieni spedizione per ogni campo. Array vuoto subito dopo la creazione. La sincronizzazione in background aggiunge gli eventi man mano che il fornitore li segnala.
ShipmentAppointmentLink[]
obbligatorio
Appuntamenti collegati a questa spedizione, dal collegamento più vecchio al più recente. Ogni voce è { id, added_at }; confronta ogni id con Ottieni appuntamento. Contiene l’appuntamento passato tramite appointment_id (se presente) subito dopo la creazione.
ShipmentHomeKitOrderLink[]
obbligatorio
Ordini di kit a domicilio collegati a questa spedizione, nello stesso formato { id, added_at }. Array vuoto per una spedizione creata da te.
string
Quando la spedizione è stata sincronizzata per l’ultima volta con il corriere, come istante UTC. null fino alla prima sincronizzazione.
string
obbligatorio
Timestamp di creazione (ISO 8601).
string
Timestamp dell’ultimo aggiornamento (ISO 8601). Può essere null.

Risposte di errore