Ugrás a fő tartalomhoz
DELETE
Mondj le egy szállítási rendelést. Ez meghívja a logisztikai szolgáltató API-ját a rendelés lemondásához, és cancelled értékre frissíti a küldemény státuszát. Egy már cancelled státuszú küldemény lemondása 200-at ad vissza az adott küldeménnyel, és a szolgáltatót csak egyszer hívja meg. A válaszban szerepel az Idempotent-Replayed: true, így meg tudod különböztetni az ismétlést a műveletet ténylegesen elvégző hívástól. Lásd: Idempotencia.
A küldemények a felvétel után már nem mondhatók le – ez 409 Conflict hibát ad vissza.
Egy DHL-visszaküldési címke önmagában nem mondható le; ez szintén 409 Conflict hibát ad vissza. Ehelyett mondd le a kimenő csomagot. Egy kimenő DHL-csomag lemondása a hozzá tartozó pending visszaküldési sorokat is lemondja. Mindegyik cancelled státuszú lesz, és egy RETURN_LEG_CANCELLED bejegyzés kerül a status_updates mezőbe. Lásd: Visszaküldési címkék. Egy több tesztkészletet tartalmazó dobozban minden készletnek saját kimenő sora és saját visszaküldési címkéje van, még akkor is, ha a doboz egyetlen készlet címkéjével utazik. Egy készlet kimenő sorának lemondása az adott készlet visszaküldési címkéjét is lemondja. Egy otthoni tesztkészlet-csomag lemondásához minden kapcsolódó otthoni tesztkészlet-rendelésnek a hozzáférési kontextusodban kell lennie. Ellenkező esetben a hívás 403-at ad vissza. Lásd: Hozzáférés.

Kérés

Útvonalparaméterek

string
kötelező
A küldemény hivatkozási azonosítója (pl. P2611194821).

Válasz

Sikeres kérés esetén az API 200 OK választ ad vissza a lemondott küldemény objektummal.
string
kötelező
A küldemény referenciaazonosítója.
string
kötelező
A küldemény életciklus-státusza. Sikeres lemondás után cancelled lesz.
string
kötelező
Logisztikai szolgáltató. Lehetséges értékei: go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups vagy dhl_express. Az otthoni tesztkészlet-csomag dhl_parcel, illetve dhl_warenpost, ha külföldre megy Warenpost International küldeményként.
string
A logisztikai szolgáltatótól kapott külső csomagkövetési szám. Lehet null.
string
A csomag tartalmának szabad szöveges leírása, ahogyan a létrehozáskor megadták. Lehet null.
string
kötelező
Ki nyomtatta a címkét: aniva vagy external. Csak az aniva küldemények fogadják el ezt a hívást.
string
A kétcsomagos szállítmány másik csomagjának referenciája. Egyirányú csomagnál null.
object
Felvételi cím. Lehet null.
object
Kézbesítési cím. Ugyanolyan szerkezetű, mint az origin. Lehet null.
object
Ütemezett felvételi időablak. Lehet null.
string
Opcionális megjegyzések. Lehet null.
object[]
kötelező
A logisztikai szolgáltató időrendi életciklus-eseményei (a legrégebbitől kezdve). Minden elem tartalmazza a state, code, detail_code, status, description, location és time mezőket. Az egyes mezőket lásd a Küldemény lekérdezése oldalon. Üres tömb, ha még nem érkezett esemény.
ShipmentAppointmentLink[]
kötelező
A lemondás előtt ehhez a küldeményhez kapcsolt időpontok. Minden elem { id, added_at } formátumú; az egyes id értékeket az Időpont lekérdezése végponttal vetheted össze. Csak a hozzáférési körödbe tartozó időpontok szerepelnek a listában.
ShipmentHomeKitOrderLink[]
kötelező
Az ehhez a küldeményhez kapcsolt otthoni tesztkészlet-rendelések, a legrégebben kapcsolttól kezdve, ugyanabban az { id, added_at } szerkezetben. Csak a hozzáférési körödbe tartozó rendelések szerepelnek a listában. Rendelői csomagok esetén üres tömb.
string
Mikor történt a küldemény utolsó egyeztetése a futárszolgálattal, UTC időpillanatként. Az első szinkronizálásig null.
string
kötelező
Létrehozási időbélyeg (ISO 8601).
string
Utolsó frissítés időbélyege (ISO 8601). Lehet null.

Hibaválaszok