Naar hoofdinhoud gaan
PATCH
Werk zendinggegevens bij, zoals het ophaalschema, aantal pakketten of opmerkingen. Als velden die relevant zijn voor de logistiek wijzigen (ophaaldatum, tijd, aantal pakketten of gewicht), wordt de bestaande logistieke opdracht geannuleerd en wordt er automatisch een nieuwe aangemaakt. Velden die je weglaat blijven behouden vanuit de bestaande zending. Bijgewerkte schemavelden worden gevalideerd aan de hand van de regels voor het ophaalschema.
Zendingen kunnen na ophaling niet meer worden gewijzigd. Een poging om een zending bij te werken die al is opgehaald geeft 409 Conflict terug.
Het label van een thuistestkitpakket is al afgedrukt, dus alleen notes kan wijzigen. Een nieuw ophaalvenster of gewicht voor een thuistestkitpakket geeft 409 Conflict terug; annuleer het pakket en maak in plaats daarvan een nieuwe zending aan. Om een thuistestkitpakket bij te werken moet elke gekoppelde thuistestkitbestelling binnen je toegangscontext vallen. Anders geeft het verzoek 403 terug. Zie Toegang.

Verzoek

Padparameters

string
vereist
Referentie-ID van de zending (bijv. P2611194821).

Bodyparameters

Alle bodyparameters zijn optioneel — neem alleen de velden op die je wilt wijzigen.
string
Nieuwe ophaaldatum in het formaat YYYY-MM-DD, geïnterpreteerd in de tijdzone van de herkomstlocatie.
string
Nieuwe vroegste ophaaltijd in het formaat HH:MM, geïnterpreteerd als lokale kloktijd in de tijdzone van de herkomstlocatie.
string
Nieuwe laatste ophaaltijd in het formaat HH:MM, geïnterpreteerd als lokale kloktijd in de tijdzone van de herkomstlocatie.
integer
Nieuw aantal pakketten.
number
Nieuw gewicht in kg.
string
Nieuwe notities of opmerkingen. Maximaal 128 tekens.

Respons

Bij succes geeft de API 200 OK terug met de bijgewerkte zending.
string
vereist
Referentie-identifier van de zending.
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. Alleen aniva-zendingen accepteren deze aanroep.
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 state, code, detail_code, status, description, location en time. Zie Zending ophalen voor elk veld. Lege array als er nog geen gebeurtenissen zijn waargenomen.
ShipmentAppointmentLink[]
vereist
Afspraken gekoppeld aan deze zending, oudste koppeling eerst. Elk item heeft de vorm { id, added_at }; haal elke id op via Afspraak ophalen. Alleen de afspraken binnen je toegangscontext worden weergegeven.
ShipmentHomeKitOrderLink[]
vereist
Thuistestbestellingen gekoppeld aan deze zending, oudste koppeling eerst, in dezelfde { id, added_at }-structuur. Alleen de bestellingen binnen je toegangscontext worden vermeld. Lege array voor praktijkpakketten.
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