Naar hoofdinhoud gaan
POST
Maak een verzendopdracht aan vanaf de opgegeven vertreklocatie. Je geeft het bestemmingslaboratorium op met destination_lab. De zending gaat naar het geregistreerde verzendadres van dat laboratorium. Vereist de scope shipments_manage. Stuur een optionele Idempotency-Key-header mee om het aanmaken veilig opnieuw te kunnen proberen — bij herhaling van dezelfde sleutel krijg je de oorspronkelijke respons terug in plaats van een tweede aan te maken. Zie Idempotentie.

Verzoek

Bodyparameters

string
vereist
UUID van de testlocatie van vertrek. De locatie moet actief zijn en binnen de toegangscontext van je API-sleutel vallen. Gebruik Locaties weergeven om beschikbare locatie-ID’s te vinden.
string
vereist
Bestemmingslaboratorium. Een van zotzklimas, labclinic, nordicgroup, biomes, imd of quade. De zending gaat naar het verzendadres dat voor dit laboratorium is geregistreerd. Een laboratorium zonder geregistreerd verzendadres retourneert 400.
string
Optionele afspraak-UUID om deze zending bij het aanmaken aan te koppelen. De afspraak moet binnen de toegangscontext van je API-sleutel vallen. De koppeling verschijnt inline als item in de appointments-array van de zending, en omgekeerd als item in de shipments-array van de afspraak. Gebruik Afspraken koppelen aan zending en Afspraken loskoppelen van zending om na het aanmaken extra afspraken te koppelen of de oorspronkelijke koppeling te verwijderen.
string
vereist
Ophaaldatum in YYYY-MM-DD-indeling (bijv. 2026-04-15), geïnterpreteerd in de tijdzone van de vertreklocatie. Moet een werkdag zijn (maandag–vrijdag), vandaag of in de toekomst. Ophalen op dezelfde dag is niet beschikbaar na 16:00 Europe/Berlin.
string
vereist
Vroegste ophaaltijd in HH:MM-indeling (bijv. 09:00), geïnterpreteerd als lokale tijd in de tijdzone van de vertreklocatie. Moet tussen 09:00 en 19:00 liggen.
string
vereist
Laatste ophaaltijd in HH:MM-indeling (bijv. 12:00), geïnterpreteerd als lokale tijd in de tijdzone van de vertreklocatie. Moet tussen 09:00 en 19:00 liggen. Het tijdvenster (pickup_time_till - pickup_time_from) moet minstens 2 uur zijn.
integer
standaard:"1"
Aantal pakketten. Standaard 1.
number
standaard:"0.5"
Gewicht in kg. Standaard 0.5.
string
Instructies voor de koerier bij het ophalen (opmerkingen van de afzender). Als je dit weglaat, worden de opgeslagen opmerkingen van het ophaaladres gebruikt (of geen, als het adres er geen heeft). Maximaal 128 tekens.
string
Vrije tekstbeschrijving van de inhoud van het pakket, getoond aan de koerier en teruggestuurd als contents. Maximaal 40 tekens (bijv. Medizinisch freigestellte Probe).
string
Optionele interne notities. Maximaal 128 tekens.

Respons

Bij succes retourneert de API 201 Created met de nieuwe zending.
string
vereist
Referentie-ID van de zending (bijv. P2604151234).
string
vereist
Levenscyclusstatus van de zending. Een van pending, in_transit, delivered, fault of cancelled.
string
vereist
Vervoerder. Een van go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups of dhl_express. Een pakket met een thuistestkit is dhl_parcel, of dhl_warenpost wanneer het naar het buitenland gaat als Warenpost International.
string
Extern trackingnummer van de vervoerder. Kan null zijn.
string
Vrije tekstbeschrijving van wat er in het pakket zit, zoals opgegeven bij het aanmaken. Kan null zijn.
string
vereist
Wie het label heeft afgedrukt: aniva of external. Een zending die je aanmaakt is aniva.
string
Referentie van het andere pakket in een zending van twee pakketten. null voor een pakket in één richting.
object
Ophaaladres. Kan null zijn.
object
Bezorgadres. Zelfde structuur als origin. Kan null zijn.
object
Gepland ophaalvenster. Kan null zijn.
string
Optionele notities. Kan null zijn.
object[]
vereist
Chronologische levenscyclusgebeurtenissen van de logistieke dienstverlener (oudste eerst). Elk item heeft een state, code, detail_code, status, description, location en time. Zie Zending ophalen voor elk veld. Lege array direct na het aanmaken. De achtergrondsynchronisatie voegt gebeurtenissen toe zodra de dienstverlener ze meldt.
ShipmentAppointmentLink[]
vereist
Afspraken gekoppeld aan deze zending, oudste koppeling eerst. Elk item is { id, added_at }; zoek elke id op via Afspraak ophalen. Bevat direct na het aanmaken de afspraak die via appointment_id is meegegeven (indien van toepassing).
ShipmentHomeKitOrderLink[]
vereist
Thuistestbestellingen gekoppeld aan deze zending, in dezelfde { id, added_at }-structuur. Lege array voor een zending die je aanmaakt.
string
Wanneer de zending voor het laatst met de vervoerder is gesynchroniseerd, als UTC-tijdstip. null tot de eerste synchronisatie.
string
vereist
Tijdstempel van aanmaken (ISO 8601).
string
Tijdstempel van laatste update (ISO 8601). Kan null zijn.

Foutresponsen