Salt la conținutul principal
POST
Creează o comandă de expediere din locația de origine specificată. Indici laboratorul de destinație prin destination_lab. Expedierea ajunge la adresa de livrare înregistrată a acelui laborator. Necesită scope-ul shipments_manage. Trimite un antet opțional Idempotency-Key pentru ca această creare să poată fi reîncercată în siguranță — repetarea aceleiași chei returnează răspunsul inițial în loc să creeze încă una. Vezi Idempotență.

Cerere

Parametri de corp

string
obligatoriu
UUID-ul locației de testare de origine. Locația trebuie să fie activă și în contextul de acces al cheii tale API. Folosește Listează locațiile pentru a găsi ID-urile locațiilor disponibile.
string
obligatoriu
Laboratorul de destinație. Una dintre valorile zotzklimas, labclinic, nordicgroup, biomes, imd sau quade. Expedierea ajunge la adresa de livrare înregistrată pentru acest laborator. Un laborator fără o adresă de livrare înregistrată returnează 400.
string
UUID opțional al programării pe care o asociezi cu această expediere la creare. Programarea trebuie să fie în contextul de acces al cheii tale API. Asocierea apare direct ca o intrare în lista appointments a expedierii și, reciproc, ca o intrare în lista shipments a programării. Pentru a asocia programări suplimentare după creare sau pentru a elimina asocierea inițială, folosește Atașează programări la expediere și Detașează programări de la expediere.
string
obligatoriu
Data ridicării în format YYYY-MM-DD (de ex., 2026-04-15), interpretată în fusul orar al locației de origine. Trebuie să fie o zi lucrătoare (luni–vineri), azi sau în viitor. Ridicările în aceeași zi nu sunt disponibile după 16:00 Europe/Berlin.
string
obligatoriu
Cea mai devreme oră de ridicare în format HH:MM (de ex., 09:00), interpretată ca oră locală în fusul orar al locației de origine. Trebuie să fie între 09:00 și 19:00.
string
obligatoriu
Cea mai târzie oră de ridicare în format HH:MM (de ex., 12:00), interpretată ca oră locală în fusul orar al locației de origine. Trebuie să fie între 09:00 și 19:00. Intervalul (pickup_time_till - pickup_time_from) trebuie să fie de cel puțin 2 ore.
integer
implicit:"1"
Numărul de colete. Valoare implicită: 1.
number
implicit:"0.5"
Greutatea în kg. Valoare implicită: 0.5.
string
Instrucțiuni pentru curier la ridicare (mențiuni ale expeditorului). Dacă lipsesc, se folosesc mențiunile salvate ale adresei de ridicare (sau niciuna, dacă adresa nu are). Maximum 128 de caractere.
string
Descriere în text liber a conținutului coletului, afișată curierului și returnată ca contents. Maximum 40 de caractere (de ex., Medizinisch freigestellte Probe).
string
Note interne opționale. Maximum 128 de caractere.

Răspuns

În caz de succes, API-ul returnează 201 Created împreună cu noua expediere.
string
obligatoriu
Identificatorul de referință al expedierii (de ex., P2604151234).
string
obligatoriu
Starea expedierii în ciclul de viață. Una dintre valorile pending, in_transit, delivered, fault sau cancelled.
string
obligatoriu
Furnizorul de logistică. Una dintre valorile go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups sau dhl_express. Un colet cu kit pentru acasă folosește dhl_parcel sau dhl_warenpost când pleacă în străinătate ca Warenpost International.
string
Numărul extern de urmărire de la furnizorul de logistică. Poate fi null.
string
Descriere în text liber a conținutului coletului, așa cum a fost furnizată la creare. Poate fi null.
string
obligatoriu
Cine a tipărit eticheta: aniva sau external. O expediere pe care o creezi este aniva.
string
Referința celuilalt colet dintr-o expediere cu două colete. null pentru un colet într-un singur sens.
object
Adresa de ridicare. Poate fi null.
object
Adresa de livrare. Aceeași structură ca origin. Poate fi null.
object
Intervalul programat de ridicare. Poate fi null.
string
Note opționale. Poate fi null.
object[]
obligatoriu
Evenimente cronologice din ciclul de viață de la furnizorul de logistică (cele mai vechi primele). Fiecare intrare are state, code, detail_code, status, description, location și time. Vezi Obține expedierea pentru fiecare câmp. Listă goală imediat după creare. Sincronizarea în fundal adaugă evenimente pe măsură ce furnizorul le raportează.
ShipmentAppointmentLink[]
obligatoriu
Programările asociate cu această expediere, de la cea mai veche asociere. Fiecare intrare are forma { id, added_at }; verifică fiecare id prin Obține programarea. Conține programarea transmisă prin appointment_id (dacă există) imediat după creare.
ShipmentHomeKitOrderLink[]
obligatoriu
Comenzile de kituri pentru acasă asociate cu această expediere, în aceeași formă { id, added_at }. Listă goală pentru o expediere pe care o creezi.
string
Momentul ultimei sincronizări a expedierii cu transportatorul, ca moment UTC. null până la prima sincronizare.
string
obligatoriu
Data și ora creării (ISO 8601).
string
Data și ora ultimei actualizări (ISO 8601). Poate fi null.

Răspunsuri de eroare