Hoppa till huvudinnehåll
GET
Hämta en enskild försändelse via dess referens-ID. Svaret kommer från vår databas och anropar aldrig transportören. En bakgrundssynkronisering uppdaterar varje försändelse (var 10:e minut för GO!, varje timme för DHL) och synced_at visar när transportören senast tillfrågades. Kräver scope shipments_view eller shipments_manage.

Förfrågan

Sökvägsparametrar

string
obligatorisk
Försändelsens referens-ID (t.ex. P2611194821).

Svar

Vid lyckat anrop returnerar API:et 200 OK med försändelseobjektet.
string
obligatorisk
Försändelsens referensidentifierare.
string
obligatorisk
Försändelsens livscykelstatus. Ett av pending, in_transit, delivered, fault eller cancelled.
string
obligatorisk
Logistikleverantör. Ett av go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups eller dhl_express. Ett paket med hemtestkit använder dhl_parcel, eller dhl_warenpost när det skickas utomlands som Warenpost International.
string
Externt spårningsnummer från logistikleverantören. Kan vara null.
string
Fritextbeskrivning av paketets innehåll så som den angavs när försändelsen skapades (t.ex. "Medizinisch freigestellte Probe", "Home test kit"). Endast i informationssyfte — om ett paket är på väg till ett laboratorium utläses från destination, och dess motpart från paired_with. Kan vara null.
string
obligatorisk
Vem som skrev ut etiketten: aniva eller external. Endast aniva-försändelser tar emot Uppdatera och Avboka; ett external-paket spåras men returnerar 501 vid båda.
string
Referens till det andra paketet i en sändning med två paket – paketet som hade med en returetikett och paketet som etiketten skickar tillbaka. Anges på båda. null för ett paket som bara går åt ett håll.
object
Upphämtningsadress. Kan vara null.
object
Leveransadress. Samma struktur som origin. Kan vara null.
object
Schemalagt upphämtningsfönster. Kan vara null.
string
Valfria anteckningar. Kan vara null.
object[]
obligatorisk
Kronologiska livscykelhändelser från logistikleverantören (äldst först). Tom array om leverantören inte har rapporterat några händelser ännu. Använd detta för händelsevyer i gränssnittet, granskning och mer detaljerade signaler från transportören; förlita dig på status för den aktuella huvudstatusen.
ShipmentAppointmentLink[]
obligatorisk
Bokningar kopplade till denna försändelse, äldsta kopplingen först. Varje post är { id, added_at }; slå upp varje id med Hämta bokning för hela bokningsobjektet. Tom array när inga bokningar är kopplade. Endast bokningarna i din åtkomstkontext listas.
ShipmentHomeKitOrderLink[]
obligatorisk
Beställningar av hemtestkit kopplade till denna försändelse, äldsta kopplingen först, med samma struktur { id, added_at }. Slå upp varje id med Hämta beställning av hemtestkit. Tom array för paket från mottagningar. Endast beställningarna i din åtkomstkontext listas. Se Åtkomst.
string
När försändelsen senast stämdes av mot transportören, som en UTC-tidpunkt. Läsningar anropar aldrig transportören – en bakgrundssynkronisering håller försändelserna uppdaterade – så det här visar hur gammalt svaret är. null fram till den första synkroniseringen.
string
obligatorisk
Tidsstämpel för skapande (ISO 8601).
string
Tidsstämpel för senaste uppdatering (ISO 8601). Kan vara null.

Upprepade anrop

Aniva lagrar svaret från den här slutpunkten i 60 minuter för varje API-nyckel. Ett upprepat anrop inom den tiden får det lagrade svaret så länge försändelsen är oförändrad. Efter en ändring får du ett nytt svar. Headerna Cache-Status och Age visar att svaret är lagrat och hur gammalt det är. I ett lagrat svar kan synced_at och updated_at vara äldre än i ett nytt svar. För att få veta om en ändring direkt, prenumerera på webhook-händelserna shipment.created och shipment.updated. Se Upprepade läsningar.

Felsvar