Ir al contenido principal

Actualizar una expedición

A
Escrito por Axel Candia

Modifica los datos de una expedición ya existente. Solo se envían los campos que querés cambiar; el resto se mantiene igual.

POST https://api.app.vonzu.es/api/v2/services/update

Cabeceras

secret-api-key: TU_API_KEY
Authorization-Domain: TU_DOMINIO
Content-Type: application/json

Estructura del cuerpo

Los cambios se envían dentro de un objeto update. Incluí en él únicamente los campos que quieras modificar:

{
  "update": {
    "reference": "MI-REFERENCIA-001",
    "campo_a_modificar": "nuevo valor"
  }
}

Identificación de la expedición: incluí la reference de la expedición dentro de update para indicar sobre cuál querés aplicar los cambios. Si tu integración utiliza otro identificador (por ejemplo el id interno), confirmalo con el equipo de GRIP.

Los campos aceptados son los mismos que en la creación (ver Crear una expedición), más algunos específicos de operación:

Campo

Tipo

Descripción

address / origin

object

Actualiza la dirección de destino / origen.

contact

object

Actualiza los datos de contacto.

schedules

array

Actualiza las franjas horarias.

barcodes

array de string

Actualiza los códigos de barras.

description / comments

string

Actualiza descripción o comentarios.

date

string (YYYY-MM-DD)

Cambia la fecha del servicio.

driversUsernames

array de string

Asigna uno o varios conductores a la expedición.

clientUsername

string

Reasigna la expedición a otro cliente.

packageCount

number

Actualiza el número de bultos.

status

object

Cambia el estado, con un campo code (por ejemplo completed).

concertDate

string (YYYY-MM-DD)

Fecha concertada con el destinatario.

concertSchedules

array

Franjas horarias concertadas.

pod

object

Prueba de entrega (POD): puede incluir type e image.

reimbursement

number

Actualiza el importe de reembolso.

reimbursementStatus

string

Estado del reembolso.

weight / volume

number

Actualiza peso / volumen.

payer

string

Actualiza el pagador.

channel

string

Actualiza el canal.

agencyId / originAgencyId

string

Asigna agencia de destino / origen.

dedicationTime

number

Tiempo de dedicación (minutos).

removals

number

Número de retiradas.

insuredValue

number

Valor asegurado.

skills

array de string

Requisitos del conductor.

extraFields

object

Campos personalizados.

logisticsUnitSSCC

string

Código SSCC de la unidad logística.

dontCalculateDate

boolean

Si es true, no recalcula la fecha automáticamente.

Ejemplo: actualización simple

Cambiar únicamente el canal de una expedición:

{
  "update": {
    "reference": "MI-REFERENCIA-001",
    "channel": "online"
  }
}

Ejemplo: actualización operativa

Asignar conductor, marcar como completada y registrar la fecha concertada:

{
  "update": {
    "reference": "MI-REFERENCIA-001",
    "driversUsernames": ["nicoledriver2"],
    "clientUsername": "Celeritas",
    "packageCount": 2,
    "status": { "code": "completed" },
    "concertDate": "2023-07-17",
    "concertSchedules": [
      ["00:30:00", "01:45:00"]
    ]
  }
}

Respuesta

La API responde con estado 200 OK. Para obtener el estado actualizado de la expedición, podés consultarla con Buscar por referencia.

¿Ha quedado contestada tu pregunta?