Saltar al contingut principal
PATCH
Actualitza els detalls de l’enviament, com ara l’horari de recollida, el nombre de paquets o les notes. Si canvia algun camp rellevant per a la logística (data de recollida, hora, nombre de paquets o pes), l’ordre logística existent es cancel·la i se’n crea una de nova automàticament. Els camps que ometis es conserven de l’enviament existent. Els camps d’horari actualitzats es validen segons les regles d’horari de recollida.
Els enviaments no es poden modificar després de la recollida. Intentar actualitzar un enviament que ja s’ha recollit retorna 409 Conflict.
Un paquet de kit de prova a casa ja té l’etiqueta impresa, així que només pot canviar notes. Una nova franja de recollida o un nou pes en un paquet de kit de prova a casa retorna 409 Conflict; cancel·la’l i crea un enviament nou en el seu lloc. Per actualitzar un paquet de kit de prova a casa, totes les comandes de kit de prova a casa vinculades han de ser dins del teu context d’accés. En cas contrari, la crida retorna 403. Consulta Accés.

Sol·licitud

Paràmetres de ruta

string
requerit
ID de referència de l’enviament (p. ex., P2611194821).

Paràmetres del cos

Tots els paràmetres del cos són opcionals — inclou només els camps que vulguis canviar.
string
Nova data de recollida en format YYYY-MM-DD, interpretada en el fus horari de la ubicació d’origen.
string
Nova hora mínima de recollida en format HH:MM, interpretada com a hora local en el fus horari de la ubicació d’origen.
string
Nova hora màxima de recollida en format HH:MM, interpretada com a hora local en el fus horari de la ubicació d’origen.
integer
Nou nombre de paquets.
number
Nou pes en kg.
string
Noves notes o observacions. Màxim 128 caràcters.

Resposta

Si té èxit, l’API retorna 200 OK amb l’enviament actualitzat.
string
requerit
Identificador de referència de l’enviament.
string
requerit
Estat del cicle de vida de l’enviament. Un de pending, in_transit, delivered, fault o cancelled.
string
requerit
Proveïdor logístic. Pot ser go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups o dhl_express. Un paquet de kit a domicili és dhl_parcel, o dhl_warenpost quan s’envia a l’estranger com a Warenpost International.
string
Número de seguiment extern del proveïdor logístic. Pot ser null.
string
Descripció en text lliure del contingut del paquet, tal com es va indicar en crear-lo. Pot ser null.
string
requerit
Qui ha imprès l’etiqueta: aniva o external. Només els enviaments d’aniva accepten aquesta crida.
string
Referència de l’altre paquet d’un enviament de dos paquets. null per a un paquet d’un sol trajecte.
object
Adreça de recollida. Pot ser null.
object
Adreça de lliurament. Mateixa estructura que origin. Pot ser null.
object
Franja de recollida programada. Pot ser null.
string
Notes opcionals. Pot ser null.
object[]
requerit
Esdeveniments cronològics del cicle de vida del proveïdor logístic (el més antic primer). Cada entrada té state, code, detail_code, status, description, location i time. Consulta Obtén l’enviament per a cada camp. Matriu buida si encara no s’ha observat cap esdeveniment.
ShipmentAppointmentLink[]
requerit
Cites vinculades a aquest enviament, el vincle més antic primer. Cada entrada és { id, added_at }; creua cada id amb Obtén la cita. Només es llisten les cites del teu context d’accés.
ShipmentHomeKitOrderLink[]
requerit
Comandes de kits a domicili vinculades a aquest enviament, el vincle més antic primer, amb el mateix format { id, added_at }. Només es llisten les comandes del teu context d’accés. Matriu buida per als paquets de consulta.
string
Quan es va conciliar l’enviament per última vegada amb el transportista, com a instant UTC. null fins a la primera sincronització.
string
requerit
Marca de temps de creació (ISO 8601).
string
Marca de temps de l’última actualització (ISO 8601). Pot ser null.

Respostes d’error