Pāriet uz galveno saturu
POST
Izveido sūtījuma pasūtījumu no norādītās izcelsmes vietas. Galamērķa laboratoriju norādi ar destination_lab. Sūtījums tiek nosūtīts uz šīs laboratorijas reģistrēto piegādes adresi. Nepieciešams shipments_manage tvērums. Nosūti neobligātu Idempotency-Key galveni, lai šo izveides pieprasījumu varētu droši atkārtot — atkārtojot to pašu atslēgu, tiek atgriezta sākotnējā atbilde, nevis izveidots otrs pieraksts. Skati Idempotence.

Pieprasījums

Pieprasījuma satura parametri

string
obligāts
Izcelsmes testēšanas vietas UUID. Atrašanās vietai jābūt aktīvai un tavas API atslēgas piekļuves kontekstā. Lai atrastu pieejamos atrašanās vietu ID, izmanto Uzskaitīt atrašanās vietas.
string
obligāts
Galamērķa laboratorija. Viena no šīm vērtībām: zotzklimas, labclinic, nordicgroup, biomes, imd vai quade. Sūtījums tiek nosūtīts uz šai laboratorijai reģistrēto piegādes adresi. Ja laboratorijai nav reģistrētas piegādes adreses, tiek atgriezts 400.
string
Neobligāts pieraksta UUID, ko sasaistīt ar šo sūtījumu izveides brīdī. Pierakstam jābūt tavas API atslēgas piekļuves kontekstā. Saite parādās tieši kā ieraksts sūtījuma appointments masīvā un attiecīgi kā ieraksts pieraksta shipments masīvā. Lai pēc izveides pievienotu papildu pierakstus vai noņemtu sākotnējo saiti, izmanto Pievienot pierakstus sūtījumam un Atvienot pierakstus no sūtījuma.
string
obligāts
Paņemšanas datums formātā YYYY-MM-DD (piem., 2026-04-15), kas tiek interpretēts izcelsmes vietas laika joslā. Jābūt darba dienai (pirmdiena–piektdiena), šodienai vai nākotnē. Paņemšana tajā pašā dienā nav pieejama pēc 16:00 (Europe/Berlin).
string
obligāts
Agrākais paņemšanas laiks formātā HH:MM (piem., 09:00), kas tiek interpretēts kā vietējais laiks izcelsmes vietas laika joslā. Jābūt no 09:00 līdz 19:00.
string
obligāts
Vēlākais paņemšanas laiks formātā HH:MM (piem., 12:00), kas tiek interpretēts kā vietējais laiks izcelsmes vietas laika joslā. Jābūt no 09:00 līdz 19:00. Laika logam (pickup_time_till - pickup_time_from) jābūt vismaz 2 stundas garam.
integer
noklusējums:"1"
Paku skaits. Noklusējuma vērtība ir 1.
number
noklusējums:"0.5"
Svars kg. Noklusējuma vērtība ir 0.5.
string
Norādījumi kurjeram paņemšanas brīdī (nosūtītāja piezīmes). Ja tas netiek norādīts, tiek izmantotas paņemšanas adresē saglabātās piezīmes (vai nekādas, ja adresei to nav). Ne vairāk kā 128 rakstzīmes.
string
Brīva teksta apraksts par pakas saturu, kas tiek parādīts kurjeram un atgriezts kā contents. Ne vairāk kā 40 rakstzīmes (piem., Medizinisch freigestellte Probe).
string
Neobligātas iekšējās piezīmes. Ne vairāk kā 128 rakstzīmes.

Atbilde

Veiksmīgas darbības gadījumā API atgriež 201 Created ar jauno sūtījumu.
string
obligāts
Sūtījuma atsauces identifikators (piem., P2604151234).
string
obligāts
Sūtījuma dzīves cikla statuss. Viena no šīm vērtībām: pending, in_transit, delivered, fault vai cancelled.
string
obligāts
Loģistikas pakalpojumu sniedzējs. Viena no vērtībām: go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups vai dhl_express. Mājas komplekta paka ir dhl_parcel vai dhl_warenpost, ja tā dodas uz ārzemēm kā Warenpost International.
string
Loģistikas pakalpojumu sniedzēja ārējais izsekošanas numurs. Var būt null.
string
Brīvā teksta apraksts par pakas saturu, kā norādīts izveides brīdī. Var būt null.
string
obligāts
Kas izdrukāja etiķeti: aniva vai external. Tevis izveidots sūtījums ir aniva.
string
Otras pakas atsauce divu paku sūtījumā. null vienvirziena pakai.
object
Paņemšanas adrese. Var būt null.
object
Piegādes adrese. Tāda pati struktūra kā origin. Var būt null.
object
Ieplānotais paņemšanas laika logs. Var būt null.
string
Neobligātas piezīmes. Var būt null.
object[]
obligāts
Hronoloģiski loģistikas pakalpojumu sniedzēja dzīves cikla notikumi (vecākie vispirms). Katram ierakstam ir state, code, detail_code, status, description, location un time. Katra lauka aprakstu skati sadaļā Iegūt sūtījumu. Uzreiz pēc izveides tas ir tukšs masīvs. Fona sinhronizācija pievieno notikumus, tiklīdz pakalpojumu sniedzējs par tiem ziņo.
ShipmentAppointmentLink[]
obligāts
Ar šo sūtījumu saistītie pieraksti, sākot ar vecāko saiti. Katrs ieraksts ir { id, added_at }; katru id pārbaudi ar Iegūt pierakstu. Uzreiz pēc izveides satur ar appointment_id padoto pierakstu (ja tāds ir).
ShipmentHomeKitOrderLink[]
obligāts
Ar šo sūtījumu saistītie mājas komplektu pasūtījumi tādā pašā { id, added_at } formā. Tevis izveidotam sūtījumam tas ir tukšs masīvs.
string
Laiks, kad sūtījums pēdējo reizi tika salāgots ar pārvadātāju, kā UTC laika punkts. null līdz pirmajai sinhronizācijai.
string
obligāts
Izveides laikspiedols (ISO 8601).
string
Pēdējās atjaunināšanas laikspiedols (ISO 8601). Var būt null.

Kļūdu atbildes